https://api.katapult.io/core/v1/ssh_keys/ssh_key
| Code | Error | When it happens |
|---|---|---|
|
|
missing_api_token
|
No API token was provided in the Authorization header. Ensure a token is provided prefixed with Bearer |
|
|
unauthorized_network_for_api_token
|
Network is not allowed to access the API with this API token |
|
|
invalid_api_token
|
The API token provided was not valid (it may not exist or have expired) |
|
|
token_owner_suspended
|
The user that owns the API token has been suspended |
|
|
invalid_capabilities_token
|
The capabilities token provided was not valid (either not valid, expired or not signed by the correct key) |
|
|
scope_not_granted
|
The scope required for this endpoint has not been granted to the authenticating identity |
|
|
permission_denied
|
The authenticated identity is not permitted to perform this action |
|
|
ssh_key_not_found
|
No SSH key was found matching any of the criteria provided in the arguments |
|
|
deletion_restricted
|
Object cannot be deleted |
|
|
rate_limit_reached
|
You have reached the rate limit for this type of request |
|
|
service_unavailable
|
The service is currently unavailable, please try again later |
ssh_key
object
required
body
id
string
ssh_key
object
id
string
name
string
fingerprint
string
{
"ssh_key": {
"id": "string",
"name": "string",
"fingerprint": "string"
}
}Sent to https://api.katapult.io/core/v1 as a bearer token and never to Krystal Documentation. It isn't stored anywhere, so paste it again on each endpoint page.
Pre-filled with the endpoint's shape — declared defaults where it has them, otherwise a placeholder per type. Edit it before executing; the Arguments tab documents every field.