workspace

get settings (admin only)

Changed on

Returns the full workspace settings including admin-managed integration credentials. Admin-only — non-admin callers should use getPublicSettings.

get/w/{workspace}/workspaces/get_settings

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/w/{workspace}/workspaces/get_settings
  • Auth: one of:
    • HTTP bearer
    • API key in cookie token

Path parameters

workspacestring required

Response

status

workspace_idstring
slack_namestring
slack_team_idstring
slack_command_scriptstring
slack_oauth_client_idstring
slack_oauth_client_secretstring
teams_team_idstring
teams_command_scriptstring
teams_team_namestring
teams_team_guidstring
planstring
customer_idstring
webhookstring
dbt_warehousesDbtWarehouses

Warehouses a dbt project may run against, by name. main is the one a project gets when its descriptor names none. Each entry points at a resource; it never holds credentials.

default_appstring
mute_critical_alertsboolean
colorstring
public_app_execution_limit_per_minuteinteger

Rate limit for public app executions per minute per server. NULL or 0 means disabled.

error_handler_fallback_to_instance_alertsboolean

Report failed jobs to the instance critical alert channels when no workspace error handler is set.

guest_access_enabledboolean

Whether this workspace admits guest sessions. An app's own guest execution mode is inert while this is false.

guest_jwt_public_keystring

PEM public key a guest JWT (jwt_guest_) is verified against for this workspace. Mutually exclusive with guest_jwt_jwks_url.

guest_jwt_jwks_urlstring

JWKS URL a guest JWT (jwt_guest_) is verified against for this workspace. Mutually exclusive with guest_jwt_public_key.

add_admins_and_developers_to_forksboolean

Whether every new fork of this workspace starts with its admins and developers as members, keeping their role.

Changes

  • 23a2db1435bfRevision changes
    • info

      added the optional property / to the response with the status

  • 6791a875b9ebRevision changes
    • warning

      added the new cloudflare enum value to the // response property for the response status

    • warning

      added the new cloudflare enum value to the // response property for the response status

    • warning

      added the new cloudflare enum value to the // response property for the response status

    • warning

      added the new typesafe enum value to the // response property for the response status

    • warning

      added the new typesafe enum value to the // response property for the response status

    • warning

      added the new typesafe enum value to the // response property for the response status