incident_teams
Creates, updates, deletes, gets or lists an incident_teams
resource.
Overview
Name | incident_teams |
Type | Resource |
Id | datadog.service_management.incident_teams |
Fields
The following fields are returned by SELECT
queries:
- get_incident_team
- list_incident_teams
Name | Datatype | Description |
---|---|---|
id | string | The incident team's ID. (example: 00000000-7ea3-0000-000a-000000000000) |
attributes | object | The incident team's attributes from a response. |
relationships | object | The incident team's relationships. |
type | string | Incident Team resource type. (default: teams, example: teams) |
Name | Datatype | Description |
---|---|---|
id | string | The incident team's ID. (example: 00000000-7ea3-0000-000a-000000000000) |
attributes | object | The incident team's attributes from a response. |
relationships | object | The incident team's relationships. |
type | string | Incident Team resource type. (default: teams, example: teams) |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get_incident_team | select | team_id , region | include | Get details of an incident team. If the include[users] query parameter is provided,the included attribute will contain the users related to these incident teams. |
list_incident_teams | select | region | include , page[size] , page[offset] , filter | Get all incident teams 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 teams. |
create_incident_team | insert | region , data__data | Creates a new incident team. | |
update_incident_team | update | team_id , region , data__data | Updates an existing incident team. Only provide the attributes which should be updated as this request is a partial update. | |
delete_incident_team | delete | team_id , region | Deletes an existing incident team. |
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) |
team_id | string | The ID of the incident team. |
filter | string | A search query that filters teams 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_team
- list_incident_teams
Get details of an incident team. If the include[users]
query parameter is provided,
the included attribute will contain the users related to these incident teams.
SELECT
id,
attributes,
relationships,
type
FROM datadog.service_management.incident_teams
WHERE team_id = '{{ team_id }}' -- required
AND region = '{{ region }}' -- required
AND include = '{{ include }}'
;
Get all incident teams 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 teams.
SELECT
id,
attributes,
relationships,
type
FROM datadog.service_management.incident_teams
WHERE region = '{{ region }}' -- required
AND include = '{{ include }}'
AND page[size] = '{{ page[size] }}'
AND page[offset] = '{{ page[offset] }}'
AND filter = '{{ filter }}'
;
INSERT
examples
- create_incident_team
- Manifest
Creates a new incident team.
INSERT INTO datadog.service_management.incident_teams (
data__data,
region
)
SELECT
'{{ data }}' /* required */,
'{{ region }}'
RETURNING
data,
included
;
# Description fields are for documentation purposes
- name: incident_teams
props:
- name: region
value: string
description: Required parameter for the incident_teams resource.
- name: data
value: object
description: |
Incident Team data for a create request.
UPDATE
examples
- update_incident_team
Updates an existing incident team. Only provide the attributes which should be updated as this request is a partial update.
UPDATE datadog.service_management.incident_teams
SET
data__data = '{{ data }}'
WHERE
team_id = '{{ team_id }}' --required
AND region = '{{ region }}' --required
AND data__data = '{{ data }}' --required
RETURNING
data,
included;
DELETE
examples
- delete_incident_team
Deletes an existing incident team.
DELETE FROM datadog.service_management.incident_teams
WHERE team_id = '{{ team_id }}' --required
AND region = '{{ region }}' --required
;