---
title: "Remove Run Policy"
method: DELETE
path: "/schedule/runPolicy/{id}"
tags: ["Schedule"]
---

# Remove Run Policy

`DELETE /schedule/runPolicy/{id}`

Used to remove existing run policies

## Path parameters

- `id` string, required

## Response `200`

The run policy that was removed

- Plan
  - `id` string — Plan id. Set by system.
  - `cloud_safe_id` string — Cloud safe ID representation (e.g. GCP/email/Kubernetes safe)
  - `organization_id` string — DEPRECATED - use workspace_id instead
  - `workspace_id` string — 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_id` string — Reference id to this plan in another system
  - `deployment_id` string — DEPRECATED - use deployment_ids - The deployment ID associated with this run policy
  - `deployment_ids` string[] — The deployment IDs associated with this run policy
  - `uri` string — DEPRECATED - Alias for web_url
  - `web_url` string — Optional URL override for web deployments
  - `api_url` string — Optional URL override for API deployments
  - `link_agent_label` string — DEPRECATED - use link_agent_labels
  - `link_agent_labels` string[] — Optional Link Agent Labels override for the deployment
  - `link_bypass_mabl_proxy` boolean — Optional link_bypass_mabl_proxy override for the deployment (mabl link only)
  - `use_personal_link_agent` boolean — 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_label` string — 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.
  - `tcm_bindings` XrayEntityBinding[] — The plan's external TCM bindings. Populated at read time on single plan reads when include_tcm_bindings is true; empty if the plan has no bindings; not persisted.
    - `external_tcm_binding_id` string — Unique identifier for the binding
    - `workspace_id` string — Unique identifier for the associated Workspace
    - `workspace_integration_id` string — Unique identifier for the associated WorkspaceIntegration
    - `external_tcm_platform` 'xray' — Supported external test case management platforms
    - `external_entity_id` string — Unique identifier for the associated entity in the external test case management solution
    - `mabl_entity_type` 'test' | 'test_case' | 'plan' | 'plan_run' — Types of mabl entities that can be bound to external TCM.
    - `mabl_entity_id` string — Unique identifier for the associated mabl entity
    - `created_time` integer — Time at which the binding was created
    - `created_by_id` string — The ID of the user who created this binding
    - `auto_sync_enabled` boolean — Per-binding automatic result synchronization setting
    - `external_entity_key` string — Unique key for the associated entity in Xray. NOTE: This is not persisted to the DB. It is a convenience method for the UI.
  - `credentials_id` string — Optional ID of the credentials object to use with this run policy
  - `credentials_required` boolean — Flag indicating whether or not credentials are required for this run policy
  - `http_auth_credentials_id` string — Optional ID of credentials to pass in the HTTP request (as opposed to interactive login credentials)
  - `http_auth_credentials_required` boolean — Flag indicating whether or not HTTP auth credentials are required for this run policy
  - `http_headers` HttpHeader[] — Custom HTTP headers to send with all requests
    - `name` string, required — The name of the header
    - `value` string — The value of the header
    - `log_header_value` boolean — Log the header value in the execution log, if not true only the header name is logged.
  - `http_headers_required` boolean — Flag indicating whether or not custom HTTP headers are required for this run policy
  - `enabled` boolean — Whether this run policy is currently enabled
  - `generated` boolean — Whether this run policy was automatically generated by the platform as opposed to being entered by a user
  - `default` boolean — Whether this is the default run policy
  - `ephemeral` boolean — Whether this is an ephemeral run policy created for an ad hoc plan run
  - `created_time` integer — time the run policy was created
  - `created_by_id` string — The ID of the user who created this run policy
  - `last_updated_time` integer — time the run policy object was last updated
  - `last_updated_by_id` string — The ID of the user who last updated this run policy
  - `name` string — The display name of the run policy
  - `description` string — Detailed description of this run policy
  - `journeys` TestConfiguration[] — DEPRECATED - use execution_stages
    - `journey_id` string, required
    - `parameters` ExecutionParameter[]
      - `type` 'basic_auth' | 'credentials' | 'ignore_variables' | 'value' | 'variable_row' | 'variables', required — The type of this parameter
      - `name` string — The name of this parameter
      - `value` string, required — The value of this parameter
      - `argument` string — Additional text data for this parameter.
      - `argumentObject` union — Additional data for this parameter.
        - DynamicScenarioSelection — Dynamic scenario selection parameter argument
          - `type` 'dynamic'
          - `query` string, required — The user query prompt
          - `count` integer, required — The estimated count of scenarios
        - StaticScenarioSelection — Static scenario selection parameter argument
          - `type` 'static'
          - `scenario_ids` string[], required — The selection scenario IDs
          - `count` integer, required — The estimated count of scenarios
  - `test_invariant_ids` string[] — 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_variants` object — 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
  - `journeys_ddt_migration_backup` TestConfiguration[] — Backup of journeys list to prevent data loss in case of failed migration
    - `journey_id` string, required
    - `parameters` ExecutionParameter[]
      - `type` 'basic_auth' | 'credentials' | 'ignore_variables' | 'value' | 'variable_row' | 'variables', required — The type of this parameter
      - `name` string — The name of this parameter
      - `value` string, required — The value of this parameter
      - `argument` string — Additional text data for this parameter.
      - `argumentObject` union — Additional data for this parameter.
        - DynamicScenarioSelection — Dynamic scenario selection parameter argument
          - `type` 'dynamic'
          - `query` string, required — The user query prompt
          - `count` integer, required — The estimated count of scenarios
        - StaticScenarioSelection — Static scenario selection parameter argument
          - `type` 'static'
          - `scenario_ids` string[], required — The selection scenario IDs
          - `count` integer, required — The estimated count of scenarios
  - `parameters` ExecutionParameter[] — Execution parameters that are shared across all Tests in the Plan
    - `type` 'basic_auth' | 'credentials' | 'ignore_variables' | 'value' | 'variable_row' | 'variables', required — The type of this parameter
    - `name` string — The name of this parameter
    - `value` string, required — The value of this parameter
    - `argument` string — Additional text data for this parameter.
    - `argumentObject` union — Additional data for this parameter.
      - DynamicScenarioSelection — Dynamic scenario selection parameter argument
        - `type` 'dynamic'
        - `query` string, required — The user query prompt
        - `count` integer, required — The estimated count of scenarios
      - StaticScenarioSelection — Static scenario selection parameter argument
        - `type` 'static'
        - `scenario_ids` string[], required — The selection scenario IDs
        - `count` integer, required — The estimated count of scenarios
  - `triggers` Trigger[]
    - `trigger_type` 'timer' | 'event' | 'schedule' | 'insight' | 'plan_execution' — The type of trigger
    - `properties` object — Properties that are specific to the trigger type
  - `browser_type` 'chrome' | 'edge' | 'firefox' | 'internet_explorer' | 'safari' | 'webkit' — DEPRECATED - The browser that should be used when executing journeys, use browser_types
  - `browser_types` string[] — The browser that should be used when executing journeys
  - `mobile_device_ids` string[] — 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.
  - `web_emulation_types` WebEmulationConfiguration[]
    - `browser_type` 'chrome' | 'firefox' | 'webkit', required — Browser engine to be used in this emulation
    - `device_emulation` DeviceEmulation, required — Emulation configuration
      - `device_config` DeviceEmulationConfiguration, required — Emulation configuration
        - `name` string, required — Emulation configuration display name
        - `preset_type` 'blackberry_playbook' | 'blackberry_z30' | 'galaxy_fold' | 'galaxy_note_3' | 'galaxy_note_ii' | 'galaxy_s5' | 'galaxy_s6' | 'galaxy_s8' | 'galaxy_s21' | 'galaxy_s22' | 'galaxy_s23' | 'galaxy_s_iii' | 'galaxy_tab_s7' | 'ipad' | 'ipad_air_2020' | 'ipad_mini' | 'ipad_mini_4' | 'ipad_pro' | 'ipad_ten_point_two' | 'iphone_11_pro_max' | 'iphone_11' | 'iphone_12' | 'iphone_12_pro_max' | 'iphone_13_mini' | 'iphone_13' | 'iphone_13_pro' | 'iphone_13_pro_max' | 'iphone_14' | 'iphone_14_pro' | 'iphone_14_plus' | 'iphone_14_pro_max' | 'iphone_15' | 'iphone_15_plus' | 'iphone_15_pro' | 'iphone_15_pro_max' | 'iphone_4' | 'iphone_5_se' | 'iphone_6_7_8' | 'iphone_6_7_8_plus' | 'iphone_x' | 'jiophone_2' | 'kindle_fire_hdx' | 'laptop_with_hidpi_screen' | 'laptop_with_mdpi_screen' | 'laptop_with_touch' | 'lg_optimus_l70' | 'microsoft_lumia_550' | 'microsoft_lumia_950' | 'moto_g4' | 'nexus_4' | 'nexus_5' | 'nexus_5x' | 'nexus_6' | 'nexus_6p' | 'nexus_7' | 'nexus_10' | 'nokia_lumia_520' | 'nokia_n9' | 'pixel_2' | 'pixel_2_xl' | 'pixel_6' | 'surface_duo' — Preset device configuration (optional)
        - `user_agent` string — Client User Agent string
        - `type` 'phone' | 'tablet' | 'notebook' — General device type
        - `capabilities` string[] — Optional device capabilities
        - `screen` object — Screen configuration
          - `device_pixel_ratio` number, double — Device pixel ratio (may be decimal)
          - `horizontal` DeviceScreenDimensions
            - `height` integer, required — Height (pixels)
            - `width` integer, required — Width (pixels)
          - `vertical` DeviceScreenDimensions
            - `height` integer, required — Height (pixels)
            - `width` integer, required — Width (pixels)
      - `orientation` 'portrait_primary' | 'portrait_secondary' | 'landscape_primary' | 'landscape_secondary', required — Fixed device orientation
  - `execution_runner_type` 'cloud_java_v1' | 'cloud_nodejs_v2' — [Deprecated] Test execution runner to use, optional
  - `browser_runner_types` PlanBrowserRunnerTypes
    - `chrome` 'cloud_java_v1' | 'cloud_nodejs_v2'
    - `firefox` 'cloud_java_v1' | 'cloud_nodejs_v2'
    - `safari` 'cloud_java_v1' | 'cloud_nodejs_v2'
  - `nodejs_runtime_variant` 'playwright' | 'puppeteer' — Override the Node.js execution runtime variant, if v2 runtime in use
  - `tags` Tag[] — Tag objects associated with this entity
    - `name` string, required — tag name
    - `values` string[]
  - `labels` Label[] — User provided labels
    - `name` string, required — name
    - `color` string — color
  - `run_multiplier` integer — if > 1, will start multiple copies of each journey run when this plan runs
  - `debug_level` integer — 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_attributes` ActionAttributeType[] — Exclude action attributes during execution
  - `excluded_observers` string[] — Exclude specific observers during execution
  - `execution_stages` ExecutionStage[] — Describes how journey should be executed
    - `name` string — Name of this stage
    - `concurrency` 'sequential' | 'parallel' — How journeys should be executed
    - `concurrency_limit` integer — The maximum number of concurrent test runs for this stage. Only used with parallel execution
    - `always_run_stage` boolean — if true this stage will always run regardless of whether previous stages have passed
    - `always_run_journeys` boolean — if true all journeys within this stage will be run even if a preceding journey has failed
    - `journeys` TestConfiguration[] — The journeys included in this stage; if concurrency is sequential they will be executed in this order
      - `journey_id` string, required
      - `parameters` ExecutionParameter[]
        - `type` 'basic_auth' | 'credentials' | 'ignore_variables' | 'value' | 'variable_row' | 'variables', required — The type of this parameter
        - `name` string — The name of this parameter
        - `value` string, required — The value of this parameter
        - `argument` string — Additional text data for this parameter.
        - `argumentObject` union — Additional data for this parameter.
          - DynamicScenarioSelection — Dynamic scenario selection parameter argument
            - `type` 'dynamic'
            - `query` string, required — The user query prompt
            - `count` integer, required — The estimated count of scenarios
          - StaticScenarioSelection — Static scenario selection parameter argument
            - `type` 'static'
            - `scenario_ids` string[], required — The selection scenario IDs
            - `count` integer, required — The estimated count of scenarios
    - `browser_types_override` string[]
    - `use_browser_types_override` boolean — If true, the browser types in this stage will be used instead of the browser types from the plan
    - `run_multiplier_override` integer
    - `use_run_multiplier_override` boolean — If true, the run multiplier in this stage will be used instead of the run multiplier from the plan
    - `ignore_datatables` boolean — If true, the data tables specified in the journeys in this stage will be ignored
  - `retry_on_failure` boolean — If true, runs of this plan will automatically be retried if any journey run fails
  - `retry_failed_journeys_only` boolean — If true, will only retry journeys that had failed journey runs
  - `visual_change_baseline_overwrite` object — values used to substitute when looking for the baseline to do visual comparison
    - `environment_id` string — The ID of the environment that will serve as baseline for visual comparison
    - `plan_id` string — The ID of the plan that will serve as baseline for visual comparison
  - `use_visual_models` boolean — If true, use and maintain models for visual change detection
  - `send_mabl_header` boolean — 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.
  - `localization_options` LocalizationOptions[] — The localization options to use when executing this plan. It's an array to support potential multi-locale testing within one plan, but for now only the first element is used.
    - `locale` string — The language locale identifier to run the test with, e.g. en-US, jp, etc.
    - `timezone_identifier` string — The timezone identifier to run the test with, e.g. America/Los_Angeles, etc.
  - `mobile_app_file_ids` object — Optional map of mobile platform => mobile app file ID override

## Other responses

- `404` — Run Policy not found
- `default` — Unknown error

---

[API](https://skmtc.net/mabl/apis/mabl-api.md) · [All operations](https://skmtc.net/mabl/apis/mabl-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mabl/mabl-api/revisions/d0fc0114da66/schema)