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.id	string	Should be the VCS Connection Id (OPTIONAL)
data.relationships.project.data.type	string	Should be "project" (OPTIONAL)
data.relationships.project.data.id	string	Project ID to assign this workspace to (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

organizationIdstringRequired

organization Identifier

workspaceIdstringRequired

workspace Identifier

Query parameters

Responses

200

Successful response

application/vnd.api+json

get/organization/{organizationId}/workspace/{workspaceId}

HTTPcURLJavaScriptPython

GET /api/v1/organization/{organizationId}/workspace/{workspaceId} HTTP/1.1
Accept: */*

200

Successful response

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "branch": "text",
      "description": "text",
      "folder": "text",
      "locked": true,
      "name": "text",
      "source": "text",
      "terraformVersion": "text"
    },
    "relationships": {
      "history": {
        "id": "text",
        "type": "history"
      },
      "job": {
        "id": "text",
        "type": "job"
      },
      "organization": {
        "id": "text",
        "type": "organization"
      },
      "schedule": {
        "id": "text",
        "type": "schedule"
      },
      "ssh": {
        "id": "text",
        "type": "ssh"
      },
      "variable": {
        "id": "text",
        "type": "variable"
      },
      "vcs": {
        "id": "text",
        "type": "vcs"
      }
    }
  },
  "included": [
    {
      "attributes": {},
      "id": "text",
      "relationships": {},
      "type": "text"
    }
  ]
}

post

Creates an item of type workspace and adds it to workspace

Path parameters

organizationIdstringRequired

organization Identifier

Body

application/vnd.api+json

Responses

201

Successful response

application/vnd.api+json

post/organization/{organizationId}/workspace

HTTPcURLJavaScriptPython

POST /api/v1/organization/{organizationId}/workspace HTTP/1.1
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 469

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "branch": "text",
      "description": "text",
      "folder": "text",
      "locked": true,
      "name": "text",
      "source": "text",
      "terraformVersion": "text"
    },
    "relationships": {
      "history": {
        "id": "text",
        "type": "history"
      },
      "job": {
        "id": "text",
        "type": "job"
      },
      "organization": {
        "id": "text",
        "type": "organization"
      },
      "schedule": {
        "id": "text",
        "type": "schedule"
      },
      "ssh": {
        "id": "text",
        "type": "ssh"
      },
      "variable": {
        "id": "text",
        "type": "variable"
      },
      "vcs": {
        "id": "text",
        "type": "vcs"
      }
    }
  }
}

201

Successful response

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "branch": "text",
      "description": "text",
      "folder": "text",
      "locked": true,
      "name": "text",
      "source": "text",
      "terraformVersion": "text"
    },
    "relationships": {
      "history": {
        "id": "text",
        "type": "history"
      },
      "job": {
        "id": "text",
        "type": "job"
      },
      "organization": {
        "id": "text",
        "type": "organization"
      },
      "schedule": {
        "id": "text",
        "type": "schedule"
      },
      "ssh": {
        "id": "text",
        "type": "ssh"
      },
      "variable": {
        "id": "text",
        "type": "variable"
      },
      "vcs": {
        "id": "text",
        "type": "vcs"
      }
    }
  }
}

delete

Deletes an instance of type workspace

Path parameters

organizationIdstringRequired

organization Identifier

workspaceIdstringRequired

workspace Identifier

Responses

204

Successful response

No content

delete/organization/{organizationId}/workspace/{workspaceId}

HTTPcURLJavaScriptPython

DELETE /api/v1/organization/{organizationId}/workspace/{workspaceId} HTTP/1.1
Accept: */*

204

Successful response

No content

patch

Modifies an instance of type workspace

Path parameters

organizationIdstringRequired

organization Identifier

workspaceIdstringRequired

workspace Identifier

Body

application/vnd.api+json

Responses

204

Successful response

No content

patch/organization/{organizationId}/workspace/{workspaceId}

HTTPcURLJavaScriptPython

PATCH /api/v1/organization/{organizationId}/workspace/{workspaceId} HTTP/1.1
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 469

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "branch": "text",
      "description": "text",
      "folder": "text",
      "locked": true,
      "name": "text",
      "source": "text",
      "terraformVersion": "text"
    },
    "relationships": {
      "history": {
        "id": "text",
        "type": "history"
      },
      "job": {
        "id": "text",
        "type": "job"
      },
      "organization": {
        "id": "text",
        "type": "organization"
      },
      "schedule": {
        "id": "text",
        "type": "schedule"
      },
      "ssh": {
        "id": "text",
        "type": "ssh"
      },
      "variable": {
        "id": "text",
        "type": "variable"
      },
      "vcs": {
        "id": "text",
        "type": "vcs"
      }
    }
  }
}

204

Successful response

No content

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