Skip to content

user.public_key

Manage public keys

Create

Path
POST /v7.0/users/{user_id}/public_keys
Description
Store a public key
Authentication required
yes
Scope
user.public_key#create
Aliases
new
Blocking
no

Input parameters

Layout
object
Namespace
public_key
ParameterTypeRequiredDetails
label
Label
 String yes

Default: null

Validation rules
RuleDetails
Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty

Length
  • Maximum length: 255 characters (inclusive).

Validation error message: length must be at most 255
key
Public key
 Text yes

Default: null

Validation rules
RuleDetails
Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty

Format

Must match this regular expression:

\A[^\n]+\z

null

Validation error message: must not contain line breaks

Length
  • Maximum length: 5000 characters (inclusive).

Validation error message: length must be at most 5000
auto_add
Auto add
 Boolean no

Add this key automatically into newly created VPS

Default: false

Output parameters

Layout
object
Namespace
public_key
ParameterTypeDescription
id
Id
 Integer
label
Label
 String
key
Public key
 Text
auto_add
Auto add
 Boolean Add this key automatically into newly created VPS
fingerprint
Fingerprint
 String MD5 fingerprint
comment
Comment
 String Optional comment
created_at
Created at
 Datetime
updated_at
Updated at
 Datetime

Delete

Path
DELETE /v7.0/users/{user_id}/public_keys/{public_key_id}
Description
Delete public key
Authentication required
yes
Scope
user.public_key#delete
Aliases
destroy
Blocking
no

Input parameters

No parameters.

Output parameters

No parameters.

Index

Path
GET /v7.0/users/{user_id}/public_keys
Description
List saved public keys
Authentication required
yes
Scope
user.public_key#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
public_key
ParameterTypeRequiredDetails
from_id
From ID
 Integer no

List objects with IDs greater or lower than this value

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).

Validation error message: must be at least 0
limit
Limit
 Integer no

Number of objects to retrieve

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).
  • Maximum: 1000 (inclusive).

Validation error message: must be between 0 and 1000

Output parameters

Layout
object_list
Namespace
public_keys
ParameterTypeDescription
id
Id
 Integer
label
Label
 String
key
Public key
 Text
auto_add
Auto add
 Boolean Add this key automatically into newly created VPS
fingerprint
Fingerprint
 String MD5 fingerprint
comment
Comment
 String Optional comment
created_at
Created at
 Datetime
updated_at
Updated at
 Datetime

Show

Path
GET /v7.0/users/{user_id}/public_keys/{public_key_id}
Description
Show saved public key
Authentication required
yes
Scope
user.public_key#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
public_key
ParameterTypeDescription
id
Id
 Integer
label
Label
 String
key
Public key
 Text
auto_add
Auto add
 Boolean Add this key automatically into newly created VPS
fingerprint
Fingerprint
 String MD5 fingerprint
comment
Comment
 String Optional comment
created_at
Created at
 Datetime
updated_at
Updated at
 Datetime

Update

Path
PUT /v7.0/users/{user_id}/public_keys/{public_key_id}
Description
Update a public key
Authentication required
yes
Scope
user.public_key#update
Aliases
Blocking
no

Input parameters

Layout
object
Namespace
public_key
ParameterTypeRequiredDetails
label
Label
 String no

Default: null

Validation rules
RuleDetails
Length
  • Maximum length: 255 characters (inclusive).

Validation error message: length must be at most 255
key
Public key
 Text no

Default: null

Validation rules
RuleDetails
Format

Must match this regular expression:

\A[^\n]+\z

null

Validation error message: must not contain line breaks

Length
  • Maximum length: 5000 characters (inclusive).

Validation error message: length must be at most 5000
auto_add
Auto add
 Boolean no

Add this key automatically into newly created VPS

Default: null

Output parameters

Layout
object
Namespace
public_key
ParameterTypeDescription
id
Id
 Integer
label
Label
 String
key
Public key
 Text
auto_add
Auto add
 Boolean Add this key automatically into newly created VPS
fingerprint
Fingerprint
 String MD5 fingerprint
comment
Comment
 String Optional comment
created_at
Created at
 Datetime
updated_at
Updated at
 Datetime