VPS device management

This endpoint collection is still in beta and is subject to change

Route: /api/v2/vps/<int:deviceId>

This resource is used to gain console access to a VPS instance.

Method: DELETE - Delete VPS instance

Provided a valid existing Device ID and the requestor has the appropriate permissions, this method will delete a VPS instance.

Parameters

Sample request

curl -X 'DELETE' \
  'https://core.hivelocity.net/api/v2/vps/$deviceId' \
  -H 'accept: application/json' \
  -H "X-API-KEY: $API_KEY" \

Sample Response

{
  "taskId": "string",
  "taskCreated": {},
  "result": "string",
  "taskUpdated": {},
  "metaData": "string",
  "clientId": 0,
  "deviceId": 0
}

Response codes

Method: PUT - Update VPS instance

Provided a valid existing Device ID and the requestor has the appropriate permissions, this method will update a VPS instance's SSH Keys or do an upgrade to a larger instance.

🚧

The VPS instance to be updated/upgraded must be turned off before attempting the change.

VPS devices may only be upgraded, not downgraded

Parameters

Sample request

curl -X 'PUT' \
  'https://core.hivelocity.net/api/v2/vps/$deviceId' \
  -H 'accept: application/json' \
  -H 'X-API-KEY: $API-KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "sshKeyIds": [],
  "productId": 0
}'

Sample Response

{
  "taskId": "string",
  "taskCreated": {},
  "result": "string",
  "taskUpdated": {},
  "metaData": "string",
  "clientId": 0,
  "deviceId": 0
}

Response codes

Method: GET - GET VPS instance

Provided a valid existing Device ID and the requestor has the appropriate permissions, this method will return details about the VPS device ID provided.

Parameters

Sample request

curl -X 'GET' \
  'https://core.hivelocity.net/api/v2/vps/$deviceId' \
  -H 'accept: application/json' \
  -H "X-API-KEY: $API_KEY" \

Sample Response

{
  "taskId": "string",
  "taskCreated": {},
  "result": "string",
  "taskUpdated": {},
  "metaData": "string",
  "clientId": 0,
  "deviceId": 0
}

Response codes

Route: /api/v2/vps/<int:deviceId>/console

This resource is used to gain console access to a VPS instance.

Method: POST - Create a one time use URL for console access to a VPS instance

Provided a valid existing Device ID is provided and the requestor has the appropriate permissions, this method will provide console access to the specified VPS instance via a one time use URL.

Parameters

Sample request

curl -X 'POST' \
   'https://core.hivelocity.net/api/v2/vps/$deviceId/console' \
   -H "X-API-KEY: $API_KEY" \
   -H 'accept: application/json'

Sample Response

{
  "url": "string"
}

Response codes

Function in myV:

Route: /api/v2/vps/<int:deviceId>/events

This resource is used to fetch VPS Instance Events.

Method: GET - Get VPS instance events

Provided a valid existing Device ID is provided and the requestor has the appropriate permissions, this method will display an array of event logs for the VPS instance specified.

Parameters

Sample Request

curl -X 'GET' \
  'https://core.hivelocity.net/api/v2/vps/$deviceId/events' \
  -H "X-API-KEY: $API_KEY" \
  -H 'accept: application/json'

Sample Response

[
  {
    "eventId": "string",
    "type": "string",
    "createdAt": "2023-07-11T17:41:11.396Z",
    "level": "string",
    "state": "string"
  }
]

Response Codes

Route: /api/v2/vps/<int:deviceId>/metrics

This resource is used to fetch VPS Instance metrics.

Method: GET - Get metrics for a VPS instance (Endpoint page coming soon)

Provided a valid existing Device ID and the metric type to be returned is provided and the requestor has the appropriate permissions, this method will return image data to display a chart of the specified metric. The image data is returned in Base64 encoded image data.

Parameters

Sample Request

curl -X 'GET' \
  "https://core.hivelocity.net/api/v2/vps/31844/metrics?metricType=$metricType" \
  -H 'accept: application/json' \
  -H "X-API-KEY: $API_KEY"

Sample Response

{
  "endTime": 0,
  "startTime": 0,
  "metricType": "string",
  "imageData": "string"
}

Response Codes