---
title: Pause a progressive rollout
description: Datadog, the leading service for cloud-scale monitoring.
breadcrumbs: Docs > API Reference > Feature Flags
---

# Pause a progressive rollout{% #pause-a-progressive-rollout %}

{% tab title="v2" %}

| Datadog site      | API endpoint                                                                                            |
| ----------------- | ------------------------------------------------------------------------------------------------------- |
| ap1.datadoghq.com | POST https://api.ap1.datadoghq.com/api/v2/feature-flags/exposure-schedules/{exposure_schedule_id}/pause |
| ap2.datadoghq.com | POST https://api.ap2.datadoghq.com/api/v2/feature-flags/exposure-schedules/{exposure_schedule_id}/pause |
| app.datadoghq.eu  | POST https://api.datadoghq.eu/api/v2/feature-flags/exposure-schedules/{exposure_schedule_id}/pause      |
| app.ddog-gov.com  | POST https://api.ddog-gov.com/api/v2/feature-flags/exposure-schedules/{exposure_schedule_id}/pause      |
| us2.ddog-gov.com  | POST https://api.us2.ddog-gov.com/api/v2/feature-flags/exposure-schedules/{exposure_schedule_id}/pause  |
| app.datadoghq.com | POST https://api.datadoghq.com/api/v2/feature-flags/exposure-schedules/{exposure_schedule_id}/pause     |
| us3.datadoghq.com | POST https://api.us3.datadoghq.com/api/v2/feature-flags/exposure-schedules/{exposure_schedule_id}/pause |
| us5.datadoghq.com | POST https://api.us5.datadoghq.com/api/v2/feature-flags/exposure-schedules/{exposure_schedule_id}/pause |

### Overview

Pauses a progressive rollout while preserving rollout state. This endpoint requires the `feature_flag_config_write` permission.

### Arguments

#### Path Parameters

| Name                                   | Type   | Description                      |
| -------------------------------------- | ------ | -------------------------------- |
| exposure_schedule_id [*required*] | string | The ID of the exposure schedule. |

### Response

{% tab title="200" %}
OK
{% tab title="Model" %}
Response containing a progressive rollout schedule.

| Parent field       | Field                                             | Type      | Description                                                                                                 |
| ------------------ | ------------------------------------------------- | --------- | ----------------------------------------------------------------------------------------------------------- |
|                    | data [*required*]                            | object    | Data wrapper for progressive rollout schedule responses.                                                    |
| data               | attributes [*required*]                      | object    | Progressive release details for a targeting rule allocation.                                                |
| attributes         | absolute_start_time                               | date-time | The absolute UTC start time for this schedule.                                                              |
| attributes         | allocation_id [*required*]                   | uuid      | The targeting rule allocation ID this progressive rollout belongs to.                                       |
| attributes         | control_variant_id                                | string    | The control variant ID used for experiment comparisons.                                                     |
| attributes         | created_at [*required*]                      | date-time | The timestamp when the schedule was created.                                                                |
| attributes         | guardrail_triggered_action                        | string    | Last guardrail action triggered for this schedule.                                                          |
| attributes         | guardrail_triggers [*required*]              | [object]  | Guardrail trigger records for this schedule.                                                                |
| guardrail_triggers | allocation_exposure_schedule_id [*required*] | uuid      | The progressive rollout ID this trigger belongs to.                                                         |
| guardrail_triggers | created_at [*required*]                      | date-time | The timestamp when this trigger was created.                                                                |
| guardrail_triggers | flagging_variant_id [*required*]             | uuid      | The variant ID that triggered this event.                                                                   |
| guardrail_triggers | id [*required*]                              | uuid      | The unique identifier of the guardrail trigger.                                                             |
| guardrail_triggers | metric_id [*required*]                       | string    | The metric ID associated with the trigger.                                                                  |
| guardrail_triggers | triggered_action [*required*]                | string    | The action that was triggered.                                                                              |
| guardrail_triggers | updated_at [*required*]                      | date-time | The timestamp when this trigger was last updated.                                                           |
| attributes         | id                                                | uuid      | The unique identifier of the progressive rollout.                                                           |
| attributes         | rollout_options [*required*]                 | object    | Applied progression options for a progressive rollout.                                                      |
| rollout_options    | autostart [*required*]                       | boolean   | Whether the schedule starts automatically.                                                                  |
| rollout_options    | selection_interval_ms [*required*]           | int64     | Interval in milliseconds for uniform interval strategies.                                                   |
| rollout_options    | strategy [*required*]                        | enum      | The progression strategy used by a progressive rollout. Allowed enum values: `UNIFORM_INTERVALS,NO_ROLLOUT` |
| attributes         | rollout_steps [*required*]                   | [object]  | Ordered progression steps for exposure.                                                                     |
| rollout_steps      | allocation_exposure_schedule_id [*required*] | uuid      | The progressive rollout ID this step belongs to.                                                            |
| rollout_steps      | created_at [*required*]                      | date-time | The timestamp when the progression step was created.                                                        |
| rollout_steps      | exposure_ratio [*required*]                  | double    | The exposure ratio for this step.                                                                           |
| rollout_steps      | grouped_step_index [*required*]              | int64     | Logical index grouping related steps.                                                                       |
| rollout_steps      | id [*required*]                              | uuid      | The unique identifier of the progression step.                                                              |
| rollout_steps      | interval_ms                                       | int64     | Step duration in milliseconds.                                                                              |
| rollout_steps      | is_pause_record [*required*]                 | boolean   | Whether this step represents a pause record.                                                                |
| rollout_steps      | order_position [*required*]                  | int64     | Sort order for the progression step.                                                                        |
| rollout_steps      | updated_at [*required*]                      | date-time | The timestamp when the progression step was last updated.                                                   |
| attributes         | updated_at [*required*]                      | date-time | The timestamp when the schedule was last updated.                                                           |
| data               | id [*required*]                              | uuid      | The unique identifier of the progressive rollout.                                                           |
| data               | type [*required*]                            | enum      | The resource type for progressive rollout schedules. Allowed enum values: `allocation_exposure_schedules`   |

{% /tab %}

{% tab title="Example" %}

```json
{
  "data": {
    "attributes": {
      "absolute_start_time": "2025-06-13T12:00:00Z",
      "allocation_id": "550e8400-e29b-41d4-a716-446655440020",
      "control_variant_id": "550e8400-e29b-41d4-a716-446655440012",
      "created_at": "2024-01-01T12:00:00Z",
      "guardrail_triggered_action": "PAUSE",
      "guardrail_triggers": [
        {
          "allocation_exposure_schedule_id": "550e8400-e29b-41d4-a716-446655440010",
          "created_at": "2024-01-01T12:00:00Z",
          "flagging_variant_id": "550e8400-e29b-41d4-a716-446655440001",
          "id": "550e8400-e29b-41d4-a716-446655440080",
          "metric_id": "metric-error-rate",
          "triggered_action": "PAUSE",
          "updated_at": "2024-01-01T12:00:00Z"
        }
      ],
      "id": "550e8400-e29b-41d4-a716-446655440010",
      "rollout_options": {
        "autostart": false,
        "selection_interval_ms": 3600000,
        "strategy": "UNIFORM_INTERVALS"
      },
      "rollout_steps": [
        {
          "allocation_exposure_schedule_id": "550e8400-e29b-41d4-a716-446655440010",
          "created_at": "2024-01-01T12:00:00Z",
          "exposure_ratio": 0.1,
          "grouped_step_index": 0,
          "id": "550e8400-e29b-41d4-a716-446655440040",
          "interval_ms": 3600000,
          "is_pause_record": false,
          "order_position": 0,
          "updated_at": "2024-01-01T12:00:00Z"
        }
      ],
      "updated_at": "2024-01-01T12:00:00Z"
    },
    "id": "550e8400-e29b-41d4-a716-446655440010",
    "type": "allocation_exposure_schedules"
  }
}
```

{% /tab %}

{% /tab %}

{% tab title="400" %}
Bad Request
{% tab title="Model" %}
API error response.

| Field                    | Type     | Description       |
| ------------------------ | -------- | ----------------- |
| errors [*required*] | [string] | A list of errors. |

{% /tab %}

{% tab title="Example" %}

```json
{
  "errors": [
    "Bad Request"
  ]
}
```

{% /tab %}

{% /tab %}

{% tab title="403" %}
Forbidden
{% tab title="Model" %}
API error response.

| Field                    | Type     | Description       |
| ------------------------ | -------- | ----------------- |
| errors [*required*] | [string] | A list of errors. |

{% /tab %}

{% tab title="Example" %}

```json
{
  "errors": [
    "Bad Request"
  ]
}
```

{% /tab %}

{% /tab %}

{% tab title="404" %}
Not Found
{% tab title="Model" %}
API error response.

| Field                    | Type     | Description       |
| ------------------------ | -------- | ----------------- |
| errors [*required*] | [string] | A list of errors. |

{% /tab %}

{% tab title="Example" %}

```json
{
  "errors": [
    "Bad Request"
  ]
}
```

{% /tab %}

{% /tab %}

{% tab title="409" %}
Conflict
{% tab title="Model" %}
API error response.

| Field                    | Type     | Description       |
| ------------------------ | -------- | ----------------- |
| errors [*required*] | [string] | A list of errors. |

{% /tab %}

{% tab title="Example" %}

```json
{
  "errors": [
    "Bad Request"
  ]
}
```

{% /tab %}

{% /tab %}

{% tab title="429" %}
Too many requests
{% tab title="Model" %}
API error response.

| Field                    | Type     | Description       |
| ------------------------ | -------- | ----------------- |
| errors [*required*] | [string] | A list of errors. |

{% /tab %}

{% tab title="Example" %}

```json
{
  "errors": [
    "Bad Request"
  ]
}
```

{% /tab %}

{% /tab %}

### Code Example

##### 
                  \# Path parameters export exposure_schedule_id="550e8400-e29b-41d4-a716-446655440010" \# Curl command curl -X POST "https://api.datadoghq.com/api/v2/feature-flags/exposure-schedules/${exposure_schedule_id}/pause" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" 
                
##### 

```python
"""
Pause a progressive rollout returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.feature_flags_api import FeatureFlagsApi
from uuid import UUID

configuration = Configuration()
with ApiClient(configuration) as api_client:
    api_instance = FeatureFlagsApi(api_client)
    response = api_instance.pause_exposure_schedule(
        exposure_schedule_id=UUID("550e8400-e29b-41d4-a716-446655440010"),
    )

    print(response)
```

#### Instructions

First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands:
    DD_SITE="datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"
##### 

```ruby
# Pause a progressive rollout returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V2::FeatureFlagsAPI.new
p api_instance.pause_exposure_schedule("550e8400-e29b-41d4-a716-446655440010")
```

#### Instructions

First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands:
    DD_SITE="datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
##### 

```go
// Pause a progressive rollout returns "OK" response

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"

	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
	"github.com/google/uuid"
)

func main() {
	ctx := datadog.NewDefaultContext(context.Background())
	configuration := datadog.NewConfiguration()
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV2.NewFeatureFlagsApi(apiClient)
	resp, r, err := api.PauseExposureSchedule(ctx, uuid.MustParse("550e8400-e29b-41d4-a716-446655440010"))

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `FeatureFlagsApi.PauseExposureSchedule`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `FeatureFlagsApi.PauseExposureSchedule`:\n%s\n", responseContent)
}
```

#### Instructions

First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands:
    DD_SITE="datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"
##### 

```java
// Pause a progressive rollout returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.FeatureFlagsApi;
import com.datadog.api.client.v2.model.AllocationExposureScheduleResponse;
import java.util.UUID;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    FeatureFlagsApi apiInstance = new FeatureFlagsApi(defaultClient);

    try {
      AllocationExposureScheduleResponse result =
          apiInstance.pauseExposureSchedule(
              UUID.fromString("550e8400-e29b-41d4-a716-446655440010"));
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling FeatureFlagsApi#pauseExposureSchedule");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}
```

#### Instructions

First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands:
    DD_SITE="datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"
##### 

```rust
// Pause a progressive rollout returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_feature_flags::FeatureFlagsAPI;
use uuid::Uuid;

#[tokio::main]
async fn main() {
    let configuration = datadog::Configuration::new();
    let api = FeatureFlagsAPI::with_config(configuration);
    let resp = api
        .pause_exposure_schedule(
            Uuid::parse_str("550e8400-e29b-41d4-a716-446655440010").expect("invalid UUID"),
        )
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}
```

#### Instructions

First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands:
    DD_SITE="datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run
##### 

```typescript
/**
 * Pause a progressive rollout returns "OK" response
 */

import { client, v2 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration();
const apiInstance = new v2.FeatureFlagsApi(configuration);

const params: v2.FeatureFlagsApiPauseExposureScheduleRequest = {
  exposureScheduleId: "550e8400-e29b-41d4-a716-446655440010",
};

apiInstance
  .pauseExposureSchedule(params)
  .then((data: v2.AllocationExposureScheduleResponse) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  })
  .catch((error: any) => console.error(error));
```

#### Instructions

First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands:
    DD_SITE="datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"
{% /tab %}