--- title: Toggle a report schedule description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Report Schedules --- > For the complete documentation index, see [llms.txt](https://docs.datadoghq.com/llms.txt). # Toggle a report schedule{% #toggle-a-report-schedule %} Copy pageCopied {% tab title="v2" %} | Datadog site | API endpoint | | ----------------- | ------------------------------------------------------------------------------------ | | ap1.datadoghq.com | PATCH https://api.ap1.datadoghq.com/api/v2/reporting/schedule/{schedule_uuid}/toggle | | ap2.datadoghq.com | PATCH https://api.ap2.datadoghq.com/api/v2/reporting/schedule/{schedule_uuid}/toggle | | app.datadoghq.eu | PATCH https://api.datadoghq.eu/api/v2/reporting/schedule/{schedule_uuid}/toggle | | app.ddog-gov.com | PATCH https://api.ddog-gov.com/api/v2/reporting/schedule/{schedule_uuid}/toggle | | us2.ddog-gov.com | PATCH https://api.us2.ddog-gov.com/api/v2/reporting/schedule/{schedule_uuid}/toggle | | uk1.datadoghq.com | PATCH https://api.uk1.datadoghq.com/api/v2/reporting/schedule/{schedule_uuid}/toggle | | app.datadoghq.com | PATCH https://api.datadoghq.com/api/v2/reporting/schedule/{schedule_uuid}/toggle | | us3.datadoghq.com | PATCH https://api.us3.datadoghq.com/api/v2/reporting/schedule/{schedule_uuid}/toggle | | us5.datadoghq.com | PATCH https://api.us5.datadoghq.com/api/v2/reporting/schedule/{schedule_uuid}/toggle | ### Overview Activate or pause a report schedule by setting its status to `active` or `inactive`. Requires a reporting write permission appropriate to the targeted resource type and schedule ownership. ### Arguments #### Path Parameters | Name | Type | Description | | ------------------------------- | ------ | ------------------------------------------------------- | | schedule_uuid [*required*] | string | The unique identifier of the report schedule to toggle. | ### Request #### Body Data (required) {% tab title="Model" %} | Parent field | Field | Type | Description | | ------------ | ---------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------ | | | data [*required*] | object | The JSON:API data object for a report schedule toggle request. | | data | attributes [*required*] | object | The status to set on the report schedule. | | attributes | status [*required*] | enum | Whether the schedule is currently delivering reports (`active`) or paused (`inactive`). Allowed enum values: `active,inactive` | | data | type [*required*] | enum | JSON:API resource type for report schedules. Allowed enum values: `schedule` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "status": "active" }, "type": "schedule" } } ``` {% /tab %} ### Response {% tab title="200" %} OK {% tab title="Model" %} Response containing a single report schedule. | Parent field | Field | Type | Description | | ------------------ | ------------------------------------ | --------------- | ------------------------------------------------------------------------------------------------------------------------------ | | | data [*required*] | object | The JSON:API data object representing a report schedule. | | data | attributes [*required*] | object | The configuration and derived state of a report schedule. | | attributes | delivery_format | enum | The delivery format for dashboard report schedules, or `null` if not set. Allowed enum values: `pdf,png,pdf_and_png` | | attributes | description [*required*] | string | The description of the report. | | attributes | next_recurrence [*required*] | int64 | The Unix timestamp, in milliseconds, of the next scheduled delivery, or `null` if none is scheduled. | | attributes | recipients [*required*] | [string] | The recipients of the report (email addresses, Slack channel references, or Microsoft Teams channel references). | | attributes | resource_id [*required*] | string | The identifier of the resource rendered in the report. | | attributes | resource_type [*required*] | enum | The type of dashboard resource the report schedule targets. Allowed enum values: `dashboard,integration_dashboard` | | attributes | rrule [*required*] | string | The recurrence rule for the schedule, expressed as an iCalendar `RRULE` string. | | attributes | status [*required*] | enum | Whether the schedule is currently delivering reports (`active`) or paused (`inactive`). Allowed enum values: `active,inactive` | | attributes | tab_id [*required*] | string | The identifier of the dashboard tab rendered in the report, or `null` if not set. | | attributes | template_variables [*required*] | [object] | The dashboard template variables applied when rendering the report. | | template_variables | name [*required*] | string | The name of the template variable. | | template_variables | values [*required*] | [string] | The selected values for the template variable. | | attributes | timeframe [*required*] | string | The relative timeframe of data included in the report, or `null` if not set. | | attributes | timezone [*required*] | string | The IANA time zone identifier the recurrence rule is evaluated in. | | attributes | title [*required*] | string | The title of the report. | | data | id [*required*] | string | The unique identifier of the report schedule. | | data | relationships [*required*] | object | Relationships for the report schedule. | | relationships | author [*required*] | object | Relationship to the author of the report schedule. | | author | data [*required*] | object | Relationship data for the author of the report schedule. | | data | id [*required*] | string | The user UUID of the report schedule author. | | data | type [*required*] | enum | JSON:API resource type for the included report author. Allowed enum values: `users` | | data | type [*required*] | enum | JSON:API resource type for report schedules. Allowed enum values: `schedule` | | | included | [ ] | Related resources included with the report schedule, such as the author. | | included | Option 1 | object | A user included as a related JSON:API resource. | | Option 1 | attributes [*required*] | object | Attributes of the report author. | | attributes | email [*required*] | string | The email address of the report author, or `null` if unavailable. | | attributes | name [*required*] | string | The display name of the report author, or `null` if unavailable. | | Option 1 | id [*required*] | string | The user UUID. | | Option 1 | type [*required*] | enum | JSON:API resource type for the included report author. Allowed enum values: `users` | | included | Option 2 | object | A report target resource included as a related JSON:API resource. | | Option 2 | attributes [*required*] | object | Attributes of an included report target resource. | | attributes | resource_type [*required*] | enum | The type of dashboard resource the report schedule targets. Allowed enum values: `dashboard,integration_dashboard` | | attributes | template_variables | [object] | Template variable metadata from the dashboard resource, when available. | | template_variables | available_values | [string] | Available values for the template variable. | | template_variables | defaults | [string] | Default values for the template variable. | | template_variables | name | string | The template variable name. | | template_variables | prefix | string | The tag prefix for the template variable, when available. | | attributes | title | string | The title of the dashboard or integration dashboard resource, when available. | | Option 2 | id [*required*] | string | The resource identifier. | | Option 2 | type [*required*] | enum | JSON:API resource type for an included report resource. Allowed enum values: `resource` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "delivery_format": "pdf", "description": "Weekly summary of infrastructure health.", "next_recurrence": 1780923600000, "recipients": [ "user@example.com", "slack:T01234567.C01234567.alerts", "teams:11111111-1111-1111-1111-111111111111|22222222-2222-2222-2222-222222222222|19:exampleChannelId@thread.tacv2" ], "resource_id": "abc-def-ghi", "resource_type": "dashboard", "rrule": "DTSTART;TZID=America/New_York:20260601T090000\nRRULE:FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0", "status": "active", "tab_id": "66666666-7777-8888-9999-000000000000", "template_variables": [ { "name": "env", "values": [ "prod" ] } ], "timeframe": "1w", "timezone": "America/New_York", "title": "Weekly Infrastructure Report" }, "id": "11111111-2222-3333-4444-555555555555", "relationships": { "author": { "data": { "id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "type": "users" } } }, "type": "schedule" }, "included": [ { "attributes": { "email": "user@example.com", "name": "Example User" }, "id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "type": "users" } ] } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Forbidden {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="404" %} Not Found {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "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 ##### \## default # \# Path parameters export schedule_uuid="11111111-2222-3333-4444-555555555555" \# Curl command curl -X PATCH "https://api.datadoghq.com/api/v2/reporting/schedule/${schedule_uuid}/toggle" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "data": { "attributes": { "status": "inactive" }, "type": "schedule" } } EOF ##### ```python """ Toggle a report schedule returns "OK" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.report_schedules_api import ReportSchedulesApi from datadog_api_client.v2.model.report_schedule_status import ReportScheduleStatus from datadog_api_client.v2.model.report_schedule_toggle_request import ReportScheduleToggleRequest from datadog_api_client.v2.model.report_schedule_toggle_request_attributes import ReportScheduleToggleRequestAttributes from datadog_api_client.v2.model.report_schedule_toggle_request_data import ReportScheduleToggleRequestData from datadog_api_client.v2.model.report_schedule_type import ReportScheduleType from uuid import UUID body = ReportScheduleToggleRequest( data=ReportScheduleToggleRequestData( attributes=ReportScheduleToggleRequestAttributes( status=ReportScheduleStatus.ACTIVE, ), type=ReportScheduleType.SCHEDULE, ), ) configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = ReportSchedulesApi(api_client) response = api_instance.toggle_report_schedule( schedule_uuid=UUID("9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d"), body=body ) 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_APP_KEY="" python3 "example.py" ##### ```ruby # Toggle a report schedule returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V2::ReportSchedulesAPI.new body = DatadogAPIClient::V2::ReportScheduleToggleRequest.new({ data: DatadogAPIClient::V2::ReportScheduleToggleRequestData.new({ attributes: DatadogAPIClient::V2::ReportScheduleToggleRequestAttributes.new({ status: DatadogAPIClient::V2::ReportScheduleStatus::ACTIVE, }), type: DatadogAPIClient::V2::ReportScheduleType::SCHEDULE, }), }) p api_instance.toggle_report_schedule("9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d", body) ``` #### 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_APP_KEY="" rb "example.rb" ##### ```go // Toggle a report schedule 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() { body := datadogV2.ReportScheduleToggleRequest{ Data: datadogV2.ReportScheduleToggleRequestData{ Attributes: datadogV2.ReportScheduleToggleRequestAttributes{ Status: datadogV2.REPORTSCHEDULESTATUS_ACTIVE, }, Type: datadogV2.REPORTSCHEDULETYPE_SCHEDULE, }, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewReportSchedulesApi(apiClient) resp, r, err := api.ToggleReportSchedule(ctx, uuid.MustParse("9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d"), body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ReportSchedulesApi.ToggleReportSchedule`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `ReportSchedulesApi.ToggleReportSchedule`:\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_APP_KEY="" go run "main.go" ##### ```java // Toggle a report schedule returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.ReportSchedulesApi; import com.datadog.api.client.v2.model.ReportScheduleResponse; import com.datadog.api.client.v2.model.ReportScheduleStatus; import com.datadog.api.client.v2.model.ReportScheduleToggleRequest; import com.datadog.api.client.v2.model.ReportScheduleToggleRequestAttributes; import com.datadog.api.client.v2.model.ReportScheduleToggleRequestData; import com.datadog.api.client.v2.model.ReportScheduleType; import java.util.UUID; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); ReportSchedulesApi apiInstance = new ReportSchedulesApi(defaultClient); ReportScheduleToggleRequest body = new ReportScheduleToggleRequest() .data( new ReportScheduleToggleRequestData() .attributes( new ReportScheduleToggleRequestAttributes() .status(ReportScheduleStatus.ACTIVE)) .type(ReportScheduleType.SCHEDULE)); try { ReportScheduleResponse result = apiInstance.toggleReportSchedule( UUID.fromString("11111111-2222-3333-4444-555555555555"), body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling ReportSchedulesApi#toggleReportSchedule"); 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_APP_KEY="" java "Example.java" ##### ```rust // Toggle a report schedule returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_report_schedules::ReportSchedulesAPI; use datadog_api_client::datadogV2::model::ReportScheduleStatus; use datadog_api_client::datadogV2::model::ReportScheduleToggleRequest; use datadog_api_client::datadogV2::model::ReportScheduleToggleRequestAttributes; use datadog_api_client::datadogV2::model::ReportScheduleToggleRequestData; use datadog_api_client::datadogV2::model::ReportScheduleType; use uuid::Uuid; #[tokio::main] async fn main() { let body = ReportScheduleToggleRequest::new(ReportScheduleToggleRequestData::new( ReportScheduleToggleRequestAttributes::new(ReportScheduleStatus::ACTIVE), ReportScheduleType::SCHEDULE, )); let configuration = datadog::Configuration::new(); let api = ReportSchedulesAPI::with_config(configuration); let resp = api .toggle_report_schedule( Uuid::parse_str("00000000-0000-0000-0000-000000000000").expect("invalid UUID"), body, ) .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_APP_KEY="" cargo run ##### ```typescript /** * Toggle a report schedule returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v2.ReportSchedulesApi(configuration); const params: v2.ReportSchedulesApiToggleReportScheduleRequest = { body: { data: { attributes: { status: "active", }, type: "schedule", }, }, scheduleUuid: "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d", }; apiInstance .toggleReportSchedule(params) .then((data: v2.ReportScheduleResponse) => { 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_APP_KEY="" tsc "example.ts" {% /tab %}