Class OnCallApi

Hierarchy

OnCallApi

Index

Constructors

Properties

configuration requestFactory responseProcessor

Methods

createOnCallEscalationPolicy createOnCallSchedule deleteOnCallEscalationPolicy deleteOnCallSchedule getOnCallEscalationPolicy getOnCallSchedule getOnCallTeamRoutingRules getScheduleOnCallUser getTeamOnCallUsers setOnCallTeamRoutingRules updateOnCallEscalationPolicy updateOnCallSchedule

Constructors

constructor

new OnCallApi(configuration: Configuration, requestFactory?: OnCallApiRequestFactory, responseProcessor?: OnCallApiResponseProcessor): OnCallApi
Parameters
- configuration: Configuration
- Optional requestFactory: OnCallApiRequestFactory
- Optional responseProcessor: OnCallApiResponseProcessor
Returns OnCallApi
- Defined in packages/datadog-api-client-v2/apis/OnCallApi.ts:1519

Properties

`Private` configuration

configuration: Configuration

`Private` requestFactory

requestFactory: OnCallApiRequestFactory

`Private` responseProcessor

responseProcessor: OnCallApiResponseProcessor

Methods

createOnCallEscalationPolicy

createOnCallEscalationPolicy(param: OnCallApiCreateOnCallEscalationPolicyRequest, options?: Configuration): Promise<EscalationPolicy>
Create a new On-Call escalation policy
Parameters
- param: OnCallApiCreateOnCallEscalationPolicyRequest
  
  The request object
- Optional options: Configuration
Returns Promise<EscalationPolicy>
- Defined in packages/datadog-api-client-v2/apis/OnCallApi.ts:1535

createOnCallSchedule

createOnCallSchedule(param: OnCallApiCreateOnCallScheduleRequest, options?: Configuration): Promise<Schedule>
Create a new On-Call schedule
Parameters
- param: OnCallApiCreateOnCallScheduleRequest
  
  The request object
- Optional options: Configuration
Returns Promise<Schedule>
- Defined in packages/datadog-api-client-v2/apis/OnCallApi.ts:1560

deleteOnCallEscalationPolicy

deleteOnCallEscalationPolicy(param: OnCallApiDeleteOnCallEscalationPolicyRequest, options?: Configuration): Promise<void>
Delete an On-Call escalation policy
Parameters
- param: OnCallApiDeleteOnCallEscalationPolicyRequest
  
  The request object
- Optional options: Configuration
Returns Promise<void>
- Defined in packages/datadog-api-client-v2/apis/OnCallApi.ts:1582

deleteOnCallSchedule

deleteOnCallSchedule(param: OnCallApiDeleteOnCallScheduleRequest, options?: Configuration): Promise<void>
Delete an On-Call schedule
Parameters
- param: OnCallApiDeleteOnCallScheduleRequest
  
  The request object
- Optional options: Configuration
Returns Promise<void>
- Defined in packages/datadog-api-client-v2/apis/OnCallApi.ts:1603

getOnCallEscalationPolicy

getOnCallEscalationPolicy(param: OnCallApiGetOnCallEscalationPolicyRequest, options?: Configuration): Promise<EscalationPolicy>
Get an On-Call escalation policy
Parameters
- param: OnCallApiGetOnCallEscalationPolicyRequest
  
  The request object
- Optional options: Configuration
Returns Promise<EscalationPolicy>
- Defined in packages/datadog-api-client-v2/apis/OnCallApi.ts:1624

getOnCallSchedule

getOnCallSchedule(param: OnCallApiGetOnCallScheduleRequest, options?: Configuration): Promise<Schedule>
Get an On-Call schedule
Parameters
- param: OnCallApiGetOnCallScheduleRequest
  
  The request object
- Optional options: Configuration
Returns Promise<Schedule>
- Defined in packages/datadog-api-client-v2/apis/OnCallApi.ts:1648

getOnCallTeamRoutingRules

getOnCallTeamRoutingRules(param: OnCallApiGetOnCallTeamRoutingRulesRequest, options?: Configuration): Promise<TeamRoutingRules>
Get a team's On-Call routing rules
Parameters
- param: OnCallApiGetOnCallTeamRoutingRulesRequest
  
  The request object
- Optional options: Configuration
Returns Promise<TeamRoutingRules>
- Defined in packages/datadog-api-client-v2/apis/OnCallApi.ts:1670

getScheduleOnCallUser

getScheduleOnCallUser(param: OnCallApiGetScheduleOnCallUserRequest, options?: Configuration): Promise<Shift>
Retrieves the user who is on-call for the specified schedule at a given time.
Parameters
- param: OnCallApiGetScheduleOnCallUserRequest
  
  The request object
- Optional options: Configuration
Returns Promise<Shift>
- Defined in packages/datadog-api-client-v2/apis/OnCallApi.ts:1694

getTeamOnCallUsers

getTeamOnCallUsers(param: OnCallApiGetTeamOnCallUsersRequest, options?: Configuration): Promise<TeamOnCallResponders>
Get a team's on-call users at a given time
Parameters
- param: OnCallApiGetTeamOnCallUsersRequest
  
  The request object
- Optional options: Configuration
Returns Promise<TeamOnCallResponders>
- Defined in packages/datadog-api-client-v2/apis/OnCallApi.ts:1717

setOnCallTeamRoutingRules

setOnCallTeamRoutingRules(param: OnCallApiSetOnCallTeamRoutingRulesRequest, options?: Configuration): Promise<TeamRoutingRules>
Set a team's On-Call routing rules
Parameters
- param: OnCallApiSetOnCallTeamRoutingRulesRequest
  
  The request object
- Optional options: Configuration
Returns Promise<TeamRoutingRules>
- Defined in packages/datadog-api-client-v2/apis/OnCallApi.ts:1739

updateOnCallEscalationPolicy

updateOnCallEscalationPolicy(param: OnCallApiUpdateOnCallEscalationPolicyRequest, options?: Configuration): Promise<EscalationPolicy>
Update an On-Call escalation policy
Parameters
- param: OnCallApiUpdateOnCallEscalationPolicyRequest
  
  The request object
- Optional options: Configuration
Returns Promise<EscalationPolicy>
- Defined in packages/datadog-api-client-v2/apis/OnCallApi.ts:1764

updateOnCallSchedule

updateOnCallSchedule(param: OnCallApiUpdateOnCallScheduleRequest, options?: Configuration): Promise<Schedule>
Update a new On-Call schedule
Parameters
- param: OnCallApiUpdateOnCallScheduleRequest
  
  The request object
- Optional options: Configuration
Returns Promise<Schedule>
- Defined in packages/datadog-api-client-v2/apis/OnCallApi.ts:1790

Generated using TypeDoc