--- title: Create a schedule description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Fleet Automation --- # Create a schedule{% #create-a-schedule %} Copy pageCopied {% tab title="v2" %} This endpoint is in Preview and may introduce breaking changes. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). | Datadog site | API endpoint | | ----------------- | --------------------------------------------------------------- | | ap1.datadoghq.com | POST https://api.ap1.datadoghq.com/api/unstable/fleet/schedules | | ap2.datadoghq.com | POST https://api.ap2.datadoghq.com/api/unstable/fleet/schedules | | app.datadoghq.eu | POST https://api.datadoghq.eu/api/unstable/fleet/schedules | | app.ddog-gov.com | POST https://api.ddog-gov.com/api/unstable/fleet/schedules | | us2.ddog-gov.com | POST https://api.us2.ddog-gov.com/api/unstable/fleet/schedules | | app.datadoghq.com | POST https://api.datadoghq.com/api/unstable/fleet/schedules | | us3.datadoghq.com | POST https://api.us3.datadoghq.com/api/unstable/fleet/schedules | | us5.datadoghq.com | POST https://api.us5.datadoghq.com/api/unstable/fleet/schedules | ### Overview Create a new schedule for automated package upgrades. Schedules define when and how often to automatically deploy package upgrades to a fleet of hosts. Each schedule includes: - A filter query to select target hosts - A recurrence rule defining maintenance windows - A version strategy (e.g., always latest, or N versions behind latest) When the schedule triggers during a maintenance window, it automatically creates a deployment that upgrades the Datadog Agent to the specified version on all matching hosts. This endpoint requires the `agent_upgrade_write` permission. ### Request #### Body Data (required) Request payload containing the schedule details. {% tab title="Model" %} | Parent field | Field | Type | Description | | ------------ | --------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------- | | | data [*required*] | object | Data for creating a new schedule. | | data | attributes [*required*] | object | Attributes for creating a new schedule. | | attributes | name [*required*] | string | Human-readable name for the schedule. | | attributes | query [*required*] | string | Query used to filter and select target hosts for scheduled deployments. Uses the Datadog query syntax. | | attributes | rule [*required*] | object | Defines the recurrence pattern for the schedule. Specifies when deployments should be automatically triggered based on maintenance windows. | | rule | days_of_week [*required*] | [string] | List of days of the week when the schedule should trigger. Valid values are: "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun". | | rule | maintenance_window_duration [*required*] | int64 | Duration of the maintenance window in minutes. | | rule | start_maintenance_window [*required*] | string | Start time of the maintenance window in 24-hour clock format (HH:MM). Deployments will be triggered at this time on the specified days. | | rule | timezone [*required*] | string | Timezone for the schedule in IANA Time Zone Database format (e.g., "America/New_York", "UTC"). | | attributes | status | enum | The status of the schedule. | | attributes | version_to_latest | int64 | Number of major versions behind the latest to target for upgrades. | | data | type [*required*] | enum | The type of schedule resource. Allowed enum values: `schedule` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "name": "Weekly Production Agent Updates", "query": "env:prod AND service:web", "rule": { "days_of_week": [ "Mon", "Wed", "Fri" ], "maintenance_window_duration": 1200, "start_maintenance_window": "02:00", "timezone": "America/New_York" }, "status": "active", "version_to_latest": 0 }, "type": "schedule" } } ``` {% /tab %} ### Response {% tab title="201" %} CREATED {% tab title="Model" %} Response containing a single schedule. | Parent field | Field | Type | Description | | ------------ | --------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------- | | | data | object | A schedule that automatically creates deployments based on a recurrence rule. | | data | attributes [*required*] | object | Attributes of a schedule in the response. | | attributes | created_at_unix | int64 | Unix timestamp (seconds since epoch) when the schedule was created. | | attributes | created_by | string | User handle of the person who created the schedule. | | attributes | name | string | Human-readable name for the schedule. | | attributes | query | string | Query used to filter and select target hosts for scheduled deployments. Uses the Datadog query syntax. | | attributes | rule | object | Defines the recurrence pattern for the schedule. Specifies when deployments should be automatically triggered based on maintenance windows. | | rule | days_of_week [*required*] | [string] | List of days of the week when the schedule should trigger. Valid values are: "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun". | | rule | maintenance_window_duration [*required*] | int64 | Duration of the maintenance window in minutes. | | rule | start_maintenance_window [*required*] | string | Start time of the maintenance window in 24-hour clock format (HH:MM). Deployments will be triggered at this time on the specified days. | | rule | timezone [*required*] | string | Timezone for the schedule in IANA Time Zone Database format (e.g., "America/New_York", "UTC"). | | attributes | status | enum | The status of the schedule. | | attributes | updated_at_unix | int64 | Unix timestamp (seconds since epoch) when the schedule was last updated. | | attributes | updated_by | string | User handle of the person who last updated the schedule. | | attributes | version_to_latest | int64 | Number of major versions behind the latest to target for upgrades. | | data | id [*required*] | string | Unique identifier for the schedule. | | data | type [*required*] | enum | The type of schedule resource. Allowed enum values: `schedule` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "created_at_unix": 1699999999, "created_by": "user@example.com", "name": "Weekly Production Agent Updates", "query": "env:prod AND service:web", "rule": { "days_of_week": [ "Mon", "Wed", "Fri" ], "maintenance_window_duration": 1200, "start_maintenance_window": "02:00", "timezone": "America/New_York" }, "status": "active", "updated_at_unix": 1699999999, "updated_by": "user@example.com", "version_to_latest": 0 }, "id": "abc-def-ghi-123", "type": "schedule" } } ``` {% /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="401" %} Unauthorized {% 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="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 ##### \## Conservative staging updates (N-1 version) # \# Curl command curl -X POST "https://api.datadoghq.com/api/unstable/fleet/schedules" \ -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": { "name": "Staging Environment - Conservative Updates", "query": "env:staging", "rule": { "days_of_week": [ "Fri" ], "maintenance_window_duration": 240, "start_maintenance_window": "22:00", "timezone": "UTC" }, "status": "active", "version_to_latest": 1 }, "type": "schedule" } } EOF \## default # \# Curl command curl -X POST "https://api.datadoghq.com/api/unstable/fleet/schedules" \ -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": { "name": "Weekly Production Agent Updates", "query": "env:prod", "rule": { "days_of_week": [ "Mon", "Wed" ], "maintenance_window_duration": 180, "start_maintenance_window": "02:00", "timezone": "America/New_York" }, "status": "active", "version_to_latest": 0 }, "type": "schedule" } } EOF \## Weekly production agent updates # \# Curl command curl -X POST "https://api.datadoghq.com/api/unstable/fleet/schedules" \ -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": { "name": "Weekly Production Agent Updates", "query": "env:prod", "rule": { "days_of_week": [ "Mon", "Wed" ], "maintenance_window_duration": 180, "start_maintenance_window": "02:00", "timezone": "America/New_York" }, "status": "active", "version_to_latest": 0 }, "type": "schedule" } } EOF ##### ```python """ Create a schedule returns "CREATED" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.fleet_automation_api import FleetAutomationApi from datadog_api_client.v2.model.fleet_schedule_create import FleetScheduleCreate from datadog_api_client.v2.model.fleet_schedule_create_attributes import FleetScheduleCreateAttributes from datadog_api_client.v2.model.fleet_schedule_create_request import FleetScheduleCreateRequest from datadog_api_client.v2.model.fleet_schedule_recurrence_rule import FleetScheduleRecurrenceRule from datadog_api_client.v2.model.fleet_schedule_resource_type import FleetScheduleResourceType from datadog_api_client.v2.model.fleet_schedule_status import FleetScheduleStatus body = FleetScheduleCreateRequest( data=FleetScheduleCreate( attributes=FleetScheduleCreateAttributes( name="Weekly Production Agent Updates", query="env:prod AND service:web", rule=FleetScheduleRecurrenceRule( days_of_week=[ "Mon", "Wed", "Fri", ], maintenance_window_duration=1200, start_maintenance_window="02:00", timezone="America/New_York", ), status=FleetScheduleStatus.ACTIVE, version_to_latest=0, ), type=FleetScheduleResourceType.SCHEDULE, ), ) configuration = Configuration() configuration.unstable_operations["create_fleet_schedule"] = True with ApiClient(configuration) as api_client: api_instance = FleetAutomationApi(api_client) response = api_instance.create_fleet_schedule(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 # Create a schedule returns "CREATED" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.unstable_operations["v2.create_fleet_schedule".to_sym] = true end api_instance = DatadogAPIClient::V2::FleetAutomationAPI.new body = DatadogAPIClient::V2::FleetScheduleCreateRequest.new({ data: DatadogAPIClient::V2::FleetScheduleCreate.new({ attributes: DatadogAPIClient::V2::FleetScheduleCreateAttributes.new({ name: "Weekly Production Agent Updates", query: "env:prod AND service:web", rule: DatadogAPIClient::V2::FleetScheduleRecurrenceRule.new({ days_of_week: [ "Mon", "Wed", "Fri", ], maintenance_window_duration: 1200, start_maintenance_window: "02:00", timezone: "America/New_York", }), status: DatadogAPIClient::V2::FleetScheduleStatus::ACTIVE, version_to_latest: 0, }), type: DatadogAPIClient::V2::FleetScheduleResourceType::SCHEDULE, }), }) p api_instance.create_fleet_schedule(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 // Create a schedule returns "CREATED" 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" ) func main() { body := datadogV2.FleetScheduleCreateRequest{ Data: datadogV2.FleetScheduleCreate{ Attributes: datadogV2.FleetScheduleCreateAttributes{ Name: "Weekly Production Agent Updates", Query: "env:prod AND service:web", Rule: datadogV2.FleetScheduleRecurrenceRule{ DaysOfWeek: []string{ "Mon", "Wed", "Fri", }, MaintenanceWindowDuration: 1200, StartMaintenanceWindow: "02:00", Timezone: "America/New_York", }, Status: datadogV2.FLEETSCHEDULESTATUS_ACTIVE.Ptr(), VersionToLatest: datadog.PtrInt64(0), }, Type: datadogV2.FLEETSCHEDULERESOURCETYPE_SCHEDULE, }, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() configuration.SetUnstableOperationEnabled("v2.CreateFleetSchedule", true) apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewFleetAutomationApi(apiClient) resp, r, err := api.CreateFleetSchedule(ctx, body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `FleetAutomationApi.CreateFleetSchedule`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `FleetAutomationApi.CreateFleetSchedule`:\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 // Create a schedule returns "CREATED" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.FleetAutomationApi; import com.datadog.api.client.v2.model.FleetScheduleCreate; import com.datadog.api.client.v2.model.FleetScheduleCreateAttributes; import com.datadog.api.client.v2.model.FleetScheduleCreateRequest; import com.datadog.api.client.v2.model.FleetScheduleRecurrenceRule; import com.datadog.api.client.v2.model.FleetScheduleResourceType; import com.datadog.api.client.v2.model.FleetScheduleResponse; import com.datadog.api.client.v2.model.FleetScheduleStatus; import java.util.Arrays; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setUnstableOperationEnabled("v2.createFleetSchedule", true); FleetAutomationApi apiInstance = new FleetAutomationApi(defaultClient); FleetScheduleCreateRequest body = new FleetScheduleCreateRequest() .data( new FleetScheduleCreate() .attributes( new FleetScheduleCreateAttributes() .name("Weekly Production Agent Updates") .query("env:prod AND service:web") .rule( new FleetScheduleRecurrenceRule() .daysOfWeek(Arrays.asList("Mon", "Wed", "Fri")) .maintenanceWindowDuration(1200L) .startMaintenanceWindow("02:00") .timezone("America/New_York")) .status(FleetScheduleStatus.ACTIVE) .versionToLatest(0L)) .type(FleetScheduleResourceType.SCHEDULE)); try { FleetScheduleResponse result = apiInstance.createFleetSchedule(body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling FleetAutomationApi#createFleetSchedule"); 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 // Create a schedule returns "CREATED" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_fleet_automation::FleetAutomationAPI; use datadog_api_client::datadogV2::model::FleetScheduleCreate; use datadog_api_client::datadogV2::model::FleetScheduleCreateAttributes; use datadog_api_client::datadogV2::model::FleetScheduleCreateRequest; use datadog_api_client::datadogV2::model::FleetScheduleRecurrenceRule; use datadog_api_client::datadogV2::model::FleetScheduleResourceType; use datadog_api_client::datadogV2::model::FleetScheduleStatus; #[tokio::main] async fn main() { let body = FleetScheduleCreateRequest::new(FleetScheduleCreate::new( FleetScheduleCreateAttributes::new( "Weekly Production Agent Updates".to_string(), "env:prod AND service:web".to_string(), FleetScheduleRecurrenceRule::new( vec!["Mon".to_string(), "Wed".to_string(), "Fri".to_string()], 1200, "02:00".to_string(), "America/New_York".to_string(), ), ) .status(FleetScheduleStatus::ACTIVE) .version_to_latest(0), FleetScheduleResourceType::SCHEDULE, )); let mut configuration = datadog::Configuration::new(); configuration.set_unstable_operation_enabled("v2.CreateFleetSchedule", true); let api = FleetAutomationAPI::with_config(configuration); let resp = api.create_fleet_schedule(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 /** * Create a schedule returns "CREATED" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); configuration.unstableOperations["v2.createFleetSchedule"] = true; const apiInstance = new v2.FleetAutomationApi(configuration); const params: v2.FleetAutomationApiCreateFleetScheduleRequest = { body: { data: { attributes: { name: "Weekly Production Agent Updates", query: "env:prod AND service:web", rule: { daysOfWeek: ["Mon", "Wed", "Fri"], maintenanceWindowDuration: 1200, startMaintenanceWindow: "02:00", timezone: "America/New_York", }, status: "active", versionToLatest: 0, }, type: "schedule", }, }, }; apiInstance .createFleetSchedule(params) .then((data: v2.FleetScheduleResponse) => { 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 %}