List workspace-creation tasks¶

View workspace-creation tasks submitted by the current identity that are still in progress or recently completed.

HTTP
GET $CLOUDSIGMA_API_BASE/workspaces/creations

Before you call this API¶

Configure the regional API endpoint and authentication.

You do not need to enter a workspace before calling this API.

Request¶

Input examples

Replace $CLOUDSIGMA_API_KEY with an actual value.

Shell
curl "$CLOUDSIGMA_API_BASE/workspaces/creations" \
  -H "X-API-Key: $CLOUDSIGMA_API_KEY"

Successful response¶

On success, the API returns 200. If there are no tasks, data.creations is an empty array. A record represents a created workspace only when its status is succeeded and it includes workspace_id.

Response example

JSON
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "creations": [
      {
        "id": "creation_01",
        "name": "Analytics workspace",
        "status": "succeeded",
        "workspace_id": "ws_01",
        "created_at": "2026-08-28T09:00:00Z",
        "updated_at": "2026-08-28T09:01:00Z"
      }
    ]
  }
}

Field details

Field	Type	Description
`code`	string	`OK` on success.
`msg`	string	`OK` on success.
`data.creations`	array of object	Creation tasks for the current identity.
`data.creations.id`	string	Workspace-creation task ID.
`data.creations.name`	string	Name of the workspace to create.
`data.creations.status`	string	Task status: `pending`, `running`, `succeeded`, `failed`, or `cleanup_pending`.
`data.creations.workspace_id`	string	Created workspace ID. Omitted if creation has not succeeded.
`data.creations.error_code`	string	Error code when creation fails. Omitted otherwise.
`data.creations.created_at`	string	Task creation time.
`data.creations.updated_at`	string	Task update time.

Error response¶

Response example

JSON
{
  "code": "ErrServer",
  "msg": "Internal server error",
  "data": null
}

Field details

Field	Type	Description
`code`	string	Error code.
`msg`	string	Human-readable error message.
`data`	null	`null` in an error response.

Next steps¶

For a successful task that returned workspace_id, list workspaces to confirm that the workspace is accessible.

Last updated on Sep 15, 2026