Overview
Error Handling

Methods

API Documentation (API Version bleed)

Account/SSH/Key/

DESCRIPTION

This package contains functions to add, list, update and remove named public ssh keys for use on provisioned servers.

add

URL:

https://api.liquidweb.com/bleed/Account/SSH/Key/add

Description:

Parameters:

ParameterTypeNotes
public_key_nameA single word, consisting of only letters, digits, and underscores.* Required
public_key_valueA public ssh key, e.g. the contents of an id_rsa.pub or id_dsa.pub file.* Required

Returns:

FieldType
addedA boolean value (0 or 1).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

list

URL:

https://api.liquidweb.com/bleed/Account/SSH/Key/list

Description:

Parameters:

ParameterTypeNotes
page_numA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 1
page_sizeA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 25
public_key_nameA single word, consisting of only letters, digits, and underscores.

Returns:

FieldType
item_countA non-negative integer value (i.e. 0 and up).
item_totalA non-negative integer value (i.e. 0 and up).
itemsAn array of associative arrays containing
 
idA positive integer value (i.e. 1 and up).
public_key_nameA single word, consisting of only letters, digits, and underscores.
public_key_valueA public ssh key, e.g. the contents of an id_rsa.pub or id_dsa.pub file.
page_numA positive integer value (i.e. 1 and up).
page_sizeA positive integer value (i.e. 1 and up).
page_totalA positive integer value (i.e. 1 and up).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

remove

URL:

https://api.liquidweb.com/bleed/Account/SSH/Key/remove

Description:

Parameters:

ParameterTypeNotes
idA positive integer value (i.e. 1 and up).* Required if:
  • public_key_name is not given
public_key_nameA single word, consisting of only letters, digits, and underscores.* Required if:
  • id is not given

Returns:

FieldType
removedA boolean value (0 or 1).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

update

URL:

https://api.liquidweb.com/bleed/Account/SSH/Key/update

Description:

Parameters:

ParameterTypeNotes
idA positive integer value (i.e. 1 and up).* Required if:
  • public_key_name is not given
public_key_nameA single word, consisting of only letters, digits, and underscores.* Required if:
  • id is not given
public_key_valueA public ssh key, e.g. the contents of an id_rsa.pub or id_dsa.pub file.

Returns:

FieldType
idA positive integer value (i.e. 1 and up).
public_key_nameA string permitting tabs, carriage returns and newlines
public_key_valueA public ssh key, e.g. the contents of an id_rsa.pub or id_dsa.pub file.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types