Region Service API

Cloud region discovery and routing service. This is service not intended for direct access by end users. Region related functionality is typically exposed by higher level services e.g. Compute and Kubernetes, that provide subsets of resources that are compatible with that service.
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

FileStorage

FileStorageClasses

Images

Networks

SecurityGroups

Default

Up 
get /api/v1/organizations/{organizationID}/identities
(apiV1OrganizationsOrganizationIDIdentitiesGet)
Get all identities scoped to an organization.

Path parameters

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

Return type

array[identityRead]

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",
    "openstack" : {
      "cloud" : "cloud",
      "cloudConfig" : "cloudConfig",
      "sshKeyName" : "sshKeyName",
      "sshPrivateKey" : "sshPrivateKey",
      "serverGroupId" : "serverGroupId",
      "userId" : "userId",
      "projectId" : "projectId"
    },
    "type" : "openstack"
  }
}, {
  "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",
    "openstack" : {
      "cloud" : "cloud",
      "cloudConfig" : "cloudConfig",
      "sshKeyName" : "sshKeyName",
      "sshPrivateKey" : "sshPrivateKey",
      "serverGroupId" : "serverGroupId",
      "userId" : "userId",
      "projectId" : "projectId"
    },
    "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"
}

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 identites.

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/v1/organizations/{organizationID}/networks
(apiV1OrganizationsOrganizationIDNetworksGet)
List networks.

Path parameters

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

Return type

array[networkRead]

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" : {
    "dnsNameservers" : [ null, null ],
    "regionId" : "regionId",
    "prefix" : "prefix",
    "openstack" : {
      "subnetId" : "subnetId",
      "vlanId" : 0,
      "routerId" : "routerId",
      "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" : {
    "dnsNameservers" : [ null, null ],
    "regionId" : "regionId",
    "prefix" : "prefix",
    "openstack" : {
      "subnetId" : "subnetId",
      "vlanId" : 0,
      "routerId" : "routerId",
      "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 list of networks.

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 
delete /api/v1/organizations/{organizationID}/projects/{projectID}/identities/{identityID}
(apiV1OrganizationsOrganizationIDProjectsProjectIDIdentitiesIdentityIDDelete)
Delete an identity and any resources associated with it.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null
projectID (required)
Path Parameter — The project ID. default: null
identityID (required)
Path Parameter — The identity 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 
get /api/v1/organizations/{organizationID}/projects/{projectID}/identities/{identityID}
(apiV1OrganizationsOrganizationIDProjectsProjectIDIdentitiesIdentityIDGet)
Get a single identity.

Path parameters

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

Return type

identityRead

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",
    "openstack" : {
      "cloud" : "cloud",
      "cloudConfig" : "cloudConfig",
      "sshKeyName" : "sshKeyName",
      "sshPrivateKey" : "sshPrivateKey",
      "serverGroupId" : "serverGroupId",
      "userId" : "userId",
      "projectId" : "projectId"
    },
    "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"
}

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 identity response. identityRead

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 
delete /api/v1/organizations/{organizationID}/projects/{projectID}/identities/{identityID}/networks/{networkID}
(apiV1OrganizationsOrganizationIDProjectsProjectIDIdentitiesIdentityIDNetworksNetworkIDDelete)
Delete a new network.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null
projectID (required)
Path Parameter — The project ID. default: null
identityID (required)
Path Parameter — The identity ID. default: null
networkID (required)
Path Parameter — The network 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/v1/organizations/{organizationID}/projects/{projectID}/identities/{identityID}/networks/{networkID}
(apiV1OrganizationsOrganizationIDProjectsProjectIDIdentitiesIdentityIDNetworksNetworkIDGet)
Get a physical network.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null
projectID (required)
Path Parameter — The project ID. default: null
identityID (required)
Path Parameter — The identity ID. default: null
networkID (required)
Path Parameter — The network ID. default: null

Return type

networkRead

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" : {
    "dnsNameservers" : [ null, null ],
    "regionId" : "regionId",
    "prefix" : "prefix",
    "openstack" : {
      "subnetId" : "subnetId",
      "vlanId" : 0,
      "routerId" : "routerId",
      "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 network. networkRead

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/v1/organizations/{organizationID}/projects/{projectID}/identities/{identityID}/networks
(apiV1OrganizationsOrganizationIDProjectsProjectIDIdentitiesIdentityIDNetworksPost)
Create a new network.

Path parameters

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

Consumes

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

Request body

networkWrite networkWrite (optional)
Body Parameter —

Return type

networkRead

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" : {
    "dnsNameservers" : [ null, null ],
    "regionId" : "regionId",
    "prefix" : "prefix",
    "openstack" : {
      "subnetId" : "subnetId",
      "vlanId" : 0,
      "routerId" : "routerId",
      "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 network. networkRead

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/v1/organizations/{organizationID}/projects/{projectID}/identities/{identityID}/securitygroups
(apiV1OrganizationsOrganizationIDProjectsProjectIDIdentitiesIdentityIDSecuritygroupsPost)
Create a new security group.

Path parameters

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

Consumes

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

Request body

securityGroupWrite securityGroupWrite (optional)
Body Parameter —

Return type

securityGroupRead

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" : {
    "rules" : [ {
      "protocol" : "any",
      "port" : {
        "number" : 5249,
        "range" : {
          "start" : 39501,
          "end" : 9607
        }
      },
      "cidr" : "cidr",
      "direction" : "ingress"
    }, {
      "protocol" : "any",
      "port" : {
        "number" : 5249,
        "range" : {
          "start" : 39501,
          "end" : 9607
        }
      },
      "cidr" : "cidr",
      "direction" : "ingress"
    } ]
  }
}

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 security group. securityGroupRead

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 
delete /api/v1/organizations/{organizationID}/projects/{projectID}/identities/{identityID}/securitygroups/{securityGroupID}
(apiV1OrganizationsOrganizationIDProjectsProjectIDIdentitiesIdentityIDSecuritygroupsSecurityGroupIDDelete)
Delete a security group.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null
projectID (required)
Path Parameter — The project ID. default: null
identityID (required)
Path Parameter — The identity ID. default: null
securityGroupID (required)
Path Parameter — The security group 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/v1/organizations/{organizationID}/projects/{projectID}/identities/{identityID}/securitygroups/{securityGroupID}
(apiV1OrganizationsOrganizationIDProjectsProjectIDIdentitiesIdentityIDSecuritygroupsSecurityGroupIDGet)
Get a security group.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null
projectID (required)
Path Parameter — The project ID. default: null
identityID (required)
Path Parameter — The identity ID. default: null
securityGroupID (required)
Path Parameter — The security group ID. default: null

Return type

securityGroupRead

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" : {
    "rules" : [ {
      "protocol" : "any",
      "port" : {
        "number" : 5249,
        "range" : {
          "start" : 39501,
          "end" : 9607
        }
      },
      "cidr" : "cidr",
      "direction" : "ingress"
    }, {
      "protocol" : "any",
      "port" : {
        "number" : 5249,
        "range" : {
          "start" : 39501,
          "end" : 9607
        }
      },
      "cidr" : "cidr",
      "direction" : "ingress"
    } ]
  }
}

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 security group. securityGroupRead

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/v1/organizations/{organizationID}/projects/{projectID}/identities/{identityID}/securitygroups/{securityGroupID}
(apiV1OrganizationsOrganizationIDProjectsProjectIDIdentitiesIdentityIDSecuritygroupsSecurityGroupIDPut)
Updates a security group.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null
projectID (required)
Path Parameter — The project ID. default: null
identityID (required)
Path Parameter — The identity ID. default: null
securityGroupID (required)
Path Parameter — The security group ID. default: null

Consumes

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

Request body

securityGroupWrite securityGroupWrite (optional)
Body Parameter —

Return type

securityGroupRead

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" : {
    "rules" : [ {
      "protocol" : "any",
      "port" : {
        "number" : 5249,
        "range" : {
          "start" : 39501,
          "end" : 9607
        }
      },
      "cidr" : "cidr",
      "direction" : "ingress"
    }, {
      "protocol" : "any",
      "port" : {
        "number" : 5249,
        "range" : {
          "start" : 39501,
          "end" : 9607
        }
      },
      "cidr" : "cidr",
      "direction" : "ingress"
    } ]
  }
}

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 security group. securityGroupRead

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/v1/organizations/{organizationID}/projects/{projectID}/identities/{identityID}/servers
(apiV1OrganizationsOrganizationIDProjectsProjectIDIdentitiesIdentityIDServersPost)
Create a new server.

Path parameters

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

Consumes

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

Request body

serverWrite serverWrite (optional)
Body Parameter —

Return type

serverRead

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",
    "publicIPAllocation" : {
      "enabled" : true
    },
    "flavorId" : "flavorId",
    "securityGroups" : [ {
      "id" : "id"
    }, {
      "id" : "id"
    } ],
    "networks" : [ {
      "id" : "id",
      "allowedAddressPairs" : [ {
        "macAddress" : "macAddress",
        "cidr" : "cidr"
      }, {
        "macAddress" : "macAddress",
        "cidr" : "cidr"
      } ]
    } ]
  },
  "status" : {
    "phase" : "Pending",
    "privateIP" : "privateIP",
    "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 server. serverRead

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/v1/organizations/{organizationID}/projects/{projectID}/identities/{identityID}/servers/{serverID}/consoleoutput
(apiV1OrganizationsOrganizationIDProjectsProjectIDIdentitiesIdentityIDServersServerIDConsoleoutputGet)
Get the console output for a server.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null
projectID (required)
Path Parameter — The project ID. default: null
identityID (required)
Path Parameter — The identity ID. default: null
serverID (required)
Path Parameter — The server 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"
}

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

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}/identities/{identityID}/servers/{serverID}/consolesessions
(apiV1OrganizationsOrganizationIDProjectsProjectIDIdentitiesIdentityIDServersServerIDConsolesessionsGet)
Create a new console session for a server.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null
projectID (required)
Path Parameter — The project ID. default: null
identityID (required)
Path Parameter — The identity ID. default: null
serverID (required)
Path Parameter — The server 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"
}

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

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}/identities/{identityID}/servers/{serverID}
(apiV1OrganizationsOrganizationIDProjectsProjectIDIdentitiesIdentityIDServersServerIDDelete)
Delete a server.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null
projectID (required)
Path Parameter — The project ID. default: null
identityID (required)
Path Parameter — The identity ID. default: null
serverID (required)
Path Parameter — The server 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/v1/organizations/{organizationID}/projects/{projectID}/identities/{identityID}/servers/{serverID}
(apiV1OrganizationsOrganizationIDProjectsProjectIDIdentitiesIdentityIDServersServerIDGet)
Get a server.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null
projectID (required)
Path Parameter — The project ID. default: null
identityID (required)
Path Parameter — The identity ID. default: null
serverID (required)
Path Parameter — The server ID. default: null

Return type

serverRead

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",
    "publicIPAllocation" : {
      "enabled" : true
    },
    "flavorId" : "flavorId",
    "securityGroups" : [ {
      "id" : "id"
    }, {
      "id" : "id"
    } ],
    "networks" : [ {
      "id" : "id",
      "allowedAddressPairs" : [ {
        "macAddress" : "macAddress",
        "cidr" : "cidr"
      }, {
        "macAddress" : "macAddress",
        "cidr" : "cidr"
      } ]
    } ]
  },
  "status" : {
    "phase" : "Pending",
    "privateIP" : "privateIP",
    "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 server. serverRead

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/v1/organizations/{organizationID}/projects/{projectID}/identities/{identityID}/servers/{serverID}/hardreboot
(apiV1OrganizationsOrganizationIDProjectsProjectIDIdentitiesIdentityIDServersServerIDHardrebootPost)
Hard reboot a server.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null
projectID (required)
Path Parameter — The project ID. default: null
identityID (required)
Path Parameter — The identity ID. default: null
serverID (required)
Path Parameter — The server 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 
put /api/v1/organizations/{organizationID}/projects/{projectID}/identities/{identityID}/servers/{serverID}
(apiV1OrganizationsOrganizationIDProjectsProjectIDIdentitiesIdentityIDServersServerIDPut)
Update a server.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null
projectID (required)
Path Parameter — The project ID. default: null
identityID (required)
Path Parameter — The identity ID. default: null
serverID (required)
Path Parameter — The server ID. default: null

Consumes

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

Request body

serverWrite serverWrite (optional)
Body Parameter —

Return type

serverRead

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",
    "publicIPAllocation" : {
      "enabled" : true
    },
    "flavorId" : "flavorId",
    "securityGroups" : [ {
      "id" : "id"
    }, {
      "id" : "id"
    } ],
    "networks" : [ {
      "id" : "id",
      "allowedAddressPairs" : [ {
        "macAddress" : "macAddress",
        "cidr" : "cidr"
      }, {
        "macAddress" : "macAddress",
        "cidr" : "cidr"
      } ]
    } ]
  },
  "status" : {
    "phase" : "Pending",
    "privateIP" : "privateIP",
    "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 server. serverRead

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/v1/organizations/{organizationID}/projects/{projectID}/identities/{identityID}/servers/{serverID}/softreboot
(apiV1OrganizationsOrganizationIDProjectsProjectIDIdentitiesIdentityIDServersServerIDSoftrebootPost)
Soft reboot a server.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null
projectID (required)
Path Parameter — The project ID. default: null
identityID (required)
Path Parameter — The identity ID. default: null
serverID (required)
Path Parameter — The server 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 
post /api/v1/organizations/{organizationID}/projects/{projectID}/identities/{identityID}/servers/{serverID}/start
(apiV1OrganizationsOrganizationIDProjectsProjectIDIdentitiesIdentityIDServersServerIDStartPost)
Start a server that was previously stopped via the stop endpoint.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null
projectID (required)
Path Parameter — The project ID. default: null
identityID (required)
Path Parameter — The identity ID. default: null
serverID (required)
Path Parameter — The server 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 
post /api/v1/organizations/{organizationID}/projects/{projectID}/identities/{identityID}/servers/{serverID}/stop
(apiV1OrganizationsOrganizationIDProjectsProjectIDIdentitiesIdentityIDServersServerIDStopPost)
Stop a running server. The server can be restarted later via the start endpoint.

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null
projectID (required)
Path Parameter — The project ID. default: null
identityID (required)
Path Parameter — The identity ID. default: null
serverID (required)
Path Parameter — The server 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 
post /api/v1/organizations/{organizationID}/projects/{projectID}/identities
(apiV1OrganizationsOrganizationIDProjectsProjectIDIdentitiesPost)
Create a new identity in the region.

Path parameters

organizationID (required)
Path Parameter — An 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

identityWrite identityWrite (required)
Body Parameter —

Return type

identityRead

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",
    "openstack" : {
      "cloud" : "cloud",
      "cloudConfig" : "cloudConfig",
      "sshKeyName" : "sshKeyName",
      "sshPrivateKey" : "sshPrivateKey",
      "serverGroupId" : "serverGroupId",
      "userId" : "userId",
      "projectId" : "projectId"
    },
    "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"
}

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

An identity response. identityRead

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/v1/organizations/{organizationID}/regions
(apiV1OrganizationsOrganizationIDRegionsGet)
List all regions.

Path parameters

organizationID (required)
Path Parameter — An 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"
}

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.

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
Up 
get /api/v1/organizations/{organizationID}/regions/{regionID}/detail
(apiV1OrganizationsOrganizationIDRegionsRegionIDDetailGet)
Get a detailed view of the region.

Path parameters

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

Return type

regionDetailRead

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" : {
    "kubernetes" : {
      "domainName" : "domainName",
      "kubeconfig" : "kubeconfig"
    },
    "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"
}

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. regionDetailRead

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}/regions/{regionID}/externalnetworks
(apiV1OrganizationsOrganizationIDRegionsRegionIDExternalnetworksGet)
Get a list of external networks.

Path parameters

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

Return type

array[externalNetwork]

Example data

Content-Type: application/json
[ {
  "name" : "name",
  "id" : "id"
}, {
  "name" : "name",
  "id" : "id"
} ]

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 valid external networks.

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}/regions/{regionID}/flavors
(apiV1OrganizationsOrganizationIDRegionsRegionIDFlavorsGet)
Lists all compute flavors.

Path parameters

organizationID (required)
Path Parameter — An 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
Up 
get /api/v1/organizations/{organizationID}/regions/{regionID}/images
(apiV1OrganizationsOrganizationIDRegionsRegionIDImagesGet)
Lists all compute images.

Path parameters

organizationID (required)
Path Parameter — An 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
Up 
get /api/v1/organizations/{organizationID}/securitygroups
(apiV1OrganizationsOrganizationIDSecuritygroupsGet)
List security groups.

Path parameters

organizationID (required)
Path Parameter — An 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[securityGroupRead]

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" : {
    "rules" : [ {
      "protocol" : "any",
      "port" : {
        "number" : 5249,
        "range" : {
          "start" : 39501,
          "end" : 9607
        }
      },
      "cidr" : "cidr",
      "direction" : "ingress"
    }, {
      "protocol" : "any",
      "port" : {
        "number" : 5249,
        "range" : {
          "start" : 39501,
          "end" : 9607
        }
      },
      "cidr" : "cidr",
      "direction" : "ingress"
    } ]
  }
}, {
  "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" : {
    "rules" : [ {
      "protocol" : "any",
      "port" : {
        "number" : 5249,
        "range" : {
          "start" : 39501,
          "end" : 9607
        }
      },
      "cidr" : "cidr",
      "direction" : "ingress"
    }, {
      "protocol" : "any",
      "port" : {
        "number" : 5249,
        "range" : {
          "start" : 39501,
          "end" : 9607
        }
      },
      "cidr" : "cidr",
      "direction" : "ingress"
    } ]
  }
} ]

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 security groups.

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/v1/organizations/{organizationID}/servers
(apiV1OrganizationsOrganizationIDServersGet)
List servers.

Path parameters

organizationID (required)
Path Parameter — An 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[serverRead]

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",
    "publicIPAllocation" : {
      "enabled" : true
    },
    "flavorId" : "flavorId",
    "securityGroups" : [ {
      "id" : "id"
    }, {
      "id" : "id"
    } ],
    "networks" : [ {
      "id" : "id",
      "allowedAddressPairs" : [ {
        "macAddress" : "macAddress",
        "cidr" : "cidr"
      }, {
        "macAddress" : "macAddress",
        "cidr" : "cidr"
      } ]
    } ]
  },
  "status" : {
    "phase" : "Pending",
    "privateIP" : "privateIP",
    "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",
    "publicIPAllocation" : {
      "enabled" : true
    },
    "flavorId" : "flavorId",
    "securityGroups" : [ {
      "id" : "id"
    }, {
      "id" : "id"
    } ],
    "networks" : [ {
      "id" : "id",
      "allowedAddressPairs" : [ {
        "macAddress" : "macAddress",
        "cidr" : "cidr"
      }, {
        "macAddress" : "macAddress",
        "cidr" : "cidr"
      } ]
    } ]
  },
  "status" : {
    "phase" : "Pending",
    "privateIP" : "privateIP",
    "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 list of servers.

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/servers
(apiV2ServersGet)
List servers.

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[serverV2Read]

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

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 servers.

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/servers
(apiV2ServersPost)
Create a new server.

Consumes

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

Request body

serverV2Create serverV2Create (optional)
Body Parameter —

Return type

serverV2Read

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 server. serverV2Read

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/servers/{serverID}/consoleoutput
(apiV2ServersServerIDConsoleoutputGet)
Get the console output for a server.

Path parameters

serverID (required)
Path Parameter — The server 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"
}

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

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/servers/{serverID}/consolesessions
(apiV2ServersServerIDConsolesessionsGet)
Create a new console session for a server.

Path parameters

serverID (required)
Path Parameter — The server 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"
}

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

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/servers/{serverID}
(apiV2ServersServerIDDelete)
Delete a server.

Path parameters

serverID (required)
Path Parameter — The server 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/servers/{serverID}
(apiV2ServersServerIDGet)
Get a server.

Path parameters

serverID (required)
Path Parameter — The server ID. default: null

Return type

serverV2Read

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 server. serverV2Read

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/servers/{serverID}/hardreboot
(apiV2ServersServerIDHardrebootPost)
Hard reboot a server.

Path parameters

serverID (required)
Path Parameter — The server 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 
put /api/v2/servers/{serverID}
(apiV2ServersServerIDPut)
Update a server.

Path parameters

serverID (required)
Path Parameter — The server ID. default: null

Consumes

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

Request body

serverV2Update serverV2Update (optional)
Body Parameter —

Return type

serverV2Read

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 server. serverV2Read

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/servers/{serverID}/softreboot
(apiV2ServersServerIDSoftrebootPost)
Soft reboot a server.

Path parameters

serverID (required)
Path Parameter — The server 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/servers/{serverID}/sshkey
(apiV2ServersServerIDSshkeyGet)
Retrieve the SSH key for a server.

Path parameters

serverID (required)
Path Parameter — The server 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/servers/{serverID}/start
(apiV2ServersServerIDStartPost)
Start a server that was previously stopped via the stop endpoint.

Path parameters

serverID (required)
Path Parameter — The server 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 
post /api/v2/servers/{serverID}/stop
(apiV2ServersServerIDStopPost)
Stop a running server. The server can be restarted later via the start endpoint.

Path parameters

serverID (required)
Path Parameter — The server 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

FileStorage

Up 
delete /api/v2/filestorage/{filestorageID}
Delete file storage (apiV2FilestorageFilestorageIDDelete)
Delete a storage.

Path parameters

filestorageID (required)
Path Parameter — The storage unique identifier. 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/filestorage/{filestorageID}
Get file storage (apiV2FilestorageFilestorageIDGet)
Get all storage information this ID.

Path parameters

filestorageID (required)
Path Parameter — The storage unique identifier. default: null

Return type

storageV2Read

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" : {
    "attachments" : {
      "networkIDs" : [ "networkIDs", "networkIDs" ]
    },
    "size" : "size",
    "storageType" : {
      "NFS" : {
        "rootSquash" : true
      }
    }
  },
  "status" : {
    "storageClassId" : "storageClassId",
    "attachments" : {
      "networkIds" : [ {
        "provisioningStatus" : "unknown",
        "id" : "id"
      }, {
        "provisioningStatus" : "unknown",
        "id" : "id"
      } ]
    },
    "regionId" : "regionId",
    "usage" : {
      "used" : "used",
      "free" : "free",
      "capacity" : "capacity"
    }
  }
}

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 storage. storageV2Read

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/filestorage/{filestorageID}
Update file storage (apiV2FilestorageFilestorageIDPut)
Update this storage.

Path parameters

filestorageID (required)
Path Parameter — The storage unique identifier. default: null

Consumes

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

Request body

storageV2Update storageV2Update (optional)
Body Parameter —

Return type

storageV2Read

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" : {
    "attachments" : {
      "networkIDs" : [ "networkIDs", "networkIDs" ]
    },
    "size" : "size",
    "storageType" : {
      "NFS" : {
        "rootSquash" : true
      }
    }
  },
  "status" : {
    "storageClassId" : "storageClassId",
    "attachments" : {
      "networkIds" : [ {
        "provisioningStatus" : "unknown",
        "id" : "id"
      }, {
        "provisioningStatus" : "unknown",
        "id" : "id"
      } ]
    },
    "regionId" : "regionId",
    "usage" : {
      "used" : "used",
      "free" : "free",
      "capacity" : "capacity"
    }
  }
}

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 storage. storageV2Read

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/filestorage
List file storage (apiV2FilestorageGet)
List storage for project.

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

Return type

array[storageV2Read]

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" : {
    "attachments" : {
      "networkIDs" : [ "networkIDs", "networkIDs" ]
    },
    "size" : "size",
    "storageType" : {
      "NFS" : {
        "rootSquash" : true
      }
    }
  },
  "status" : {
    "storageClassId" : "storageClassId",
    "attachments" : {
      "networkIds" : [ {
        "provisioningStatus" : "unknown",
        "id" : "id"
      }, {
        "provisioningStatus" : "unknown",
        "id" : "id"
      } ]
    },
    "regionId" : "regionId",
    "usage" : {
      "used" : "used",
      "free" : "free",
      "capacity" : "capacity"
    }
  }
}, {
  "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" : {
    "attachments" : {
      "networkIDs" : [ "networkIDs", "networkIDs" ]
    },
    "size" : "size",
    "storageType" : {
      "NFS" : {
        "rootSquash" : true
      }
    }
  },
  "status" : {
    "storageClassId" : "storageClassId",
    "attachments" : {
      "networkIds" : [ {
        "provisioningStatus" : "unknown",
        "id" : "id"
      }, {
        "provisioningStatus" : "unknown",
        "id" : "id"
      } ]
    },
    "regionId" : "regionId",
    "usage" : {
      "used" : "used",
      "free" : "free",
      "capacity" : "capacity"
    }
  }
} ]

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 storages.

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/filestorage
Create file storage (apiV2FilestoragePost)
Create a new storage.

Consumes

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

Request body

storageV2Create storageV2Create (optional)
Body Parameter —

Return type

storageV2Read

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" : {
    "attachments" : {
      "networkIDs" : [ "networkIDs", "networkIDs" ]
    },
    "size" : "size",
    "storageType" : {
      "NFS" : {
        "rootSquash" : true
      }
    }
  },
  "status" : {
    "storageClassId" : "storageClassId",
    "attachments" : {
      "networkIds" : [ {
        "provisioningStatus" : "unknown",
        "id" : "id"
      }, {
        "provisioningStatus" : "unknown",
        "id" : "id"
      } ]
    },
    "regionId" : "regionId",
    "usage" : {
      "used" : "used",
      "free" : "free",
      "capacity" : "capacity"
    }
  }
}

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 storage. storageV2Read

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

FileStorageClasses

Up 
get /api/v2/filestorageclasses
List file storage classes (apiV2FilestorageclassesGet)
List storage classes.

Query parameters

regionID (optional)
Query Parameter — Allows resources to be filtered by region. default: null

Return type

array[storageClassV2Read]

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" : {
    "regionId" : "regionId",
    "protocols" : [ "nfsv3", "nfsv3" ]
  }
}, {
  "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" : {
    "regionId" : "regionId",
    "protocols" : [ "nfsv3", "nfsv3" ]
  }
} ]

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 storage classes.

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

Images

Up 
delete /api/v1/organizations/{organizationID}/regions/{regionID}/images/{imageID}
Delete a compute image. (apiV1OrganizationsOrganizationIDRegionsRegionIDImagesImageIDDelete)

Path parameters

organizationID (required)
Path Parameter — An organization ID. default: null
regionID (required)
Path Parameter — The region ID. default: null
imageID (required)
Path Parameter — The image 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}/regions/{regionID}/images
Create a compute image from a disk image URL. (apiV1OrganizationsOrganizationIDRegionsRegionIDImagesPost)
Create a compute image. You must give a URL to fetch the image file from.

Path parameters

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

Consumes

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

Request body

imageCreate imageCreate (optional)
Body Parameter —

Return type

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

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 image that can be used on this platform. image

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

Networks

Up 
get /api/v2/networks
List networks (apiV2NetworksGet)
List networks.

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

Return type

array[networkV2Read]

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" : {
    "dnsNameservers" : [ null, null ],
    "routes" : [ {
      "prefix" : "prefix",
      "nexthop" : "nexthop"
    }, {
      "prefix" : "prefix",
      "nexthop" : "nexthop"
    } ]
  },
  "status" : {
    "regionId" : "regionId",
    "prefix" : "prefix"
  }
}, {
  "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" : {
    "dnsNameservers" : [ null, null ],
    "routes" : [ {
      "prefix" : "prefix",
      "nexthop" : "nexthop"
    }, {
      "prefix" : "prefix",
      "nexthop" : "nexthop"
    } ]
  },
  "status" : {
    "regionId" : "regionId",
    "prefix" : "prefix"
  }
} ]

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 layer 3 networks.

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 
delete /api/v2/networks/{networkID}
Delete network (apiV2NetworksNetworkIDDelete)
Delete a network.

Path parameters

networkID (required)
Path Parameter — The network 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/networks/{networkID}
Get network (apiV2NetworksNetworkIDGet)
Get a network.

Path parameters

networkID (required)
Path Parameter — The network ID. default: null

Return type

networkV2Read

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" : {
    "dnsNameservers" : [ null, null ],
    "routes" : [ {
      "prefix" : "prefix",
      "nexthop" : "nexthop"
    }, {
      "prefix" : "prefix",
      "nexthop" : "nexthop"
    } ]
  },
  "status" : {
    "regionId" : "regionId",
    "prefix" : "prefix"
  }
}

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 layer 3 network. networkV2Read

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/networks/{networkID}
Update network (apiV2NetworksNetworkIDPut)
Update a network.

Path parameters

networkID (required)
Path Parameter — The network ID. default: null

Consumes

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

Request body

networkV2Update networkV2Update (optional)
Body Parameter —

Return type

networkV2Read

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" : {
    "dnsNameservers" : [ null, null ],
    "routes" : [ {
      "prefix" : "prefix",
      "nexthop" : "nexthop"
    }, {
      "prefix" : "prefix",
      "nexthop" : "nexthop"
    } ]
  },
  "status" : {
    "regionId" : "regionId",
    "prefix" : "prefix"
  }
}

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 layer 3 network. networkV2Read

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/networks
Create network (apiV2NetworksPost)
Create a new network.

Consumes

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

Request body

networkV2Create networkV2Create (optional)
Body Parameter —

Return type

networkV2Read

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" : {
    "dnsNameservers" : [ null, null ],
    "routes" : [ {
      "prefix" : "prefix",
      "nexthop" : "nexthop"
    }, {
      "prefix" : "prefix",
      "nexthop" : "nexthop"
    } ]
  },
  "status" : {
    "regionId" : "regionId",
    "prefix" : "prefix"
  }
}

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 layer 3 network. networkV2Read

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

SecurityGroups

Up 
get /api/v2/securitygroups
List security groups (apiV2SecuritygroupsGet)
List security groups.

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[securityGroupV2Read]

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" : {
    "rules" : [ {
      "protocol" : "any",
      "portMax" : 39501,
      "port" : 5249,
      "prefix" : "prefix",
      "direction" : "ingress"
    }, {
      "protocol" : "any",
      "portMax" : 39501,
      "port" : 5249,
      "prefix" : "prefix",
      "direction" : "ingress"
    } ]
  },
  "status" : {
    "regionId" : "regionId",
    "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" : {
    "rules" : [ {
      "protocol" : "any",
      "portMax" : 39501,
      "port" : 5249,
      "prefix" : "prefix",
      "direction" : "ingress"
    }, {
      "protocol" : "any",
      "portMax" : 39501,
      "port" : 5249,
      "prefix" : "prefix",
      "direction" : "ingress"
    } ]
  },
  "status" : {
    "regionId" : "regionId",
    "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 list of security groups.

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/securitygroups
Create security group (apiV2SecuritygroupsPost)
Create a new security group.

Consumes

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

Request body

securityGroupV2Create securityGroupV2Create (optional)
Body Parameter —

Return type

securityGroupV2Read

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" : {
    "rules" : [ {
      "protocol" : "any",
      "portMax" : 39501,
      "port" : 5249,
      "prefix" : "prefix",
      "direction" : "ingress"
    }, {
      "protocol" : "any",
      "portMax" : 39501,
      "port" : 5249,
      "prefix" : "prefix",
      "direction" : "ingress"
    } ]
  },
  "status" : {
    "regionId" : "regionId",
    "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 security group. securityGroupV2Read

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 
delete /api/v2/securitygroups/{securityGroupID}
Delete security group (apiV2SecuritygroupsSecurityGroupIDDelete)
Delete a security groups.

Path parameters

securityGroupID (required)
Path Parameter — The security group 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/securitygroups/{securityGroupID}
Get security group (apiV2SecuritygroupsSecurityGroupIDGet)
Get a security group.

Path parameters

securityGroupID (required)
Path Parameter — The security group ID. default: null

Return type

securityGroupV2Read

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" : {
    "rules" : [ {
      "protocol" : "any",
      "portMax" : 39501,
      "port" : 5249,
      "prefix" : "prefix",
      "direction" : "ingress"
    }, {
      "protocol" : "any",
      "portMax" : 39501,
      "port" : 5249,
      "prefix" : "prefix",
      "direction" : "ingress"
    } ]
  },
  "status" : {
    "regionId" : "regionId",
    "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 security group. securityGroupV2Read

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/securitygroups/{securityGroupID}
Update security group (apiV2SecuritygroupsSecurityGroupIDPut)
Update a security group.

Path parameters

securityGroupID (required)
Path Parameter — The security group ID. default: null

Consumes

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

Request body

securityGroupV2Update securityGroupV2Update (optional)
Body Parameter —

Return type

securityGroupV2Read

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" : {
    "rules" : [ {
      "protocol" : "any",
      "portMax" : 39501,
      "port" : 5249,
      "prefix" : "prefix",
      "direction" : "ingress"
    }, {
      "protocol" : "any",
      "portMax" : 39501,
      "port" : 5249,
      "prefix" : "prefix",
      "direction" : "ingress"
    } ]
  },
  "status" : {
    "regionId" : "regionId",
    "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 security group. securityGroupV2Read

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

Models

[ Jump to Methods ]

Table of Contents

  1. NFSV2Spec -
  2. consoleOutput -
  3. consoleSession -
  4. error -
  5. externalNetwork -
  6. flavor -
  7. flavorSpec -
  8. gpuSpec -
  9. gpuVendor -
  10. identityRead -
  11. identitySpec -
  12. identitySpecOpenStack -
  13. identityWrite -
  14. identityWriteSpec -
  15. image -
  16. imageCreate -
  17. imageCreateSpec -
  18. imageGpu -
  19. imageOS -
  20. imageSpec -
  21. imageVirtualization -
  22. instanceLifecyclePhase -
  23. networkDirection -
  24. networkProtocol -
  25. networkRead -
  26. networkReadSpec -
  27. networkSpecOpenstack -
  28. networkV2Create -
  29. networkV2CreateSpec -
  30. networkV2Read -
  31. networkV2Spec -
  32. networkV2Status -
  33. networkV2Update -
  34. networkWrite -
  35. networkWriteSpec -
  36. organizationScopedResourceReadMetadata -
  37. osDistro -
  38. osFamily -
  39. osKernel -
  40. projectScopedResourceReadMetadata -
  41. regionDetailKubernetes -
  42. regionDetailRead -
  43. regionDetailSpec -
  44. regionFeatures -
  45. regionRead -
  46. regionSpec -
  47. regionType -
  48. resourceHealthStatus -
  49. resourceMetadata -
  50. resourceProvisioningStatus -
  51. resourceReadMetadata -
  52. resourceWriteMetadata -
  53. route -
  54. securityGroupRead -
  55. securityGroupRule -
  56. securityGroupRulePort -
  57. securityGroupRulePortRange -
  58. securityGroupRuleV2 -
  59. securityGroupSpec -
  60. securityGroupV2Create -
  61. securityGroupV2CreateSpec -
  62. securityGroupV2Read -
  63. securityGroupV2Spec -
  64. securityGroupV2Status -
  65. securityGroupV2Update -
  66. securityGroupWrite -
  67. serverNetwork -
  68. serverNetworkAllowedAddressPair -
  69. serverPublicIPAllocation -
  70. serverRead -
  71. serverSecurityGroup -
  72. serverSpec -
  73. serverStatus -
  74. serverV2Create -
  75. serverV2CreateSpec -
  76. serverV2Networking -
  77. serverV2Read -
  78. serverV2Spec -
  79. serverV2Status -
  80. serverV2Update -
  81. serverWrite -
  82. sshKey -
  83. staticResourceMetadata -
  84. storageAttachmentV2Spec -
  85. storageAttachmentV2Status -
  86. storageAttachmentV2Status_networkIds_inner -
  87. storageClassProtocolType -
  88. storageClassV2Read -
  89. storageClassV2Spec -
  90. storageTypeV2Spec -
  91. storageUsageV2Spec -
  92. storageV2Create -
  93. storageV2Create_spec -
  94. storageV2Read -
  95. storageV2Spec -
  96. storageV2Status -
  97. storageV2Update -
  98. tag -

NFSV2Spec - Up

NFS specific
rootSquash
Boolean root squash

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.

externalNetwork - Up

An Openstack external network.
id
String The resource ID.
name
String The resource name.

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.

identityRead - Up

A provider specific identity.
metadata
projectScopedResourceReadMetadata
spec
identitySpec

identitySpec - Up

A provider specific identity.
type
regionType
regionId
String The region an identity is provisioned in.
openstack (optional)
identitySpecOpenStack

identitySpecOpenStack - Up

Everything an OpenStack client needs to function.
cloud (optional)
String The name of the cloud in the cloud config.
cloudConfig (optional)
String A base64 encoded cloud config file.
userId (optional)
String User identitifer allocated for the infrastructure.
projectId (optional)
String Project identifier allocated for the infrastructure.
serverGroupId (optional)
String Server group identifier allocated for the intrastructure.
sshKeyName (optional)
String Ephemeral SSH key generated for the identity.
sshPrivateKey (optional)
String Ephemeral SSH private key to be used by higher order services.

identityWrite - Up

An identity request.
metadata
resourceWriteMetadata
spec
identityWriteSpec

identityWriteSpec - Up

Request parameters for creating an identity.
regionId
String The region an identity is provisioned in.

image - Up

An image.
metadata
staticResourceMetadata
spec
imageSpec

imageCreate - Up

A compute image create request.
metadata
resourceWriteMetadata
spec
imageCreateSpec

imageCreateSpec - Up

A compute image specification.
sourceFormat (optional)
String The disk format of the image. If not provided, the value defaults to raw.
Enum:
raw
qcow2
sourceURL
String A URL to upload the image from.
virtualization
imageVirtualization
os
imageOS
softwareVersions (optional)
map[String, String] Image preinstalled version version metadata.
gpu (optional)
imageGpu

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".

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.

instanceLifecyclePhase - Up

The lifecycle phase of an instance.

networkDirection - Up

The direction of the rule.

networkProtocol - Up

The layer 3+ protocol to allow.

networkRead - Up

A network.
metadata
projectScopedResourceReadMetadata
spec
networkReadSpec

networkReadSpec - Up

A physical network's specification.
prefix
String An IPv4 prefix for the network.
dnsNameservers
array[String] A list of IPv4 addresses. format: ipv4
regionId
String The region an identity is provisioned in.
openstack (optional)
networkSpecOpenstack

networkSpecOpenstack - Up

An openstack network.
vlanId (optional)
Integer The allocated VLAN ID.
networkId (optional)
String The openstack network ID.
subnetId (optional)
String The openstack subnet ID.
routerId (optional)
String The openstack router ID.

networkV2Create - Up

A network request.
metadata
resourceWriteMetadata
spec
networkV2CreateSpec

networkV2CreateSpec - Up

A network's specification.
dnsNameservers
array[String] A list of IPv4 addresses. format: ipv4
routes (optional)
array[route] A list of network routes.
organizationId
String The organization to provision the resource in.
projectId
String The project to provision the resource in.
regionId
String The region a network is to be provisioned in.
prefix
String An IPv4 prefix for the network.

networkV2Read - Up

A network.
metadata
projectScopedResourceReadMetadata
spec
networkV2Spec
status
networkV2Status

networkV2Spec - Up

A network's specification.
dnsNameservers
array[String] A list of IPv4 addresses. format: ipv4
routes (optional)
array[route] A list of network routes.

networkV2Status - Up

Read only status about a network.
regionId
String The region a network is provisioned in.
prefix
String An IPv4 prefix for the network.

networkV2Update - Up

A network request.
metadata
resourceWriteMetadata
spec
networkV2Spec

networkWrite - Up

A network request.
metadata
resourceWriteMetadata
spec (optional)
networkWriteSpec

networkWriteSpec - Up

A physical network's specification.
prefix
String An IPv4 prefix for the network.
dnsNameservers
array[String] A list of IPv4 addresses. format: ipv4

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.

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.

regionDetailKubernetes - Up

Region specific information when the type is "kubernetes".
kubeconfig
String The region's base64 encoded Kubernetes configuration file.
domainName (optional)
String The region's requested domain name for consuming services.

regionDetailRead - Up

A region.
metadata
resourceReadMetadata
spec
regionDetailSpec

regionDetailSpec - Up

Information about the region.
type
regionType
kubernetes (optional)
regionDetailKubernetes
features
regionFeatures

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.

route - Up

A network route.
prefix
String An IPv4 prefix for the route.
nexthop
String An IPv4 address for the route's next hop.

securityGroupRead - Up

A security group.
metadata
projectScopedResourceReadMetadata
spec
securityGroupSpec

securityGroupRule - Up

A security group rule's specification, this operates at OSI layer 3 and above. If omitted the CIDR prefix defaults to 0.0.0.0/0 e.g. allow from anywhere. The port can only be specified for layer 4 protocols e.g. TCP or UDP, and if omitted this default to all ports.
direction
networkDirection
protocol
networkProtocol
port (optional)
securityGroupRulePort
cidr (optional)
String An IPv4 address. format: ipv4

securityGroupRulePort - Up

The port definition to allow traffic.
number (optional)
Integer The port to allow.
range (optional)
securityGroupRulePortRange

securityGroupRulePortRange - Up

The port range to allow traffic, valid for layer 4 protocols only e.g. TCP, UDP.
start
Integer The start of the port range.
end
Integer The end of the port range.

securityGroupRuleV2 - Up

A security group rule's specification, this operates at OSI layer 3 and above. If omitted the prefix defaults to 0.0.0.0/0 e.g. allow from anywhere.
direction
networkDirection
protocol
networkProtocol
port (optional)
Integer Port number for layer 4 protocols, if not specified matches all ports.
portMax (optional)
Integer maxumum port number for layer 4 protocols to include a range.
prefix (optional)
String An IPv4 address. format: ipv4

securityGroupSpec - Up

A security group's specification.
rules
array[securityGroupRule] A set of security group rules to apply.

securityGroupV2Create - Up

A security group request.
metadata
resourceWriteMetadata
spec
securityGroupV2CreateSpec

securityGroupV2CreateSpec - Up

A security group's specification.
rules
array[securityGroupRuleV2] A set of security group rules to apply.
networkId
String The network a security group belongs to.

securityGroupV2Read - Up

A security group.
metadata
projectScopedResourceReadMetadata
spec
securityGroupV2Spec
status
securityGroupV2Status

securityGroupV2Spec - Up

A security group's specification.
rules
array[securityGroupRuleV2] A set of security group rules to apply.

securityGroupV2Status - Up

Read only status information about a security group.
regionId
String The region a security group belongs to.
networkId
String The network a security group belongs to.

securityGroupV2Update - Up

A security group request.
metadata
resourceWriteMetadata
spec
securityGroupV2Spec

securityGroupWrite - Up

A security group request.
metadata
resourceWriteMetadata
spec
securityGroupSpec

serverNetwork - Up

The server's network.
id
String Network to attach the server to
allowedAddressPairs (optional)
array[serverNetworkAllowedAddressPair] A list of allowed address pairs.

serverNetworkAllowedAddressPair - Up

Allow multiple MAC/IP address (range) pairs to pass through this network port.
cidr
String The CIDR to allow.
macAddress (optional)
String The MAC address to allow.

serverPublicIPAllocation - Up

The server's public IP allocation.
enabled
Boolean Whether to allocate a public IP.

serverRead - Up

A server.
metadata
projectScopedResourceReadMetadata
spec
serverSpec
status
serverStatus

serverSecurityGroup - Up

A security group.
id
String The security group ID.

serverSpec - Up

A server's specification.
flavorId
String The flavor of the server.
imageId
String The image of the server.
securityGroups (optional)
array[serverSecurityGroup] A list of security groups.
publicIPAllocation (optional)
serverPublicIPAllocation
networks
array[serverNetwork] A list of networks.
userData (optional)
byte[] UserData contains base64-encoded configuration information or scripts to use upon launch. format: byte

serverStatus - Up

A server's status.
phase (optional)
instanceLifecyclePhase
privateIP (optional)
String The private IP address of the server.
publicIP (optional)
String The public IP address of the server.

serverV2Create - Up

A server creation request.
metadata
resourceWriteMetadata
spec
serverV2CreateSpec

serverV2CreateSpec - Up

A server's specification.
flavorId
String The flavor of the server.
imageId
String The image of the server.
networking (optional)
serverV2Networking
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
networkId
String The network ID to attach a server to.

serverV2Networking - Up

A server'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.

serverV2Read - Up

A server.
metadata
projectScopedResourceReadMetadata
spec
serverV2Spec
status
serverV2Status

serverV2Spec - Up

A server's specification.
flavorId
String The flavor of the server.
imageId
String The image of the server.
networking (optional)
serverV2Networking
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

serverV2Status - Up

Read only status information about a security group.
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.

serverV2Update - Up

A server update request.
metadata
resourceWriteMetadata
spec
serverV2Spec

serverWrite - Up

A server request.
metadata
resourceWriteMetadata
spec
serverSpec

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.

storageAttachmentV2Spec - Up

Describes the network attachment for storage
networkIDs
array[String] A list of network IDs

storageAttachmentV2Status - Up

Describes the network attachment for storage
networkIds
array[storageAttachmentV2Status_networkIds_inner]

storageAttachmentV2Status_networkIds_inner - Up

id (optional)
String
provisioningStatus (optional)
resourceProvisioningStatus

storageClassProtocolType - Up

The protocol type of the storage class.

storageClassV2Read - Up

A storage class.
metadata
resourceReadMetadata
spec
storageClassV2Spec

storageClassV2Spec - Up

A storage class's specification.
regionId
String The region an storage class is provisioned in.
protocols
array[storageClassProtocolType]

storageTypeV2Spec - Up

A storage's type
NFS (optional)
NFSV2Spec

storageUsageV2Spec - Up

Information about the usage of the storage
capacity
String total space allotted
used (optional)
String amount of storage space utilizied
free (optional)
String amount of storage space free to utilize

storageV2Create - Up

A storage create request.
metadata
resourceWriteMetadata
spec
storageV2Create_spec

storageV2Create_spec - Up

size
String Size of the storage
storageType
storageTypeV2Spec
attachments (optional)
storageAttachmentV2Spec
storageClassId
String The storage class ID to provision the storage into.
organizationId
String The organization to provision the resource in.
regionId
String The region ID to provision the storage into.
projectId
String The project to provision the resource in.

storageV2Read - Up

A storage read only group.
metadata
projectScopedResourceReadMetadata
spec
storageV2Spec
status
storageV2Status

storageV2Spec - Up

A storage's specification.
size
String Size of the storage
storageType
storageTypeV2Spec
attachments (optional)
storageAttachmentV2Spec

storageV2Status - Up

Read only status about storage
storageClassId
String identifier for the storage
regionId
String The region an identity is provisioned in.
usage
storageUsageV2Spec
attachments (optional)
storageAttachmentV2Status

storageV2Update - Up

A storage create request.
metadata
resourceWriteMetadata
spec
storageV2Spec

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.