Credentials

• Get a list of filtered credentials

• Create a new credential

• Update a credential with it's ID

• Delete a credential with it's ID

GET a list of credentials

GEThttps://app.configure8.io/public/v1/credentials

Query parameters

Response

200401403

Body

application/json

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

JavaScriptCurlPython

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

Response

200

{
  "items": [
    {
      "id": "text",
      "name": "text",
      "providerName": "AWS",
      "providerType": "CLOUD",
      "orgId": "text",
      "configuration": [
        []
      ],
      "status": "ACTIVE",
      "createdBy": "text",
      "lastChangedBy": "text",
      "createDateTime": "2024-12-21T11:56:07.479Z",
      "lastChangedDateTime": "2024-12-21T11:56:07.479Z",
      "createSchedule": false
    }
  ],
  "totalFound": 0,
  "pageNumber": 0,
  "pageSize": 0
}

POST a new credential

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

Body

application/json

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

201400401403

Body

application/json

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

JavaScriptCurlPython

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

201

{
  "id": "text",
  "name": "text",
  "providerName": "AWS",
  "providerType": "CLOUD",
  "orgId": "text",
  "configuration": [
    []
  ],
  "status": "ACTIVE",
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2024-12-21T11:56:07.479Z",
  "lastChangedDateTime": "2024-12-21T11:56:07.479Z",
  "createSchedule": false
}

PUT a credential

PUThttps://app.configure8.io/public/v1/credentials/{id}

Path parameters

id*string

Id of credential to update

Body

application/json

Credential object to be updated

namestring

Name of the credential

configurationarray of string

Configuration of the credential

statusenum

Status of the credential

ACTIVEDISABLEDBROKEN

Response

200400401403

Body

application/json

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

JavaScriptCurlPython

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

200

{
  "id": "text",
  "name": "text",
  "providerName": "AWS",
  "providerType": "CLOUD",
  "orgId": "text",
  "configuration": [
    []
  ],
  "status": "ACTIVE",
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2024-12-21T11:56:07.479Z",
  "lastChangedDateTime": "2024-12-21T11:56:07.479Z",
  "createSchedule": false
}

DELETE a credential

DELETEhttps://app.configure8.io/public/v1/credentials/{id}

Path parameters

id*string

Id of credential to delete

Response

200401403

Request

JavaScriptCurlPython

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