latestOpenAPI 3.0.32026-08-227451,2751.8 MB

d0fc0114da66

AbTestConfig2

Access1

Account21

AgentInstruction5

AgentSession17

Alert9

Analysis8

AnalysisCache3

ApiKey10

Application8

AppModeling6

AsynchronousJob6

Authorization2

AuthorizationPreflight1

Billing6

Branch10

Chat1

Company11

CompanyDomain5

Conversation9

Copy2

Coverage12

Credentials5

CustomFailureReason6

CustomFilter5

DatabaseConnection6

DatabaseQueryExecution4

DataTable18

Deployment6

Diagnostic4

Environment5

Event11

Execution12

ExecutionCluster5

ExecutionHost7

ExecutionInput3

ExecutionNotification5

ExecutionRunner6

Export1

ExportRequest4

fileUpload1

FileUpload9

Find2

FindModel1

FindSummary2

Flow22

Health3

Insight7

Issue9

KnowledgeGraph18

LinkAgent16

LinkLabel6

LinkMablnet18

LinkMetric1

LinkServer7

Login5

MablscriptOverride4

MabltronDistribution2

Mailbox8

MetadataGeneration1

Metric1

MiscellaneousPublic2

MobileAppFile5

MobileDeviceConfiguration1

MobileTrainingSession9

Note5

OauthToken6

Organization16

PlanRun18

Prompt1

Quota4

Report37

Reporting22

ResourceGroup8

RoleGrant4

Saml3

Schedule17

snippet11

Snippet1

StateDetection6

Test27

TestCase4

TestCaseManagement13

TestGeneration1

TestRun40

Usage7

User27

ValidateUrl4

VariableRow4

VariableTable6

VmImage2

WorkspaceInfrastructure1

WorkspaceIntegration11

WorkspaceInvitation7

XrayProxy4

Schedule

Retrieve Run Policy

Used to retrieve an existing run policy

get/schedule/runPolicy/{id}

Path parameters

idstring required

The run policy ID to retrieve

Query parameters

include_tcm_bindingsboolean

When true, include the plan's external TCM bindings in the response

Response

The run policy that was retrieved

idstring

Plan id. Set by system.

cloud_safe_idstring

Cloud safe ID representation (e.g. GCP/email/Kubernetes safe)

organization_idstring

DEPRECATED - use workspace_id instead

workspace_idstring

The workspace id this plan belongs to

plan_type'functional' | 'performance'

The type of plan

plan_source'mabl_cloud' | 'external' | 'mabl_local' | 'mabl_agent'

Where the test lives

ref_idstring

Reference id to this plan in another system

deployment_idstring

DEPRECATED - use deployment_ids - The deployment ID associated with this run policy

deployment_idsstring[]

The deployment IDs associated with this run policy

uristring

DEPRECATED - Alias for web_url

web_urlstring

Optional URL override for web deployments

api_urlstring

Optional URL override for API deployments

link_agent_labelstring

DEPRECATED - use link_agent_labels

link_agent_labelsstring[]

Optional Link Agent Labels override for the deployment

link_bypass_mabl_proxyboolean

Optional link_bypass_mabl_proxy override for the deployment (mabl link only)

use_personal_link_agentboolean

Route this run's test traffic through the triggering user's own personal mablnet Link tunnels, in addition to the environment's configured link agents. Overrides the deployment's use_personal_link_agent for this run. The owner is the user who triggers the run, resolved server-side — there is no id to pass. By default the run stripes across every live personal tunnel the user has (e.g. one per machine); set personal_link_tunnel_label to pin it to one. mablnet-only; requires that user to have at least one live personal Link Agent connected.

personal_link_tunnel_labelstring

Restrict use_personal_link_agent to a single personal tunnel by its (server-derived) Link label, instead of striping across all of the user's live personal tunnels. Ignored when use_personal_link_agent is not set.

credentials_idstring

Optional ID of the credentials object to use with this run policy

credentials_requiredboolean

Flag indicating whether or not credentials are required for this run policy

http_auth_credentials_idstring

Optional ID of credentials to pass in the HTTP request (as opposed to interactive login credentials)

http_auth_credentials_requiredboolean

Flag indicating whether or not HTTP auth credentials are required for this run policy

http_headers_requiredboolean

Flag indicating whether or not custom HTTP headers are required for this run policy

enabledboolean

Whether this run policy is currently enabled

generatedboolean

Whether this run policy was automatically generated by the platform as opposed to being entered by a user

defaultboolean

Whether this is the default run policy

ephemeralboolean

Whether this is an ephemeral run policy created for an ad hoc plan run

created_timeinteger

time the run policy was created

created_by_idstring

The ID of the user who created this run policy

last_updated_timeinteger

time the run policy object was last updated

last_updated_by_idstring

The ID of the user who last updated this run policy

namestring

The display name of the run policy

descriptionstring

Detailed description of this run policy

test_invariant_idsstring[]

Server-maintained denormalized list of invariant ids of every test referenced anywhere in this plan's execution_stages. Used to index plan-by-test lookups in Datastore (which cannot index doubly-nested array paths). Do not set from clients - any value provided will be overwritten on save.

page_load_wait'FAST' | 'NORMAL' | 'SLOW' | 'SLOWER' | 'INHERIT'

The amount of time to wait after page loads, if supported by the runtime.

flow_variantsobject

Any specific flow variants that should be used when running the plan. Any flow variants set here will be used instead of the head version when the given flow is encountered for this plan

DEPRECATED - The browser that should be used when executing journeys, use browser_types

browser_typesstring[]

The browser that should be used when executing journeys

mobile_device_idsstring[]

Devices to use for mobile testing

emulation_mode'desktop' | 'mobile_web'

Desktop (default) or mobile device emulation. When mobile is specified, browser_types is ignored in favor of web_emulation_types.

execution_runner_type'cloud_java_v1' | 'cloud_nodejs_v2'

[Deprecated] Test execution runner to use, optional

nodejs_runtime_variant'playwright' | 'puppeteer'

Override the Node.js execution runtime variant, if v2 runtime in use

run_multiplierinteger

if > 1, will start multiple copies of each journey run when this plan runs

debug_levelinteger

The debugging level to use for the test run. Higher debug levels include more debug information in the run. Default is zero and runs with standard debugging.

excluded_action_attributesActionAttributeType[]

Exclude action attributes during execution

excluded_observersstring[]

Exclude specific observers during execution

retry_on_failureboolean

If true, runs of this plan will automatically be retried if any journey run fails

retry_failed_journeys_onlyboolean

If true, will only retry journeys that had failed journey runs

use_visual_modelsboolean

If true, use and maintain models for visual change detection

send_mabl_headerboolean

Controls whether or not the x-mabl-agent header is sent on requests (can be overridden by test)

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

available runner sizes

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.

trace_fidelity'full' | 'metrics' | 'inherit'

How much Chrome trace data to capture. full records the complete category set, and is what the "Download step trace" artifact contains. metrics records only the categories the published performance measures are computed from, so a trace downloaded from a metrics run carries the film strip and timeline but not the full set of Chrome records. inherit defers to the next level down.

mobile_app_file_idsobject

Optional map of mobile platform => mobile app file ID override