Get virtual machine package

GET 
/virtual_machine_packages/virtual_machine_package

Return information about a given virtual machine package

Scopes

• virtual_machine_packages:read

OAuth2 Scopes

When using OAuth2 authentication, scopes are prefixed with api.katapult.io/core/v1/.

Request

Query Parameters

virtual_machine_package[id] string

All 'virtual_machine_package[]' params are mutually exclusive, only one can be provided.

virtual_machine_package[permalink] string

All 'virtual_machine_package[]' params are mutually exclusive, only one can be provided.

Responses

200

Return information about a given virtual machine package

application/json

Schema

Schema

virtual_machine_package

object

required

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)

{
  "virtual_machine_package": {
    "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"
    }
  }
}

400

No API token was provided in the Authorization header. Ensure a token is provided prefixed with Bearer

application/json

Schema

Schema

code MissingAPITokenEnum (string)

Possible values: [missing_api_token]

description string
detail object

Example (from schema)

{
  "code": "missing_api_token",
  "description": "string",
  "detail": {}
}

403

403 error response

application/json

Schema

Schema

oneOf

UnauthorizedNetworkForAPITokenSchema

Network is not allowed to access the API with this API token

code UnauthorizedNetworkForAPITokenEnum (string)

Possible values: [unauthorized_network_for_api_token]

description string

detail

object

ip_address string

The IP address the request was received from

InvalidAPITokenSchema

The API token provided was not valid (it may not exist or have expired)

code InvalidAPITokenEnum (string)

Possible values: [invalid_api_token]

description string

detail

object

details stringnullable

InvalidCapabilitiesTokenSchema

The capabilities token provided was not valid (either not valid, expired or not signed by the correct key)

code InvalidCapabilitiesTokenEnum (string)

Possible values: [invalid_capabilities_token]

description string

detail object

ScopeNotGrantedErrorSchema

The scope required for this endpoint has not been granted to the authenticating identity

code ScopeNotGrantedErrorEnum (string)

Possible values: [scope_not_granted]

description string

detail

ScopeNotGrantedError

scopes string[]

Example (from schema)

{}

404

No package was found matching any of the criteria provided in the arguments

application/json

Schema

Schema

code VirtualMachinePackageNotFoundEnum (string)

Possible values: [package_not_found]

description string
detail object

Example (from schema)

{
  "code": "package_not_found",
  "description": "string",
  "detail": {}
}

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
  }
}

503

The service is currently unavailable, please try again later

application/json

Schema

Schema

code ServiceUnavailableEnum (string)

Possible values: [service_unavailable]

description string
detail object

Example (from schema)

{
  "code": "service_unavailable",
  "description": "string",
  "detail": {}
}

Loading...