Kubernetes Service API
The Kubernetes Service API provides services that allows provisioning and life cycle
management of Kubernetes clusters.
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}/clustermanagers
(apiV1OrganizationsOrganizationIDClustermanagersGet)
Lists cluster managers within the organization.
Path parameters
organizationID (required)
Path Parameter — The 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"
}
}, {
"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"
}
} ]
Example data
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
200
A list of cluster managers.
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}/clusters
(apiV1OrganizationsOrganizationIDClustersGet)
List all clusters within the organization.
Path parameters
organizationID (required)
Path Parameter — The organization ID. default: null
Query parameters
tag (optional)
Query Parameter — A set of tags to match against resources in the form "name=value",
thus when encoded you get "?tag=foo%3Dcat&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" : {
"applicationBundleName" : "applicationBundleName",
"autoUpgrade" : {
"daysOfWeek" : {
"sunday" : {
"start" : 1,
"end" : 13
},
"saturday" : {
"start" : 1,
"end" : 13
},
"tuesday" : {
"start" : 1,
"end" : 13
},
"wednesday" : {
"start" : 1,
"end" : 13
},
"thursday" : {
"start" : 1,
"end" : 13
},
"friday" : {
"start" : 1,
"end" : 13
},
"monday" : {
"start" : 1,
"end" : 13
}
},
"enabled" : true
},
"regionId" : "regionId",
"workloadPools" : [ {
"machine" : {
"disk" : {
"size" : 5
},
"replicas" : 1,
"flavorId" : "flavorId"
},
"name" : "name",
"autoscaling" : {
"minimumReplicas" : 5
},
"labels" : {
"key" : "labels"
}
}, {
"machine" : {
"disk" : {
"size" : 5
},
"replicas" : 1,
"flavorId" : "flavorId"
},
"name" : "name",
"autoscaling" : {
"minimumReplicas" : 5
},
"labels" : {
"key" : "labels"
}
} ],
"clusterManagerId" : "clusterManagerId",
"networking" : {
"dnsNameservers" : [ "dnsNameservers", "dnsNameservers" ],
"nodePrefix" : "nodePrefix",
"podPrefix" : "podPrefix",
"servicePrefix" : "servicePrefix"
},
"api" : {
"subjectAlternativeNames" : [ "subjectAlternativeNames", "subjectAlternativeNames" ],
"allowedPrefixes" : [ "allowedPrefixes", "allowedPrefixes" ]
},
"version" : "version"
}
}, {
"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" : {
"applicationBundleName" : "applicationBundleName",
"autoUpgrade" : {
"daysOfWeek" : {
"sunday" : {
"start" : 1,
"end" : 13
},
"saturday" : {
"start" : 1,
"end" : 13
},
"tuesday" : {
"start" : 1,
"end" : 13
},
"wednesday" : {
"start" : 1,
"end" : 13
},
"thursday" : {
"start" : 1,
"end" : 13
},
"friday" : {
"start" : 1,
"end" : 13
},
"monday" : {
"start" : 1,
"end" : 13
}
},
"enabled" : true
},
"regionId" : "regionId",
"workloadPools" : [ {
"machine" : {
"disk" : {
"size" : 5
},
"replicas" : 1,
"flavorId" : "flavorId"
},
"name" : "name",
"autoscaling" : {
"minimumReplicas" : 5
},
"labels" : {
"key" : "labels"
}
}, {
"machine" : {
"disk" : {
"size" : 5
},
"replicas" : 1,
"flavorId" : "flavorId"
},
"name" : "name",
"autoscaling" : {
"minimumReplicas" : 5
},
"labels" : {
"key" : "labels"
}
} ],
"clusterManagerId" : "clusterManagerId",
"networking" : {
"dnsNameservers" : [ "dnsNameservers", "dnsNameservers" ],
"nodePrefix" : "nodePrefix",
"podPrefix" : "podPrefix",
"servicePrefix" : "servicePrefix"
},
"api" : {
"subjectAlternativeNames" : [ "subjectAlternativeNames", "subjectAlternativeNames" ],
"allowedPrefixes" : [ "allowedPrefixes", "allowedPrefixes" ]
},
"version" : "version"
}
} ]
Example data
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
200
A list of Kubernetes clusters.
400
Request body failed schema validation, or the request does not contain
all the required fields.
error
401
Authentication failed or the access token has expired.
error
403
Request was denied by authorization, this may be caused by the authorization
token not having the required scope for an API, or the user doesn't have the
necessary privileges on the provider platform.
error
404
Unable to find a resource.
error
500
An unexpected or unhandled error occurred. This may be a transient error and
may succeed on a retry. If this isn't the case, please report it as an issue.
error
Up
delete /api/v1/organizations/{organizationID}/projects/{projectID}/clustermanagers/{clusterManagerID}
(apiV1OrganizationsOrganizationIDProjectsProjectIDClustermanagersClusterManagerIDDelete)
Deletes a cluster manager from within the scoped project.
This is a cascading operation and will delete all managed clusters.
Path parameters
organizationID (required)
Path Parameter — The organization ID. default: null
projectID (required)
Path Parameter — The project ID. default: null
clusterManagerID (required)
Path Parameter — The cluster manager 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
put /api/v1/organizations/{organizationID}/projects/{projectID}/clustermanagers/{clusterManagerID}
(apiV1OrganizationsOrganizationIDProjectsProjectIDClustermanagersClusterManagerIDPut)
Updates a cluster manager within the scoped project.
Path parameters
organizationID (required)
Path Parameter — The organization ID. default: null
projectID (required)
Path Parameter — The project ID. default: null
clusterManagerID (required)
Path Parameter — The cluster manager ID. default: null
Consumes
This API call consumes the following media types via the request header:
Request body
Example data
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
post /api/v1/organizations/{organizationID}/projects/{projectID}/clustermanagers
(apiV1OrganizationsOrganizationIDProjectsProjectIDClustermanagersPost)
Creates a new cluster manager within the project.
Path parameters
organizationID (required)
Path Parameter — The organization ID. default: null
projectID (required)
Path Parameter — The project ID. default: null
Consumes
This API call consumes the following media types via the 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"
}
}
Example data
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
A cluster manager.
clusterManagerRead
400
Request body failed schema validation, or the request does not contain
all the required fields.
error
401
Authentication failed or the access token has expired.
error
403
Request was denied by authorization, this may be caused by the authorization
token not having the required scope for an API, or the user doesn't have the
necessary privileges on the provider platform.
error
409
Resource conflicts with another, usually this means they have the same name.
error
500
An unexpected or unhandled error occurred. This may be a transient error and
may succeed on a retry. If this isn't the case, please report it as an issue.
error
Up
delete /api/v1/organizations/{organizationID}/projects/{projectID}/clusters/{clusterID}
(apiV1OrganizationsOrganizationIDProjectsProjectIDClustersClusterIDDelete)
Delete a cluster.
Path parameters
organizationID (required)
Path Parameter — The organization ID. default: null
projectID (required)
Path Parameter — The project ID. default: null
clusterID (required)
Path Parameter — The cluster ID. default: null
Example data
Content-Type: application/json
{
"error_description" : "error_description",
"error" : "invalid_request"
}
Example data
Content-Type: application/json
{
"error_description" : "error_description",
"error" : "invalid_request"
}
Example data
Content-Type: application/json
{
"error_description" : "error_description",
"error" : "invalid_request"
}
Example data
Content-Type: application/json
{
"error_description" : "error_description",
"error" : "invalid_request"
}
Example data
Content-Type: application/json
{
"error_description" : "error_description",
"error" : "invalid_request"
}
Produces
This API call produces the following media types according to the 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}/clusters/{clusterID}/kubeconfig
(apiV1OrganizationsOrganizationIDProjectsProjectIDClustersClusterIDKubeconfigGet)
Get a cluster's Kubernetes configuration.
Path parameters
organizationID (required)
Path Parameter — The organization ID. default: null
projectID (required)
Path Parameter — The project ID. default: null
clusterID (required)
Path Parameter — The cluster ID. default: null
Example data
Content-Type: application/json
{
"error_description" : "error_description",
"error" : "invalid_request"
}
Example data
Content-Type: application/json
{
"error_description" : "error_description",
"error" : "invalid_request"
}
Example data
Content-Type: application/json
{
"error_description" : "error_description",
"error" : "invalid_request"
}
Example data
Content-Type: application/json
{
"error_description" : "error_description",
"error" : "invalid_request"
}
Example data
Content-Type: application/json
{
"error_description" : "error_description",
"error" : "invalid_request"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/octet-streamapplication/json
Responses
200
A Kubernetes cluster configuration.
400
Request body failed schema validation, or the request does not contain
all the required fields.
error
401
Authentication failed or the access token has expired.
error
403
Request was denied by authorization, this may be caused by the authorization
token not having the required scope for an API, or the user doesn't have the
necessary privileges on the provider platform.
error
404
Unable to find a resource.
error
500
An unexpected or unhandled error occurred. This may be a transient error and
may succeed on a retry. If this isn't the case, please report it as an issue.
error
Up
put /api/v1/organizations/{organizationID}/projects/{projectID}/clusters/{clusterID}
(apiV1OrganizationsOrganizationIDProjectsProjectIDClustersClusterIDPut)
Update a cluster.
Path parameters
organizationID (required)
Path Parameter — The organization ID. default: null
projectID (required)
Path Parameter — The project ID. default: null
clusterID (required)
Path Parameter — The cluster ID. default: null
Consumes
This API call consumes the following media types via the request header:
Request body
Example data
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
post /api/v1/organizations/{organizationID}/projects/{projectID}/clusters
(apiV1OrganizationsOrganizationIDProjectsProjectIDClustersPost)
Creates a new cluster.
Path parameters
organizationID (required)
Path Parameter — The organization ID. default: null
projectID (required)
Path Parameter — The project ID. default: null
Consumes
This API call consumes the following media types via the 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" : {
"applicationBundleName" : "applicationBundleName",
"autoUpgrade" : {
"daysOfWeek" : {
"sunday" : {
"start" : 1,
"end" : 13
},
"saturday" : {
"start" : 1,
"end" : 13
},
"tuesday" : {
"start" : 1,
"end" : 13
},
"wednesday" : {
"start" : 1,
"end" : 13
},
"thursday" : {
"start" : 1,
"end" : 13
},
"friday" : {
"start" : 1,
"end" : 13
},
"monday" : {
"start" : 1,
"end" : 13
}
},
"enabled" : true
},
"regionId" : "regionId",
"workloadPools" : [ {
"machine" : {
"disk" : {
"size" : 5
},
"replicas" : 1,
"flavorId" : "flavorId"
},
"name" : "name",
"autoscaling" : {
"minimumReplicas" : 5
},
"labels" : {
"key" : "labels"
}
}, {
"machine" : {
"disk" : {
"size" : 5
},
"replicas" : 1,
"flavorId" : "flavorId"
},
"name" : "name",
"autoscaling" : {
"minimumReplicas" : 5
},
"labels" : {
"key" : "labels"
}
} ],
"clusterManagerId" : "clusterManagerId",
"networking" : {
"dnsNameservers" : [ "dnsNameservers", "dnsNameservers" ],
"nodePrefix" : "nodePrefix",
"podPrefix" : "podPrefix",
"servicePrefix" : "servicePrefix"
},
"api" : {
"subjectAlternativeNames" : [ "subjectAlternativeNames", "subjectAlternativeNames" ],
"allowedPrefixes" : [ "allowedPrefixes", "allowedPrefixes" ]
},
"version" : "version"
}
}
Example data
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
A Kubernetes cluster.
kubernetesClusterRead
400
Request body failed schema validation, or the request does not contain
all the required fields.
error
401
Authentication failed or the access token has expired.
error
403
Request was denied by authorization, this may be caused by the authorization
token not having the required scope for an API, or the user doesn't have the
necessary privileges on the provider platform.
error
409
Resource conflicts with another, usually this means they have the same name.
error
500
An unexpected or unhandled error occurred. This may be a transient error and
may succeed on a retry. If this isn't the case, please report it as an issue.
error
Up
delete /api/v1/organizations/{organizationID}/projects/{projectID}/virtualclusters/{clusterID}
(apiV1OrganizationsOrganizationIDProjectsProjectIDVirtualclustersClusterIDDelete)
Delete a virtual cluster.
Path parameters
organizationID (required)
Path Parameter — The organization ID. default: null
projectID (required)
Path Parameter — The project ID. default: null
clusterID (required)
Path Parameter — The cluster ID. default: null
Example data
Content-Type: application/json
{
"error_description" : "error_description",
"error" : "invalid_request"
}
Example data
Content-Type: application/json
{
"error_description" : "error_description",
"error" : "invalid_request"
}
Example data
Content-Type: application/json
{
"error_description" : "error_description",
"error" : "invalid_request"
}
Example data
Content-Type: application/json
{
"error_description" : "error_description",
"error" : "invalid_request"
}
Example data
Content-Type: application/json
{
"error_description" : "error_description",
"error" : "invalid_request"
}
Produces
This API call produces the following media types according to the 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}/virtualclusters/{clusterID}/kubeconfig
(apiV1OrganizationsOrganizationIDProjectsProjectIDVirtualclustersClusterIDKubeconfigGet)
Get a virtual cluster's Kubernetes configuration.
Path parameters
organizationID (required)
Path Parameter — The organization ID. default: null
projectID (required)
Path Parameter — The project ID. default: null
clusterID (required)
Path Parameter — The cluster ID. default: null
Example data
Content-Type: application/json
{
"error_description" : "error_description",
"error" : "invalid_request"
}
Example data
Content-Type: application/json
{
"error_description" : "error_description",
"error" : "invalid_request"
}
Example data
Content-Type: application/json
{
"error_description" : "error_description",
"error" : "invalid_request"
}
Example data
Content-Type: application/json
{
"error_description" : "error_description",
"error" : "invalid_request"
}
Example data
Content-Type: application/json
{
"error_description" : "error_description",
"error" : "invalid_request"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/octet-streamapplication/json
Responses
200
A Kubernetes cluster configuration.
400
Request body failed schema validation, or the request does not contain
all the required fields.
error
401
Authentication failed or the access token has expired.
error
403
Request was denied by authorization, this may be caused by the authorization
token not having the required scope for an API, or the user doesn't have the
necessary privileges on the provider platform.
error
404
Unable to find a resource.
error
500
An unexpected or unhandled error occurred. This may be a transient error and
may succeed on a retry. If this isn't the case, please report it as an issue.
error
Up
put /api/v1/organizations/{organizationID}/projects/{projectID}/virtualclusters/{clusterID}
(apiV1OrganizationsOrganizationIDProjectsProjectIDVirtualclustersClusterIDPut)
Update a virtual cluster.
Path parameters
organizationID (required)
Path Parameter — The organization ID. default: null
projectID (required)
Path Parameter — The project ID. default: null
clusterID (required)
Path Parameter — The cluster ID. default: null
Consumes
This API call consumes the following media types via the request header:
Request body
Example data
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
post /api/v1/organizations/{organizationID}/projects/{projectID}/virtualclusters
(apiV1OrganizationsOrganizationIDProjectsProjectIDVirtualclustersPost)
Creates a new virtual cluster.
Path parameters
organizationID (required)
Path Parameter — The organization ID. default: null
projectID (required)
Path Parameter — The project ID. default: null
Consumes
This API call consumes the following media types via the 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",
"workloadPools" : [ {
"replicas" : 0,
"name" : "name",
"flavorId" : "flavorId"
}, {
"replicas" : 0,
"name" : "name",
"flavorId" : "flavorId"
} ]
}
}
Example data
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
A virtual Kubernetes cluster.
virtualKubernetesClusterRead
400
Request body failed schema validation, or the request does not contain
all the required fields.
error
401
Authentication failed or the access token has expired.
error
403
Request was denied by authorization, this may be caused by the authorization
token not having the required scope for an API, or the user doesn't have the
necessary privileges on the provider platform.
error
409
Resource conflicts with another, usually this means they have the same name.
error
500
An unexpected or unhandled error occurred. This may be a transient error and
may succeed on a retry. If this isn't the case, please report it as an issue.
error
Up
get /api/v1/organizations/{organizationID}/regions
(apiV1OrganizationsOrganizationIDRegionsGet)
Lists a curated set of regions.
Path parameters
organizationID (required)
Path Parameter — The organization ID. default: null
Query parameters
regionType (required)
Query Parameter — The type of region we are asking for. 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"
}
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.
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}/flavors
(apiV1OrganizationsOrganizationIDRegionsRegionIDFlavorsGet)
Lists all Kubernetes compatible flavors that the user has access to.
Path parameters
organizationID (required)
Path Parameter — The organization ID. default: null
regionID (required)
Path Parameter — The region ID. default: null
Return type
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 Kubernetes compatible images that the user has access to.
Path parameters
organizationID (required)
Path Parameter — The organization ID. default: null
regionID (required)
Path Parameter — The region ID. default: null
Return type
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}/virtualclusters
(apiV1OrganizationsOrganizationIDVirtualclustersGet)
List all virtual clusters within the organization.
Path parameters
organizationID (required)
Path Parameter — The organization ID. default: null
Query parameters
tag (optional)
Query Parameter — A set of tags to match against resources in the form "name=value",
thus when encoded you get "?tag=foo%3Dcat&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",
"workloadPools" : [ {
"replicas" : 0,
"name" : "name",
"flavorId" : "flavorId"
}, {
"replicas" : 0,
"name" : "name",
"flavorId" : "flavorId"
} ]
}
}, {
"metadata" : {
"modifiedTime" : "2000-01-23T04:56:07.000+00:00",
"creationTime" : "2000-01-23T04:56:07.000+00:00",
"description" : "description",
"deletionTime" : "2000-01-23T04:56:07.000+00:00",
"tags" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ],
"organizationId" : "organizationId",
"createdBy" : "createdBy",
"healthStatus" : "unknown",
"provisioningStatus" : "unknown",
"name" : "name",
"modifiedBy" : "modifiedBy",
"id" : "id",
"projectId" : "projectId"
},
"spec" : {
"regionId" : "regionId",
"workloadPools" : [ {
"replicas" : 0,
"name" : "name",
"flavorId" : "flavorId"
}, {
"replicas" : 0,
"name" : "name",
"flavorId" : "flavorId"
} ]
}
} ]
Example data
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
200
A list of virtual Kubernetes clusters.
400
Request body failed schema validation, or the request does not contain
all the required fields.
error
401
Authentication failed or the access token has expired.
error
403
Request was denied by authorization, this may be caused by the authorization
token not having the required scope for an API, or the user doesn't have the
necessary privileges on the provider platform.
error
404
Unable to find a resource.
error
500
An unexpected or unhandled error occurred. This may be a transient error and
may succeed on a retry. If this isn't the case, please report it as an issue.
error
[ Jump to Methods ]
Table of Contents
clusterManagerRead - clusterManagerWrite - error - flavor - flavorSpec - gpuSpec - gpuVendor - image - imageGpu - imageOS - imageSpec - imageVirtualization - kubernetesClusterAPI - kubernetesClusterAutoUpgrade - kubernetesClusterAutoUpgradeDaysOfWeek - kubernetesClusterAutoUpgradeWindow - kubernetesClusterAutoscaling - kubernetesClusterNetwork - kubernetesClusterRead - kubernetesClusterSpec - kubernetesClusterWorkloadPool - kubernetesClusterWrite - machinePool - organizationScopedResourceReadMetadata - osDistro - osFamily - osKernel - projectScopedResourceReadMetadata - regionFeatures - regionRead - regionSpec - regionType - regionTypeParameter - resourceHealthStatus - resourceMetadata - resourceProvisioningStatus - resourceReadMetadata - resourceWriteMetadata - staticResourceMetadata - tag - virtualKubernetesClusterRead - virtualKubernetesClusterSpec - virtualKubernetesClusterWorkloadPool - virtualKubernetesClusterWrite - volume -
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.
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.
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.
Kubernetes API settings.
subjectAlternativeNames (optional)
array[String] Set of non-standard X.509 SANs to add to the API certificate.
allowedPrefixes (optional)
array[String] Set of address prefixes to allow access to the Kubernetes API.
If set, enables auto-upgrade to a set schedule, or if not set, opts
out of upgrades entirely. Upgrades still occur when the cluster's
application bundle reaches end of life irrespective of whether auto upgrades
are disabled. The absence of this object represents a default auto-upgrade policy of
the platform.
enabled
Boolean Whether or not auto upgrades are enabled.
daysOfWeek (optional)
When defined allows explicit control of what days an auto upgrade can
occur on.
sunday (optional)
monday (optional)
tuesday (optional)
wednesday (optional)
thursday (optional)
friday (optional)
saturday (optional)
Defines when in the day an upgrade is allowed to occur, specified as an
hour starting from 0 up to 23. Upgrade windows can overflow into the next
day e.g. a start of 22 will begin upgrades from 10pm, and an end of 6 will
stop upgrades after 6am.
A Kubernetes cluster workload pool autoscaling configuration. Cluster autoscaling
must also be enabled in the cluster features.
minimumReplicas
Integer The minimum number of replicas to allow. Must be less than the maximum.
A Kubernetes cluster network settings.
nodePrefix (optional)
String Network prefix to provision nodes in. Must be a valid CIDR block.
servicePrefix (optional)
String Network prefix to provision services in. Must be a valid CIDR block.
podPrefix (optional)
String Network prefix to provision pods in. Must be a valid CIDR block.
dnsNameservers (optional)
Kubernetes cluster creation parameters.
regionId
String The region to provision the cluster in.
clusterManagerId (optional)
String The name of the cluster manager to use, if one is not specified
the system will create one for you.
version
String The Kubernetes version. This should be derived from image metadata.
applicationBundleName (optional)
String An explicit set of applications to use for deploy.
autoUpgrade (optional)
workloadPools
api (optional)
networking (optional)
A Kubernetes cluster workload pool.
name
machine
labels (optional)
autoscaling (optional)
Kubernetes cluster create or update.
A Kubernetes cluster machine.
replicas (optional)
Integer Number of machines for a statically sized pool or the maximum for an auto-scaled pool.
flavorId (optional)
disk (optional)
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.
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 region type. "physical" means a full Kubernetes cluster deployment, "virtual" is a virtual
Kubernetes cluster hosted by another one.
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)
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.
Virtual Kubernetes cluster read.
Virtual Kubernetes cluster creation parameters.
regionId
String The region to provision the cluster in.
workloadPools
A virtual workload pool.
name
String The workload pool name.
flavorId
replicas
Virtual Kubernetes cluster create or update.