incident_services

Creates, updates, deletes, gets or lists an incident_services resource.

Overview

Name	incident_services
Type	Resource
Id	datadog.service_management.incident_services

Fields

The following fields are returned by SELECT queries:

get_incident_service

Name	Datatype	Description
id	string	The incident service's ID. (example: 00000000-0000-0000-0000-000000000000)
attributes	object	The incident service's attributes from a response.
relationships	object	The incident service's relationships.
type	string	Incident service resource type. (default: services, example: services)

list_incident_services

Name	Datatype	Description
id	string	The incident service's ID. (example: 00000000-0000-0000-0000-000000000000)
attributes	object	The incident service's attributes from a response.
relationships	object	The incident service's relationships.
type	string	Incident service resource type. (default: services, example: services)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_incident_service	select	service_id, region	include	Get details of an incident service. If the include[users] query parameter is provided, the included attribute will contain the users related to these incident services.
list_incident_services	select	region	include, page[size], page[offset], filter	Get all incident services uploaded for the requesting user's organization. If the include[users] query parameter is provided, the included attribute will contain the users related to these incident services.
create_incident_service	insert	region, data__data		Creates a new incident service.
update_incident_service	update	service_id, region, data__data		Updates an existing incident service. Only provide the attributes which should be updated as this request is a partial update.
delete_incident_service	delete	service_id, region		Deletes an existing incident service.

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
region	string	(default: datadoghq.com)
service_id	string	The ID of the incident service.
filter	string	A search query that filters services by name.
include	string	Specifies which types of related objects should be included in the response.
page[offset]	integer (int64)	Specific offset to use as the beginning of the returned page.
page[size]	integer (int64)	Size for a given page. The maximum allowed value is 100.

SELECT examples

get_incident_service

Get details of an incident service. If the include[users] query parameter is provided,
the included attribute will contain the users related to these incident services.

SELECT
id,
attributes,
relationships,
type
FROM datadog.service_management.incident_services
WHERE service_id = '{{ service_id }}' -- required
AND region = '{{ region }}' -- required
AND include = '{{ include }}'
;

list_incident_services

Get all incident services uploaded for the requesting user's organization. If the include[users] query parameter is provided, the included attribute will contain the users related to these incident services.

SELECT
id,
attributes,
relationships,
type
FROM datadog.service_management.incident_services
WHERE region = '{{ region }}' -- required
AND include = '{{ include }}'
AND page[size] = '{{ page[size] }}'
AND page[offset] = '{{ page[offset] }}'
AND filter = '{{ filter }}'
;

INSERT examples

create_incident_service

Creates a new incident service.

INSERT INTO datadog.service_management.incident_services (
data__data,
region
)
SELECT 
'{{ data }}' /* required */,
'{{ region }}'
RETURNING
data,
included
;

Manifest

# Description fields are for documentation purposes
- name: incident_services
  props:
    - name: region
      value: string
      description: Required parameter for the incident_services resource.
    - name: data
      value: object
      description: |
        Incident Service payload for create requests.

UPDATE examples

update_incident_service

Updates an existing incident service. Only provide the attributes which should be updated as this request is a partial update.

UPDATE datadog.service_management.incident_services
SET 
data__data = '{{ data }}'
WHERE 
service_id = '{{ service_id }}' --required
AND region = '{{ region }}' --required
AND data__data = '{{ data }}' --required
RETURNING
data,
included;

DELETE examples

delete_incident_service

Deletes an existing incident service.

DELETE FROM datadog.service_management.incident_services
WHERE service_id = '{{ service_id }}' --required
AND region = '{{ region }}' --required
;