The identity and technical contract details declared by the specification.
Weekday
string
A day of the week.
DowntimeScheduleRecurrencesCreateRequest
object
A recurring downtime schedule definition.
2 properties
1 required
ScheduleUpdateRequestDataRelationships
object
Houses relationships for the schedule update, typically referencing teams.
1 property
APIErrorResponse
object
API error response.
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
ScheduleUpdateRequestDataType
string
Schedules resource type.
DowntimeMonitorIncludedItem
object
Information about the monitor identified by the downtime.
3 properties
ScheduleDataRelationshipsLayers
object
Associates layers with this schedule in a data structure.
1 property
DowntimeCreateRequestData
object
Object to create a downtime.
2 properties
2 required
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
ScheduleMemberType
string
Schedule Members resource type.
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
UserAttributesStatus
string
The user's status.
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…
ScheduleUserType
string
Users resource type.
ScheduleRequestDataAttributesLayersItemsMembersItems
object
Defines a single member within a schedule layer, including the reference to the underlying user.
1 property
Layer
object
Encapsulates a layer resource, holding attributes like rotation details, plus relationships to the members covering that layer.
4 properties
1 required
DowntimeMonitorIdentifierTags
object
Object of the monitor tags.
1 property
1 required
DowntimeScheduleRecurrenceResponse
object
An RRULE-based recurring downtime.
3 properties
TeamReferenceType
string
Teams resource type.
DowntimeCreateRequest
object
Request for creating a downtime.
1 property
1 required
ScheduleRequestDataAttributesLayersItemsMembersItemsUser
object
Identifies the user participating in this layer as a single object with an id.
1 property
DowntimeScheduleOneTimeResponse
object
A one-time downtime definition.
2 properties
1 required
DowntimeRelationshipsCreatedBy
object
The user who created the downtime.
1 property
DowntimeScheduleRecurrenceDuration
string
The length of the downtime. Must begin with an integer and end with one of 'm', 'h', d', or 'w'.
ScheduleMemberRelationshipsUser
object
Wraps the user data reference for a schedule member.
1 property
1 required
LayerType
string
Layers resource type.
RelationshipToUserData
object
Relationship to user object.
2 properties
2 required
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
ScheduleData
object
Represents the primary data object for a schedule, linking attributes and relationships.
4 properties
1 required
DowntimeNotifyEndStates
array
States that will trigger a monitor notification when the notifyendtypes action occurs.
DataRelationshipsTeamsDataItemsType
string
Teams resource type.
RelationshipToOrganizationData
object
Relationship to organization object.
2 properties
2 required
DowntimeDisplayTimezone
stringnull
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.
ScheduleUserAttributes
object
Provides basic user information for a schedule, including a name and email address.
3 properties
TeamReferenceAttributes
object
Encapsulates the basic attributes of a Team reference, such as name, handle, and an optional avatar or description.
4 properties
DowntimeCreateRequestAttributes
object
Downtime details.
8 properties
2 required
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…
DowntimeScheduleCreateRequest
Schedule for the downtime.
LayerRelationshipsMembersDataItems
object
Represents a single member object in a layer's members array, referencing a unique Datadog user ID.
2 properties
2 required
DowntimeResourceType
string
Downtime resource type.
RolesType
string
Roles type.
DowntimeIncludedMonitorType
string
Monitor 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
TeamReference
object
Provides a reference to a team, including ID, type, and basic attributes/relationships.
3 properties
1 required
OrganizationsType
string
Organizations resource type.
UserResponseRelationships
object
Relationships of the user object returned by the API.
4 properties
ScheduleMemberRelationshipsUserData
object
Points to the user data associated with this schedule member, including an ID and type.
2 properties
2 required
RelationshipToOrganization
object
Relationship to an organization.
1 property
1 required
ScheduleDataType
string
Schedules resource type.
TimeRestriction
object
Defines a single time restriction rule with start and end times and the applicable weekdays.
4 properties
ScheduleDataRelationshipsLayersDataItems
object
Relates a layer to this schedule, identified by id and type (must be layers).
2 properties
2 required
DowntimeMonitorIdentifierId
object
Object of the monitor identifier.
1 property
1 required
ScheduleDataRelationshipsLayersDataItemsType
string
Layers resource type.
DataRelationshipsTeams
object
Associates teams with this schedule in a data structure.
1 property
RelationshipToOrganizations
object
Relationship to organizations.
1 property
1 required
DowntimeStatus
string
The current status of the downtime.
DowntimeScheduleRecurrencesResponse
object
A recurring downtime schedule definition.
3 properties
1 required
UserAttributes
object
Attributes of user object returned by the API.
12 properties
DowntimeRelationshipsCreatedByData
objectnull
Data for the user who created the downtime.
2 properties
ScheduleDataRelationships
object
Groups the relationships for a schedule object, referencing layers and teams.
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
DowntimeRelationshipsMonitor
object
The monitor identified by the downtime.
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
User
object
User object returned by the API.
4 properties
RelationshipToRoleData
object
Relationship to role object.
2 properties
LayerRelationships
object
Holds references to objects related to the Layer entity, such as its members.
1 property
DowntimeScope
string
The scope to which the downtime applies. Must follow the [common search syntax](https://docs.datadoghq.com/logs/explorer/searchsyntax/).
UsersType
string
Users resource type.
DowntimeResponseIncludedItem
An object related to a downtime.
ScheduleUpdateRequestDataAttributesLayersItems
object
Represents a layer within a schedule update, including rotation details, members, and optional restrictions.
8 properties
5 required
DowntimeRelationshipsMonitorData
objectnull
Data for the monitor.
2 properties
ScheduleDataIncludedItem
Any additional resources related to this schedule, such as teams and layers.
DowntimeScheduleRecurrenceCreateUpdateRequest
object
An object defining the recurrence of the downtime.
3 properties
2 required
DowntimeRelationships
object
All relationships associated with downtime.
2 properties
DowntimeMonitorIdentifier
Monitor identifier for the downtime.
ScheduleUpdateRequest
object
A top-level wrapper for a schedule update request, referring to the data object with the new details.
1 property
1 required
DowntimeMonitorIncludedAttributes
object
Attributes of 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.
LayerRelationshipsMembers
object
Holds an array of references to the members of a Layer, each containing member IDs.
1 property
ScheduleMember
object
Represents a single member entry in a schedule, referencing a specific user.
3 properties
1 required
DowntimeResponseAttributes
object
Downtime details.
12 properties
DowntimeMuteFirstRecoveryNotification
boolean
If the first recovery notification during a downtime should be muted.
RelationshipToUsers
object
Relationship to users.
1 property
1 required
LayerAttributes
object
Describes key properties of a Layer, including rotation details, name, start/end times, and any restrictions.
6 properties
LayerRelationshipsMembersDataItemsType
string
Members resource type.
RelationshipToRoles
object
Relationship to roles.
1 property
DowntimeNotifyEndStateTypes
string
State that will trigger a monitor notification when the notifyendtypes action occurs.
DowntimeMessage
stringnull
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.
LayerAttributesInterval
object
Defines how often the rotation repeats, using a combination of days and optional seconds.
2 properties
DowntimeScheduleOneTimeCreateUpdateRequest
object
A one-time downtime definition.
2 properties
DowntimeResponseData
object
Downtime data.
4 properties
ScheduleMemberRelationshipsUserDataType
string
Users resource type.
ScheduleDataAttributes
object
Provides core properties of a schedule object such as its name and time zone.
2 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Datadog publishes across the network.
