on_call_schedule_responders
Creates, updates, deletes, gets or lists an on_call_schedule_responders resource.
Overview
| Name | on_call_schedule_responders |
| Type | Resource |
| Id | datadog.service_management.on_call_schedule_responders |
Fields
The following fields are returned by SELECT queries:
- get_schedule_on_call_responders
| Name | Datatype | Description |
|---|---|---|
id | string | Unique identifier of this on-call responders lookup. |
attributes | object | Attributes for a schedule's on-call responders lookup. |
relationships | object | Relationships for a schedule's on-call responders lookup, including the schedule and its responder groups. |
type | string | Represents the resource type for a schedule's grouped on-call responders across the previous, current, and next positions. (schedule_oncall_responders) (default: schedule_oncall_responders, example: schedule_oncall_responders) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_schedule_on_call_responders | select | schedule_id | include, filter[position], filter[at_ts] | Retrieves the on-call responders for the specified schedule, grouped by position (previous, current, next), at a given time. Supports schedules with multiple concurrent on-call responders at a position, by returning a list of shifts per position. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
schedule_id | string | The ID of the schedule. |
site | string | The Datadog site (region) for your organization, for example datadoghq.com, us3.datadoghq.com, us5.datadoghq.com, ap1.datadoghq.com, ap2.datadoghq.com, datadoghq.eu, ddog-gov.com. Resolved from the DD_SITE environment variable when set. Optional: defaults to datadoghq.com, or the value of the DD_SITE environment variable when set; a WHERE value overrides both. |
filter[at_ts] | string | Retrieves the on-call responders at the given timestamp in RFC3339 format (for example, 2025-05-07T02:53:01Z or 2025-05-07T02:53:01+00:00). When using timezone offsets with + or -, ensure proper URL encoding (+ should be encoded as %2B). Defaults to the current time if omitted. |
filter[position] | string | Comma-separated list of positions to retrieve. Allowed values: previous, current, next. Defaults to current if omitted. |
include | string | Comma-separated list of included relationships to be returned. Allowed values: schedule, responders, responders.shifts, responders.shifts.user. |
SELECT examples
- get_schedule_on_call_responders
Retrieves the on-call responders for the specified schedule, grouped by position (previous, current, next), at a given time. Supports schedules with multiple concurrent on-call responders at a position, by returning a list of shifts per position.
SELECT
id,
attributes,
relationships,
type
FROM datadog.service_management.on_call_schedule_responders
WHERE schedule_id = '{{ schedule_id }}' -- required
AND include = '{{ include }}'
AND filter[position] = '{{ filter[position] }}'
AND filter[at_ts] = '{{ filter[at_ts] }}'
;