Datadog Policies API is one of 186 APIs that Datadog publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 4 JSON Schema definitions.
Tagged areas include Policies. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, an API reference, and 4 JSON Schemas.
This API exposes
3 operations
across 3 paths,
and defines 63 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against 3 base URLs: https://{subdomain}.{site}, {protocol}://{name}, https://{subdomain}.{site}.
The identity and technical contract details declared by the specification.
EscalationPolicyUpdateRequestData
object
Represents the data for updating an existing escalation policy, including its ID, attributes, relationships, and resource type.
4 properties
3 required
EscalationPolicyStepTargetType
string
Specifies the type of escalation target (example users, schedules, or teams).
EscalationPolicyDataRelationships
object
Represents the relationships for an escalation policy, including references to steps and teams.
2 properties
1 required
APIErrorResponse
object
API error response.
1 property
1 required
EscalationPolicyStep
object
Represents a single step in an escalation policy, including its attributes, relationships, and resource type.
4 properties
1 required
ScheduleDataRelationshipsLayersDataItemsType
string
Layers resource type.
EscalationPolicyDataAttributes
object
Defines the main attributes of an escalation policy, such as its name and behavior on policy end.
3 properties
1 required
CloudWorkloadSecurityAgentPolicyType
string
The type of the resource, must always be policy
DataRelationshipsTeams
object
Associates teams with this schedule in a data structure.
1 property
EscalationPolicyUser
object
Represents a user object in the context of an escalation policy, including their id, type, and basic attributes.
3 properties
1 required
EscalationPolicyDataRelationshipsSteps
object
Defines the relationship to a collection of steps within an escalation policy. Contains an array of step data references.
1 property
DataRelationshipsTeamsDataItems
object
Relates a team to this schedule, identified by id and type (must be teams).
2 properties
2 required
RestrictionPolicyAttributes
object
Restriction policy attributes.
1 property
1 required
RestrictionPolicyResponse
object
Response containing information about a single restriction policy.
1 property
1 required
CloudWorkloadSecurityAgentPolicyUpdateRequest
object
Request object that includes the Agent policy with the attributes to update
1 property
1 required
EscalationPolicyUpdateRequestDataRelationships
object
Represents relationships in an escalation policy update request, including references to teams.
1 property
TeamReferenceAttributes
object
Encapsulates the basic attributes of a Team reference, such as name, handle, and an optional avatar or description.
4 properties
UserTargetType
string
Indicates that the resource is of type users.
TeamTarget
object
Represents a team target for an escalation policy step, including the team's ID and resource type.
2 properties
2 required
EscalationPolicyUpdateRequestDataType
string
Indicates that the resource is of type policies.
ScheduleTargetType
string
Indicates that the resource is of type schedules.
ScheduleDataAttributes
object
Provides core properties of a schedule object such as its name and time zone.
2 properties
ScheduleDataRelationshipsLayers
object
Associates layers with this schedule in a data structure.
1 property
EscalationPolicyUpdateRequestDataAttributesStepsItems
object
Defines a single escalation step within an escalation policy update request. Contains assignment strategy, escalation timeout, an optional step ID, and a list…
4 properties
1 required
EscalationPolicyIncluded
Represents included related resources when retrieving an escalation policy, such as teams, steps, or targets.
RestrictionPolicy
object
Restriction policy object.
3 properties
3 required
EscalationTargets
object
A list of escalation targets for a step
1 property
CloudWorkloadSecurityAgentPolicyUpdaterAttributes
object
The attributes of the user who last updated the policy
2 properties
EscalationPolicyUserAttributes
object
Provides basic user information for an escalation policy, including a name and email address.
3 properties
CloudWorkloadSecurityAgentPolicyUpdateData
object
Object for a single Agent policy
3 properties
2 required
EscalationPolicyDataRelationshipsStepsDataItems
object
Defines a relationship to a single step within an escalation policy. Contains the step's id and type.
2 properties
2 required
CloudWorkloadSecurityAgentPolicyData
object
Object for a single Agent policy
3 properties
EscalationPolicyStepRelationships
object
Represents the relationship of an escalation policy step to its targets.
1 property
EscalationPolicyUpdateRequestDataAttributes
object
Defines the attributes that can be updated for an escalation policy, such as description, name, resolution behavior, retries, and steps.
4 properties
2 required
EscalationPolicyStepAttributes
object
Defines attributes for an escalation policy step, such as assignment strategy and escalation timeout.
2 properties
TeamTargetType
string
Indicates that the resource is of type teams.
ScheduleDataRelationshipsLayersDataItems
object
Relates a layer to this schedule, identified by id and type (must be layers).
2 properties
2 required
UserAttributesStatus
string
The user's status.
CloudWorkloadSecurityAgentPolicyUpdateAttributes
object
Update an existing Cloud Workload Security Agent policy
5 properties
EscalationTarget
Represents an escalation target, which can be a team, user, or schedule.
ScheduleDataRelationships
object
Groups the relationships for a schedule object, referencing layers and teams.
2 properties
EscalationPolicyData
object
Represents the data for a single escalation policy, including its attributes, ID, relationships, and resource type.
4 properties
1 required
RestrictionPolicyType
string
Restriction policy type.
EscalationPolicyDataRelationshipsStepsDataItemsType
string
Indicates that the resource is of type steps.
TeamReferenceType
string
Teams resource type.
CloudWorkloadSecurityAgentPolicyID
string
The ID of the Agent policy
UserTarget
object
Represents a user target for an escalation policy step, including the user's ID and resource type.
2 properties
2 required
EscalationPolicy
object
Represents a complete escalation policy response, including policy data and optionally included related resources.
2 properties
TeamReference
object
Provides a reference to a team, including ID, type, and basic attributes/relationships.
3 properties
1 required
EscalationPolicyStepTarget
object
Defines a single escalation target within a step for an escalation policy creation request. Contains id and type.
2 properties
RestrictionPolicyBinding
object
Specifies which principals are associated with a relation.
2 properties
2 required
EscalationPolicyUpdateRequest
object
Represents a request to update an existing escalation policy, including the updated policy data.
1 property
1 required
EscalationPolicyUserType
string
Users resource type.
ScheduleDataType
string
Schedules resource type.
EscalationPolicyStepAttributesAssignment
string
Specifies how this escalation step will assign targets (example default or round-robin).
EscalationPolicyDataType
string
Indicates that the resource is of type policies.
ScheduleTarget
object
Represents a schedule target for an escalation policy step, including its ID and resource type.
2 properties
2 required
CloudWorkloadSecurityAgentPolicyResponse
object
Response object that includes an Agent policy
1 property
RestrictionPolicyUpdateRequest
object
Update request for a restriction policy.
1 property
1 required
EscalationPolicyStepType
string
Indicates that the resource is of type steps.
ScheduleData
object
Represents the primary data object for a schedule, linking attributes and relationships.
4 properties
1 required
CloudWorkloadSecurityAgentPolicyAttributes
object
A Cloud Workload Security Agent policy returned by the API
15 properties
DataRelationshipsTeamsDataItemsType
string
Teams resource type.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Datadog publishes across the network.
