GET
/
api
/
svc
/
v1
/
workspaces
curl --request GET \
  --url https://{controlPlaneURL}/api/svc/v1/workspaces \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "fqn": "<string>",
      "name": "<string>",
      "tenantName": "<string>",
      "clusterId": "<string>",
      "createdBySubject": {
        "subjectId": "<string>",
        "subjectType": "user",
        "subjectSlug": "<string>",
        "subjectDisplayName": "<string>"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "environmentId": "<string>",
      "manifest": {
        "type": "workspace",
        "cluster_fqn": "<string>",
        "name": "<string>",
        "environment_name": "<string>",
        "labels": {},
        "annotations": {},
        "collaborators": [
          {
            "subject": "<string>",
            "role_id": "<string>"
          }
        ],
        "permissions": [
          {
            "resource_fqn": "<string>",
            "resource_type": "<string>",
            "role_id": "<string>"
          }
        ]
      },
      "isSystemWs": true,
      "createdBy": "<string>"
    }
  ],
  "pagination": {
    "total": 100,
    "offset": 0,
    "limit": 10
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
limit
integer
default:100

Number of items per page

Required range: 1 <= x <= 1000
Example:

10

​
offset
integer
default:0

Number of items to skip

Required range: x >= 0
Example:

0

​
clusterId
string

ClusterId of the Cluster

​
name
string

Workspace Name

​
fqn
string

Workspace FQN

Response

200 - application/json

Returns all the workspaces associated with a user and also the response includes paginated data.

The response is of type object.