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.
Version: 1.4.0
BasePath:
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
- OAuth AuthorizationUrl:https://identity.nks.europe-west4.nscale.com/oauth2/v2/authorizationTokenUrl:https://identity.nks.europe-west4.nscale.com/oauth2/v2/token
[ Jump to Models ]
Table of Contents
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
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 request header;
the media type will be conveyed by the 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
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"
},
"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" : {
"dnsNameservers" : [ null, null ],
"regionId" : "regionId",
"prefix" : "prefix",
"openstack" : {
"subnetId" : "subnetId",
"vlanId" : 0,
"routerId" : "routerId",
"networkId" : "networkId"
},
"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 request header;
the media type will be conveyed by the 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 request header;
the media type will be conveyed by the 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
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 request header;
the media type will be conveyed by the 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 request header;
the media type will be conveyed by the 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
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"
},
"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 request header;
the media type will be conveyed by the 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 request header:
Request body
Return type
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"
},
"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 request header;
the media type will be conveyed by the 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 request header:
Request body
Return type
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"
}
}
Example data
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 request header;
the media type will be conveyed by the 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 request header;
the media type will be conveyed by the 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
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"
}
}
Example data
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 request header;
the media type will be conveyed by the 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 request header:
Request body
Return type
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"
}
}
Example data
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 request header;
the media type will be conveyed by the 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
get /api/v1/organizations/{organizationID}/projects/{projectID}/identities/{identityID}/securitygroups/{securityGroupID}/rules
(apiV1OrganizationsOrganizationIDProjectsProjectIDIdentitiesIdentityIDSecuritygroupsSecurityGroupIDRulesGet)
List security groups rules.
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
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" : {
"protocol" : "tcp",
"port" : {
"number" : 0,
"range" : {
"start" : 6,
"end" : 1
}
},
"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" : {
"protocol" : "tcp",
"port" : {
"number" : 0,
"range" : {
"start" : 6,
"end" : 1
}
},
"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 request header;
the media type will be conveyed by the response header.
Responses
200
A list of security group rules.
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/{securityGroupID}/rules
(apiV1OrganizationsOrganizationIDProjectsProjectIDIdentitiesIdentityIDSecuritygroupsSecurityGroupIDRulesPost)
Create a new security group rule.
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 request header:
Request body
Return type
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" : {
"protocol" : "tcp",
"port" : {
"number" : 0,
"range" : {
"start" : 6,
"end" : 1
}
},
"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 request header;
the media type will be conveyed by the response header.
Responses
201
A security group rule.
securityGroupRuleRead
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}/rules/{ruleID}
(apiV1OrganizationsOrganizationIDProjectsProjectIDIdentitiesIdentityIDSecuritygroupsSecurityGroupIDRulesRuleIDDelete)
Delete a security group rule.
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
ruleID (required)
Path Parameter — The security group rule 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 request header;
the media type will be conveyed by the 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}/rules/{ruleID}
(apiV1OrganizationsOrganizationIDProjectsProjectIDIdentitiesIdentityIDSecuritygroupsSecurityGroupIDRulesRuleIDGet)
Get a security group rule.
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
ruleID (required)
Path Parameter — The security group rule ID. default: null
Return type
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" : {
"protocol" : "tcp",
"port" : {
"number" : 0,
"range" : {
"start" : 6,
"end" : 1
}
},
"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 request header;
the media type will be conveyed by the response header.
Responses
200
A security group rule.
securityGroupRuleRead
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 request header:
Request body
Return type
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" : {
"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 request header;
the media type will be conveyed by the 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
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 request header;
the media type will be conveyed by the 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
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" : {
"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 request header;
the media type will be conveyed by the 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
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 request header:
Request body
Return type
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" : {
"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 request header;
the media type will be conveyed by the 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
(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 request header:
Request body
Return type
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 request header;
the media type will be conveyed by the 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
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 request header;
the media type will be conveyed by the 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
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 request header;
the media type will be conveyed by the 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
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 request header;
the media type will be conveyed by the 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
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 request header;
the media type will be conveyed by the 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
Example data
Content-Type: application/json
[ {
"metadata" : "metadata",
"spec" : "spec"
}, {
"metadata" : "metadata",
"spec" : "spec"
} ]
Example data
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 request header;
the media type will be conveyed by the 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&bar%3Ddog". default: null
Return type
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"
}
}, {
"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"
}
} ]
Example data
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 request header;
the media type will be conveyed by the 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&bar%3Ddog". default: null
Return type
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" : {
"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" : {
"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 request header;
the media type will be conveyed by the 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
[ Jump to Methods ]
Table of Contents
error - externalNetwork - flavor - flavorSpec - gpuSpec - gpuVendor - identityRead - identitySpec - identitySpecOpenStack - identityWrite - identityWriteSpec - image - imageGpu - imageOS - imageSpec - imageVirtualization - networkDirection - networkProtocol - networkRead - networkReadSpec - networkSpecOpenstack - networkWrite - networkWriteSpec - organizationScopedResourceReadMetadata - osDistro - osFamily - osKernel - projectScopedResourceReadMetadata - regionDetailKubernetes - regionDetailRead - regionDetailSpec - regionFeatures - regionRead - regionSpec - regionType - resourceHealthStatus - resourceMetadata - resourceProvisioningStatus - resourceReadMetadata - resourceWriteMetadata - securityGroupRead - securityGroupReadSpec - securityGroupRulePort - securityGroupRulePortRange - securityGroupRuleRead - securityGroupRuleSpec - securityGroupRuleWrite - securityGroupWrite - serverNetwork - serverNetworkAllowedAddressPair - serverPublicIPAllocation - serverRead - serverSecurityGroup - serverSpec - serverStatus - serverWrite - staticResourceMetadata - tag -
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.
invalid_request
unauthorized_client
access_denied
unsupported_response_type
invalid_scope
server_error
temporarily_unavailable
invalid_client
invalid_grant
unsupported_grant_type
not_found
conflict
method_not_allowed
unsupported_media_type
forbidden
error_description
String Verbose message describing the error.
An Openstack external network.
A flavor.
baremetal (optional)
Boolean Whether the flavor is for a dedicated machine.
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)
GPU specification.
vendor
model
memory
physicalCount
Integer The physical number of GPUs (cards) available.
logicalCount
Integer The logical number of GPUs available as seen in the OS.
A provider specific identity.
A provider specific identity.
type
regionId
String The region an identity is provisioned in.
openstack (optional)
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.
Request parameters for creating an identity.
regionId
String The region an identity is provisioned in.
The GPU driver if installed.
vendor
driver
String The GPU driver version, this is vendor specific.
models (optional)
An operating system description.
kernel
family
distro
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".
An image.
sizeGiB
Integer Minimum disk size required to use the image in GiB.
virtualization
os
softwareVersions (optional)
gpu (optional)
What type of machine the image is for.
The direction of the rule.
A physical network's specification.
prefix
String An IPv4 prefix for the network.
dnsNameservers
type
regionId
String The region an identity is provisioned in.
openstack (optional)
An openstack network.
vlanId (optional)
networkId (optional)
String The openstack network ID.
subnetId (optional)
String The openstack subnet ID.
routerId (optional)
String The openstack router ID.
A physical network's specification.
prefix
String An IPv4 prefix for the network.
dnsNameservers
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)
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
healthStatus
organizationId
String The organization identifier the resource belongs to.
A family of operating systems. This typically defines the package format.
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)
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
healthStatus
organizationId
String The organization identifier the resource belongs to.
projectId
String The project identifier the resource belongs to.
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.
Information about the region.
type
kubernetes (optional)
features
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.
Information about the region.
The region's provider type.
The health state of a resource.
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)
The provisioning state of a resource.
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)
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
healthStatus
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)
A security group's specification.
regionId
String The region an identity is provisioned in.
The port definition to allow traffic.
number (optional)
range (optional)
The port range to allow traffic.
start
Integer The start of the port range.
end
A security group rule's specification.
direction
protocol
port
cidr
A security group rule request.
A security group request.
metadata
spec (optional)
Object A security group's specification.
The server's network.
id
String Network to attach the server to
allowedAddressPairs (optional)
Allow multiple MAC/IP address (range) pairs to pass through this network port.
cidr
macAddress (optional)
String The MAC address to allow.
The server's public IP allocation.
enabled
Boolean Whether to allocate a public IP.
A server's specification.
flavorId
String The flavor of the server.
imageId
String The image of the server.
securityGroups (optional)
publicIPAllocation (optional)
networks
userData (optional)
byte[] UserData contains base64-encoded configuration information or scripts to use upon launch. format: byte
A server's status.
privateIP (optional)
String The private IP address of the server.
publicIP (optional)
String The public IP address of the server.
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)
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.
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.