Credentials

GET a list of credentials

GEThttps://app.configure8.io/public/v1/credentials
Query parameters
Response
Body
items*array of CredentialDto (object)
totalFound*number

Total credentials found

pageNumber*number

Requested page, note that it starts with 0

pageSize*number

Maximum credentials in one paginated response

Request
const response = await fetch('https://app.configure8.io/public/v1/credentials', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "items": [
    {
      "id": "text",
      "name": "text",
      "providerName": "AWS",
      "providerType": "CLOUD",
      "orgId": "text",
      "configuration": [
        []
      ],
      "status": "ACTIVE",
      "createdBy": "text",
      "lastChangedBy": "text",
      "createDateTime": "2025-01-21T04:06:33.020Z",
      "lastChangedDateTime": "2025-01-21T04:06:33.020Z",
      "createSchedule": false
    }
  ],
  "totalFound": 0,
  "pageNumber": 0,
  "pageSize": 0
}

POST a new credential

POSThttps://app.configure8.io/public/v1/credentials
Body

Credential object to be created

name*string

Name of the credential

providerName*enum

Name of the provider

AWSGCPGitHubGitLabAzure DevOpsAZUREBitbucketCircleCICustomPluginDatadogEmbeddedViewHttpClientJenkinsJira NewRelicOpsGeniePagerDutyScorecardsSonarCloudSplunk
providerType*enum

Type of the provider

CLOUDREPOSCICDOTHERISSUE_TRACKINGOMSCODE_INSPECTION
configuration*array of CredentialAspectDto (object)

Configuration of the credential

statusenum

Status of the credential

ACTIVEDISABLEDBROKEN
Response
Body
id*string

Credential id

name*string

Credential name

providerName*enum

Credential provider name

AWSGCPGitHubGitLabAzure DevOpsAZUREBitbucketCircleCICustomPluginDatadogEmbeddedViewHttpClientJenkinsJira NewRelicOpsGeniePagerDutyScorecardsSonarCloudSplunk
providerType*enum

Credential provider type

CLOUDREPOSCICDOTHERISSUE_TRACKINGOMSCODE_INSPECTION
orgId*string

Credential organization id

configuration*array of array

Credential configuration

status*enum

Credential status

ACTIVEDISABLEDBROKEN
createdBystring

Credential created by

lastChangedBystring

Credential last changed by

createDateTimestring (date-time)

Credential created at

lastChangedDateTimestring (date-time)

Credential updated at

createScheduleboolean

Credential updated at

Request
const response = await fetch('https://app.configure8.io/public/v1/credentials', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "providerName": "AWS",
      "providerType": "CLOUD",
      "configuration": [
        {
          "name": "text"
        }
      ]
    }),
});
const data = await response.json();
Response
{
  "id": "text",
  "name": "text",
  "providerName": "AWS",
  "providerType": "CLOUD",
  "orgId": "text",
  "configuration": [
    []
  ],
  "status": "ACTIVE",
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2025-01-21T04:06:33.020Z",
  "lastChangedDateTime": "2025-01-21T04:06:33.020Z",
  "createSchedule": false
}

PUT a credential

PUThttps://app.configure8.io/public/v1/credentials/{id}
Path parameters
id*string

Id of credential to update

Body

Credential object to be updated

namestring

Name of the credential

configurationarray of string

Configuration of the credential

statusenum

Status of the credential

ACTIVEDISABLEDBROKEN
Response
Body
id*string

Credential id

name*string

Credential name

providerName*enum

Credential provider name

AWSGCPGitHubGitLabAzure DevOpsAZUREBitbucketCircleCICustomPluginDatadogEmbeddedViewHttpClientJenkinsJira NewRelicOpsGeniePagerDutyScorecardsSonarCloudSplunk
providerType*enum

Credential provider type

CLOUDREPOSCICDOTHERISSUE_TRACKINGOMSCODE_INSPECTION
orgId*string

Credential organization id

configuration*array of array

Credential configuration

status*enum

Credential status

ACTIVEDISABLEDBROKEN
createdBystring

Credential created by

lastChangedBystring

Credential last changed by

createDateTimestring (date-time)

Credential created at

lastChangedDateTimestring (date-time)

Credential updated at

createScheduleboolean

Credential updated at

Request
const response = await fetch('https://app.configure8.io/public/v1/credentials/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();
Response
{
  "id": "text",
  "name": "text",
  "providerName": "AWS",
  "providerType": "CLOUD",
  "orgId": "text",
  "configuration": [
    []
  ],
  "status": "ACTIVE",
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2025-01-21T04:06:33.020Z",
  "lastChangedDateTime": "2025-01-21T04:06:33.020Z",
  "createSchedule": false
}

DELETE a credential

DELETEhttps://app.configure8.io/public/v1/credentials/{id}
Path parameters
id*string

Id of credential to delete

Response
Request
const response = await fetch('https://app.configure8.io/public/v1/credentials/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Last updated

Copyright © 2023 configure8, Inc. All rights reserved.