List virtual machines

GET 
/organizations/organization/virtual_machines

Returns a list of all virtual machines for a given organization

Scopes

• virtual_machines
• virtual_machines:read

OAuth2 Scopes

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

Request

Query Parameters

organization[id] string

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

organization[sub_domain] string

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

annotations[][key] string[]

An array of annotations to filter by.

All annotations[] params should have the same amount of elements.

annotations[][value] string[]

An array of annotations to filter by.

All annotations[] params should have the same amount of elements.

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

Returns a list of all virtual machines for a given organization

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?

virtual_machines

object[]

required

Array [

id string

name string

hostname string

fqdn string

created_at integer

zone

object

id string

name string

permalink stringnullable

data_center

object

id string

name string

permalink string

country

object

id string

name string

iso_code2 string

iso_code3 string

time_zone stringnullable

eu boolean

package

object

nullable

name string

gpu_type

object

nullable

id string

name string

permalink string

ip_addresses

object[]

Array [

address string

]

hypervisor

object

nullable

id string

name string

]

Example (from schema)

{
  "pagination": {
    "current_page": 0,
    "total_pages": 0,
    "total": 0,
    "per_page": 0,
    "large_set": true
  },
  "virtual_machines": [
    {
      "id": "string",
      "name": "string",
      "hostname": "string",
      "fqdn": "string",
      "created_at": 0,
      "zone": {
        "id": "string",
        "name": "string",
        "permalink": "string",
        "data_center": {
          "id": "string",
          "name": "string",
          "permalink": "string",
          "country": {
            "id": "string",
            "name": "string",
            "iso_code2": "string",
            "iso_code3": "string",
            "time_zone": "string",
            "eu": true
          }
        }
      },
      "package": {
        "name": "string"
      },
      "gpu_type": {
        "id": "string",
        "name": "string",
        "permalink": "string"
      },
      "ip_addresses": [
        {
          "address": "string"
        }
      ],
      "hypervisor": {
        "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[]

OrganizationSuspendedSchema

An organization was found from the arguments provided but it was suspended

code OrganizationSuspendedEnum (string)

Possible values: [organization_suspended]

description string

detail object

OrganizationNotActivatedSchema

An organization was found from the arguments provided but it wasn't activated yet

code OrganizationNotActivatedEnum (string)

Possible values: [organization_not_activated]

description string

detail object

Example (from schema)

{}

404

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

application/json

Schema

Schema

code OrganizationNotFoundEnum (string)

Possible values: [organization_not_found]

description string
detail object

Example (from schema)

{
  "code": "organization_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...