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
Path | Type | Description |
---|---|---|
For a complete list of organization operation please visit the OpenAPI specification
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)
Deletes an instance of type workspace
organization Identifier
workspace Identifier
Successful response
Modifies an instance of type workspace
organization Identifier
workspace Identifier
Create Permissions : (team manage workspace) Delete Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Successful response
Creates an item of type workspace and adds it to workspace
organization Identifier
Create Permissions : (team manage workspace) Delete Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Successful response
Create Permissions : (team manage workspace) Delete Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Returns an instance of type workspace
organization Identifier
workspace Identifier
Selects the set of workspace fields that should be returned in the result.
Selects the set of relationships that should be expanded as a compound document in the result.
Successful response
Create Permissions : (team manage workspace) Delete Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Included resources