credentials.ssh.show

GET

/credentials/ssh/{credentialId}

const url = 'https://example.com/api/credentials/ssh/example';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/credentials/ssh/example

Reads one reusable SSH credential with masked detail and server usage visibility. Public docs: /docs/servers/credentials/ssh-keys/#server-ssh-credential-path

Parameters

Path Parameters

credentialId

required

string

>= 1 characters

Query Parameters

includeUsage

Any of:

boolean

Responses

200

application/json

object

schemaVersion

required

string

Allowed value: credentials.show/v1

credential

required

object

required

string

name

required

string

kind

required

string

Allowed value: ssh-private-key

username

string

publicKeyConfigured

required

boolean

privateKeyConfigured

required

boolean

createdAt

required

string

rotatedAt

string

usage

object

totalServers

required

number

activeServers

required

number

inactiveServers

required

number

servers

required

Array<object>

object

serverId

required

string

serverName

required

string

lifecycleStatus

required

string

Allowed values: active inactive

providerKey

required

string

host

required

string

username

string

generatedAt

required

string

Example

{
  "schemaVersion": "credentials.show/v1",
  "credential": {
    "kind": "ssh-private-key"
  },
  "usage": {
    "servers": [
      {
        "lifecycleStatus": "active"
      }
    ]
  }
}