Skip to main content
GET
/
api
/
v1
/
org
/
credentials
/
{credential_id}
Get credential details
import requests

url = "https://platform.ankra.app/api/v1/org/credentials/{credential_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "provider": "<string>",
  "organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "system": true,
  "available": true,
  "clusters": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "kind": "imported",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "operations": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "status": "<string>",
      "cluster_kind": "imported",
      "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "cluster_name": "<string>"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "token": "<string>",
  "username": "<string>",
  "access_key_id": "<string>",
  "secret_access_key": "<string>",
  "role_arn": "<string>",
  "gitlab_url": "<string>",
  "access_token": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

authorization
string | null

Path Parameters

credential_id
string<uuid4>
required

Response

Credential retrieved successfully

id
string<uuid>
required
name
string
required
provider
string
required
organisation_id
string<uuid>
required
system
boolean
required
available
boolean
required
clusters
GetCredentialClusterInfoResult · object[]
required
operations
GetCredentialOperationInfoResult · object[]
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
token
string | null
username
string | null
access_key_id
string | null
secret_access_key
string | null
role_arn
string | null
gitlab_url
string | null
access_token
string | null