The identity and technical contract details declared by the specification.
UsersType
string
Users resource type.
ScheduleMemberRelationshipsUserDataType
string
Users resource type.
DowntimeScheduleRecurrencesCreateRequest
object
A recurring downtime schedule definition.
2 properties
1 required
DowntimeRelationshipsMonitorData
object
Data for the monitor.
2 properties
DowntimeScheduleCurrentDowntimeResponse
object
The most recent actual start and end dates for a recurring downtime. For a canceled downtime, this is the previously occurring downtime. For active downtimes,…
2 properties
DowntimeScheduleResponse
The schedule that defines when the monitor starts, stops, and recurs. There are two types of schedules: one-time and recurring. Recurring schedules may have up…
DowntimeRelationshipsCreatedByData
object
Data for the user who created the downtime.
2 properties
ScheduleMemberRelationshipsUserData
object
Points to the user data associated with this schedule member, including an ID and type.
2 properties
2 required
ScheduleRequestDataAttributesLayersItemsMembersItemsUser
object
Identifies the user participating in this layer as a single object with an id.
1 property
DowntimeScheduleRecurrenceCreateUpdateRequest
object
An object defining the recurrence of the downtime.
3 properties
2 required
UserAttributes
object
Attributes of user object returned by the API.
12 properties
ScheduleDataAttributes
object
Provides core properties of a schedule object such as its name and time zone.
2 properties
ScheduleUpdateRequestDataAttributesLayersItems
object
Represents a layer within a schedule update, including rotation details, members, and optional restrictions.
8 properties
5 required
LayerAttributesInterval
object
Defines how often the rotation repeats, using a combination of days and optional seconds.
2 properties
DowntimeScheduleRecurrenceRrule
string
The RRULE standard for defining recurring events. For example, to have a recurring event on the first day of each month, set the type to rrule and set the FREQ…
DowntimeIncludedMonitorType
string
Monitor resource type.
UserAttributesStatus
string
The user's status.
ScheduleMemberRelationshipsUser
object
Wraps the user data reference for a schedule member.
1 property
1 required
LayerType
string
Layers resource type.
DataRelationshipsTeams
object
Associates teams with this schedule in a data structure.
1 property
ScheduleDataRelationshipsLayersDataItems
object
Relates a layer to this schedule, identified by id and type (must be layers).
2 properties
2 required
ScheduleCreateRequestDataAttributesLayersItems
object
Describes a schedule layer, including rotation intervals, members, restrictions, and timeline settings.
7 properties
5 required
User
object
User object returned by the API.
4 properties
LayerAttributes
object
Describes key properties of a Layer, including rotation details, name, start/end times, and any restrictions.
6 properties
ScheduleCreateRequestDataRelationships
object
Gathers relationship objects for the schedule creation request, including the teams to associate.
1 property
ScheduleMemberRelationships
object
Defines relationships for a schedule member, primarily referencing a single user.
1 property
ScheduleUpdateRequestDataAttributes
object
Defines the updatable attributes for a schedule, such as name, time zone, and layers.
3 properties
3 required
DowntimeDisplayTimezone
string
The timezone in which to display the downtime's start and end times in Datadog applications. This is not used as an offset for scheduling.
ScheduleDataRelationshipsLayersDataItemsType
string
Layers resource type.
DowntimeResponseAttributes
object
Downtime details.
12 properties
RelationshipToOrganization
object
Relationship to an organization.
1 property
1 required
DowntimeCreateRequestAttributes
object
Downtime details.
8 properties
2 required
ScheduleDataRelationshipsLayers
object
Associates layers with this schedule in a data structure.
1 property
RelationshipToUserData
object
Relationship to user object.
2 properties
2 required
DataRelationshipsTeamsDataItemsType
string
Teams resource type.
TimeRestriction
object
Defines a single time restriction rule with start and end times and the applicable weekdays.
4 properties
ScheduleCreateRequest
object
The top-level request body for schedule creation, wrapping a data object.
1 property
1 required
DowntimeMessage
string
A message to include with notifications for this downtime. Email notifications can be sent to specific users by using the same @username notation as events.
ShiftDataRelationships
object
The definition of ShiftDataRelationships object.
1 property
ShiftDataAttributes
object
The definition of ShiftDataAttributes object.
2 properties
ShiftDataType
string
Indicates that the resource is of type 'shifts'.
ScheduleDataIncludedItem
Any additional resources related to this schedule, such as teams and layers.
ShiftDataRelationshipsUserData
object
Represents a reference to the user assigned to this shift, containing the user's ID and resource type.
2 properties
2 required
LayerRelationshipsMembers
object
Holds an array of references to the members of a Layer, each containing member IDs.
1 property
ScheduleUpdateRequestDataType
string
Schedules resource type.
ScheduleUser
object
Represents a user object in the context of a schedule, including their id, type, and basic attributes.
3 properties
1 required
DowntimeMuteFirstRecoveryNotification
boolean
If the first recovery notification during a downtime should be muted.
Schedule
object
Top-level container for a schedule object, including both the data payload and any related included resources (such as teams, layers, or members).
2 properties
DowntimeCreateRequest
object
Request for creating a downtime.
1 property
1 required
ShiftIncluded
The definition of ShiftIncluded object.
ScheduleDataRelationships
object
Groups the relationships for a schedule object, referencing layers and teams.
2 properties
DowntimeScheduleRecurrenceDuration
string
The length of the downtime. Must begin with an integer and end with one of 'm', 'h', d', or 'w'.
ScheduleUpdateRequestDataRelationships
object
Houses relationships for the schedule update, typically referencing teams.
1 property
TeamReference
object
Provides a reference to a team, including ID, type, and basic attributes/relationships.
3 properties
1 required
DowntimeScheduleRecurrenceResponse
object
An RRULE-based recurring downtime.
3 properties
DowntimeMonitorIdentifier
Monitor identifier for the downtime.
ScheduleMember
object
Represents a single member entry in a schedule, referencing a specific user.
3 properties
1 required
OrganizationsType
string
Organizations resource type.
TeamReferenceAttributes
object
Encapsulates the basic attributes of a Team reference, such as name, handle, and an optional avatar or description.
4 properties
DowntimeMonitorIncludedAttributes
object
Attributes of the monitor identified by the downtime.
1 property
ShiftData
object
The definition of ShiftData object.
4 properties
1 required
ScheduleDataType
string
Schedules resource type.
ScheduleUserType
string
Users resource type.
DowntimeResponseData
object
Downtime data.
4 properties
ScheduleUpdateRequestData
object
Contains all data needed to update an existing schedule, including its attributes (such as name and time zone) and any relationships to teams.
4 properties
3 required
Weekday
string
A day of the week.
DowntimeRelationshipsCreatedBy
object
The user who created the downtime.
1 property
APIErrorResponse
object
API error response.
1 property
1 required
DowntimeNotifyEndStates
array
States that will trigger a monitor notification when the notifyendtypes action occurs.
UserResponseRelationships
object
Relationships of the user object returned by the API.
4 properties
Layer
object
Encapsulates a layer resource, holding attributes like rotation details, plus relationships to the members covering that layer.
4 properties
1 required
DowntimeMonitorIncludedItem
object
Information about the monitor identified by the downtime.
3 properties
Shift
object
The definition of Shift object.
2 properties
LayerRelationshipsMembersDataItemsType
string
Members resource type.
ScheduleCreateRequestDataAttributes
object
Describes the main attributes for creating a new schedule, including name, layers, and time zone.
3 properties
3 required
DowntimeScheduleCreateRequest
Schedule for the downtime.
DowntimeMonitorIdentifierTags
object
Object of the monitor tags.
1 property
1 required
DowntimeRelationships
object
All relationships associated with downtime.
2 properties
RelationshipToRoleData
object
Relationship to role object.
2 properties
RelationshipToOrganizationData
object
Relationship to organization object.
2 properties
2 required
ScheduleData
object
Represents the primary data object for a schedule, linking attributes and relationships.
4 properties
1 required
DowntimeRelationshipsMonitor
object
The monitor identified by the downtime.
1 property
DowntimeNotifyEndStateActions
string
Action that will trigger a monitor notification if the downtime is in the notifyendtypes state.
RelationshipToUsers
object
Relationship to users.
1 property
1 required
DowntimeNotifyEndTypes
array
Actions that will trigger a monitor notification if the downtime is in the notifyendtypes state.
DataRelationshipsTeamsDataItems
object
Relates a team to this schedule, identified by id and type (must be teams).
2 properties
2 required
ScheduleRequestDataAttributesLayersItemsMembersItems
object
Defines a single member within a schedule layer, including the reference to the underlying user.
1 property
DowntimeResourceType
string
Downtime resource type.
ScheduleUserAttributes
object
Provides basic user information for a schedule, including a name and email address.
3 properties
DowntimeMonitorIdentifierId
object
Object of the monitor identifier.
1 property
1 required
LayerRelationshipsMembersDataItems
object
Represents a single member object in a layer's members array, referencing a unique Datadog user ID.
2 properties
2 required
RelationshipToRoles
object
Relationship to roles.
1 property
DowntimeScheduleOneTimeCreateUpdateRequest
object
A one-time downtime definition.
2 properties
ScheduleCreateRequestData
object
The core data wrapper for creating a schedule, encompassing attributes, relationships, and the resource type.
3 properties
2 required
RelationshipToOrganizations
object
Relationship to organizations.
1 property
1 required
ScheduleCreateRequestDataType
string
Schedules resource type.
ShiftDataRelationshipsUserDataType
string
Indicates that the related resource is of type 'users'.
ScheduleMemberType
string
Schedule Members resource type.
DowntimeResponse
object
Downtiming gives you greater control over monitor notifications by allowing you to globally exclude scopes from alerting. Downtime settings, which can be sched…
2 properties
DowntimeStatus
string
The current status of the downtime.
LayerRelationships
object
Holds references to objects related to the Layer entity, such as its members.
1 property
DowntimeNotifyEndStateTypes
string
State that will trigger a monitor notification when the notifyendtypes action occurs.
DowntimeScheduleRecurrencesResponse
object
A recurring downtime schedule definition.
3 properties
1 required
DowntimeCreateRequestData
object
Object to create a downtime.
2 properties
2 required
DowntimeScheduleOneTimeResponse
object
A one-time downtime definition.
2 properties
1 required
ShiftDataRelationshipsUser
object
Defines the relationship between a shift and the user who is working that shift.
1 property
1 required
DowntimeResponseIncludedItem
An object related to a downtime.
DowntimeScope
string
The scope to which the downtime applies. Must follow the [common search syntax](https://docs.datadoghq.com/logs/explorer/searchsyntax/).
RolesType
string
Roles type.
ScheduleUpdateRequest
object
A top-level wrapper for a schedule update request, referring to the data object with the new details.
1 property
1 required
TeamReferenceType
string
Teams resource type.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Datadog publishes across the network.
