DescribeWorkspace
Describes a workspace.
/api/org/v1/workspaces/{ws}
Path Parameters
ws
requiredA workspace ID.
- Schema
ResourceId
- Type
string
- Minimum Length 1
- Maximum Length 20
- Pattern
^[A-Z0-9]+$
- Schema
Query Parameters
This operation does not have query parameters.
Request Body
This operation does not have a request body.
Responses
200 Response
The information about the workspace is returned.
- Schema
Workspace
- Type
object
- Properties
kubeNamespace
requiredThe Kubernetes namespace to deploy resources to.
- Type
string
- Type
kubeServiceAccount
requiredThe name of the Kubernetes service account used for making Kubernetes API requests.
- Type
string
- Type
createdAt
requiredThe time when the workspace was created.
- Type
string
- Format
date-time
- Type
updatedAt
requiredThe time when the workspace was last updated.
- Type
string
- Format
date-time
- Type
400 Response
The requested operation cannot be performed because the request is malformed.
- Schema
Error
- Type
object
- Properties
message
requiredAn error message.
- Type
string
- Type
401 Response
The requested operation cannot be performed because the request lacks valid authentication credentials.
- Schema
Error
- Type
object
- Properties
message
requiredAn error message.
- Type
string
- Type
403 Response
The identity is not allowed to perform the requested operation for the resource involved.
- Schema
Error
- Type
object
- Properties
message
requiredAn error message.
- Type
string
- Type
404 Response
The resource or dependent resources involved in the requested operation do not exist.
- Schema
Error
- Type
object
- Properties
message
requiredAn error message.
- Type
string
- Type
Default Response
The requested operation failed with an error.
- Schema
Error
- Type
object
- Properties
message
requiredAn error message.
- Type
string
- Type