CRcriblio
workspaces

Update a Workspace

Changed on

Update the specified Workspace.

patch/v1/organizations/{organizationId}/workspaces/{workspaceId}

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 Workspace.

workspaceIdstring required

The <code>id</code> of the Workspace to update.

Request body

aliasstring

User-friendly alias for the Workspace.

descriptionstring

Brief description of the Workspace.

tagsstring[]

Tags associated with the Workspace.

Example request

{
  "alias": "Production Environment",
  "description": "Main production Workspace for customer data processing",
  "tags": [
    "production",
    "customer-data"
  ]
}

Response

The Workspace has been successfully updated

Changes

  • bfa460b2aec3Revision changes
    • warning

      the request property's maxLength was set to 30

    • warning

      the request property's maxLength was set to 255

    • warning

      the / request property's maxLength was set to 30

  • 0d907f2a3696Revision changes
    • info

      removed the non-success response with the status