SSH Key

API for SSH key operations

Version: 0.1.0

Server

URL: https://api.kopernik.us/v0
- Kopernik.us API server

Paths

/resource/sshkey/{providerUid}

GET

List SSH keys

List SSH keys for the specified provider.

Parameters:

Name	In	Type	Required	Description
providerUid	path	ProviderId	✅	Unique identifier of the provider
nextToken	query	string	❌	Token for the next page of SSH keys, if there are more items to fetch
maxResults	query	integer	❌	Maximum number of SSH keys to fetch
jq	query	string	❌	JQ filter expression to filter the results. Only resources where the expression evaluates to a truthy value are included. The expression is applied to each resource’s JSON representation. Uses jq 1.7 syntax.

Responses:

200: SSH keys list
- Content Type: application/json - Schema: SshKeyPagedResourceResponse
400: Argument validation error
- Content Type: application/json - Schema: ErrorResponse
404: Provider not found
- Content Type: application/json - Schema: ErrorResponse

POST

Upload an SSH key

Upload a new SSH key for the specified provider

Parameters:

Name	In	Type	Required	Description
providerUid	path	ProviderId	✅	Unique identifier of the provider

Request Body:

Content Type: application/json

Schema: SshKeyCreate

Responses:

200: SSH key uploaded
- Content Type: application/json - Schema: SshKeyResourceResponse
400: Argument validation error
- Content Type: application/json - Schema: ErrorResponse

/resource/sshkey/{providerUid}/{resourceUid}

GET

Get SSH key

Get SSH key details

Parameters:

Name	In	Type	Required	Description
providerUid	path	ProviderId	✅	Unique identifier of the provider
resourceUid	path	string	✅	Unique identifier of the SSH key

Responses:

200: SSH key details
- Content Type: application/json - Schema: SshKeyResourceResponse
400: Argument validation error
- Content Type: application/json - Schema: ErrorResponse
404: SSH key not found
- Content Type: application/json - Schema: ErrorResponse

DELETE

Delete SSH key

Delete SSH key by its UID

Parameters:

Name	In	Type	Required	Description
providerUid	path	ProviderId	✅	Unique identifier of the provider
resourceUid	path	string	✅	Unique identifier of the SSH key to delete

Responses:

200: SSH key deleted
- Content Type: application/json - Schema: EmptyResponse
400: Argument validation error
- Content Type: application/json - Schema: ErrorResponse
404: SSH key not found
- Content Type: application/json - Schema: ErrorResponse

Schemas

SshKey

SSH Key

Composition: allOf

Resource

Type: object

Properties:

Name	Type	Required	Description
name	string	✅	Name of the SSH key
publicKey	string	✅	Public key of the SSH key
fingerprint	string	❌	Fingerprint of the SSH key
tags	array	❌	Tags of the SSH key

SshKeyResourceResponse

Response with SSH key

Composition: allOf

ResourceResponse

Type: object

Properties:

Name	Type	Required	Description
resource	SshKey	✅

SshKeyPagedResourceResponse

Response with paged SSH keys

Composition: allOf

PagedResourceResponse

Type: object

Properties:

Name	Type	Required	Description
resources	array<SshKey>	✅

SshKeyCreate

Request to create a new SSH key

Type: object

Properties:

Name	Type	Required	Description
publicKey	string	✅	Public key content of the SSH key
name	string	❌	Name of the SSH key
tags	array	❌	Tags for the SSH key