Compute Service API

The Compute Service API provides services that allows provisioning and life cycle management of Compute clusters.
More information: https://openapi-generator.tech
Contact Info: team@openapitools.org
Version: 1.12.0
BasePath:
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. OAuth AuthorizationUrl:https://identity.nks.europe-west4.nscale.com/oauth2/v2/authorizationTokenUrl:https://identity.nks.europe-west4.nscale.com/oauth2/v2/token

Methods

[ Jump to Models ]

Table of Contents

Default

Flavors

Images

Instances

Regions

Default

Up 
get /api/v1/organizations/{organizationID}/clusters
(apiV1OrganizationsOrganizationIDClustersGet)
List all clusters within the organization.

Path parameters

organizationID (required)
Path Parameter — The organization ID. default: null

Query parameters

tag (optional)
Query Parameter — A set of tags to match against resources in the form "name=value", thus when encoded you get "?tag=foo%3Dcat&tag=bar%3Ddog". default: null

Return type

array[computeClusterRead]

Example data

Content-Type: application/json
[ {
  "metadata" : {
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "description" : "description",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ],
    "organizationId" : "organizationId",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "modifiedBy" : "modifiedBy",
    "id" : "id",
    "projectId" : "projectId"
  },
  "spec" : {
    "regionId" : "regionId",
    "workloadPools" : [ {
      "machine" : {
        "image" : {
          "selector" : {
            "distro" : "rocky",
            "variant" : "variant",
            "version" : "version"
          },
          "id" : "id"
        },
        "disk" : {
          "size" : 6
        },
        "userData" : "userData",
        "publicIPAllocation" : {
          "enabled" : true
        },
        "firewall" : [ {
          "protocol" : "tcp",
          "prefixes" : [ "prefixes", "prefixes" ],
          "portMax" : 5,
          "port" : 1,
          "direction" : "ingress"
        }, {
          "protocol" : "tcp",
          "prefixes" : [ "prefixes", "prefixes" ],
          "portMax" : 5,
          "port" : 1,
          "direction" : "ingress"
        } ],
        "replicas" : 0,
        "flavorId" : "flavorId",
        "allowedAddressPairs" : [ {
          "macAddress" : "macAddress",
          "cidr" : "cidr"
        }, {
          "macAddress" : "macAddress",
          "cidr" : "cidr"
        } ]
      },
      "name" : "name"
    }, {
      "machine" : {
        "image" : {
          "selector" : {
            "distro" : "rocky",
            "variant" : "variant",
            "version" : "version"
          },
          "id" : "id"
        },
        "disk" : {
          "size" : 6
        },
        "userData" : "userData",
        "publicIPAllocation" : {
          "enabled" : true
        },
        "firewall" : [ {
          "protocol" : "tcp",
          "prefixes" : [ "prefixes", "prefixes" ],
          "portMax" : 5,
          "port" : 1,
          "direction" : "ingress"
        }, {
          "protocol" : "tcp",
          "prefixes" : [ "prefixes", "prefixes" ],
          "portMax" : 5,
          "port" : 1,
          "direction" : "ingress"
        } ],
        "replicas" : 0,
        "flavorId" : "flavorId",
        "allowedAddressPairs" : [ {
          "macAddress" : "macAddress",
          "cidr" : "cidr"
        }, {
          "macAddress" : "macAddress",
          "cidr" : "cidr"
        } ]
      },
      "name" : "name"
    } ]
  },
  "status" : {
    "sshPrivateKey" : "sshPrivateKey",
    "workloadPools" : [ {
      "replicas" : 5,
      "name" : "name",
      "machines" : [ {
        "hostname" : "hostname",
        "imageID" : "imageID",
        "privateIP" : "privateIP",
        "flavorID" : "flavorID",
        "publicIP" : "publicIP",
        "id" : "id",
        "status" : "Pending"
      }, {
        "hostname" : "hostname",
        "imageID" : "imageID",
        "privateIP" : "privateIP",
        "flavorID" : "flavorID",
        "publicIP" : "publicIP",
        "id" : "id",
        "status" : "Pending"
      } ]
    }, {
      "replicas" : 5,
      "name" : "name",
      "machines" : [ {
        "hostname" : "hostname",
        "imageID" : "imageID",
        "privateIP" : "privateIP",
        "flavorID" : "flavorID",
        "publicIP" : "publicIP",
        "id" : "id",
        "status" : "Pending"
      }, {
        "hostname" : "hostname",
        "imageID" : "imageID",
        "privateIP" : "privateIP",
        "flavorID" : "flavorID",
        "publicIP" : "publicIP",
        "id" : "id",
        "status" : "Pending"
      } ]
    } ]
  }
}, {
  "metadata" : {
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "description" : "description",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ],
    "organizationId" : "organizationId",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "modifiedBy" : "modifiedBy",
    "id" : "id",
    "projectId" : "projectId"
  },
  "spec" : {
    "regionId" : "regionId",
    "workloadPools" : [ {
      "machine" : {
        "image" : {
          "selector" : {
            "distro" : "rocky",
            "variant" : "variant",
            "version" : "version"
          },
          "id" : "id"
        },
        "disk" : {
          "size" : 6
        },
        "userData" : "userData",
        "publicIPAllocation" : {
          "enabled" : true
        },
        "firewall" : [ {
          "protocol" : "tcp",
          "prefixes" : [ "prefixes", "prefixes" ],
          "portMax" : 5,
          "port" : 1,
          "direction" : "ingress"
        }, {
          "protocol" : "tcp",
          "prefixes" : [ "prefixes", "prefixes" ],
          "portMax" : 5,
          "port" : 1,
          "direction" : "ingress"
        } ],
        "replicas" : 0,
        "flavorId" : "flavorId",
        "allowedAddressPairs" : [ {
          "macAddress" : "macAddress",
          "cidr" : "cidr"
        }, {
          "macAddress" : "macAddress",
          "cidr" : "cidr"
        } ]
      },
      "name" : "name"
    }, {
      "machine" : {
        "image" : {
          "selector" : {
            "distro" : "rocky",
            "variant" : "variant",
            "version" : "version"
          },
          "id" : "id"
        },
        "disk" : {
          "size" : 6
        },
        "userData" : "userData",
        "publicIPAllocation" : {
          "enabled" : true
        },
        "firewall" : [ {
          "protocol" : "tcp",
          "prefixes" : [ "prefixes", "prefixes" ],
          "portMax" : 5,
          "port" : 1,
          "direction" : "ingress"
        }, {
          "protocol" : "tcp",
          "prefixes" : [ "prefixes", "prefixes" ],
          "portMax" : 5,
          "port" : 1,
          "direction" : "ingress"
        } ],
        "replicas" : 0,
        "flavorId" : "flavorId",
        "allowedAddressPairs" : [ {
          "macAddress" : "macAddress",
          "cidr" : "cidr"
        }, {
          "macAddress" : "macAddress",
          "cidr" : "cidr"
        } ]
      },
      "name" : "name"
    } ]
  },
  "status" : {
    "sshPrivateKey" : "sshPrivateKey",
    "workloadPools" : [ {
      "replicas" : 5,
      "name" : "name",
      "machines" : [ {
        "hostname" : "hostname",
        "imageID" : "imageID",
        "privateIP" : "privateIP",
        "flavorID" : "flavorID",
        "publicIP" : "publicIP",
        "id" : "id",
        "status" : "Pending"
      }, {
        "hostname" : "hostname",
        "imageID" : "imageID",
        "privateIP" : "privateIP",
        "flavorID" : "flavorID",
        "publicIP" : "publicIP",
        "id" : "id",
        "status" : "Pending"
      } ]
    }, {
      "replicas" : 5,
      "name" : "name",
      "machines" : [ {
        "hostname" : "hostname",
        "imageID" : "imageID",
        "privateIP" : "privateIP",
        "flavorID" : "flavorID",
        "publicIP" : "publicIP",
        "id" : "id",
        "status" : "Pending"
      }, {
        "hostname" : "hostname",
        "imageID" : "imageID",
        "privateIP" : "privateIP",
        "flavorID" : "flavorID",
        "publicIP" : "publicIP",
        "id" : "id",
        "status" : "Pending"
      } ]
    } ]
  }
} ]

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A list of Compute clusters.

400

Request body failed schema validation, or the request does not contain all the required fields. error

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

404

Unable to find a resource. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
delete /api/v1/organizations/{organizationID}/projects/{projectID}/clusters/{clusterID}
(apiV1OrganizationsOrganizationIDProjectsProjectIDClustersClusterIDDelete)
Delete a cluster.

Path parameters

organizationID (required)
Path Parameter — The organization ID. default: null
projectID (required)
Path Parameter — The project ID. default: null
clusterID (required)
Path Parameter — The cluster ID. default: null

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

The request has been accepted and will be fulfilled asynchronously. You may poll the resource and monitor its provisioning and health status to await completion of the operation.

400

Request body failed schema validation, or the request does not contain all the required fields. error

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

404

Unable to find a resource. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
post /api/v1/organizations/{organizationID}/projects/{projectID}/clusters/{clusterID}/evict
(apiV1OrganizationsOrganizationIDProjectsProjectIDClustersClusterIDEvictPost)
Delete a set of machines from a cluster. This will implicitly scale down the workload pools those machines were part of.

Path parameters

organizationID (required)
Path Parameter — The organization ID. default: null
projectID (required)
Path Parameter — The project ID. default: null
clusterID (required)
Path Parameter — The cluster ID. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

evictionWrite evictionWrite (required)
Body Parameter —

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

The request has been accepted and will be fulfilled asynchronously. You may poll the resource and monitor its provisioning and health status to await completion of the operation.

400

Request body failed schema validation, or the request does not contain all the required fields. error

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

404

Unable to find a resource. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
get /api/v1/organizations/{organizationID}/projects/{projectID}/clusters/{clusterID}
(apiV1OrganizationsOrganizationIDProjectsProjectIDClustersClusterIDGet)
Get a detailed view of the cluster.

Path parameters

organizationID (required)
Path Parameter — The organization ID. default: null
projectID (required)
Path Parameter — The project ID. default: null
clusterID (required)
Path Parameter — The cluster ID. default: null

Return type

computeClusterRead

Example data

Content-Type: application/json
{
  "metadata" : {
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "description" : "description",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ],
    "organizationId" : "organizationId",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "modifiedBy" : "modifiedBy",
    "id" : "id",
    "projectId" : "projectId"
  },
  "spec" : {
    "regionId" : "regionId",
    "workloadPools" : [ {
      "machine" : {
        "image" : {
          "selector" : {
            "distro" : "rocky",
            "variant" : "variant",
            "version" : "version"
          },
          "id" : "id"
        },
        "disk" : {
          "size" : 6
        },
        "userData" : "userData",
        "publicIPAllocation" : {
          "enabled" : true
        },
        "firewall" : [ {
          "protocol" : "tcp",
          "prefixes" : [ "prefixes", "prefixes" ],
          "portMax" : 5,
          "port" : 1,
          "direction" : "ingress"
        }, {
          "protocol" : "tcp",
          "prefixes" : [ "prefixes", "prefixes" ],
          "portMax" : 5,
          "port" : 1,
          "direction" : "ingress"
        } ],
        "replicas" : 0,
        "flavorId" : "flavorId",
        "allowedAddressPairs" : [ {
          "macAddress" : "macAddress",
          "cidr" : "cidr"
        }, {
          "macAddress" : "macAddress",
          "cidr" : "cidr"
        } ]
      },
      "name" : "name"
    }, {
      "machine" : {
        "image" : {
          "selector" : {
            "distro" : "rocky",
            "variant" : "variant",
            "version" : "version"
          },
          "id" : "id"
        },
        "disk" : {
          "size" : 6
        },
        "userData" : "userData",
        "publicIPAllocation" : {
          "enabled" : true
        },
        "firewall" : [ {
          "protocol" : "tcp",
          "prefixes" : [ "prefixes", "prefixes" ],
          "portMax" : 5,
          "port" : 1,
          "direction" : "ingress"
        }, {
          "protocol" : "tcp",
          "prefixes" : [ "prefixes", "prefixes" ],
          "portMax" : 5,
          "port" : 1,
          "direction" : "ingress"
        } ],
        "replicas" : 0,
        "flavorId" : "flavorId",
        "allowedAddressPairs" : [ {
          "macAddress" : "macAddress",
          "cidr" : "cidr"
        }, {
          "macAddress" : "macAddress",
          "cidr" : "cidr"
        } ]
      },
      "name" : "name"
    } ]
  },
  "status" : {
    "sshPrivateKey" : "sshPrivateKey",
    "workloadPools" : [ {
      "replicas" : 5,
      "name" : "name",
      "machines" : [ {
        "hostname" : "hostname",
        "imageID" : "imageID",
        "privateIP" : "privateIP",
        "flavorID" : "flavorID",
        "publicIP" : "publicIP",
        "id" : "id",
        "status" : "Pending"
      }, {
        "hostname" : "hostname",
        "imageID" : "imageID",
        "privateIP" : "privateIP",
        "flavorID" : "flavorID",
        "publicIP" : "publicIP",
        "id" : "id",
        "status" : "Pending"
      } ]
    }, {
      "replicas" : 5,
      "name" : "name",
      "machines" : [ {
        "hostname" : "hostname",
        "imageID" : "imageID",
        "privateIP" : "privateIP",
        "flavorID" : "flavorID",
        "publicIP" : "publicIP",
        "id" : "id",
        "status" : "Pending"
      }, {
        "hostname" : "hostname",
        "imageID" : "imageID",
        "privateIP" : "privateIP",
        "flavorID" : "flavorID",
        "publicIP" : "publicIP",
        "id" : "id",
        "status" : "Pending"
      } ]
    } ]
  }
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A detailed description of the region. computeClusterRead

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

404

Unable to find a resource. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
get /api/v1/organizations/{organizationID}/projects/{projectID}/clusters/{clusterID}/machines/{machineID}/consoleoutput
(apiV1OrganizationsOrganizationIDProjectsProjectIDClustersClusterIDMachinesMachineIDConsoleoutputGet)
Get the console output for a machine.

Path parameters

organizationID (required)
Path Parameter — The organization ID. default: null
projectID (required)
Path Parameter — The project ID. default: null
clusterID (required)
Path Parameter — The cluster ID. default: null
machineID (required)
Path Parameter — The machine ID. default: null

Query parameters

length (optional)
Query Parameter — The requested output length. default: null

Return type

consoleOutput

Example data

Content-Type: application/json
{
  "contents" : "contents"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A console output response. consoleOutput

400

Request body failed schema validation, or the request does not contain all the required fields. error

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

404

Unable to find a resource. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
get /api/v1/organizations/{organizationID}/projects/{projectID}/clusters/{clusterID}/machines/{machineID}/consolesessions
(apiV1OrganizationsOrganizationIDProjectsProjectIDClustersClusterIDMachinesMachineIDConsolesessionsGet)
Create a new console session for a machine.

Path parameters

organizationID (required)
Path Parameter — The organization ID. default: null
projectID (required)
Path Parameter — The project ID. default: null
clusterID (required)
Path Parameter — The cluster ID. default: null
machineID (required)
Path Parameter — The machine ID. default: null

Return type

consoleSession

Example data

Content-Type: application/json
{
  "url" : "url"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A console session response. consoleSession

400

Request body failed schema validation, or the request does not contain all the required fields. error

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

404

Unable to find a resource. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
post /api/v1/organizations/{organizationID}/projects/{projectID}/clusters/{clusterID}/machines/{machineID}/hardreboot
(apiV1OrganizationsOrganizationIDProjectsProjectIDClustersClusterIDMachinesMachineIDHardrebootPost)
Hard reboot a machine within a cluster.

Path parameters

organizationID (required)
Path Parameter — The organization ID. default: null
projectID (required)
Path Parameter — The project ID. default: null
clusterID (required)
Path Parameter — The cluster ID. default: null
machineID (required)
Path Parameter — The machine ID. default: null

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

The request has been accepted and will be fulfilled asynchronously. You may poll the resource and monitor its provisioning and health status to await completion of the operation.

400

Request body failed schema validation, or the request does not contain all the required fields. error

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

404

Unable to find a resource. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
post /api/v1/organizations/{organizationID}/projects/{projectID}/clusters/{clusterID}/machines/{machineID}/softreboot
(apiV1OrganizationsOrganizationIDProjectsProjectIDClustersClusterIDMachinesMachineIDSoftrebootPost)
Soft reboot a machine within a cluster.

Path parameters

organizationID (required)
Path Parameter — The organization ID. default: null
projectID (required)
Path Parameter — The project ID. default: null
clusterID (required)
Path Parameter — The cluster ID. default: null
machineID (required)
Path Parameter — The machine ID. default: null

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

The request has been accepted and will be fulfilled asynchronously. You may poll the resource and monitor its provisioning and health status to await completion of the operation.

400

Request body failed schema validation, or the request does not contain all the required fields. error

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

404

Unable to find a resource. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
post /api/v1/organizations/{organizationID}/projects/{projectID}/clusters/{clusterID}/machines/{machineID}/start
(apiV1OrganizationsOrganizationIDProjectsProjectIDClustersClusterIDMachinesMachineIDStartPost)
Start a stopped machine within a cluster.

Path parameters

organizationID (required)
Path Parameter — The organization ID. default: null
projectID (required)
Path Parameter — The project ID. default: null
clusterID (required)
Path Parameter — The cluster ID. default: null
machineID (required)
Path Parameter — The machine ID. default: null

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

The request has been accepted and will be fulfilled asynchronously. You may poll the resource and monitor its provisioning and health status to await completion of the operation.

400

Request body failed schema validation, or the request does not contain all the required fields. error

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

404

Unable to find a resource. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
post /api/v1/organizations/{organizationID}/projects/{projectID}/clusters/{clusterID}/machines/{machineID}/stop
(apiV1OrganizationsOrganizationIDProjectsProjectIDClustersClusterIDMachinesMachineIDStopPost)
Stop a running machine within a cluster.

Path parameters

organizationID (required)
Path Parameter — The organization ID. default: null
projectID (required)
Path Parameter — The project ID. default: null
clusterID (required)
Path Parameter — The cluster ID. default: null
machineID (required)
Path Parameter — The machine ID. default: null

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

The request has been accepted and will be fulfilled asynchronously. You may poll the resource and monitor its provisioning and health status to await completion of the operation.

400

Request body failed schema validation, or the request does not contain all the required fields. error

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

404

Unable to find a resource. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
put /api/v1/organizations/{organizationID}/projects/{projectID}/clusters/{clusterID}
(apiV1OrganizationsOrganizationIDProjectsProjectIDClustersClusterIDPut)
Update a cluster within the selected cluster manager.

Path parameters

organizationID (required)
Path Parameter — The organization ID. default: null
projectID (required)
Path Parameter — The project ID. default: null
clusterID (required)
Path Parameter — The cluster ID. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

computeClusterWrite computeClusterWrite (required)
Body Parameter —

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

The request has been accepted and will be fulfilled asynchronously. You may poll the resource and monitor its provisioning and health status to await completion of the operation.

400

Request body failed schema validation, or the request does not contain all the required fields. error

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

404

Unable to find a resource. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
post /api/v1/organizations/{organizationID}/projects/{projectID}/clusters
(apiV1OrganizationsOrganizationIDProjectsProjectIDClustersPost)
Creates a new cluster.

Path parameters

organizationID (required)
Path Parameter — The organization ID. default: null
projectID (required)
Path Parameter — The project ID. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

computeClusterWrite computeClusterWrite (required)
Body Parameter —

Return type

computeClusterRead

Example data

Content-Type: application/json
{
  "metadata" : {
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "description" : "description",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ],
    "organizationId" : "organizationId",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "modifiedBy" : "modifiedBy",
    "id" : "id",
    "projectId" : "projectId"
  },
  "spec" : {
    "regionId" : "regionId",
    "workloadPools" : [ {
      "machine" : {
        "image" : {
          "selector" : {
            "distro" : "rocky",
            "variant" : "variant",
            "version" : "version"
          },
          "id" : "id"
        },
        "disk" : {
          "size" : 6
        },
        "userData" : "userData",
        "publicIPAllocation" : {
          "enabled" : true
        },
        "firewall" : [ {
          "protocol" : "tcp",
          "prefixes" : [ "prefixes", "prefixes" ],
          "portMax" : 5,
          "port" : 1,
          "direction" : "ingress"
        }, {
          "protocol" : "tcp",
          "prefixes" : [ "prefixes", "prefixes" ],
          "portMax" : 5,
          "port" : 1,
          "direction" : "ingress"
        } ],
        "replicas" : 0,
        "flavorId" : "flavorId",
        "allowedAddressPairs" : [ {
          "macAddress" : "macAddress",
          "cidr" : "cidr"
        }, {
          "macAddress" : "macAddress",
          "cidr" : "cidr"
        } ]
      },
      "name" : "name"
    }, {
      "machine" : {
        "image" : {
          "selector" : {
            "distro" : "rocky",
            "variant" : "variant",
            "version" : "version"
          },
          "id" : "id"
        },
        "disk" : {
          "size" : 6
        },
        "userData" : "userData",
        "publicIPAllocation" : {
          "enabled" : true
        },
        "firewall" : [ {
          "protocol" : "tcp",
          "prefixes" : [ "prefixes", "prefixes" ],
          "portMax" : 5,
          "port" : 1,
          "direction" : "ingress"
        }, {
          "protocol" : "tcp",
          "prefixes" : [ "prefixes", "prefixes" ],
          "portMax" : 5,
          "port" : 1,
          "direction" : "ingress"
        } ],
        "replicas" : 0,
        "flavorId" : "flavorId",
        "allowedAddressPairs" : [ {
          "macAddress" : "macAddress",
          "cidr" : "cidr"
        }, {
          "macAddress" : "macAddress",
          "cidr" : "cidr"
        } ]
      },
      "name" : "name"
    } ]
  },
  "status" : {
    "sshPrivateKey" : "sshPrivateKey",
    "workloadPools" : [ {
      "replicas" : 5,
      "name" : "name",
      "machines" : [ {
        "hostname" : "hostname",
        "imageID" : "imageID",
        "privateIP" : "privateIP",
        "flavorID" : "flavorID",
        "publicIP" : "publicIP",
        "id" : "id",
        "status" : "Pending"
      }, {
        "hostname" : "hostname",
        "imageID" : "imageID",
        "privateIP" : "privateIP",
        "flavorID" : "flavorID",
        "publicIP" : "publicIP",
        "id" : "id",
        "status" : "Pending"
      } ]
    }, {
      "replicas" : 5,
      "name" : "name",
      "machines" : [ {
        "hostname" : "hostname",
        "imageID" : "imageID",
        "privateIP" : "privateIP",
        "flavorID" : "flavorID",
        "publicIP" : "publicIP",
        "id" : "id",
        "status" : "Pending"
      }, {
        "hostname" : "hostname",
        "imageID" : "imageID",
        "privateIP" : "privateIP",
        "flavorID" : "flavorID",
        "publicIP" : "publicIP",
        "id" : "id",
        "status" : "Pending"
      } ]
    } ]
  }
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

A Compute cluster. computeClusterRead

400

Request body failed schema validation, or the request does not contain all the required fields. error

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

409

Resource conflicts with another, usually this means they have the same name. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
delete /api/v2/clusters/{clusterID}
(apiV2ClustersClusterIDDelete)
Delete a cluster.

Path parameters

clusterID (required)
Path Parameter — The cluster ID. default: null

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

The request has been accepted and will be fulfilled asynchronously. You may poll the resource and monitor its provisioning and health status to await completion of the operation.

400

Request body failed schema validation, or the request does not contain all the required fields. error

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
get /api/v2/clusters/{clusterID}
(apiV2ClustersClusterIDGet)
Get a cluster.

Path parameters

clusterID (required)
Path Parameter — The cluster ID. default: null

Return type

clusterV2Read

Example data

Content-Type: application/json
{
  "metadata" : {
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "description" : "description",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ],
    "organizationId" : "organizationId",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "modifiedBy" : "modifiedBy",
    "id" : "id",
    "projectId" : "projectId"
  },
  "spec" : {
    "pools" : [ {
      "imageId" : "imageId",
      "userData" : "userData",
      "replicas" : 0,
      "name" : "name",
      "flavorId" : "flavorId",
      "networking" : {
        "securityGroups" : [ "securityGroups", "securityGroups" ],
        "publicIP" : true,
        "allowedSourceAddresses" : [ "allowedSourceAddresses", "allowedSourceAddresses" ]
      }
    }, {
      "imageId" : "imageId",
      "userData" : "userData",
      "replicas" : 0,
      "name" : "name",
      "flavorId" : "flavorId",
      "networking" : {
        "securityGroups" : [ "securityGroups", "securityGroups" ],
        "publicIP" : true,
        "allowedSourceAddresses" : [ "allowedSourceAddresses", "allowedSourceAddresses" ]
      }
    } ]
  },
  "status" : {
    "regionId" : "regionId",
    "pools" : [ {
      "replicas" : 6,
      "name" : "name"
    }, {
      "replicas" : 6,
      "name" : "name"
    } ],
    "networkId" : "networkId"
  }
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A cluster response. clusterV2Read

400

Request body failed schema validation, or the request does not contain all the required fields. error

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
put /api/v2/clusters/{clusterID}
(apiV2ClustersClusterIDPut)
Update a cluster.

Path parameters

clusterID (required)
Path Parameter — The cluster ID. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

clusterV2Update clusterV2Update (required)
Body Parameter —

Return type

clusterV2Read

Example data

Content-Type: application/json
{
  "metadata" : {
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "description" : "description",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ],
    "organizationId" : "organizationId",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "modifiedBy" : "modifiedBy",
    "id" : "id",
    "projectId" : "projectId"
  },
  "spec" : {
    "pools" : [ {
      "imageId" : "imageId",
      "userData" : "userData",
      "replicas" : 0,
      "name" : "name",
      "flavorId" : "flavorId",
      "networking" : {
        "securityGroups" : [ "securityGroups", "securityGroups" ],
        "publicIP" : true,
        "allowedSourceAddresses" : [ "allowedSourceAddresses", "allowedSourceAddresses" ]
      }
    }, {
      "imageId" : "imageId",
      "userData" : "userData",
      "replicas" : 0,
      "name" : "name",
      "flavorId" : "flavorId",
      "networking" : {
        "securityGroups" : [ "securityGroups", "securityGroups" ],
        "publicIP" : true,
        "allowedSourceAddresses" : [ "allowedSourceAddresses", "allowedSourceAddresses" ]
      }
    } ]
  },
  "status" : {
    "regionId" : "regionId",
    "pools" : [ {
      "replicas" : 6,
      "name" : "name"
    }, {
      "replicas" : 6,
      "name" : "name"
    } ],
    "networkId" : "networkId"
  }
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

A cluster response. clusterV2Read

400

Request body failed schema validation, or the request does not contain all the required fields. error

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
get /api/v2/clusters
(apiV2ClustersGet)
List compute clusters.

Query parameters

tag (optional)
Query Parameter — A set of tags to match against resources in the form "name=value", thus when encoded you get "?tag=foo%3Dcat&tag=bar%3Ddog". default: null
organizationID (optional)
Query Parameter — Allows resources to be filtered by organization. default: null
projectID (optional)
Query Parameter — Allows resources to be filtered by project. default: null
regionID (optional)
Query Parameter — Allows resources to be filtered by region. default: null
networkID (optional)
Query Parameter — Allows resources to be filtered by network. default: null

Return type

array[clusterV2Read]

Example data

Content-Type: application/json
[ {
  "metadata" : {
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "description" : "description",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ],
    "organizationId" : "organizationId",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "modifiedBy" : "modifiedBy",
    "id" : "id",
    "projectId" : "projectId"
  },
  "spec" : {
    "pools" : [ {
      "imageId" : "imageId",
      "userData" : "userData",
      "replicas" : 0,
      "name" : "name",
      "flavorId" : "flavorId",
      "networking" : {
        "securityGroups" : [ "securityGroups", "securityGroups" ],
        "publicIP" : true,
        "allowedSourceAddresses" : [ "allowedSourceAddresses", "allowedSourceAddresses" ]
      }
    }, {
      "imageId" : "imageId",
      "userData" : "userData",
      "replicas" : 0,
      "name" : "name",
      "flavorId" : "flavorId",
      "networking" : {
        "securityGroups" : [ "securityGroups", "securityGroups" ],
        "publicIP" : true,
        "allowedSourceAddresses" : [ "allowedSourceAddresses", "allowedSourceAddresses" ]
      }
    } ]
  },
  "status" : {
    "regionId" : "regionId",
    "pools" : [ {
      "replicas" : 6,
      "name" : "name"
    }, {
      "replicas" : 6,
      "name" : "name"
    } ],
    "networkId" : "networkId"
  }
}, {
  "metadata" : {
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "description" : "description",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ],
    "organizationId" : "organizationId",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "modifiedBy" : "modifiedBy",
    "id" : "id",
    "projectId" : "projectId"
  },
  "spec" : {
    "pools" : [ {
      "imageId" : "imageId",
      "userData" : "userData",
      "replicas" : 0,
      "name" : "name",
      "flavorId" : "flavorId",
      "networking" : {
        "securityGroups" : [ "securityGroups", "securityGroups" ],
        "publicIP" : true,
        "allowedSourceAddresses" : [ "allowedSourceAddresses", "allowedSourceAddresses" ]
      }
    }, {
      "imageId" : "imageId",
      "userData" : "userData",
      "replicas" : 0,
      "name" : "name",
      "flavorId" : "flavorId",
      "networking" : {
        "securityGroups" : [ "securityGroups", "securityGroups" ],
        "publicIP" : true,
        "allowedSourceAddresses" : [ "allowedSourceAddresses", "allowedSourceAddresses" ]
      }
    } ]
  },
  "status" : {
    "regionId" : "regionId",
    "pools" : [ {
      "replicas" : 6,
      "name" : "name"
    }, {
      "replicas" : 6,
      "name" : "name"
    } ],
    "networkId" : "networkId"
  }
} ]

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A cluster response.

400

Request body failed schema validation, or the request does not contain all the required fields. error

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

404

Unable to find a resource. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
post /api/v2/clusters
(apiV2ClustersPost)
Create a cluster.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

clusterV2Create clusterV2Create (required)
Body Parameter —

Return type

clusterV2Read

Example data

Content-Type: application/json
{
  "metadata" : {
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "description" : "description",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ],
    "organizationId" : "organizationId",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "modifiedBy" : "modifiedBy",
    "id" : "id",
    "projectId" : "projectId"
  },
  "spec" : {
    "pools" : [ {
      "imageId" : "imageId",
      "userData" : "userData",
      "replicas" : 0,
      "name" : "name",
      "flavorId" : "flavorId",
      "networking" : {
        "securityGroups" : [ "securityGroups", "securityGroups" ],
        "publicIP" : true,
        "allowedSourceAddresses" : [ "allowedSourceAddresses", "allowedSourceAddresses" ]
      }
    }, {
      "imageId" : "imageId",
      "userData" : "userData",
      "replicas" : 0,
      "name" : "name",
      "flavorId" : "flavorId",
      "networking" : {
        "securityGroups" : [ "securityGroups", "securityGroups" ],
        "publicIP" : true,
        "allowedSourceAddresses" : [ "allowedSourceAddresses", "allowedSourceAddresses" ]
      }
    } ]
  },
  "status" : {
    "regionId" : "regionId",
    "pools" : [ {
      "replicas" : 6,
      "name" : "name"
    }, {
      "replicas" : 6,
      "name" : "name"
    } ],
    "networkId" : "networkId"
  }
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

A cluster response. clusterV2Read

400

Request body failed schema validation, or the request does not contain all the required fields. error

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error

Flavors

Up 
get /api/v1/organizations/{organizationID}/regions/{regionID}/flavors
List flavors (apiV1OrganizationsOrganizationIDRegionsRegionIDFlavorsGet)
Lists all compute compatible flavors that the user has access to.

Path parameters

organizationID (required)
Path Parameter — The organization ID. default: null
regionID (required)
Path Parameter — The region ID. default: null

Return type

array[flavor]

Example data

Content-Type: application/json
[ {
  "metadata" : {
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "createdBy" : "createdBy",
    "name" : "name",
    "description" : "description",
    "modifiedBy" : "modifiedBy",
    "id" : "id",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ]
  },
  "spec" : {
    "baremetal" : true,
    "disk" : 1,
    "memory" : 6,
    "cpus" : 0,
    "cpuFamily" : "cpuFamily",
    "gpu" : {
      "memory" : 5,
      "vendor" : "NVIDIA",
      "model" : "model",
      "physicalCount" : 5,
      "logicalCount" : 2
    }
  }
}, {
  "metadata" : {
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "createdBy" : "createdBy",
    "name" : "name",
    "description" : "description",
    "modifiedBy" : "modifiedBy",
    "id" : "id",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ]
  },
  "spec" : {
    "baremetal" : true,
    "disk" : 1,
    "memory" : 6,
    "cpus" : 0,
    "cpuFamily" : "cpuFamily",
    "gpu" : {
      "memory" : 5,
      "vendor" : "NVIDIA",
      "model" : "model",
      "physicalCount" : 5,
      "logicalCount" : 2
    }
  }
} ]

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A list of flavors.

400

Request body failed schema validation, or the request does not contain all the required fields. error

401

Authentication failed or the access token has expired. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error

Images

Up 
get /api/v1/organizations/{organizationID}/regions/{regionID}/images
List images (apiV1OrganizationsOrganizationIDRegionsRegionIDImagesGet)
Lists all compute compatible images that the user has access to.

Path parameters

organizationID (required)
Path Parameter — The organization ID. default: null
regionID (required)
Path Parameter — The region ID. default: null

Return type

array[image]

Example data

Content-Type: application/json
[ {
  "metadata" : {
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "createdBy" : "createdBy",
    "name" : "name",
    "description" : "description",
    "modifiedBy" : "modifiedBy",
    "id" : "id",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ]
  },
  "spec" : {
    "sizeGiB" : 0,
    "virtualization" : "virtualized",
    "os" : {
      "distro" : "rocky",
      "kernel" : "linux",
      "codename" : "codename",
      "variant" : "variant",
      "family" : "redhat",
      "version" : "version"
    },
    "softwareVersions" : { },
    "gpu" : {
      "models" : [ null, null ],
      "driver" : "driver",
      "vendor" : "NVIDIA"
    }
  }
}, {
  "metadata" : {
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "createdBy" : "createdBy",
    "name" : "name",
    "description" : "description",
    "modifiedBy" : "modifiedBy",
    "id" : "id",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ]
  },
  "spec" : {
    "sizeGiB" : 0,
    "virtualization" : "virtualized",
    "os" : {
      "distro" : "rocky",
      "kernel" : "linux",
      "codename" : "codename",
      "variant" : "variant",
      "family" : "redhat",
      "version" : "version"
    },
    "softwareVersions" : { },
    "gpu" : {
      "models" : [ null, null ],
      "driver" : "driver",
      "vendor" : "NVIDIA"
    }
  }
} ]

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A list of images that are compatible with this platform.

400

Request body failed schema validation, or the request does not contain all the required fields. error

401

Authentication failed or the access token has expired. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error

Instances

Up 
get /api/v2/instances
List instances (apiV2InstancesGet)
List compute instances.

Query parameters

tag (optional)
Query Parameter — A set of tags to match against resources in the form "name=value", thus when encoded you get "?tag=foo%3Dcat&tag=bar%3Ddog". default: null
organizationID (optional)
Query Parameter — Allows resources to be filtered by organization. default: null
projectID (optional)
Query Parameter — Allows resources to be filtered by project. default: null
regionID (optional)
Query Parameter — Allows resources to be filtered by region. default: null
networkID (optional)
Query Parameter — Allows resources to be filtered by network. default: null

Return type

array[instanceRead]

Example data

Content-Type: application/json
[ {
  "metadata" : {
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "description" : "description",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ],
    "organizationId" : "organizationId",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "modifiedBy" : "modifiedBy",
    "id" : "id",
    "projectId" : "projectId"
  },
  "spec" : {
    "imageId" : "imageId",
    "userData" : "userData",
    "flavorId" : "flavorId",
    "networking" : {
      "securityGroups" : [ "securityGroups", "securityGroups" ],
      "publicIP" : true,
      "allowedSourceAddresses" : [ "allowedSourceAddresses", "allowedSourceAddresses" ]
    }
  },
  "status" : {
    "powerState" : "Pending",
    "regionId" : "regionId",
    "privateIP" : "privateIP",
    "networkId" : "networkId",
    "publicIP" : "publicIP"
  }
}, {
  "metadata" : {
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "description" : "description",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ],
    "organizationId" : "organizationId",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "modifiedBy" : "modifiedBy",
    "id" : "id",
    "projectId" : "projectId"
  },
  "spec" : {
    "imageId" : "imageId",
    "userData" : "userData",
    "flavorId" : "flavorId",
    "networking" : {
      "securityGroups" : [ "securityGroups", "securityGroups" ],
      "publicIP" : true,
      "allowedSourceAddresses" : [ "allowedSourceAddresses", "allowedSourceAddresses" ]
    }
  },
  "status" : {
    "powerState" : "Pending",
    "regionId" : "regionId",
    "privateIP" : "privateIP",
    "networkId" : "networkId",
    "publicIP" : "publicIP"
  }
} ]

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A list of compute instances.

400

Request body failed schema validation, or the request does not contain all the required fields. error

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

404

Unable to find a resource. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
get /api/v2/instances/{instanceID}/consoleoutput
Get instance console output (apiV2InstancesInstanceIDConsoleoutputGet)
Get the console output for an instance.

Path parameters

instanceID (required)
Path Parameter — The instance ID. default: null

Query parameters

length (optional)
Query Parameter — The requested output length. default: null

Return type

consoleOutput

Example data

Content-Type: application/json
{
  "contents" : "contents"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A console output response. consoleOutput

400

Request body failed schema validation, or the request does not contain all the required fields. error

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

404

Unable to find a resource. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
get /api/v2/instances/{instanceID}/consolesession
Get instance console VNC (apiV2InstancesInstanceIDConsolesessionGet)
Create a new console session for an instance.

Path parameters

instanceID (required)
Path Parameter — The instance ID. default: null

Return type

consoleSession

Example data

Content-Type: application/json
{
  "url" : "url"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A console session response. consoleSession

400

Request body failed schema validation, or the request does not contain all the required fields. error

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

404

Unable to find a resource. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
delete /api/v2/instances/{instanceID}
Delete instance (apiV2InstancesInstanceIDDelete)
Delete an instance.

Path parameters

instanceID (required)
Path Parameter — The instance ID. default: null

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

The request has been accepted and will be fulfilled asynchronously. You may poll the resource and monitor its provisioning and health status to await completion of the operation.

400

Request body failed schema validation, or the request does not contain all the required fields. error

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
get /api/v2/instances/{instanceID}
Get instance (apiV2InstancesInstanceIDGet)
Get an instance.

Path parameters

instanceID (required)
Path Parameter — The instance ID. default: null

Return type

instanceRead

Example data

Content-Type: application/json
{
  "metadata" : {
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "description" : "description",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ],
    "organizationId" : "organizationId",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "modifiedBy" : "modifiedBy",
    "id" : "id",
    "projectId" : "projectId"
  },
  "spec" : {
    "imageId" : "imageId",
    "userData" : "userData",
    "flavorId" : "flavorId",
    "networking" : {
      "securityGroups" : [ "securityGroups", "securityGroups" ],
      "publicIP" : true,
      "allowedSourceAddresses" : [ "allowedSourceAddresses", "allowedSourceAddresses" ]
    }
  },
  "status" : {
    "powerState" : "Pending",
    "regionId" : "regionId",
    "privateIP" : "privateIP",
    "networkId" : "networkId",
    "publicIP" : "publicIP"
  }
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A compute instance. instanceRead

400

Request body failed schema validation, or the request does not contain all the required fields. error

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
put /api/v2/instances/{instanceID}
Update instance (apiV2InstancesInstanceIDPut)
Update an instance.

Path parameters

instanceID (required)
Path Parameter — The instance ID. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

instanceUpdate instanceUpdate (required)
Body Parameter —

Return type

instanceRead

Example data

Content-Type: application/json
{
  "metadata" : {
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "description" : "description",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ],
    "organizationId" : "organizationId",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "modifiedBy" : "modifiedBy",
    "id" : "id",
    "projectId" : "projectId"
  },
  "spec" : {
    "imageId" : "imageId",
    "userData" : "userData",
    "flavorId" : "flavorId",
    "networking" : {
      "securityGroups" : [ "securityGroups", "securityGroups" ],
      "publicIP" : true,
      "allowedSourceAddresses" : [ "allowedSourceAddresses", "allowedSourceAddresses" ]
    }
  },
  "status" : {
    "powerState" : "Pending",
    "regionId" : "regionId",
    "privateIP" : "privateIP",
    "networkId" : "networkId",
    "publicIP" : "publicIP"
  }
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

A compute instance. instanceRead

400

Request body failed schema validation, or the request does not contain all the required fields. error

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
post /api/v2/instances/{instanceID}/reboot
Reboot instance (apiV2InstancesInstanceIDRebootPost)
Reboot an instance. By default this will perform a software ACPI reboot. You can specifiy a hard power cycle as a query parameter.

Path parameters

instanceID (required)
Path Parameter — The instance ID. default: null

Query parameters

hard (optional)
Query Parameter — Whether the reboot is hard. default: null

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

The request has been accepted and will be fulfilled asynchronously. You may poll the resource and monitor its provisioning and health status to await completion of the operation.

400

Request body failed schema validation, or the request does not contain all the required fields. error

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

404

Unable to find a resource. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
get /api/v2/instances/{instanceID}/sshkey
Get instance SSH key (apiV2InstancesInstanceIDSshkeyGet)
Retrieve the SSH key for an instance.

Path parameters

instanceID (required)
Path Parameter — The instance ID. default: null

Return type

sshKey

Example data

Content-Type: application/json
{
  "privateKey" : "privateKey"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

An SSH key. sshKey

400

Request body failed schema validation, or the request does not contain all the required fields. error

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
post /api/v2/instances/{instanceID}/start
Start instance (apiV2InstancesInstanceIDStartPost)
Start a stopped instance.

Path parameters

instanceID (required)
Path Parameter — The instance ID. default: null

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

The request has been accepted and will be fulfilled asynchronously. You may poll the resource and monitor its provisioning and health status to await completion of the operation.

400

Request body failed schema validation, or the request does not contain all the required fields. error

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

404

Unable to find a resource. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
post /api/v2/instances/{instanceID}/stop
Stop instance (apiV2InstancesInstanceIDStopPost)
Stop a running instnace.

Path parameters

instanceID (required)
Path Parameter — The instance ID. default: null

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

The request has been accepted and will be fulfilled asynchronously. You may poll the resource and monitor its provisioning and health status to await completion of the operation.

400

Request body failed schema validation, or the request does not contain all the required fields. error

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

404

Unable to find a resource. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error
Up 
post /api/v2/instances
Create instance (apiV2InstancesPost)
Create an instance.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

instanceCreate instanceCreate (required)
Body Parameter —

Return type

instanceRead

Example data

Content-Type: application/json
{
  "metadata" : {
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "description" : "description",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ],
    "organizationId" : "organizationId",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "modifiedBy" : "modifiedBy",
    "id" : "id",
    "projectId" : "projectId"
  },
  "spec" : {
    "imageId" : "imageId",
    "userData" : "userData",
    "flavorId" : "flavorId",
    "networking" : {
      "securityGroups" : [ "securityGroups", "securityGroups" ],
      "publicIP" : true,
      "allowedSourceAddresses" : [ "allowedSourceAddresses", "allowedSourceAddresses" ]
    }
  },
  "status" : {
    "powerState" : "Pending",
    "regionId" : "regionId",
    "privateIP" : "privateIP",
    "networkId" : "networkId",
    "publicIP" : "publicIP"
  }
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

A compute instance. instanceRead

400

Request body failed schema validation, or the request does not contain all the required fields. error

401

Authentication failed or the access token has expired. error

403

Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error

Regions

Up 
get /api/v1/organizations/{organizationID}/regions
List regions (apiV1OrganizationsOrganizationIDRegionsGet)
Lists compute service compatible regions.

Path parameters

organizationID (required)
Path Parameter — The organization ID. default: null

Return type

array[regionRead]

Example data

Content-Type: application/json
[ {
  "metadata" : {
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "description" : "description",
    "modifiedBy" : "modifiedBy",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "id" : "id",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ]
  },
  "spec" : {
    "features" : {
      "physicalNetworks" : true
    },
    "type" : "openstack"
  }
}, {
  "metadata" : {
    "modifiedTime" : "2000-01-23T04:56:07.000+00:00",
    "creationTime" : "2000-01-23T04:56:07.000+00:00",
    "createdBy" : "createdBy",
    "healthStatus" : "unknown",
    "provisioningStatus" : "unknown",
    "name" : "name",
    "description" : "description",
    "modifiedBy" : "modifiedBy",
    "deletionTime" : "2000-01-23T04:56:07.000+00:00",
    "id" : "id",
    "tags" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ]
  },
  "spec" : {
    "features" : {
      "physicalNetworks" : true
    },
    "type" : "openstack"
  }
} ]

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Example data

Content-Type: application/json
{
  "error_description" : "error_description",
  "error" : "invalid_request"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A list of regions.

400

Request body failed schema validation, or the request does not contain all the required fields. error

401

Authentication failed or the access token has expired. error

500

An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. error

Models

[ Jump to Methods ]

Table of Contents

  1. allowedAddressPair -
  2. clusterV2Create -
  3. clusterV2CreateSpec -
  4. clusterV2Read -
  5. clusterV2Spec -
  6. clusterV2Status -
  7. clusterV2Update -
  8. computeClusterMachineStatus -
  9. computeClusterNetwork -
  10. computeClusterRead -
  11. computeClusterSpec -
  12. computeClusterStatus -
  13. computeClusterWorkloadPool -
  14. computeClusterWorkloadPoolStatus -
  15. computeClusterWrite -
  16. computeImage -
  17. consoleOutput -
  18. consoleSession -
  19. error -
  20. evictionWrite -
  21. firewallRule -
  22. flavor -
  23. flavorSpec -
  24. gpuSpec -
  25. gpuVendor -
  26. image -
  27. imageGpu -
  28. imageOS -
  29. imageSelector -
  30. imageSpec -
  31. imageVirtualization -
  32. instanceCreate -
  33. instanceCreateSpec -
  34. instanceLifecyclePhase -
  35. instanceNetworking -
  36. instanceRead -
  37. instanceSpec -
  38. instanceStatus -
  39. instanceUpdate -
  40. machinePool -
  41. organizationScopedResourceReadMetadata -
  42. osDistro -
  43. osFamily -
  44. osKernel -
  45. poolV2 -
  46. poolV2Status -
  47. projectScopedResourceReadMetadata -
  48. publicIPAllocation -
  49. regionFeatures -
  50. regionRead -
  51. regionSpec -
  52. regionType -
  53. resourceHealthStatus -
  54. resourceMetadata -
  55. resourceProvisioningStatus -
  56. resourceReadMetadata -
  57. resourceWriteMetadata -
  58. sshKey -
  59. staticResourceMetadata -
  60. tag -
  61. volume -

allowedAddressPair - Up

Allow multiple MAC/IP address (range) pairs to pass through this network port. Typically required when the machine is operating as a router.
cidr
String The CIDR to allow.
macAddress (optional)
String The MAC address to allow.

clusterV2Create - Up

A cluster creation request.
metadata
resourceWriteMetadata
spec
clusterV2CreateSpec

clusterV2CreateSpec - Up

A cluster creation specification.
pools
array[poolV2] A list of workload pools.
organizationId
String The organization to provision the resource in.
projectId
String The project to provision the resource in.
networkId
String The network ID to attach the compute instance to.

clusterV2Read - Up

A compute cluster.
metadata
projectScopedResourceReadMetadata
spec
clusterV2Spec
status
clusterV2Status

clusterV2Spec - Up

A cluster specification.
pools
array[poolV2] A list of workload pools.

clusterV2Status - Up

A cluster status.
regionId
String The region ID the cluster is running in.
networkId
String The network ID the cluster is running on.
pools
array[poolV2Status] A list of workload pool statuses.

clusterV2Update - Up

A cluster update request.
metadata
resourceWriteMetadata
spec
clusterV2Spec

computeClusterMachineStatus - Up

Compute cluster machine status.
id
String Machine ID.
hostname
String Machine hostname.
imageID
String Machine image ID.
flavorID
String Machine flavorID.
privateIP (optional)
String Machine private IP address.
publicIP (optional)
String Machine public IP address.
status
instanceLifecyclePhase
provisioningStatus
resourceProvisioningStatus
healthStatus
resourceHealthStatus

computeClusterNetwork - Up

Compute cluster network settings.
nodePrefix (optional)
String Network prefix to provision nodes in. Must be a valid CIDR block.
dnsNameservers (optional)
array[String] A list of DNS name server to use.

computeClusterRead - Up

Compute cluster read.
metadata
projectScopedResourceReadMetadata
spec
computeClusterSpec
status (optional)
computeClusterStatus

computeClusterSpec - Up

Compute cluster creation parameters.
regionId
String The region to provision the cluster in.
workloadPools
array[computeClusterWorkloadPool] A list of Compute cluster workload pools.

computeClusterStatus - Up

Compute cluster status.
sshPrivateKey (optional)
String SSH private key that allows access to the cluster.
workloadPools (optional)
array[computeClusterWorkloadPoolStatus] A list of Compute cluster workload pools status.

computeClusterWorkloadPool - Up

A Compute cluster workload pool.
name
String A valid Kubernetes label value, typically used for resource names that can be indexed in the database.
machine
machinePool

computeClusterWorkloadPoolStatus - Up

Compute cluster workload pool status.
name
String A valid Kubernetes label value, typically used for resource names that can be indexed in the database.
replicas
Integer Number of machines.
machines (optional)
array[computeClusterMachineStatus] A list of Compute cluster machines status.

computeClusterWrite - Up

Compute cluster create or update.
metadata
resourceWriteMetadata
spec
computeClusterSpec

computeImage - Up

The image to use for a server.
id (optional)
String The image ID.
selector (optional)
imageSelector

consoleOutput - Up

Console output
contents
String Console output.

consoleSession - Up

A console session response.
url
String The URL to access the console session.

error - Up

Generic error message, compatible with oauth2.
error
String A terse error string expanding on the HTTP error code. Errors are based on the OAuth 2.02 specification, but are expanded with proprietary status codes for APIs other than those specified by OAuth 2.02.
Enum:
invalid_request
server_error
access_denied
not_found
conflict
method_not_allowed
unsupported_media_type
request_entity_too_large
forbidden
error_description
String Verbose message describing the error.

evictionWrite - Up

A set of machines to evict from a cluster.
machineIDs
array[String] A list of machine IDs, these are returned in the cluster status.

firewallRule - Up

A firewall rule applied to a workload pool.
direction
String The direction of network traffic to apply the rule to.
Enum:
ingress
egress
protocol
String The protocol to allow.
Enum:
tcp
udp
port
Integer The port to allow, or start of a port range.
portMax (optional)
Integer The end of a port range, inclusive of this this port, if specified.
prefixes
array[String] A list of CIDR prefixes to allow, it might be any IPv4 or IPv6 in CIDR notation.

flavor - Up

A flavor.
metadata
staticResourceMetadata
spec
flavorSpec

flavorSpec - Up

A flavor.
baremetal (optional)
Boolean Whether the flavor is for a dedicated machine.
cpus
Integer The number of CPUs.
cpuFamily (optional)
String A free form CPU family description e.g. model number, architecture.
memory
Integer The amount of memory in GiB.
disk
Integer The amount of ephemeral disk in GB.
gpu (optional)
gpuSpec

gpuSpec - Up

GPU specification.
vendor
gpuVendor
model
String A GPU model.
memory
Integer GPU memory in GiB.
physicalCount
Integer The physical number of GPUs (cards) available.
logicalCount
Integer The logical number of GPUs available as seen in the OS.

gpuVendor - Up

The GPU vendor.

image - Up

An image.
metadata
staticResourceMetadata
spec
imageSpec

imageGpu - Up

The GPU driver if installed.
vendor
gpuVendor
driver
String The GPU driver version, this is vendor specific.
models (optional)
array[String] A list of GPU model numbers.

imageOS - Up

An operating system description.
kernel
osKernel
family
osFamily
distro
osDistro
variant (optional)
String A free form variant e.g. desktop/server.
codename (optional)
String A free form code name e.g. warty/bionic.
version
String Version of the operating system e.g. "24.04".

imageSelector - Up

A server image selector.
distro
osDistro
variant (optional)
String The operating system variant.
version
String The operating system version to use.

imageSpec - Up

An image.
sizeGiB
Integer Minimum disk size required to use the image in GiB.
virtualization
imageVirtualization
os
imageOS
softwareVersions (optional)
map[String, String] Image preinstalled version version metadata.
gpu (optional)
imageGpu

imageVirtualization - Up

What type of machine the image is for.

instanceCreate - Up

A compute instance creation request.
metadata
resourceWriteMetadata
spec
instanceCreateSpec

instanceCreateSpec - Up

A compute instance.
flavorId
String The flavor CPU/RAM of a compute instance.
imageId
String The image of a compute instance.
networking (optional)
instanceNetworking
userData (optional)
byte[] Contains base64-encoded configuration information or scripts to use upon launch. The format of the data is governed by the cloud-init standard, and may be a script, a MIME multipart archive, etc. format: byte
organizationId
String The organization to provision the resource in.
projectId
String The project to provision the resource in.
networkId
String The network ID to attach the compute instance to.

instanceLifecyclePhase - Up

The lifecycle phase of an instance.

instanceNetworking - Up

A compute instance's network configuration.
securityGroups (optional)
array[String] A list of security group IDs.
publicIP (optional)
Boolean Whether or not to provision a public IP.
allowedSourceAddresses (optional)
array[String] A list of network prefixes that are allowed to egress from the server. By default, only packets from the server's network interface's IP address are allowed to enter the network. Use of this option allows the server to act as a router without SNAT rules.

instanceRead - Up

A compute instance.
metadata
projectScopedResourceReadMetadata
spec
instanceSpec
status
instanceStatus

instanceSpec - Up

A compute instance.
flavorId
String The flavor CPU/RAM of a compute instance.
imageId
String The image of a compute instance.
networking (optional)
instanceNetworking
userData (optional)
byte[] Contains base64-encoded configuration information or scripts to use upon launch. The format of the data is governed by the cloud-init standard, and may be a script, a MIME multipart archive, etc. format: byte

instanceStatus - Up

Read only status information about a compute instance.
regionId
String The region a security group belongs to.
networkId
String The network a security group belongs to.
powerState (optional)
instanceLifecyclePhase
privateIP (optional)
String The private IP address of the server.
publicIP (optional)
String The public IP address of the server.

instanceUpdate - Up

A compute instance update request.
metadata
resourceWriteMetadata
spec
instanceSpec

machinePool - Up

A Compute cluster machine pool.
replicas
Integer Number of machines.
flavorId
String Flavor ID.
disk (optional)
volume
firewall (optional)
array[firewallRule] A list of firewall rules applied to a workload pool.
publicIPAllocation (optional)
publicIPAllocation
image
computeImage
userData (optional)
byte[] UserData contains base64-encoded configuration information or scripts to use upon launch. format: byte
allowedAddressPairs (optional)
array[allowedAddressPair] A list of allowed address pairs.

organizationScopedResourceReadMetadata - Up

Metadata required by organization scoped resource reads.
name
String A valid Kubernetes label value, typically used for resource names that can be indexed in the database.
description (optional)
String The resource description, this optionally augments the name with more context.
tags (optional)
array[tag] A list of tags.
id
String The unique resource ID.
creationTime
Date The time the resource was created. format: date-time
createdBy (optional)
String The user who created the resource.
modifiedTime (optional)
Date The time a resource was updated. format: date-time
modifiedBy (optional)
String The user who updated the resource.
deletionTime (optional)
Date The time the resource was deleted. format: date-time
provisioningStatus
resourceProvisioningStatus
healthStatus
resourceHealthStatus
organizationId
String The organization identifier the resource belongs to.

osDistro - Up

A distribution name.

osFamily - Up

A family of operating systems. This typically defines the package format.

osKernel - Up

A kernel type.

poolV2 - Up

A workload pool.
name
String The name of the pool. Instances will inherit this name plus a short suffix.
replicas
Integer The number of instances to maintain.
flavorId
String The flavor CPU/RAM of a compute instance.
imageId
String The image of a compute instance.
networking (optional)
instanceNetworking
userData (optional)
byte[] Contains base64-encoded configuration information or scripts to use upon launch. The format of the data is governed by the cloud-init standard, and may be a script, a MIME multipart archive, etc. format: byte

poolV2Status - Up

A workload pool.
name
String The name of the pool.
replicas
Integer The number of instances that exist.

projectScopedResourceReadMetadata - Up

Metadata required by project scoped resource reads.
name
String A valid Kubernetes label value, typically used for resource names that can be indexed in the database.
description (optional)
String The resource description, this optionally augments the name with more context.
tags (optional)
array[tag] A list of tags.
id
String The unique resource ID.
creationTime
Date The time the resource was created. format: date-time
createdBy (optional)
String The user who created the resource.
modifiedTime (optional)
Date The time a resource was updated. format: date-time
modifiedBy (optional)
String The user who updated the resource.
deletionTime (optional)
Date The time the resource was deleted. format: date-time
provisioningStatus
resourceProvisioningStatus
healthStatus
resourceHealthStatus
organizationId
String The organization identifier the resource belongs to.
projectId
String The project identifier the resource belongs to.

publicIPAllocation - Up

A public IP allocation settings.
enabled
Boolean Enable public IP allocation.

regionFeatures - Up

A set of features the region may provide to clients.
physicalNetworks
Boolean If set, this indicates that the region supports physical networks and one should be provisioned for clusters to use. The implication here is the region supports base-metal machines, and these must be provisioned on a physical VLAN etc.

regionRead - Up

A region.
metadata
resourceReadMetadata
spec
regionSpec

regionSpec - Up

Information about the region.
type
regionType
features
regionFeatures

regionType - Up

The region's provider type.

resourceHealthStatus - Up

The health state of a resource.

resourceMetadata - Up

Metadata required for all API resource reads and writes.
name
String A valid Kubernetes label value, typically used for resource names that can be indexed in the database.
description (optional)
String The resource description, this optionally augments the name with more context.
tags (optional)
array[tag] A list of tags.

resourceProvisioningStatus - Up

The provisioning state of a resource.

resourceReadMetadata - Up

Metadata required by all resource reads.
name
String A valid Kubernetes label value, typically used for resource names that can be indexed in the database.
description (optional)
String The resource description, this optionally augments the name with more context.
tags (optional)
array[tag] A list of tags.
id
String The unique resource ID.
creationTime
Date The time the resource was created. format: date-time
createdBy (optional)
String The user who created the resource.
modifiedTime (optional)
Date The time a resource was updated. format: date-time
modifiedBy (optional)
String The user who updated the resource.
deletionTime (optional)
Date The time the resource was deleted. format: date-time
provisioningStatus
resourceProvisioningStatus
healthStatus
resourceHealthStatus

resourceWriteMetadata - Up

Metadata required for all API resource reads and writes.
name
String A valid Kubernetes label value, typically used for resource names that can be indexed in the database.
description (optional)
String The resource description, this optionally augments the name with more context.
tags (optional)
array[tag] A list of tags.

sshKey - Up

An SSH key.
privateKey
String The SSH private key.

staticResourceMetadata - Up

This metadata is for resources that just exist, and don't require any provisioning and health status, but benefit from a standardized metadata format.
name
String A valid Kubernetes label value, typically used for resource names that can be indexed in the database.
description (optional)
String The resource description, this optionally augments the name with more context.
tags (optional)
array[tag] A list of tags.
id
String The unique resource ID.
creationTime
Date The time the resource was created. format: date-time
createdBy (optional)
String The user who created the resource.
modifiedTime (optional)
Date The time a resource was updated. format: date-time
modifiedBy (optional)
String The user who updated the resource.

tag - Up

A tag mapping arbitrary names to values. These have no special meaning for any component are are intended for use by end users to add additional context to a resource, for example to categorize it.
name
String A unique tag name.
value
String The value of the tag.

volume - Up

A volume. This is currently only valid for VM based flavors.
size
Integer Disk size in GiB.