Update a report schedule
WARNINGNote: This endpoint is in preview and is subject to change.
If you have any feedback, contact Datadog support.
PATCH
https://api.datadoghq.com/api/v2/reporting/schedule/{schedule_uuid}https://api.us3.datadoghq.com/api/v2/reporting/schedule/{schedule_uuid}https://api.us5.datadoghq.com/api/v2/reporting/schedule/{schedule_uuid}https://api.datadoghq.eu/api/v2/reporting/schedule/{schedule_uuid}https://api.ap1.datadoghq.com/api/v2/reporting/schedule/{schedule_uuid}https://api.ap2.datadoghq.com/api/v2/reporting/schedule/{schedule_uuid}https://api.uk1.datadoghq.com/api/v2/reporting/schedule/{schedule_uuid}https://api.ddog-gov.com/api/v2/reporting/schedule/{schedule_uuid}https://api.us2.ddog-gov.com/api/v2/reporting/schedule/{schedule_uuid}Overview
Update an existing scheduled report by its identifier. The editable attributes
are replaced with the supplied values; the targeted resource (resource_id and
resource_type) cannot be changed after creation.
Requires the generate_dashboard_reports permission and schedule ownership.
Arguments
Path Parameters
Name
Type
Description
schedule_uuid [required]string
The unique identifier of the report schedule to update.
Request
Body Data (required)
Field
Type
Description
data [required]object
The JSON:API data object for a report schedule update request.
attributes [required]object
The updated configuration of the report schedule. These values replace the existing
ones; the targeted resource (resource_id and resource_type) cannot be changed.
delivery_formatenum
How a PDF-export report is delivered. pdf attaches a PDF file, png embeds
an inline PNG image, and pdf_and_png delivers both.
Allowed enum values:
pdf, png, pdf_and_pngdescription [required]string
A description of the report, up to 4096 characters.
recipients [required][string]
The recipients of the report. Each entry is an email address, a Slack channel
reference in the form slack:{team_id}.{channel_id}.{channel_name}, or a Microsoft
Teams channel reference in the form teams:{tenant_id}|{team_id}|{channel_id}.
rrule [required]string
The recurrence rule for the schedule, expressed as an iCalendar RRULE string.
tab_iduuid
The identifier of the dashboard tab to render, when the dashboard has tabs.
template_variables [required][object]
The dashboard template variables applied when rendering the report.
name [required]string
The name of the template variable.
values [required][string]
The selected values for the template variable.
timeframe [required]string
The relative timeframe of data to include in the report.
timezone [required]string
The IANA time zone identifier the recurrence rule is evaluated in.
title [required]string
The title of the report, between 1 and 78 characters.
type [required]enum
JSON:API resource type for report schedules.
Allowed enum values:
schedule{
"data": {
"attributes": {
"delivery_format": "pdf",
"description": "Updated weekly summary of infrastructure health.",
"recipients": [
"user@example.com",
"slack:T01234567.C01234567.alerts",
"teams:11111111-1111-1111-1111-111111111111|22222222-2222-2222-2222-222222222222|19:exampleChannelId@thread.tacv2"
],
"rrule": "DTSTART;TZID=America/New_York:20260601T090000\nRRULE:FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0",
"tab_id": "66666666-7777-8888-9999-000000000000",
"template_variables": [
{
"name": "env",
"values": [
"prod"
]
}
],
"timeframe": "1w",
"timezone": "America/New_York",
"title": "Weekly Infrastructure Report"
},
"type": "schedule"
}
}Response
OK
Response containing a single report schedule.
Field
Type
Description
data [required]object
The JSON:API data object representing a report schedule.
attributes [required]object
The configuration and derived state of a report schedule.
delivery_formatenum
The delivery format for dashboard report schedules, or null if not set.
Allowed enum values:
pdf, png, pdf_and_pngdescription [required]string
The description of the report.
next_recurrence [required]int64
The Unix timestamp, in milliseconds, of the next scheduled delivery, or null if none is scheduled.
recipients [required][string]
The recipients of the report (email addresses, Slack channel references, or Microsoft Teams channel references).
resource_id [required]string
The identifier of the resource rendered in the report.
resource_type [required]enum
The type of dashboard resource the report schedule targets.
Allowed enum values:
dashboard, integration_dashboardrrule [required]string
The recurrence rule for the schedule, expressed as an iCalendar RRULE string.
status [required]enum
Whether the schedule is currently delivering reports (active) or paused (inactive).
Allowed enum values:
active, inactivetab_id [required]string
The identifier of the dashboard tab rendered in the report, or null if not set.
template_variables [required][object]
The dashboard template variables applied when rendering the report.
name [required]string
The name of the template variable.
values [required][string]
The selected values for the template variable.
timeframe [required]string
The relative timeframe of data included in the report, or null if not set.
timezone [required]string
The IANA time zone identifier the recurrence rule is evaluated in.
title [required]string
The title of the report.
id [required]string
The unique identifier of the report schedule.
relationships [required]object
Relationships for the report schedule.
author [required]object
Relationship to the author of the report schedule.
data [required]object
Relationship data for the author of the report schedule.
id [required]string
The user UUID of the report schedule author.
type [required]enum
JSON:API resource type for the included report author.
Allowed enum values:
userstype [required]enum
JSON:API resource type for report schedules.
Allowed enum values:
scheduleincluded[<oneOf>]
Related resources included with the report schedule, such as the author.
<type=users>object
A user included as a related JSON:API resource.
attributes [required]object
Attributes of the report author.
email [required]string
The email address of the report author, or null if unavailable.
name [required]string
The display name of the report author, or null if unavailable.
id [required]string
The user UUID.
type [required]enum
JSON:API resource type for the included report author.
Allowed enum values:
users<type=resource>object
A report target resource included as a related JSON:API resource.
attributes [required]object
Attributes of an included report target resource.
resource_type [required]enum
The type of dashboard resource the report schedule targets.
Allowed enum values:
dashboard, integration_dashboardtemplate_variables[object]
Template variable metadata from the dashboard resource, when available.
available_values[string]
Available values for the template variable.
defaults[string]
Default values for the template variable.
namestring
The template variable name.
prefixstring
The tag prefix for the template variable, when available.
titlestring
The title of the dashboard or integration dashboard resource, when available.
id [required]string
The resource identifier.
type [required]enum
JSON:API resource type for an included report resource.
Allowed enum values:
resource{
"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"
}
]
}Bad Request
API error response.
Field
Type
Description
errors [required][object]
A list of errors.
detailstring
A human-readable explanation specific to this occurrence of the error.
metaobject
Non-standard meta-information about the error
sourceobject
References to the source of the error.
headerstring
A string indicating the name of a single request header which caused the error.
parameterstring
A string indicating which URI query parameter caused the error.
pointerstring
A JSON pointer to the value in the request document that caused the error.
statusstring
Status code of the response.
titlestring
Short human-readable summary of the error.
{
"errors": [
{
"detail": "Missing required attribute in body",
"meta": {},
"source": {
"header": "Authorization",
"parameter": "limit",
"pointer": "/data/attributes/title"
},
"status": "400",
"title": "Bad Request"
}
]
}Forbidden
API error response.
Field
Type
Description
errors [required][object]
A list of errors.
detailstring
A human-readable explanation specific to this occurrence of the error.
metaobject
Non-standard meta-information about the error
sourceobject
References to the source of the error.
headerstring
A string indicating the name of a single request header which caused the error.
parameterstring
A string indicating which URI query parameter caused the error.
pointerstring
A JSON pointer to the value in the request document that caused the error.
statusstring
Status code of the response.
titlestring
Short human-readable summary of the error.
{
"errors": [
{
"detail": "Missing required attribute in body",
"meta": {},
"source": {
"header": "Authorization",
"parameter": "limit",
"pointer": "/data/attributes/title"
},
"status": "400",
"title": "Bad Request"
}
]
}Not Found
API error response.
Field
Type
Description
errors [required][object]
A list of errors.
detailstring
A human-readable explanation specific to this occurrence of the error.
metaobject
Non-standard meta-information about the error
sourceobject
References to the source of the error.
headerstring
A string indicating the name of a single request header which caused the error.
parameterstring
A string indicating which URI query parameter caused the error.
pointerstring
A JSON pointer to the value in the request document that caused the error.
statusstring
Status code of the response.
titlestring
Short human-readable summary of the error.
{
"errors": [
{
"detail": "Missing required attribute in body",
"meta": {},
"source": {
"header": "Authorization",
"parameter": "limit",
"pointer": "/data/attributes/title"
},
"status": "400",
"title": "Bad Request"
}
]
}Too many requests
API error response.
Field
Type
Description
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Code Example
Update a report schedule
# Path parameters
export schedule_uuid="11111111-2222-3333-4444-555555555555"
# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PATCH "https://api.${DD_SITE}/api/v2/reporting/schedule/${schedule_uuid}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"delivery_format": "pdf",
"description": "Updated weekly summary of infrastructure health.",
"recipients": [
"user@example.com",
"slack:T01234567.C01234567.alerts",
"teams:11111111-1111-1111-1111-111111111111|22222222-2222-2222-2222-222222222222|19:exampleChannelId@thread.tacv2"
],
"rrule": "DTSTART;TZID=America/New_York:20260601T090000\nRRULE:FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0",
"template_variables": [
{
"name": "env",
"values": [
"prod"
]
}
],
"timeframe": "1w",
"timezone": "America/New_York",
"title": "Weekly Infrastructure Report"
},
"type": "schedule"
}
}
EOF# Path parameters
export schedule_uuid="11111111-2222-3333-4444-555555555555"
# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PATCH "https://api.${DD_SITE}/api/v2/reporting/schedule/${schedule_uuid}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"delivery_format": "pdf",
"description": "Updated weekly summary of infrastructure health.",
"recipients": [
"user@example.com",
"slack:T01234567.C01234567.alerts",
"teams:11111111-1111-1111-1111-111111111111|22222222-2222-2222-2222-222222222222|19:exampleChannelId@thread.tacv2"
],
"rrule": "DTSTART;TZID=America/New_York:20260601T090000\nRRULE:FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0",
"template_variables": [
{
"name": "env",
"values": [
"prod"
]
}
],
"timeframe": "1w",
"timezone": "America/New_York",
"title": "Weekly Infrastructure Report"
},
"type": "schedule"
}
}
EOF# Path parameters
export schedule_uuid="11111111-2222-3333-4444-555555555555"
# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PATCH "https://api.${DD_SITE}/api/v2/reporting/schedule/${schedule_uuid}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"delivery_format": "pdf",
"description": "Updated weekly summary of infrastructure health.",
"recipients": [
"user@example.com",
"slack:T01234567.C01234567.alerts",
"teams:11111111-1111-1111-1111-111111111111|22222222-2222-2222-2222-222222222222|19:exampleChannelId@thread.tacv2"
],
"rrule": "DTSTART;TZID=America/New_York:20260601T090000\nRRULE:FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0",
"template_variables": [
{
"name": "env",
"values": [
"prod"
]
}
],
"timeframe": "1w",
"timezone": "America/New_York",
"title": "Weekly Infrastructure Report"
},
"type": "schedule"
}
}
EOF# Path parameters
export schedule_uuid="11111111-2222-3333-4444-555555555555"
# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PATCH "https://api.${DD_SITE}/api/v2/reporting/schedule/${schedule_uuid}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"delivery_format": "pdf",
"description": "Updated weekly summary of infrastructure health.",
"recipients": [
"user@example.com",
"slack:T01234567.C01234567.alerts",
"teams:11111111-1111-1111-1111-111111111111|22222222-2222-2222-2222-222222222222|19:exampleChannelId@thread.tacv2"
],
"rrule": "DTSTART;TZID=America/New_York:20260601T090000\nRRULE:FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0",
"template_variables": [
{
"name": "env",
"values": [
"prod"
]
}
],
"timeframe": "1w",
"timezone": "America/New_York",
"title": "Weekly Infrastructure Report"
},
"type": "schedule"
}
}
EOF# Path parameters
export schedule_uuid="11111111-2222-3333-4444-555555555555"
# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PATCH "https://api.${DD_SITE}/api/v2/reporting/schedule/${schedule_uuid}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"delivery_format": "pdf",
"description": "Updated weekly summary of infrastructure health.",
"recipients": [
"user@example.com",
"slack:T01234567.C01234567.alerts",
"teams:11111111-1111-1111-1111-111111111111|22222222-2222-2222-2222-222222222222|19:exampleChannelId@thread.tacv2"
],
"rrule": "DTSTART;TZID=America/New_York:20260601T090000\nRRULE:FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0",
"template_variables": [
{
"name": "env",
"values": [
"prod"
]
}
],
"timeframe": "1w",
"timezone": "America/New_York",
"title": "Weekly Infrastructure Report"
},
"type": "schedule"
}
}
EOF# Path parameters
export schedule_uuid="11111111-2222-3333-4444-555555555555"
# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PATCH "https://api.${DD_SITE}/api/v2/reporting/schedule/${schedule_uuid}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"delivery_format": "pdf",
"description": "Updated weekly summary of infrastructure health.",
"recipients": [
"user@example.com",
"slack:T01234567.C01234567.alerts",
"teams:11111111-1111-1111-1111-111111111111|22222222-2222-2222-2222-222222222222|19:exampleChannelId@thread.tacv2"
],
"rrule": "DTSTART;TZID=America/New_York:20260601T090000\nRRULE:FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0",
"template_variables": [
{
"name": "env",
"values": [
"prod"
]
}
],
"timeframe": "1w",
"timezone": "America/New_York",
"title": "Weekly Infrastructure Report"
},
"type": "schedule"
}
}
EOF# Path parameters
export schedule_uuid="11111111-2222-3333-4444-555555555555"
# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PATCH "https://api.${DD_SITE}/api/v2/reporting/schedule/${schedule_uuid}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"delivery_format": "pdf",
"description": "Updated weekly summary of infrastructure health.",
"recipients": [
"user@example.com",
"slack:T01234567.C01234567.alerts",
"teams:11111111-1111-1111-1111-111111111111|22222222-2222-2222-2222-222222222222|19:exampleChannelId@thread.tacv2"
],
"rrule": "DTSTART;TZID=America/New_York:20260601T090000\nRRULE:FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0",
"template_variables": [
{
"name": "env",
"values": [
"prod"
]
}
],
"timeframe": "1w",
"timezone": "America/New_York",
"title": "Weekly Infrastructure Report"
},
"type": "schedule"
}
}
EOF# Path parameters
export schedule_uuid="11111111-2222-3333-4444-555555555555"
# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PATCH "https://api.${DD_SITE}/api/v2/reporting/schedule/${schedule_uuid}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"delivery_format": "pdf",
"description": "Updated weekly summary of infrastructure health.",
"recipients": [
"user@example.com",
"slack:T01234567.C01234567.alerts",
"teams:11111111-1111-1111-1111-111111111111|22222222-2222-2222-2222-222222222222|19:exampleChannelId@thread.tacv2"
],
"rrule": "DTSTART;TZID=America/New_York:20260601T090000\nRRULE:FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0",
"template_variables": [
{
"name": "env",
"values": [
"prod"
]
}
],
"timeframe": "1w",
"timezone": "America/New_York",
"title": "Weekly Infrastructure Report"
},
"type": "schedule"
}
}
EOF# Path parameters
export schedule_uuid="11111111-2222-3333-4444-555555555555"
# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PATCH "https://api.${DD_SITE}/api/v2/reporting/schedule/${schedule_uuid}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"delivery_format": "pdf",
"description": "Updated weekly summary of infrastructure health.",
"recipients": [
"user@example.com",
"slack:T01234567.C01234567.alerts",
"teams:11111111-1111-1111-1111-111111111111|22222222-2222-2222-2222-222222222222|19:exampleChannelId@thread.tacv2"
],
"rrule": "DTSTART;TZID=America/New_York:20260601T090000\nRRULE:FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0",
"template_variables": [
{
"name": "env",
"values": [
"prod"
]
}
],
"timeframe": "1w",
"timezone": "America/New_York",
"title": "Weekly Infrastructure Report"
},
"type": "schedule"
}
}
EOFUpdate a report schedule
// Update 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.ReportSchedulePatchRequest{
Data: datadogV2.ReportSchedulePatchRequestData{
Attributes: datadogV2.ReportSchedulePatchRequestAttributes{
DeliveryFormat: datadogV2.REPORTSCHEDULEDELIVERYFORMAT_PDF.Ptr(),
Description: "Updated weekly summary of infrastructure health.",
Recipients: []string{
"user@example.com",
"slack:T01234567.C01234567.alerts",
"teams:11111111-1111-1111-1111-111111111111|22222222-2222-2222-2222-222222222222|19:exampleChannelId@thread.tacv2",
},
Rrule: `DTSTART;TZID=America/New_York:20260601T090000
RRULE:FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0`,
TabId: datadog.PtrUUID(uuid.MustParse("66666666-7777-8888-9999-000000000000")),
TemplateVariables: []datadogV2.ReportScheduleTemplateVariable{
{
Name: "env",
Values: []string{
"prod",
},
},
},
Timeframe: "1w",
Timezone: "America/New_York",
Title: "Weekly Infrastructure Report",
},
Type: datadogV2.REPORTSCHEDULETYPE_SCHEDULE,
},
}
ctx := datadog.NewDefaultContext(context.Background())
ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN"))
configuration := datadog.NewConfiguration()
configuration.SetUnstableOperationEnabled("v2.PatchReportSchedule", true)
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewReportSchedulesApi(apiClient)
resp, r, err := api.PatchReportSchedule(ctx, uuid.MustParse("9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d"), body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ReportSchedulesApi.PatchReportSchedule`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `ReportSchedulesApi.PatchReportSchedule`:\n%s\n", responseContent)
}
Instructions
First install the library and its dependencies and then save the example to main.go and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"Update a report schedule
// Update 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.ReportScheduleDeliveryFormat;
import com.datadog.api.client.v2.model.ReportSchedulePatchRequest;
import com.datadog.api.client.v2.model.ReportSchedulePatchRequestAttributes;
import com.datadog.api.client.v2.model.ReportSchedulePatchRequestData;
import com.datadog.api.client.v2.model.ReportScheduleResponse;
import com.datadog.api.client.v2.model.ReportScheduleTemplateVariable;
import com.datadog.api.client.v2.model.ReportScheduleType;
import java.util.Arrays;
import java.util.Collections;
import java.util.UUID;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
defaultClient.setUnstableOperationEnabled("v2.patchReportSchedule", true);
ReportSchedulesApi apiInstance = new ReportSchedulesApi(defaultClient);
ReportSchedulePatchRequest body =
new ReportSchedulePatchRequest()
.data(
new ReportSchedulePatchRequestData()
.attributes(
new ReportSchedulePatchRequestAttributes()
.deliveryFormat(ReportScheduleDeliveryFormat.PDF)
.description("Updated weekly summary of infrastructure health.")
.recipients(
Arrays.asList(
"user@example.com",
"slack:T01234567.C01234567.alerts",
"teams:11111111-1111-1111-1111-111111111111|22222222-2222-2222-2222-222222222222|19:exampleChannelId@thread.tacv2"))
.rrule(
"""
DTSTART;TZID=America/New_York:20260601T090000
RRULE:FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0
""")
.tabId(UUID.fromString("66666666-7777-8888-9999-000000000000"))
.templateVariables(
Collections.singletonList(
new ReportScheduleTemplateVariable()
.name("env")
.values(Collections.singletonList("prod"))))
.timeframe("1w")
.timezone("America/New_York")
.title("Weekly Infrastructure Report"))
.type(ReportScheduleType.SCHEDULE));
try {
ReportScheduleResponse result =
apiInstance.patchReportSchedule(
UUID.fromString("11111111-2222-3333-4444-555555555555"), body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReportSchedulesApi#patchReportSchedule");
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 and then save the example to Example.java and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"Update a report schedule
"""
Update a report schedule returns "OK" response
"""
from os import environ
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_delivery_format import ReportScheduleDeliveryFormat
from datadog_api_client.v2.model.report_schedule_patch_request import ReportSchedulePatchRequest
from datadog_api_client.v2.model.report_schedule_patch_request_attributes import ReportSchedulePatchRequestAttributes
from datadog_api_client.v2.model.report_schedule_patch_request_data import ReportSchedulePatchRequestData
from datadog_api_client.v2.model.report_schedule_template_variable import ReportScheduleTemplateVariable
from datadog_api_client.v2.model.report_schedule_type import ReportScheduleType
from uuid import UUID
body = ReportSchedulePatchRequest(
data=ReportSchedulePatchRequestData(
attributes=ReportSchedulePatchRequestAttributes(
delivery_format=ReportScheduleDeliveryFormat.PDF,
description="Updated weekly summary of infrastructure health.",
recipients=[
"user@example.com",
"slack:T01234567.C01234567.alerts",
"teams:11111111-1111-1111-1111-111111111111|22222222-2222-2222-2222-222222222222|19:exampleChannelId@thread.tacv2",
],
rrule="DTSTART;TZID=America/New_York:20260601T090000\nRRULE:FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0",
tab_id=UUID("66666666-7777-8888-9999-000000000000"),
template_variables=[
ReportScheduleTemplateVariable(
name="env",
values=[
"prod",
],
),
],
timeframe="1w",
timezone="America/New_York",
title="Weekly Infrastructure Report",
),
type=ReportScheduleType.SCHEDULE,
),
)
configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
configuration.unstable_operations["patch_report_schedule"] = True
with ApiClient(configuration) as api_client:
api_instance = ReportSchedulesApi(api_client)
response = api_instance.patch_report_schedule(schedule_uuid=UUID("9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d"), body=body)
print(response)
Instructions
First install the library and its dependencies and then save the example to example.py and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"Update a report schedule
# Update a report schedule returns "OK" response
require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.access_token = ENV["DD_BEARER_TOKEN"]
config.unstable_operations["v2.patch_report_schedule".to_sym] = true
end
api_instance = DatadogAPIClient::V2::ReportSchedulesAPI.new
body = DatadogAPIClient::V2::ReportSchedulePatchRequest.new({
data: DatadogAPIClient::V2::ReportSchedulePatchRequestData.new({
attributes: DatadogAPIClient::V2::ReportSchedulePatchRequestAttributes.new({
delivery_format: DatadogAPIClient::V2::ReportScheduleDeliveryFormat::PDF,
description: "Updated weekly summary of infrastructure health.",
recipients: [
"user@example.com",
"slack:T01234567.C01234567.alerts",
"teams:11111111-1111-1111-1111-111111111111|22222222-2222-2222-2222-222222222222|19:exampleChannelId@thread.tacv2",
],
rrule: 'DTSTART;TZID=America/New_York:20260601T090000\nRRULE:FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0',
tab_id: "66666666-7777-8888-9999-000000000000",
template_variables: [
DatadogAPIClient::V2::ReportScheduleTemplateVariable.new({
name: "env",
values: [
"prod",
],
}),
],
timeframe: "1w",
timezone: "America/New_York",
title: "Weekly Infrastructure Report",
}),
type: DatadogAPIClient::V2::ReportScheduleType::SCHEDULE,
}),
})
p api_instance.patch_report_schedule("9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d", body)
Instructions
First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"Update a report schedule
// Update 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::ReportScheduleDeliveryFormat;
use datadog_api_client::datadogV2::model::ReportSchedulePatchRequest;
use datadog_api_client::datadogV2::model::ReportSchedulePatchRequestAttributes;
use datadog_api_client::datadogV2::model::ReportSchedulePatchRequestData;
use datadog_api_client::datadogV2::model::ReportScheduleTemplateVariable;
use datadog_api_client::datadogV2::model::ReportScheduleType;
use uuid::Uuid;
#[tokio::main]
async fn main() {
let body =
ReportSchedulePatchRequest::new(
ReportSchedulePatchRequestData::new(
ReportSchedulePatchRequestAttributes::new(
"Updated weekly summary of infrastructure health.".to_string(),
vec![
"user@example.com".to_string(),
"slack:T01234567.C01234567.alerts".to_string(),
"teams:11111111-1111-1111-1111-111111111111|22222222-2222-2222-2222-222222222222|19:exampleChannelId@thread.tacv2".to_string()
],
r#"DTSTART;TZID=America/New_York:20260601T090000
RRULE:FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0"#.to_string(),
vec![ReportScheduleTemplateVariable::new("env".to_string(), vec!["prod".to_string()])],
"1w".to_string(),
"America/New_York".to_string(),
"Weekly Infrastructure Report".to_string(),
)
.delivery_format(ReportScheduleDeliveryFormat::PDF)
.tab_id(Uuid::parse_str("66666666-7777-8888-9999-000000000000").expect("invalid UUID")),
ReportScheduleType::SCHEDULE,
),
);
let mut configuration = datadog::Configuration::new();
configuration.set_unstable_operation_enabled("v2.patch_report_schedule", true);
let api = ReportSchedulesAPI::with_config(configuration);
let resp = api
.patch_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 and then save the example to src/main.rs and run following commands:
DD_SITE="datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="us3.datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="us5.datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="datadoghq.eu" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="ap1.datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="ap2.datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="uk1.datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="us2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runUpdate a report schedule
/**
* Update a report schedule returns "OK" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration({
authMethods: {
AuthZ: {
accessToken: process.env.DD_BEARER_TOKEN as string,
},
},
});
configuration.unstableOperations["v2.patchReportSchedule"] = true;
const apiInstance = new v2.ReportSchedulesApi(configuration);
const params: v2.ReportSchedulesApiPatchReportScheduleRequest = {
body: {
data: {
attributes: {
deliveryFormat: "pdf",
description: "Updated weekly summary of infrastructure health.",
recipients: [
"user@example.com",
"slack:T01234567.C01234567.alerts",
"teams:11111111-1111-1111-1111-111111111111|22222222-2222-2222-2222-222222222222|19:exampleChannelId@thread.tacv2",
],
rrule:
"DTSTART;TZID=America/New_York:20260601T090000\nRRULE:FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0",
tabId: "66666666-7777-8888-9999-000000000000",
templateVariables: [
{
name: "env",
values: ["prod"],
},
],
timeframe: "1w",
timezone: "America/New_York",
title: "Weekly Infrastructure Report",
},
type: "schedule",
},
},
scheduleUuid: "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
};
apiInstance
.patchReportSchedule(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 and then save the example to example.ts and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"