Workspace
This endpoint is used to create, update, search or delete workspace information inside a Terrakube organization.
To use this endpoint you should have "manageWorkspace" access at team level and a Terrakube organization
Entity fields:
Path | Type | Description |
---|---|---|
data.type | string | Should be "workspace" |
data.attributes.name | string | Unique workspace for an Terrakube organization |
data.attributes.branch | boolean | Git branch to be used |
data.attributes.source | boolean | Git repository to be used |
data.attributes.terraformVersion | boolean | Terraform version to run the workspace |
data.relationships.vcs.data.type | string | Should be "vcs" (OPTIONAL) |
data.relationships.vcs.data.type | string | Should be the VCS Connection Id (OPTIONAL) |
Example:
Supported Operations
Returns an instance of type workspace
organization Identifier
workspace Identifier
Successful response
Included resources
Creates an item of type workspace and adds it to workspace
organization Identifier
Successful response
Deletes an instance of type workspace
organization Identifier
workspace Identifier
Successful response
Modifies an instance of type workspace
organization Identifier
workspace Identifier
Successful response
For a complete list of organization operation please visit the OpenAPI specification