import requests
url = "https://platform.ankra.app/api/v1/credentials/upcloud/ssh-keys"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://platform.ankra.app/api/v1/credentials/upcloud/ssh-keys', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://platform.ankra.app/api/v1/credentials/upcloud/ssh-keys \
--header 'Authorization: Bearer <token>'[
{
"available": true,
"created_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"organisation_id": "<string>",
"provider": "<string>",
"system": true,
"updated_at": "2023-11-07T05:31:56Z",
"check": {
"mode": "automatic",
"state": "passed",
"checked_at": "2023-11-07T05:31:56Z",
"next_check_at": "2023-11-07T05:31:56Z"
},
"account_login": "<string>",
"account_type": "<string>",
"co_tenant_count": 123,
"health": {
"consecutive_failures": 123,
"state": "healthy",
"last_error_class": "<string>",
"next_attempt_at": "2023-11-07T05:31:56Z"
},
"installation_id": 123,
"last_synced_at": "2023-11-07T05:31:56Z",
"display_name": "<string>",
"repository_count": 123,
"repository_selection": "<string>",
"state": "<string>",
"syncing": false,
"managed": true,
"detail": "<string>",
"ssh_public_key": "<string>",
"fingerprint": "<string>",
"key_type": "<string>",
"comment": "<string>",
"fingerprint_error": "<string>",
"api_url": "<string>",
"project_id": "<string>",
"region": "<string>",
"endpoint": "<string>",
"tls_insecure": true
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}List SSH key credentials
Lists the organisation’s SSH key credentials. The list is the same under every cloud provider. Each item carries the stored public key with the fingerprint (as ssh-keygen -l prints it), key type and comment derived from it; a stored value that is not a readable key keeps its row, with a null fingerprint and fingerprint_error saying why.
import requests
url = "https://platform.ankra.app/api/v1/credentials/upcloud/ssh-keys"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://platform.ankra.app/api/v1/credentials/upcloud/ssh-keys', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://platform.ankra.app/api/v1/credentials/upcloud/ssh-keys \
--header 'Authorization: Bearer <token>'[
{
"available": true,
"created_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"organisation_id": "<string>",
"provider": "<string>",
"system": true,
"updated_at": "2023-11-07T05:31:56Z",
"check": {
"mode": "automatic",
"state": "passed",
"checked_at": "2023-11-07T05:31:56Z",
"next_check_at": "2023-11-07T05:31:56Z"
},
"account_login": "<string>",
"account_type": "<string>",
"co_tenant_count": 123,
"health": {
"consecutive_failures": 123,
"state": "healthy",
"last_error_class": "<string>",
"next_attempt_at": "2023-11-07T05:31:56Z"
},
"installation_id": 123,
"last_synced_at": "2023-11-07T05:31:56Z",
"display_name": "<string>",
"repository_count": 123,
"repository_selection": "<string>",
"state": "<string>",
"syncing": false,
"managed": true,
"detail": "<string>",
"ssh_public_key": "<string>",
"fingerprint": "<string>",
"key_type": "<string>",
"comment": "<string>",
"fingerprint_error": "<string>",
"api_url": "<string>",
"project_id": "<string>",
"region": "<string>",
"endpoint": "<string>",
"tls_insecure": true
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
SSH key credentials retrieved successfully
Explicit check coverage and latest probe evidence. Local checks validate key format only; automatic probes normally run every five minutes with failure backoff. Manual results are historical observations. Resource availability is not verification.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Set on Ankra Cloud credentials only: true for the built-in credential the platform mints and renews (deleting or rotating it answers 409), false for a pasted one.
Set when the credential cannot be used as listed and the operator can repair it - a Cloudflare credential whose token is missing from the secret store (state 'needs-reconnect'): the reconnect command.
Set on ssh-key credentials only: the stored OpenSSH public key. It is the public half of the pair, so it is listed on the same footing as the name.
Set on ssh-key credentials only: the OpenSSH SHA256 fingerprint of the stored public key, in the form ssh-keygen -l prints (SHA256: followed by the unpadded base64 digest). Null when the stored value is not a readable key; fingerprint_error then says why.
Set on ssh-key credentials only: the key algorithm the public key declares, such as ssh-ed25519 or ssh-rsa. Null when the stored value is not a readable key.
Set on ssh-key credentials only: the comment after the key material, an empty string when the key has none. Null when the stored value is not a readable key.
Set on ssh-key credentials only: why the stored value could not be read as an OpenSSH public key, and null when it could. A non-null value means the fingerprint is unknown, not that the credential holds no key.
Set on proxmox and morpheus credentials only: the API URL the credential connects to. A connection setting, never a secret. Absent when the stored settings could not be read.
Set on ovh and scaleway credentials only: the cloud provider's project the credential is bound to (not an Ankra project). Absent when the stored settings could not be read.
Set on aws credentials only: the region the credential was created for. Absent when the stored settings could not be read.
Set on ankracloud credentials only: the Ankra Cloud API endpoint the credential connects to.
Set on proxmox and morpheus credentials only: whether the credential skips TLS verification of the API. Absent when the stored settings could not be read.