Credentials

PreviousCosts NextModule Settings

Last updated 6 months ago

GET a list of credentials

get

/public/v1/credentials

Query parameters

searchTermsstring

Filter based on credential name

providerTypestring

Filter based on credential provider type

providerNamestring

Filter based on credential provider name

pageNumbernumber

Page number to return

pageSizenumber · default: 20

Number of items to return per page

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://app.configure8.io/public/v1/credentials'

200

401

403

{
  "totalFound": 1,
  "pageNumber": 1,
  "pageSize": 1,
  "items": [
    {
      "id": "text",
      "name": "text",
      "orgId": "text",
      "createdBy": "text",
      "lastChangedBy": "text",
      "createDateTime": "2025-02-22T05:03:28.313Z",
      "lastChangedDateTime": "2025-02-22T05:03:28.313Z",
      "createSchedule": true,
      "providerName": "AWS",
      "providerType": "CLOUD",
      "status": "ACTIVE",
      "configuration": [
        []
      ]
    }
  ]
}

POST a new credential

post

/public/v1/credentials

Body

namestringrequired

Name of the credential

providerNamestring · enumrequired

Name of the provider

Options: AWS, GCP, GitHub, GitLab, Azure DevOps, AZURE, Bitbucket, CircleCI, CustomPlugin, Datadog, EmbeddedView, HttpClient, Jenkins, Jira , NewRelic, OpsGenie, PagerDuty, Scorecards, SonarCloud, Splunk

providerTypestring · enumrequired

Type of the provider

Options: CLOUD, REPOS, CICD, OTHER, ISSUE_TRACKING, OMS, CODE_INSPECTION

statusstring · enum · default: true

Status of the credential

Options: ACTIVE, DISABLED, BROKEN

configurationobject[]required

Configuration of the credential

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://app.configure8.io/public/v1/credentials' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","providerName":"AWS","providerType":"CLOUD","status":true,"configuration":[{"name":"text","value":{}}]}'

201

400

401

403

{
  "id": "text",
  "name": "text",
  "orgId": "text",
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2025-02-22T05:03:28.313Z",
  "lastChangedDateTime": "2025-02-22T05:03:28.313Z",
  "createSchedule": true,
  "providerName": "AWS",
  "providerType": "CLOUD",
  "status": "ACTIVE",
  "configuration": [
    []
  ]
}

PUT a credential

put

/public/v1/credentials/{id}

Path parameters

idstringrequired

Id of credential to update

Body

namestring

Name of the credential

statusstring · enum

Status of the credential

Options: ACTIVE, DISABLED, BROKEN

configurationstring[]

Configuration of the credential

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://app.configure8.io/public/v1/credentials/{id}' \
  --header 'Content-Type: application/json' \
  --data '{"status":"ACTIVE","configuration":[null]}'

200

400

401

403

{
  "id": "text",
  "name": "text",
  "orgId": "text",
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2025-02-22T05:03:28.313Z",
  "lastChangedDateTime": "2025-02-22T05:03:28.313Z",
  "createSchedule": true,
  "providerName": "AWS",
  "providerType": "CLOUD",
  "status": "ACTIVE",
  "configuration": [
    []
  ]
}

DELETE a credential

delete

/public/v1/credentials/{id}

Path parameters

idstringrequired

Id of credential to delete

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://app.configure8.io/public/v1/credentials/{id}'

200

401

403

No body