Sign in
Organization

Pin where the workspace's test runs execute

Changed on

Pins the cloud and region that test runs of this workspace execute in. A pin on a workspace wins over one on its account, which wins over one on its company. A run whose test type does not execute in the pinned location runs in the default one. Only mabl can set it (global organizations write scope or mabl global admin).

put/organizations/{id}/executionLocationPin

Request

  • Base URL: https://api.mabl.com
  • URL: https://api.mabl.com/organizations/{id}/executionLocationPin
  • Auth: one of:
    • HTTP basic
    • API key in header Authorization

Path parameters

idstring required

The ID of the workspace

Request body

cloudstring required

Cloud identifier, e.g. gcp or aws

regionstring required

Region as the cloud names it, e.g. us-south1

Response

The updated workspace

idstring

The ID of the organization

cloud_safe_idstring

Cloud safe ID representation (e.g. GCP and Kubernetes safe)

created_timeinteger

Time at which the organization was created

created_by_idstring

The ID of the user who created this organization

resource_bucket_namestring

Input/output artifact bucket. Null if not yet created.

last_updated_timeinteger

Time at which the organization was last updated

last_updated_by_idstring

The ID of the user who last updated this organization

namestring

The display name of the organization

account_idstring

The id of the account this organization is in

onboardedboolean

flag indicating whether the organization has gone through onboarding

allocated_test_runsinteger

Legacy billing accounts only -- The number of test runs allocated to this workspace

allocated_api_runsinteger

Legacy billing accounts only -- The number of API test runs allocated to this workspace

allocated_a11y_runsinteger

Legacy billing accounts only -- The number of a11y step runs allocated to this workspace

labs_featuresstring[]

Set of labs features activated for this workspace

excluded_featuresstring[]

Set of features to exclude from this workspace, overriding account-level grants. When a feature appears here, authorization checks against this workspace will deny it even if the parent account has the feature enabled. Admin-only field.

execution_runner_size'x1' | 'x2' | 'x3' | 'x4' | 'x5' | 'x6' | 'small' | 'medium' | 'large' | 'inherit'

available runner sizes

generated_artifact_localestring

The workspace's locale used to create new artifacts (e.g. test failure summaries, element descriptions). Default is 'en'.

test_recovery_agent_mode'off' | 'fail_at_end' | 'pass' | 'inherit'

Test Recovery Agent mode. Use inherit (plan-level only) to defer to the workspace-level default.

auto_assign_failure_reason_enabledboolean

When true, agent-generated failure analysis assigns its suggested failure reason to the test run automatically. When false, the suggested failure reason is still persisted but is not assigned. New workspaces enable this by default. Manual assignments always take precedence.

require_agent_edits_on_branchesboolean

When true, agents must save new tests and edits to a branch rather than the main branch. Owner-editable; behind the agentic_test_editing feature flag.

recovery_agent_auto_editsboolean

When true, the recovery agent automatically kicks off test edits when it identifies a fix. Owner-editable; behind the agentic_test_editing feature flag.

require_cloud_only_credentialsboolean

When true, credentials created in this workspace must be cloud credentials, whose secrets can never be read back. Enforced on create for every caller, including API keys, rather than left to whoever creates the credential. Existing non-cloud credentials are unaffected and stay editable. Owner-editable.

effective_credit_allocationinteger

Computed effective credit allocation for this workspace. Equals allocations.credits if explicitly set, otherwise the workspace's equal share of remaining account credits.

Changes