CRcriblio
workspaces

List all Workspaces for the specified Organization

Changed on

Get a list of all Workspaces for the specified Organization.

get/v1/organizations/{organizationId}/workspaces

Request

  • Base URL
    https://gateway.cribl.cloud
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://login.cribl.cloud/oauth/token
    • or HTTP bearer

Path parameters

organizationIdstring required

The <code>id</code> of the Organization that contains the Workspaces.

Response

List of Workspaces has been successfully retrieved

countinteger required

Total number of workspaces

Example response

{
  "items": [
    {
      "workspaceId": "main",
      "leaderFQDN": "workspace-leader.example.com",
      "alias": "Production Environment",
      "description": "Main production Workspace for customer data processing",
      "tags": [
        "production",
        "customer-data"
      ]
    }
  ],
  "count": 5
}

Changes

  • 9bda0eaca345Revision changes
    • warning

      added the new ap-northeast-1 enum value to the ////// response property for the response status

    • warning

      added the new eu-west-1 enum value to the ////// response property for the response status

    • warning

      added the new eu-west-3 enum value to the ////// response property for the response status

    • warning

      added the new sa-east-1 enum value to the ////// response property for the response status

  • 1ab82a0cc26dRevision changes
    • breaking

      removed the required property // from the response with the status