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

Returns an instance of type workspace

Path parameters

organizationIdanyrequired

organization Identifier

workspaceIdanyrequired

workspace Identifier

Query parameters

fields[workspace]anyoptional

Selects the set of workspace fields that should be returned in the result.

includeanyoptional

Selects the set of relationships that should be expanded as a compound document in the result.

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/organization/{organizationId}/workspace/{workspaceId}'

200

200

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "branch": "text",
      "name": "text",
      "source": "text",
      "terraformVersion": "text"
    },
    "relationships": {
      "job": {
        "id": "text",
        "type": "job"
      },
      "organization": {
        "id": "text",
        "type": "organization"
      },
      "variable": {
        "id": "text",
        "type": "variable"
      }
    }
  },
  "included": [
    {
      "attributes": {},
      "id": "text",
      "relationships": {},
      "type": "text"
    }
  ]
}

Successful response

post

Creates an item of type workspace and adds it to workspace

Path parameters

organizationIdanyrequired

organization Identifier

Body

dataobjectoptional

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/organization/{organizationId}/workspace' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{
    "data": {
      "type": "text",
      "id": "text",
      "attributes": {
        "branch": "text",
        "name": "text",
        "source": "text",
        "terraformVersion": "text"
      },
      "relationships": {
        "job": {
          "id": "text",
          "type": "job"
        },
        "organization": {
          "id": "text",
          "type": "organization"
        },
        "variable": {
          "id": "text",
          "type": "variable"
        }
      }
    }
  }'

201

201

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "branch": "text",
      "name": "text",
      "source": "text",
      "terraformVersion": "text"
    },
    "relationships": {
      "job": {
        "id": "text",
        "type": "job"
      },
      "organization": {
        "id": "text",
        "type": "organization"
      },
      "variable": {
        "id": "text",
        "type": "variable"
      }
    }
  }
}

Successful response

delete

Deletes an instance of type workspace

Path parameters

organizationIdanyrequired

organization Identifier

workspaceIdanyrequired

workspace Identifier

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/organization/{organizationId}/workspace/{workspaceId}'

204

204

No Content

Successful response

patch

Modifies an instance of type workspace

Path parameters

organizationIdanyrequired

organization Identifier

workspaceIdanyrequired

workspace Identifier

Body

dataobjectoptional

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/organization/{organizationId}/workspace/{workspaceId}' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{
    "data": {
      "type": "text",
      "id": "text",
      "attributes": {
        "branch": "text",
        "name": "text",
        "source": "text",
        "terraformVersion": "text"
      },
      "relationships": {
        "job": {
          "id": "text",
          "type": "job"
        },
        "organization": {
          "id": "text",
          "type": "organization"
        },
        "variable": {
          "id": "text",
          "type": "variable"
        }
      }
    }
  }'

204

204

No Content

Successful response

For a complete list of organization operation please visit the OpenAPI specification