Describe a key pair.

GET

/v1/projects/{projectId}/compute/key-pairs/{keyId}

Code sample: Shell / cURL

curl --request GET \
  --url https://stratum.example.com/v1/projects/example/compute/key-pairs/example \
  --header 'Authorization: Bearer <token>'

• A Stratum cluster endpoint.

Authorizations

• bearerAuth

Parameters

Path Parameters

projectId

required

string

/^p-[a-z0-9-]+$/

keyId

required

string

/^key-[a-z0-9-]+$/

Responses

200

The key pair.

Media typeapplication/json

object

id

required

string

/^key-[a-z0-9-]+$/

projectId

required

string

/^p-[a-z0-9-]+$/

name

required

Customer-chosen name, unique within the project.

string

displayName

string

keyType

required

Parsed from the OpenSSH-format public key.

string

Allowed values: ssh-rsa ssh-ed25519 ecdsa-sha2-nistp256 ecdsa-sha2-nistp384 ecdsa-sha2-nistp521

fingerprint

required

SHA-256 fingerprint in OpenSSH format (SHA256:<base64>).

string

publicKey

required

OpenSSH-format public key (ssh-ed25519 AAAA... user@host).

string

tags

AWS-shape resource tags. Freeform UTF-8 keys (1-128 bytes, no leading/trailing whitespace) mapped to freeform UTF-8 values (0-256 bytes). Max 50 tags per resource. Reserved prefixes (stratum.dev/, stratum.platform_health., stratum:, aws:) return 400 RESERVED_NAMESPACE on customer input. PATCH replaces the whole map..

object

<= 50 properties

key

additional properties

string

<= 256 characters

createdAt

required

string format: date-time

Example

{
  "keyType": "ssh-rsa"
}

404

Resource not found.

Media typeapplication/problem+json

object

type

required

string format: uri

title

required

string

status

required

integer

>= 400 <= 599

detail

string

instance

string format: uri-reference

requestId

required

string

code

required

string

issues

The findings of a rejected IAM policy document (custom and resource policies).

Array<object>

One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.

object

code

required

The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.

string

statement

required

Index of the statement at fault; -1 for the document as a whole.

integer

>= -1

detail

required

string

action

The offending action, where one is at fault (ACTION_NOT_APPLICABLE).

string

errors

Field errors, for codes that carry them: each problem at its field (see FieldError). Documented on the responses that set it, e.g. approveNodeJoin’s INVALID_INPUT and JOIN_APPROVAL_REFUSED. Absent otherwise.

Array<object>

One field’s problem, the stage-2 installer API’s shape. field is the field’s path, message what is wrong with it.

object

field

required

The field’s path, e.g. links[0].interface, disks[1].confirm, mgmt.address or role; empty for the whole request.

string

message

required

string

details

Structured facts about the refusal, for codes that carry them. The shape is fixed per code and documented on the response that answers it, e.g. IMAGE_POOL_MISMATCH (see ImagePoolMismatchDetails) and IMAGE_IN_USE. Absent for codes that carry none.

object

key

additional properties

any

Example

{
  "issues": [
    {
      "code": "ACTION_NOT_APPLICABLE",
      "action": "compute:CreateVpc"
    }
  ]
}