Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Workspace id of the space
Response
Returns the workspaces associated with provided workspace id
Workspace
curl --request GET \
  --url https://{controlPlaneURL}/api/svc/v1/workspaces/{id} \
  --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>"
        }
      ],
      "ownedBy": {
        "account": "<string>"
      }
    },
    "accountId": "<string>",
    "isSystemWs": true,
    "createdBy": "<string>"
  }
}Get workspace associated with provided workspace id
curl --request GET \
  --url https://{controlPlaneURL}/api/svc/v1/workspaces/{id} \
  --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>"
        }
      ],
      "ownedBy": {
        "account": "<string>"
      }
    },
    "accountId": "<string>",
    "isSystemWs": true,
    "createdBy": "<string>"
  }
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Workspace id of the space
Returns the workspaces associated with provided workspace id
Workspace
Show child attributes
Was this page helpful?