Server

CRUD for servers

Find a server by ID

get

Returns a single server with basic details

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
X-Api-KeystringRequired
Path parameters
serverIdinteger · intRequired

ID of the server to return

Responses
chevron-right
200

Successful operation

get
/api/server/{serverId}

Update a server's main properties by ID

patch

Update a server's locationId and instsanceTypeId properties by server ID.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
X-Api-KeystringRequired
Path parameters
serverIdinteger · intRequired

ID of the server to patch and return

Body
Responses
chevron-right
200

Successful operation

patch
/api/server/{serverId}

Find servers by IDs

get
chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
X-Api-KeystringRequired
Query parameters
serverIdsstringRequired

Comma-separated list of server IDs

Pattern: ^\d+(,\d+)*$
Responses
chevron-right
200

Successful operation

application/json
get
/api/server

Find a server's lshw dump by ID

get

Returns a single server's lshw dump

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
X-Api-KeystringRequired
Path parameters
serverIdinteger · intRequired

ID of the server to return

Responses
chevron-right
200

Successful operation

application/json
get
/api/server/{serverId}/lshw

Find a server's memory details by ID

get

Returns a single server's memory details

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
X-Api-KeystringRequired
Path parameters
serverIdinteger · intRequired

ID of the server to return

Responses
chevron-right
200

Successful operation

application/json
get
/api/server/{serverId}/memory

Find a server's disk details by ID

get

Returns a single server's disk details

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
X-Api-KeystringRequired
Path parameters
serverIdinteger · intRequired

ID of the server to return

Responses
chevron-right
200

Successful operation

application/json
get
/api/server/{serverId}/disks

Find a server's network interface details by ID

get

Returns a single server's network interface details

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
X-Api-KeystringRequired
Path parameters
serverIdinteger · intRequired

ID of the server to return

Responses
chevron-right
200

Successful operation

application/json
get
/api/server/{serverId}/interfaces

Checks if any server can be delivered to the client

get
Query parameters
instanceTypeIdinteger · intRequired

instance type id

locationIdinteger · intOptional

location id

clientIdinteger · intRequired

client id

contractIdstringOptional

contract id

Pattern: ^[A-Z0-9_\-.]{0,240}$
overflowbooleanOptional

If true, the allocation will be allowed to overflow the client's quota and use on-demand quota

Default: falseExample: false
Responses
chevron-right
200

Successful operation

application/json
resultbooleanOptionalExample: false
get
/api/server/availability/verify
200

Successful operation

Last updated

Was this helpful?