Virtual Server management

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

This resource is used to gain console access to a Virtual Server instance.

Method: DELETE - Delete Virtual server instance

Provided a valid existing Device ID and the requestor has the appropriate permissions, this method will delete a Virtual server 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 Virtual server instance

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

🚧

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

Virtual server 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 Virtual server instance

Provided a valid existing Device ID and the requestor has the appropriate permissions, this method will return details about the Virtual server 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 Virtual server 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 Virtual server 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 Virtual server 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 Virtual server 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 Virtual server instance

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