Virtual machine packages

GET 
/virtual_machine_packages

Return the currently available virtual machine packages

Request

Query Parameters

page integer

Possible values: >= 1

Default value: 1

The page number to request. If not provided, the first page will be returned.

per_page integer

Possible values: >= 1

Default value: 30

The number of items to return per page. If not provided, the default value will be used.

Responses

200

Return the currently available virtual machine packages

application/json

Schema

Schema

pagination

object

required

current_page integer

The current page

total_pages integernullable

The total number of pages

total integernullable

The total number of items across all pages

per_page integer

The number of items per page

large_set boolean

Is this a large set and therefore the total number of records cannot be returned?

packages

object[]

required

All available virtual machine packages

Array [

id string

name string

permalink string

cpu_cores integer

ipv4_addresses integer

memory_in_gb integer

storage_in_gb integer

monthly_bandwidth_allowance_in_gb integernullable

privacy PrivacyTypesEnum (string)

Possible values: [public, private]

icon

object

nullable

url string

file_name string

file_type string

file_size integer

digest string

token string

use_dedicated_cpus boolean

group

object

id string

name string

]

Example (from schema)

{
  "pagination": {
    "current_page": 0,
    "total_pages": 0,
    "total": 0,
    "per_page": 0,
    "large_set": true
  },
  "packages": [
    {
      "id": "string",
      "name": "string",
      "permalink": "string",
      "cpu_cores": 0,
      "ipv4_addresses": 0,
      "memory_in_gb": 0,
      "storage_in_gb": 0,
      "monthly_bandwidth_allowance_in_gb": 0,
      "privacy": "public",
      "icon": {
        "url": "string",
        "file_name": "string",
        "file_type": "string",
        "file_size": 0,
        "digest": "string",
        "token": "string"
      },
      "use_dedicated_cpus": true,
      "group": {
        "id": "string",
        "name": "string"
      }
    }
  ]
}

403

403 error response

application/json

Schema

Schema

code InternalAuthErrorEnum (string)

Possible values: [internal_auth_error]

description string

detail

object

details string

Example (from schema)

{
  "code": "internal_auth_error",
  "description": "string",
  "detail": {
    "details": "string"
  }
}

429

You have reached the rate limit for this type of request

application/json

Schema

Schema

code RateLimitReachedEnum (string)

Possible values: [rate_limit_reached]

description string

detail

object

total_permitted integer

The total number of requests per minute that are permitted

Example (from schema)

{
  "code": "rate_limit_reached",
  "description": "string",
  "detail": {
    "total_permitted": 0
  }
}

Loading...