Comment on page

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:
{
    "data": {
        "type": "workspace",
        "attributes": {
            "branch": "main",
            "name": "Terrakube Workspace",
            "source": "https://github.com/AzBuilder/terraform-sample-repository.git",
            "terraformVersion": "0.15.0"
        },
        "relationships": {
            "vcs": {
                "data": {
                    "type": "vcs",
                    "id": "{{vcsIdGitHub}}"
                }
            }
        }
    }
}
Supported Operations
get
/organization/{organizationId}/workspace/{workspaceId}
post
/organization/{organizationId}/workspace
delete
/organization/{organizationId}/workspace/{workspaceId}
patch
/organization/{organizationId}/workspace/{workspaceId}
For a complete list of organization operation please visit the OpenAPI specification​

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)

Teams

Variables

Last modified 1mo ago