- to:
- - perferendis
- cc: []
- bcc: []
- subject: Enim sunt non nemo.
- preheader: null
- body: updated
- include_header: true
- include_footer: true
- custom_logo_url: null
- name: Another name
- position: 2
- skip_on_failure: true
- enabled: false
- created_at: 2025-05-22T06:43:56.276-07:00
- updated_at: 2025-05-22T06:43:58.020-07:00
schema:
- $ref: '#/components/schemas/workflow_task_response'
- description: workflow_task updated
+ $ref: '#/components/schemas/escalation_policy_level_response'
+ description: escalation policy updated with notification_target set with
+ slack_channel_id instead of slack_channel uuid
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Update a workflow task
+ summary: Update an escalation level
tags:
- - WorkflowTasks
+ - EscalationLevels
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/workflows/{workflow_id}/custom_field_selections:
+ /v1/escalation_policies/{escalation_policy_id}/escalation_paths:
get:
- deprecated: true
- description: "[DEPRECATED] Use form field endpoints instead. List workflow custom\
- \ field selections"
- operationId: listWorkflowCustomFieldSelections
+ description: List escalation paths
+ operationId: listEscalationPaths
parameters:
- explode: false
in: path
- name: workflow_id
+ name: escalation_policy_id
required: true
schema:
type: string
style: simple
- - explode: true
+ - description: "comma separated if needed. eg: escalation_policy_levels"
+ explode: true
in: query
name: include
required: false
schema:
+ enum:
+ - escalation_policy_levels
type: string
style: form
- explode: true
@@ -12134,24 +8125,22 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/workflow_custom_field_selection_list'
+ $ref: '#/components/schemas/escalation_policy_path_list'
description: success
security:
- bearer_auth: []
- summary: "[DEPRECATED] List workflow custom field selections"
+ summary: List escalation paths
tags:
- - "[DEPRECATED] WorkflowCustomFieldSelections"
+ - EscalationPaths
x-accepts:
- application/vnd.api+json
post:
- deprecated: true
- description: "[DEPRECATED] Use form field endpoints instead. Creates a new workflow\
- \ custom field selection from provided data"
- operationId: createWorkflowCustomFieldSelection
+ description: Creates a new escalation path from provided data
+ operationId: createEscalationPath
parameters:
- explode: false
in: path
- name: workflow_id
+ name: escalation_policy_id
required: true
schema:
type: string
@@ -12160,49 +8149,39 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/new_workflow_custom_field_selection'
+ $ref: '#/components/schemas/new_escalation_policy_path'
required: true
responses:
"201":
content:
application/vnd.api+json:
- example:
- data:
- id: "2"
- type: workflow_custom_field_selections
- attributes:
- custom_field_id: 41
- workflow_id: 08e8662f-faf1-41ce-aef6-6e724cae1489
- incident_condition: ANY
- values: []
- selected_option_ids: []
schema:
- $ref: '#/components/schemas/workflow_custom_field_selection_response'
- description: workflow_custom_field_selection created
+ $ref: '#/components/schemas/escalation_policy_path_response'
+ description: escalation path created
+ "422":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: invalid request
"401":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
- description: responds with unauthorized for invalid token
+ description: resource not found
security:
- bearer_auth: []
- summary: "[DEPRECATED] Creates a workflow custom field selection"
+ summary: Creates an escalation path
tags:
- - "[DEPRECATED] WorkflowCustomFieldSelections"
+ - EscalationPaths
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/workflow_custom_field_selections/{id}:
+ /v1/escalation_paths/{id}:
delete:
- deprecated: true
- description: "[DEPRECATED] Use form field endpoints instead. Delete a specific\
- \ workflow custom field selection by id"
- operationId: deleteWorkflowCustomFieldSelection
+ description: Delete a specific escalation path by id
+ operationId: deleteEscalationPath
parameters:
- explode: false
in: path
@@ -12215,41 +8194,25 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: "1"
- type: workflow_custom_field_selections
- attributes:
- custom_field_id: 40
- workflow_id: 08e8662f-faf1-41ce-aef6-6e724cae1489
- incident_condition: ANY
- values: []
- selected_option_ids: []
schema:
- $ref: '#/components/schemas/workflow_custom_field_selection_response'
- description: workflow_custom_field_selection deleted
+ $ref: '#/components/schemas/escalation_policy_path_response'
+ description: escalation path deleted
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: "[DEPRECATED] Delete a workflow custom field selection"
+ summary: Delete an escalation path
tags:
- - "[DEPRECATED] WorkflowCustomFieldSelections"
+ - EscalationPaths
x-accepts:
- application/vnd.api+json
get:
- deprecated: true
- description: "[DEPRECATED] Use form field endpoints instead. Retrieves a specific\
- \ workflow custom field selection by id"
- operationId: getWorkflowCustomFieldSelection
+ description: Retrieves a specific escalation path by id
+ operationId: getEscalationPath
parameters:
- explode: false
in: path
@@ -12258,45 +8221,39 @@ paths:
schema:
type: string
style: simple
+ - description: "comma separated if needed. eg: escalation_policy_levels"
+ explode: true
+ in: query
+ name: include
+ required: false
+ schema:
+ enum:
+ - escalation_policy_levels
+ type: string
+ style: form
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: "1"
- type: workflow_custom_field_selections
- attributes:
- custom_field_id: 40
- workflow_id: 08e8662f-faf1-41ce-aef6-6e724cae1489
- incident_condition: ANY
- values: []
- selected_option_ids: []
schema:
- $ref: '#/components/schemas/workflow_custom_field_selection_response'
- description: workflow_custom_field_selection found
+ $ref: '#/components/schemas/escalation_policy_path_response'
+ description: escalation path found
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: "[DEPRECATED] Retrieves a workflow custom field selection"
+ summary: Retrieves an escalation path
tags:
- - "[DEPRECATED] WorkflowCustomFieldSelections"
+ - EscalationPaths
x-accepts:
- application/vnd.api+json
put:
- deprecated: true
- description: "[DEPRECATED] Use form field endpoints instead. Update a specific\
- \ workflow custom field selection by id"
- operationId: updateWorkflowCustomFieldSelection
+ description: Update a specific escalation path by id
+ operationId: updateEscalationPath
parameters:
- explode: false
in: path
@@ -12309,51 +8266,37 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/update_workflow_custom_field_selection'
+ $ref: '#/components/schemas/update_escalation_policy_path'
required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: "1"
- type: workflow_custom_field_selections
- attributes:
- custom_field_id: 40
- workflow_id: 08e8662f-faf1-41ce-aef6-6e724cae1489
- incident_condition: IS
- values: []
- selected_option_ids: []
schema:
- $ref: '#/components/schemas/workflow_custom_field_selection_response'
- description: workflow_custom_field_selection updated
+ $ref: '#/components/schemas/escalation_policy_path_response'
+ description: escalation policy updated
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: "[DEPRECATED] Update a workflow custom field selection"
+ summary: Update an escalation path
tags:
- - "[DEPRECATED] WorkflowCustomFieldSelections"
+ - EscalationPaths
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/workflows/{workflow_id}/form_field_conditions:
+ /v1/form_fields/{form_field_id}/options:
get:
- description: List workflow form field conditions
- operationId: listWorkflowFormFieldConditions
+ description: List form_field_options
+ operationId: listFormFieldOptions
parameters:
- explode: false
in: path
- name: workflow_id
+ name: form_field_id
required: true
schema:
type: string
@@ -12379,27 +8322,41 @@ paths:
schema:
type: integer
style: form
+ - explode: true
+ in: query
+ name: "filter[value]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[color]"
+ required: false
+ schema:
+ type: string
+ style: form
responses:
"200":
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/workflow_form_field_condition_list'
+ $ref: '#/components/schemas/form_field_option_list'
description: success
security:
- bearer_auth: []
- summary: List workflow form field conditions
+ summary: List FormField Options
tags:
- - WorkflowFormFieldConditions
+ - FormFieldOptions
x-accepts:
- application/vnd.api+json
post:
- description: Creates a new workflow form field condition from provided data
- operationId: createWorkflowFormFieldCondition
+ description: Creates a new form_field_option from provided data
+ operationId: createFormFieldOption
parameters:
- explode: false
in: path
- name: workflow_id
+ name: form_field_id
required: true
schema:
type: string
@@ -12408,52 +8365,39 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/new_workflow_form_field_condition'
+ $ref: '#/components/schemas/new_form_field_option'
required: true
responses:
"201":
content:
application/vnd.api+json:
- example:
- data:
- id: b1532af1-db01-46b3-a590-e0ac989d7265
- type: workflow_form_field_conditions
- attributes:
- workflow_id: f7238c12-497f-40ec-89a6-42e016cbf900
- form_field_id: ff637911-19d4-461c-82cf-c999163dc5d8
- incident_condition: ANY
- values: []
- selected_group_ids: []
- selected_option_ids: []
- selected_service_ids: []
- selected_functionality_ids: []
- selected_user_ids: []
- selected_catalog_entity_ids: []
schema:
- $ref: '#/components/schemas/workflow_form_field_condition_response'
- description: workflow_form_field_condition created
+ $ref: '#/components/schemas/form_field_option_response'
+ description: form_field_option created
+ "422":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: invalid request
"401":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
description: responds with unauthorized for invalid token
security:
- bearer_auth: []
- summary: Creates a workflow form field condition
+ summary: Creates FormField Options
tags:
- - WorkflowFormFieldConditions
+ - FormFieldOptions
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/workflow_form_field_conditions/{id}:
+ /v1/form_field_options/{id}:
delete:
- description: Delete a specific workflow form field condition by id
- operationId: deleteWorkflowFormFieldCondition
+ description: Delete a specific form_field_option by id
+ operationId: deleteFormFieldOption
parameters:
- explode: false
in: path
@@ -12466,44 +8410,25 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 423b305e-c4e4-4b93-ba26-a4eac2cc48eb
- type: workflow_form_field_conditions
- attributes:
- workflow_id: f7238c12-497f-40ec-89a6-42e016cbf900
- form_field_id: d2c1f274-ecfc-4907-818c-5eca2cf61946
- incident_condition: ANY
- values: []
- selected_group_ids: []
- selected_option_ids: []
- selected_service_ids: []
- selected_functionality_ids: []
- selected_user_ids: []
- selected_catalog_entity_ids: []
schema:
- $ref: '#/components/schemas/workflow_form_field_condition_response'
- description: workflow_form_field_condition deleted
+ $ref: '#/components/schemas/form_field_option_response'
+ description: form_field_option deleted
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Delete a workflow_form field condition
+ summary: Delete FormField Options
tags:
- - WorkflowFormFieldConditions
+ - FormFieldOptions
x-accepts:
- application/vnd.api+json
get:
- description: Retrieves a specific workflow form field condition by id
- operationId: getWorkflowFormFieldCondition
+ description: Retrieves a specific form_field_option by id
+ operationId: getFormFieldOption
parameters:
- explode: false
in: path
@@ -12516,44 +8441,25 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 423b305e-c4e4-4b93-ba26-a4eac2cc48eb
- type: workflow_form_field_conditions
- attributes:
- workflow_id: f7238c12-497f-40ec-89a6-42e016cbf900
- form_field_id: d2c1f274-ecfc-4907-818c-5eca2cf61946
- incident_condition: ANY
- values: []
- selected_group_ids: []
- selected_option_ids: []
- selected_service_ids: []
- selected_functionality_ids: []
- selected_user_ids: []
- selected_catalog_entity_ids: []
schema:
- $ref: '#/components/schemas/workflow_form_field_condition_response'
- description: workflow_form_field_condition found
+ $ref: '#/components/schemas/form_field_option_response'
+ description: form_field_option found
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Retrieves a workflow form field condition
+ summary: Retrieves FormField Options
tags:
- - WorkflowFormFieldConditions
+ - FormFieldOptions
x-accepts:
- application/vnd.api+json
put:
- description: Update a specific workflow form field condition by id
- operationId: updateWorkflowFormFieldCondition
+ description: Update a specific form_field_option by id
+ operationId: updateFormFieldOption
parameters:
- explode: false
in: path
@@ -12566,53 +8472,41 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/update_workflow_form_field_condition'
+ $ref: '#/components/schemas/update_form_field_option'
required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 423b305e-c4e4-4b93-ba26-a4eac2cc48eb
- type: workflow_form_field_conditions
- attributes:
- workflow_id: f7238c12-497f-40ec-89a6-42e016cbf900
- form_field_id: d2c1f274-ecfc-4907-818c-5eca2cf61946
- incident_condition: IS
- values: []
- selected_group_ids: []
- selected_option_ids: []
- selected_service_ids: []
- selected_functionality_ids: []
- selected_user_ids: []
- selected_catalog_entity_ids: []
schema:
- $ref: '#/components/schemas/workflow_form_field_condition_response'
- description: workflow_form_field_condition updated
+ $ref: '#/components/schemas/form_field_option_response'
+ description: form_field_option updated
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Update a workflow form field condition
+ summary: Update FormField Options
tags:
- - WorkflowFormFieldConditions
+ - FormFieldOptions
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/workflow_groups:
+ /v1/form_field_placements/{form_field_placement_id}/conditions:
get:
- description: List workflow groups
- operationId: listWorkflowGroups
+ description: List form_field_placement_conditions
+ operationId: listFormFieldPlacementConditions
parameters:
+ - explode: false
+ in: path
+ name: form_field_placement_id
+ required: true
+ schema:
+ type: string
+ style: simple
- explode: true
in: query
name: include
@@ -12636,121 +8530,73 @@ paths:
style: form
- explode: true
in: query
- name: "filter[search]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[name]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[slug]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[kind]"
+ name: "filter[form_field_id]"
required: false
schema:
type: string
style: form
- - explode: true
- in: query
- name: "filter[expanded]"
- required: false
- schema:
- type: boolean
- style: form
- - explode: true
- in: query
- name: "filter[position]"
- required: false
- schema:
- type: integer
- style: form
responses:
"200":
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/workflow_group_list'
+ $ref: '#/components/schemas/form_field_placement_condition_list'
description: success
security:
- bearer_auth: []
- summary: List workflow groups
+ summary: List Form Set Conditions
tags:
- - WorkflowGroups
+ - FormFieldPlacementConditions
x-accepts:
- application/vnd.api+json
post:
- description: Creates a new workflow group from provided data
- operationId: createWorkflowGroup
- parameters: []
+ description: Creates a new form_field_placement_condition from provided data
+ operationId: createFormFieldPlacementCondition
+ parameters:
+ - explode: false
+ in: path
+ name: form_field_placement_id
+ required: true
+ schema:
+ type: string
+ style: simple
requestBody:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/new_workflow_group'
+ $ref: '#/components/schemas/new_form_field_placement_condition'
required: true
responses:
"201":
content:
application/vnd.api+json:
- example:
- data:
- id: 5b06541e-ef57-4b84-b0bd-13790351682a
- type: workflow_groups
- attributes:
- kind: incident
- name: Test
- description: null
- icon: 📁
- slug: test-incident
- expanded: true
- position: 1
schema:
- $ref: '#/components/schemas/workflow_group_response'
- description: workflow group created
+ $ref: '#/components/schemas/form_field_placement_condition_response'
+ description: form_field_placement_condition created
"422":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Name can't be blank
- status: "422"
schema:
$ref: '#/components/schemas/errors_list'
description: invalid request
"401":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
- description: resource not found
+ description: responds with unauthorized for invalid token
security:
- bearer_auth: []
- summary: Creates a workflow group
+ summary: Creates a Form Set Condition
tags:
- - WorkflowGroups
+ - FormFieldPlacementConditions
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/workflow_groups/{id}:
+ /v1/form_field_placement_conditions/{id}:
delete:
- description: Delete a specific workflow group by id
- operationId: deleteWorkflowGroup
+ description: Delete a specific form_field_placement_condition by id
+ operationId: deleteFormFieldPlacementCondition
parameters:
- explode: false
in: path
@@ -12763,41 +8609,25 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 5c167387-887b-4d58-9f55-9faf1304cfb0
- type: workflow_groups
- attributes:
- kind: incident
- name: Default
- description: null
- icon: 📁
- slug: default-incident
- expanded: true
- position: 10
schema:
- $ref: '#/components/schemas/workflow_group_response'
- description: workflow group deleted
+ $ref: '#/components/schemas/form_field_placement_condition_response'
+ description: form_field_placement_condition deleted
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Delete a workflow_group
+ summary: Delete a Form Set Condition
tags:
- - WorkflowGroups
+ - FormFieldPlacementConditions
x-accepts:
- application/vnd.api+json
get:
- description: Retrieves a specific workflow group by id
- operationId: getWorkflowGroup
+ description: Retrieves a specific form_field_placement_condition by id
+ operationId: getFormFieldPlacementCondition
parameters:
- explode: false
in: path
@@ -12810,41 +8640,25 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 5c167387-887b-4d58-9f55-9faf1304cfb0
- type: workflow_groups
- attributes:
- kind: incident
- name: Default
- description: null
- icon: 📁
- slug: default-incident
- expanded: true
- position: 10
schema:
- $ref: '#/components/schemas/workflow_group_response'
- description: workflow group found
+ $ref: '#/components/schemas/form_field_placement_condition_response'
+ description: form_field_placement_condition found
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Retrieves a workflow group
+ summary: Retrieves a Form Set Condition
tags:
- - WorkflowGroups
+ - FormFieldPlacementConditions
x-accepts:
- application/vnd.api+json
put:
- description: Update a specific workflow group by id
- operationId: updateWorkflowGroup
+ description: Update a specific form_field_placement_condition by id
+ operationId: updateFormFieldPlacementCondition
parameters:
- explode: false
in: path
@@ -12857,65 +8671,46 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/update_workflow_group'
+ $ref: '#/components/schemas/update_form_field_placement_condition'
required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 5c167387-887b-4d58-9f55-9faf1304cfb0
- type: workflow_groups
- attributes:
- kind: incident
- name: Test update
- description: null
- icon: 📁
- slug: default-incident
- expanded: true
- position: 10
schema:
- $ref: '#/components/schemas/workflow_group_response'
- description: workflow group updated
+ $ref: '#/components/schemas/form_field_placement_condition_response'
+ description: form_field_placement_condition updated
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Update a workflow group
+ summary: Update a Form Set Condition
tags:
- - WorkflowGroups
+ - FormFieldPlacementConditions
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/workflows/{workflow_id}/workflow_runs:
+ /v1/form_fields/{form_field_id}/placements:
get:
- description: List workflow runs
- operationId: ListWorkflowRuns
+ description: List form_field_placements
+ operationId: listFormFieldPlacements
parameters:
- explode: false
in: path
- name: workflow_id
+ name: form_field_id
required: true
schema:
type: string
style: simple
- - description: "comma separated if needed. eg: genius_task_runs"
- explode: true
+ - explode: true
in: query
name: include
required: false
schema:
- enum:
- - genius_task_runs
type: string
style: form
- explode: true
@@ -12934,28 +8729,7 @@ paths:
style: form
- explode: true
in: query
- name: "filter[created_at][gt]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[created_at][gte]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[created_at][lt]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[created_at][lte]"
+ name: "filter[form_field_id]"
required: false
schema:
type: string
@@ -12965,22 +8739,22 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/workflow_runs_list'
+ $ref: '#/components/schemas/form_field_placement_list'
description: success
security:
- bearer_auth: []
- summary: List workflow runs
+ summary: List Form Field Placements
tags:
- - WorkflowRuns
+ - FormFieldPlacements
x-accepts:
- application/vnd.api+json
post:
- description: Creates a new workflow run from provided data
- operationId: createWorkflowRun
+ description: Creates a new form_field_placement from provided data
+ operationId: createFormFieldPlacement
parameters:
- explode: false
in: path
- name: workflow_id
+ name: form_field_id
required: true
schema:
type: string
@@ -12989,161 +8763,172 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/new_workflow_run'
+ $ref: '#/components/schemas/new_form_field_placement'
required: true
responses:
"201":
content:
application/vnd.api+json:
- example:
- data:
- id: a62faa22-0dbe-4be5-ad05-de04c385a64f
- type: workflow_runs
- attributes:
- kind: incident
- status: queued
- status_message: null
- triggered_by: user
- user_id: 138
- queued_at: 2025-05-22T06:44:13.864-07:00
- started_at: null
- completed_at: null
- failed_at: null
- canceled_at: null
- updated_at: 2025-05-22T06:44:13.864-07:00
- created_at: 2025-05-22T06:44:13.864-07:00
- incident_id: 323f0a89-ebc4-419f-b124-d9d8857d116c
- post_mortem_id: null
- action_item_id: null
- alert_id: null
- pulse_id: null
- workflow_id: d193405d-d376-4e98-91b5-54bf6459518b
- workflow_name: Touch of Evil
- relationships:
- task_runs:
- data: []
schema:
- $ref: '#/components/schemas/workflow_run_response'
- description: workflow run created
+ $ref: '#/components/schemas/form_field_placement_response'
+ description: form_field_placement created with non_editable true
"422":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Incident conditions are not satisfied
- status: "422"
schema:
$ref: '#/components/schemas/errors_list'
- description: workflow run not created
+ description: invalid request
"401":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
description: responds with unauthorized for invalid token
security:
- bearer_auth: []
- summary: Creates a workflow run
+ summary: Creates a Form Field Placement
tags:
- - WorkflowRuns
+ - FormFieldPlacements
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/workflows:
- get:
- description: List workflows
- operationId: listWorkflows
+ /v1/form_field_placements/{id}:
+ delete:
+ description: Delete a specific form_field_placement by id
+ operationId: deleteFormFieldPlacement
parameters:
- - description: "comma separated if needed. eg: form_field_conditions,genius_tasks"
- explode: true
- in: query
- name: include
- required: false
- schema:
- enum:
- - form_field_conditions
- - genius_tasks
- - genius_workflow_runs
- type: string
- style: form
- - description: "comma separated if needed. eg: created_at,updated_at"
- explode: true
- in: query
- name: sort
- required: false
+ - explode: false
+ in: path
+ name: id
+ required: true
schema:
- enum:
- - created_at
- - -created_at
- - updated_at
- - -updated_at
- - position
- - -position
type: string
- style: form
- - explode: true
- in: query
- name: "page[number]"
- required: false
- schema:
- type: integer
- style: form
- - explode: true
- in: query
- name: "page[size]"
- required: false
- schema:
- type: integer
- style: form
- - explode: true
- in: query
- name: "filter[search]"
- required: false
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/form_field_placement_response'
+ description: form_field_placement deleted
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Delete a Form Field Placement
+ tags:
+ - FormFieldPlacements
+ x-accepts:
+ - application/vnd.api+json
+ get:
+ description: Retrieves a specific form_field_placement by id
+ operationId: getFormFieldPlacement
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
schema:
type: string
- style: form
- - explode: true
- in: query
- name: "filter[name]"
- required: false
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/form_field_placement_response'
+ description: form_field_placement found
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Retrieves a Form Field Placement
+ tags:
+ - FormFieldPlacements
+ x-accepts:
+ - application/vnd.api+json
+ put:
+ description: Update a specific form_field_placement by id
+ operationId: updateFormFieldPlacement
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
schema:
type: string
- style: form
- - explode: true
- in: query
- name: "filter[slug]"
- required: false
+ style: simple
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/update_form_field_placement'
+ required: true
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/form_field_placement_response'
+ description: form_field_placement updated with non_editable
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Update a Form Field Placement
+ tags:
+ - FormFieldPlacements
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/form_fields/{form_field_id}/positions:
+ get:
+ description: List form field positions
+ operationId: listFormFieldPositions
+ parameters:
+ - explode: false
+ in: path
+ name: form_field_id
+ required: true
schema:
type: string
- style: form
+ style: simple
- explode: true
in: query
- name: "filter[created_at][gt]"
+ name: include
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[created_at][gte]"
+ name: "page[number]"
required: false
schema:
- type: string
+ type: integer
style: form
- explode: true
in: query
- name: "filter[created_at][lt]"
+ name: "page[size]"
required: false
schema:
- type: string
+ type: integer
style: form
- explode: true
in: query
- name: "filter[created_at][lte]"
+ name: "filter[form]"
required: false
schema:
type: string
@@ -13153,129 +8938,57 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/workflow_list'
+ $ref: '#/components/schemas/form_field_position_list'
description: success
security:
- bearer_auth: []
- summary: List workflows
+ summary: List FormField Position
tags:
- - Workflows
+ - FormFieldPositions
x-accepts:
- application/vnd.api+json
post:
- description: Creates a new workflow from provided data
- operationId: createWorkflow
- parameters: []
+ description: Creates a new form field_position from provided data
+ operationId: createFormFieldPosition
+ parameters:
+ - explode: false
+ in: path
+ name: form_field_id
+ required: true
+ schema:
+ type: string
+ style: simple
requestBody:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/new_workflow'
+ $ref: '#/components/schemas/new_form_field_position'
required: true
responses:
"201":
content:
application/vnd.api+json:
- example:
- data:
- id: 9578345c-c57e-4c5a-9c7c-2ca99e01c8c5
- type: workflows
- attributes:
- name: Test
- slug: test
- description: null
- command: incident-test
- command_feedback_enabled: true
- repeat_every_duration: null
- repeat_condition_duration_since_first_run: null
- repeat_condition_number_of_repeats: 0
- continuously_repeat: false
- repeat_on: []
- wait: null
- enabled: true
- locked: true
- position: 1
- workflow_group_id: fcf9ee3a-e4c8-4c7f-b7e2-cb139b5a38ac
- trigger_params:
- trigger_type: incident
- triggers: []
- incident_visibilities: []
- incident_kinds:
- - normal
- incident_statuses: []
- incident_inactivity_duration: null
- incident_condition: ALL
- incident_condition_visibility: ANY
- incident_condition_kind: IS
- incident_condition_status: ANY
- incident_condition_sub_status: ANY
- incident_condition_environment: ANY
- incident_condition_severity: ANY
- incident_condition_incident_type: ANY
- incident_condition_incident_roles: ANY
- incident_condition_service: ANY
- incident_condition_functionality: ANY
- incident_condition_group: ANY
- incident_condition_cause: ANY
- incident_condition_summary: null
- incident_condition_started_at: null
- incident_condition_detected_at: null
- incident_condition_acknowledged_at: null
- incident_condition_mitigated_at: null
- incident_condition_resolved_at: null
- incident_conditional_inactivity: null
- incident_post_mortem_condition_cause: ANY
- severity_ids: []
- environment_ids: []
- incident_type_ids: []
- incident_role_ids: []
- service_ids: []
- functionality_ids: []
- group_ids: []
- updated_at: 2025-05-22T06:44:28.692-07:00
- created_at: 2025-05-22T06:44:28.692-07:00
- relationships:
- custom_field_selections:
- data: []
- workflow_tasks:
- data: []
- workflow_runs:
- data: []
schema:
- $ref: '#/components/schemas/workflow_response'
- description: admins can set 'locked' while creating a workflow
+ $ref: '#/components/schemas/form_field_position_response'
+ description: form_field_position created
"401":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
description: responds with unauthorized for invalid token
- "403":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Unauthorized Action. Only admins can set locked
- status: "403"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: non-admins can't set 'locked' while creating a workflow
security:
- bearer_auth: []
- summary: Creates a workflow
+ summary: Creates FormField Positions
tags:
- - Workflows
+ - FormFieldPositions
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/workflows/{id}:
+ /v1/form_field_positions/{id}:
delete:
- description: Delete a specific workflow by id
- operationId: deleteWorkflow
+ description: Delete a specific form_field position by id
+ operationId: deleteFormFieldPosition
parameters:
- explode: false
in: path
@@ -13288,94 +9001,25 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 49c1bf7b-7a2a-4517-ad51-26c711a97a0f
- type: workflows
- attributes:
- name: L.A. Confidential
- slug: l-a-confidential
- description: null
- command: null
- command_feedback_enabled: true
- repeat_every_duration: null
- repeat_condition_duration_since_first_run: ""
- repeat_condition_number_of_repeats: 0
- continuously_repeat: false
- repeat_on: []
- wait: null
- enabled: true
- locked: true
- position: 1
- workflow_group_id: null
- trigger_params:
- trigger_type: incident
- triggers: []
- incident_visibilities: []
- incident_kinds:
- - normal
- incident_statuses: []
- incident_inactivity_duration: null
- incident_condition: ALL
- incident_condition_visibility: ANY
- incident_condition_kind: IS
- incident_condition_status: ANY
- incident_condition_sub_status: ANY
- incident_condition_environment: ANY
- incident_condition_severity: ANY
- incident_condition_incident_type: ANY
- incident_condition_incident_roles: ANY
- incident_condition_service: ANY
- incident_condition_functionality: ANY
- incident_condition_group: ANY
- incident_condition_cause: ANY
- incident_condition_summary: null
- incident_condition_started_at: null
- incident_condition_detected_at: null
- incident_condition_acknowledged_at: null
- incident_condition_mitigated_at: null
- incident_condition_resolved_at: null
- incident_conditional_inactivity: null
- incident_post_mortem_condition_cause: ANY
- severity_ids: []
- environment_ids: []
- incident_type_ids: []
- incident_role_ids: []
- service_ids: []
- functionality_ids: []
- group_ids: []
- updated_at: 2025-05-22T06:44:42.334-07:00
- created_at: 2025-05-22T06:44:41.596-07:00
- relationships:
- custom_field_selections:
- data: []
- workflow_tasks:
- data: []
- workflow_runs:
- data: []
schema:
- $ref: '#/components/schemas/workflow_response'
- description: admin can destroy locked workflow
+ $ref: '#/components/schemas/form_field_position_response'
+ description: form_field_position deleted
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
- description: non-admin can't destroy locked workflow
+ description: resource not found
security:
- bearer_auth: []
- summary: Delete a workflow
+ summary: Delete a FormFieldPosition
tags:
- - Workflows
+ - FormFieldPositions
x-accepts:
- application/vnd.api+json
get:
- description: Retrieves a specific workflow by id
- operationId: getWorkflow
+ description: Retrieves a specific form field_position by id
+ operationId: getFormFieldPosition
parameters:
- explode: false
in: path
@@ -13384,110 +9028,29 @@ paths:
schema:
type: string
style: simple
- - description: "comma separated if needed. eg: form_field_conditions,genius_tasks"
- explode: true
- in: query
- name: include
- required: false
- schema:
- enum:
- - form_field_conditions
- - genius_tasks
- - genius_workflow_runs
- type: string
- style: form
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 752c5365-f88b-47ef-b7a1-36cc2db6823f
- type: workflows
- attributes:
- name: Stalker
- slug: stalker
- description: null
- command: incident-stalker
- command_feedback_enabled: true
- repeat_every_duration: null
- repeat_condition_duration_since_first_run: ""
- repeat_condition_number_of_repeats: 0
- continuously_repeat: false
- repeat_on: []
- wait: null
- enabled: true
- locked: false
- position: 1
- workflow_group_id: null
- trigger_params:
- trigger_type: incident
- triggers: []
- incident_visibilities: []
- incident_kinds:
- - normal
- incident_statuses: []
- incident_inactivity_duration: null
- incident_condition: ALL
- incident_condition_visibility: ANY
- incident_condition_kind: IS
- incident_condition_status: ANY
- incident_condition_sub_status: ANY
- incident_condition_environment: ANY
- incident_condition_severity: ANY
- incident_condition_incident_type: ANY
- incident_condition_incident_roles: ANY
- incident_condition_service: ANY
- incident_condition_functionality: ANY
- incident_condition_group: ANY
- incident_condition_cause: ANY
- incident_condition_summary: null
- incident_condition_started_at: null
- incident_condition_detected_at: null
- incident_condition_acknowledged_at: null
- incident_condition_mitigated_at: null
- incident_condition_resolved_at: null
- incident_conditional_inactivity: null
- incident_post_mortem_condition_cause: ANY
- severity_ids: []
- environment_ids: []
- incident_type_ids: []
- incident_role_ids: []
- service_ids: []
- functionality_ids: []
- group_ids: []
- updated_at: 2025-05-22T06:44:30.648-07:00
- created_at: 2025-05-22T06:44:30.648-07:00
- relationships:
- custom_field_selections:
- data: []
- workflow_tasks:
- data: []
- workflow_runs:
- data: []
schema:
- $ref: '#/components/schemas/workflow_response'
- description: workflow found
+ $ref: '#/components/schemas/form_field_position_response'
+ description: form_field_position found
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Retrieves a workflow
+ summary: Retrieves a FormFieldPosition
tags:
- - Workflows
+ - FormFieldPositions
x-accepts:
- application/vnd.api+json
put:
- description: Update a specific workflow by id
- operationId: updateWorkflow
+ description: Update a specific form_field position by id
+ operationId: updateFormFieldPosition
parameters:
- explode: false
in: path
@@ -13500,150 +9063,43 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/update_workflow'
+ $ref: '#/components/schemas/update_form_field_position'
required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: b36177dd-eb5a-409c-98cb-ce5010f10f74
- type: workflows
- attributes:
- name: Updated
- slug: updated
- description: null
- command: incident-eternal-sunshine-of-the-spotless-mind
- command_feedback_enabled: true
- repeat_every_duration: null
- repeat_condition_duration_since_first_run: null
- repeat_condition_number_of_repeats: 0
- continuously_repeat: false
- repeat_on: []
- wait: null
- enabled: true
- locked: true
- position: 1
- workflow_group_id: null
- trigger_params:
- trigger_type: incident
- triggers: []
- incident_visibilities: []
- incident_kinds:
- - normal
- incident_statuses: []
- incident_inactivity_duration: null
- incident_condition: ALL
- incident_condition_visibility: ANY
- incident_condition_kind: IS
- incident_condition_status: ANY
- incident_condition_sub_status: ANY
- incident_condition_environment: ANY
- incident_condition_severity: ANY
- incident_condition_incident_type: ANY
- incident_condition_incident_roles: ANY
- incident_condition_service: ANY
- incident_condition_functionality: ANY
- incident_condition_group: ANY
- incident_condition_cause: ANY
- incident_condition_summary: null
- incident_condition_started_at: null
- incident_condition_detected_at: null
- incident_condition_acknowledged_at: null
- incident_condition_mitigated_at: null
- incident_condition_resolved_at: null
- incident_conditional_inactivity: null
- incident_post_mortem_condition_cause: ANY
- severity_ids: []
- environment_ids: []
- incident_type_ids: []
- incident_role_ids: []
- service_ids: []
- functionality_ids: []
- group_ids: []
- updated_at: 2025-05-22T06:44:38.525-07:00
- created_at: 2025-05-22T06:44:37.782-07:00
- relationships:
- custom_field_selections:
- data: []
- workflow_tasks:
- data: []
- workflow_runs:
- data: []
schema:
- $ref: '#/components/schemas/workflow_response'
- description: admin can update 'locked' attribute
+ $ref: '#/components/schemas/form_field_position_response'
+ description: form_field_position updated
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
- description: non-admin can't update locked workflow
- "403":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Unauthorized Action. Only admins can set locked
- status: "403"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: non-admin can't update 'locked' attribute
+ description: resource not found
security:
- bearer_auth: []
- summary: Update a workflow
+ summary: Update a FormFieldPosition
tags:
- - Workflows
+ - FormFieldPositions
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/heartbeats/{heartbeat_id}/ping:
- post:
- description: Ping a specific heartbeat by id
- operationId: pingHeartbeat
+ /v1/form_fields:
+ get:
+ description: List form_fields
+ operationId: listFormFields
parameters:
- - explode: false
- in: path
- name: heartbeat_id
- required: true
- schema:
- type: string
- style: simple
- responses:
- "204":
- description: create ping
- "404":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: resource not found
- security:
- - bearer_auth: []
- summary: Ping a heartbeat
- tags:
- - Heartbeats
- x-accepts:
- - application/vnd.api+json
- /v1/heartbeats:
- get:
- description: List heartbeats
- operationId: listHeartbeats
- parameters:
- - explode: true
- in: query
- name: include
- required: false
+ - description: "comma separated if needed. eg: options,positions"
+ explode: true
+ in: query
+ name: include
+ required: false
schema:
+ enum:
+ - options
+ - positions
type: string
style: form
- explode: true
@@ -13681,6 +9137,20 @@ paths:
schema:
type: string
style: form
+ - explode: true
+ in: query
+ name: "filter[kind]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[enabled]"
+ required: false
+ schema:
+ type: boolean
+ style: form
- explode: true
in: query
name: "filter[created_at][gt]"
@@ -13714,271 +9184,173 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/heartbeat_list'
+ $ref: '#/components/schemas/form_field_list'
description: success
security:
- bearer_auth: []
- summary: List heartbeats
+ summary: List Form Fields
tags:
- - Heartbeats
+ - FormFields
x-accepts:
- application/vnd.api+json
post:
- description: Creates a new heartbeat from provided data
- operationId: createHeartbeat
+ description: Creates a new form_field from provided data
+ operationId: createFormField
parameters: []
requestBody:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/new_heartbeat'
+ $ref: '#/components/schemas/new_form_field'
required: true
responses:
"201":
content:
application/vnd.api+json:
- example:
- data:
- id: dd40583c-5592-4d27-8afd-7944a253fa53
- type: heartbeats
- attributes:
- slug: api
- name: API
- description: This is a description
- alert_summary: API is down
- alert_urgency_id: 315aac23-3ed7-4ab7-9a55-fea8b34b19cc
- interval: 1
- interval_unit: minutes
- notification_target_id: "148"
- notification_target_type: User
- ping_url: http://localhost:3001/v1/heartbeats/dd40583c-5592-4d27-8afd-7944a253fa53/ping
- secret: heartbeat_640a61b61d426936c407f9d02012fae0404729f3c72d1915f34c68e01dc3c660
- last_pinged_at: null
- expires_at: null
- enabled: false
- status: waiting
- updated_at: 2025-05-22T06:44:53.592-07:00
- created_at: 2025-05-22T06:44:53.592-07:00
schema:
- $ref: '#/components/schemas/heartbeat_response'
- description: heartbeat created
+ $ref: '#/components/schemas/form_field_response'
+ description: form_field created with auto_set_by_catalog_property_id
"422":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Name can't be blank
- status: "422"
- - title: Name can't be blank
- status: "422"
schema:
$ref: '#/components/schemas/errors_list'
- description: invalid request
+ description: form_field creation fails with auto_set_by_catalog_property_id
+ for catalog fields of different type
"401":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
description: responds with unauthorized for invalid token
security:
- bearer_auth: []
- summary: Creates a heartbeat
+ summary: Creates a Form Field
tags:
- - Heartbeats
+ - FormFields
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/heartbeats/{id}:
+ /v1/form_fields/{id}:
delete:
- description: Delete a specific heartbeat by id
- operationId: deleteHeartbeat
+ description: Delete a specific form_field by id
+ operationId: deleteFormField
parameters:
- explode: false
in: path
name: id
required: true
schema:
- type: string
+ $ref: '#/components/schemas/getAlertField_id_parameter'
style: simple
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 859bf1b6-8c78-4f57-8d11-7387e3d3c966
- type: heartbeats
- attributes:
- slug: ut-sint-quidem-dolores
- name: Ut sint quidem dolores.
- description: Excepturi odit et quaerat.
- alert_summary: API is down
- alert_urgency_id: ea8a0937-cd5c-4860-adb7-6db1c1fef449
- interval: 9
- interval_unit: seconds
- notification_target_id: "150"
- notification_target_type: User
- ping_url: http://localhost:3001/v1/heartbeats/859bf1b6-8c78-4f57-8d11-7387e3d3c966/ping
- secret: heartbeat_2324f8ca3fb555d579f2e03308b76e752a14b49a24a461b949f82b079a0ce85f
- last_pinged_at: null
- expires_at: null
- enabled: false
- status: waiting
- updated_at: 2025-05-22T06:44:55.385-07:00
- created_at: 2025-05-22T06:44:45.857-07:00
schema:
- $ref: '#/components/schemas/heartbeat_response'
- description: heartbeat deleted
+ $ref: '#/components/schemas/form_field_response'
+ description: form_field deleted
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Delete a heartbeat
+ summary: Delete a Form Field
tags:
- - Heartbeats
+ - FormFields
x-accepts:
- application/vnd.api+json
get:
- description: Retrieves a specific heartbeat by id
- operationId: getHeartbeat
+ description: Retrieves a specific form_field by id
+ operationId: getFormField
parameters:
- explode: false
in: path
name: id
required: true
schema:
- type: string
+ $ref: '#/components/schemas/getAlertField_id_parameter'
style: simple
+ - description: "comma separated if needed. eg: options,positions"
+ explode: true
+ in: query
+ name: include
+ required: false
+ schema:
+ enum:
+ - options
+ - positions
+ type: string
+ style: form
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 859bf1b6-8c78-4f57-8d11-7387e3d3c966
- type: heartbeats
- attributes:
- slug: ut-sint-quidem-dolores
- name: Ut sint quidem dolores.
- description: Excepturi odit et quaerat.
- alert_summary: API is down
- alert_urgency_id: ea8a0937-cd5c-4860-adb7-6db1c1fef449
- interval: 9
- interval_unit: seconds
- notification_target_id: "150"
- notification_target_type: User
- ping_url: http://localhost:3001/v1/heartbeats/859bf1b6-8c78-4f57-8d11-7387e3d3c966/ping
- secret: heartbeat_2324f8ca3fb555d579f2e03308b76e752a14b49a24a461b949f82b079a0ce85f
- last_pinged_at: null
- expires_at: null
- enabled: false
- status: waiting
- updated_at: 2025-05-22T06:44:45.857-07:00
- created_at: 2025-05-22T06:44:45.857-07:00
schema:
- $ref: '#/components/schemas/heartbeat_response'
- description: heartbeat found
+ $ref: '#/components/schemas/form_field_response'
+ description: form_field found by slug
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Retrieves a heartbeat
+ summary: Retrieves a Form Field
tags:
- - Heartbeats
+ - FormFields
x-accepts:
- application/vnd.api+json
put:
- description: Update a specific heartbeat by id
- operationId: updateHeartbeat
+ description: Update a specific form_field by id
+ operationId: updateFormField
parameters:
- explode: false
in: path
name: id
required: true
schema:
- type: string
+ $ref: '#/components/schemas/getAlertField_id_parameter'
style: simple
requestBody:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/update_heartbeat'
+ $ref: '#/components/schemas/update_form_field'
required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 859bf1b6-8c78-4f57-8d11-7387e3d3c966
- type: heartbeats
- attributes:
- slug: ut-sint-quidem-dolores
- name: api.rootly.com
- description: This is a description
- alert_summary: API is down
- alert_urgency_id: 315aac23-3ed7-4ab7-9a55-fea8b34b19cc
- interval: 10
- interval_unit: minutes
- notification_target_id: "150"
- notification_target_type: User
- ping_url: http://localhost:3001/v1/heartbeats/859bf1b6-8c78-4f57-8d11-7387e3d3c966/ping
- secret: heartbeat_2324f8ca3fb555d579f2e03308b76e752a14b49a24a461b949f82b079a0ce85f
- last_pinged_at: null
- expires_at: null
- enabled: false
- status: waiting
- updated_at: 2025-05-22T06:44:54.832-07:00
- created_at: 2025-05-22T06:44:45.857-07:00
schema:
- $ref: '#/components/schemas/heartbeat_response'
- description: heartbeat updated
+ $ref: '#/components/schemas/form_field_response'
+ description: form_field updated
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Update a heartbeat
+ summary: Update a Form Field
tags:
- - Heartbeats
+ - FormFields
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/incidents/{incident_id}/action_items:
+ /v1/form_sets/{form_set_id}/conditions:
get:
- description: List incident action items
- operationId: listIncidentActionItems
+ description: List form_set_conditions
+ operationId: listFormSetConditions
parameters:
- explode: false
in: path
- name: incident_id
+ name: form_set_id
required: true
schema:
type: string
@@ -14004,27 +9376,34 @@ paths:
schema:
type: integer
style: form
+ - explode: true
+ in: query
+ name: "filter[form_field_id]"
+ required: false
+ schema:
+ type: string
+ style: form
responses:
"200":
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/incident_action_item_list'
+ $ref: '#/components/schemas/form_set_condition_list'
description: success
security:
- bearer_auth: []
- summary: List incident action items
+ summary: List Form Set Conditions
tags:
- - IncidentActionItems
+ - FormSetConditions
x-accepts:
- application/vnd.api+json
post:
- description: Creates a new action item from provided data
- operationId: createIncidentActionItem
+ description: Creates a new form_set_condition from provided data
+ operationId: createFormSetCondition
parameters:
- explode: false
in: path
- name: incident_id
+ name: form_set_id
required: true
schema:
type: string
@@ -14033,145 +9412,39 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/new_incident_action_item'
+ $ref: '#/components/schemas/new_form_set_condition'
required: true
responses:
"201":
content:
application/vnd.api+json:
- example:
- data:
- id: 8f01bff1-192a-482e-80b0-59a5db53c1de
- type: incident_action_items
- attributes:
- incident_id: 8c553caf-e233-46ca-b6bc-f55bc09ee84c
- incident_title: Totam quas consequatur aut.
- description: New action item description
- assigned_to:
- id: 161
- email: esteban@oreilly.test
- deleted_at: null
- created_at: 2025-05-22T06:44:55.806-07:00
- updated_at: 2025-05-22T06:45:00.237-07:00
- current_team_id: 127
- first_name: August
- last_name: Fay
- time_zone: UTC
- last_seen_at: null
- profile_photo_id: null
- ability_cache:
- team_ids:
- - 127
- administrating_team_ids: []
- last_notification_email_sent_at: null
- accept_terms: true
- onboarding_completed: true
- service_user: false
- accept_marketing: true
- teams_count: 1
- created_through_sso: false
- scim_uid: null
- session_token: null
- incidents_example_count: 0
- incidents_test_count: 0
- incidents_normal_count: 0
- incidents_scheduled_count: 0
- incidents_backfilled_count: 0
- incidents_count: 0
- theme: light_v2
- skip_tutorial: false
- external_id: null
- jti: db4baebc-2f76-4a09-bbba-6de5c97bd1c8
- is_super_admin: false
- has_impersonate_write_permission: false
- view_multiple_schedules: true
- push_notification_new_alert_sound: default
- push_notification_shift_starts_sound: soft_bloob
- push_notification_shift_ends_sound: soft_bloob
- how_did_you_hear_about_us: null
- push_notification_new_alert_volume: 1.0
- opsgenie_id: null
- victor_ops_id: null
- pagerduty_id: null
- assigned_to_group_ids:
- - 3ea14d85-d8fe-4e13-81ec-2c9c0ecd8355
- - 20635bb2-9e4c-48c0-9639-1c5547392ab0
- kind: task
- priority: medium
- status: open
- due_date: null
- jira_issue_id: null
- jira_issue_url: null
- asana_task_id: null
- asana_task_url: null
- github_issue_id: null
- github_issue_url: null
- gitlab_issue_id: null
- gitlab_issue_url: null
- shortcut_story_id: null
- shortcut_story_url: null
- shortcut_task_id: null
- shortcut_task_url: null
- trello_card_id: null
- trello_card_url: null
- linear_issue_id: null
- linear_issue_url: null
- zendesk_ticket_id: null
- zendesk_ticket_url: null
- motion_task_id: null
- motion_task_url: null
- clickup_task_id: null
- clickup_task_url: null
- airtable_base_key: null
- airtable_table_name: null
- airtable_record_id: null
- airtable_record_url: null
- freshservice_ticket_id: null
- freshservice_ticket_url: null
- freshservice_task_id: null
- freshservice_task_url: null
- url: https://test.rootly.com/account/incidents/totam-quas-consequatur-aut#nav-action-items
- short_url: null
- created_at: 2025-05-22T06:45:00.447-07:00
- updated_at: 2025-05-22T06:45:00.447-07:00
- summary: New action item summary
schema:
- $ref: '#/components/schemas/incident_action_item_response'
- description: incident_action_item created
+ $ref: '#/components/schemas/form_set_condition_response'
+ description: form_set_condition created
"422":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Summary can't be blank
- status: "422"
- - title: Summary raw can't be blank
- status: "422"
schema:
$ref: '#/components/schemas/errors_list'
description: invalid request
"401":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
description: responds with unauthorized for invalid token
security:
- bearer_auth: []
- summary: Creates an incident action item
+ summary: Creates a Form Set Condition
tags:
- - IncidentActionItems
+ - FormSetConditions
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/action_items/{id}:
+ /v1/form_set_conditions/{id}:
delete:
- description: Delete a specific incident action item by id
- operationId: deleteIncidentActionItem
+ description: Delete a specific form_set_condition by id
+ operationId: deleteFormSetCondition
parameters:
- explode: false
in: path
@@ -14184,80 +9457,25 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 7812a61d-04cf-43c0-9a23-95cfcad8f83d
- type: incident_action_items
- attributes:
- incident_id: 8c553caf-e233-46ca-b6bc-f55bc09ee84c
- incident_title: Totam quas consequatur aut.
- description: shabby chic wolf locavore pickled twee poke. YOLO
- godard health goth pork belly cold-pressed swag
- assigned_to: null
- assigned_to_group_ids: []
- kind: follow_up
- priority: low
- status: open
- due_date: null
- jira_issue_id: null
- jira_issue_url: null
- asana_task_id: null
- asana_task_url: null
- github_issue_id: null
- github_issue_url: null
- gitlab_issue_id: null
- gitlab_issue_url: null
- shortcut_story_id: null
- shortcut_story_url: null
- shortcut_task_id: null
- shortcut_task_url: null
- trello_card_id: null
- trello_card_url: null
- linear_issue_id: null
- linear_issue_url: null
- zendesk_ticket_id: null
- zendesk_ticket_url: null
- motion_task_id: null
- motion_task_url: null
- clickup_task_id: null
- clickup_task_url: null
- airtable_base_key: null
- airtable_table_name: null
- airtable_record_id: null
- airtable_record_url: null
- freshservice_ticket_id: null
- freshservice_ticket_url: null
- freshservice_task_id: null
- freshservice_task_url: null
- url: https://test.rootly.com/account/incidents/totam-quas-consequatur-aut#nav-action-items
- short_url: null
- created_at: 2025-05-22T06:44:59.472-07:00
- updated_at: 2025-05-22T06:45:02.719-07:00
- summary: shabby chic wolf locavore pickled twee poke. YOLO godard
- health goth pork belly cold-pressed swag
schema:
- $ref: '#/components/schemas/incident_action_item_response'
- description: incident_action_item deleted
+ $ref: '#/components/schemas/form_set_condition_response'
+ description: form_set_condition deleted
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Delete an incident action item
+ summary: Delete a Form Set Condition
tags:
- - IncidentActionItems
+ - FormSetConditions
x-accepts:
- application/vnd.api+json
get:
- description: Retrieves a specific incident_action_item by id
- operationId: getIncidentActionItems
+ description: Retrieves a specific form_set_condition by id
+ operationId: getFormSetCondition
parameters:
- explode: false
in: path
@@ -14270,80 +9488,25 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 7812a61d-04cf-43c0-9a23-95cfcad8f83d
- type: incident_action_items
- attributes:
- incident_id: 8c553caf-e233-46ca-b6bc-f55bc09ee84c
- incident_title: Totam quas consequatur aut.
- description: shabby chic wolf locavore pickled twee poke. YOLO
- godard health goth pork belly cold-pressed swag
- assigned_to: null
- assigned_to_group_ids: []
- kind: follow_up
- priority: low
- status: open
- due_date: null
- jira_issue_id: null
- jira_issue_url: null
- asana_task_id: null
- asana_task_url: null
- github_issue_id: null
- github_issue_url: null
- gitlab_issue_id: null
- gitlab_issue_url: null
- shortcut_story_id: null
- shortcut_story_url: null
- shortcut_task_id: null
- shortcut_task_url: null
- trello_card_id: null
- trello_card_url: null
- linear_issue_id: null
- linear_issue_url: null
- zendesk_ticket_id: null
- zendesk_ticket_url: null
- motion_task_id: null
- motion_task_url: null
- clickup_task_id: null
- clickup_task_url: null
- airtable_base_key: null
- airtable_table_name: null
- airtable_record_id: null
- airtable_record_url: null
- freshservice_ticket_id: null
- freshservice_ticket_url: null
- freshservice_task_id: null
- freshservice_task_url: null
- url: https://test.rootly.com/account/incidents/totam-quas-consequatur-aut#nav-action-items
- short_url: null
- created_at: 2025-05-22T06:44:59.472-07:00
- updated_at: 2025-05-22T06:44:59.472-07:00
- summary: shabby chic wolf locavore pickled twee poke. YOLO godard
- health goth pork belly cold-pressed swag
schema:
- $ref: '#/components/schemas/incident_action_item_response'
- description: incident_action_item found
+ $ref: '#/components/schemas/form_set_condition_response'
+ description: form_set_condition found
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Retrieves an incident action item
+ summary: Retrieves a Form Set Condition
tags:
- - IncidentActionItems
+ - FormSetConditions
x-accepts:
- application/vnd.api+json
put:
- description: Update a specific incident action item by id
- operationId: updateIncidentActionItem
+ description: Update a specific form_set_condition by id
+ operationId: updateFormSetCondition
parameters:
- explode: false
in: path
@@ -14356,86 +9519,33 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/update_incident_action_item'
+ $ref: '#/components/schemas/update_form_set_condition'
required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 7812a61d-04cf-43c0-9a23-95cfcad8f83d
- type: incident_action_items
- attributes:
- incident_id: 8c553caf-e233-46ca-b6bc-f55bc09ee84c
- incident_title: Totam quas consequatur aut.
- description: Action item description updated
- assigned_to: null
- assigned_to_group_ids: []
- kind: follow_up
- priority: low
- status: open
- due_date: null
- jira_issue_id: null
- jira_issue_url: null
- asana_task_id: null
- asana_task_url: null
- github_issue_id: null
- github_issue_url: null
- gitlab_issue_id: null
- gitlab_issue_url: null
- shortcut_story_id: null
- shortcut_story_url: null
- shortcut_task_id: null
- shortcut_task_url: null
- trello_card_id: null
- trello_card_url: null
- linear_issue_id: null
- linear_issue_url: null
- zendesk_ticket_id: null
- zendesk_ticket_url: null
- motion_task_id: null
- motion_task_url: null
- clickup_task_id: null
- clickup_task_url: null
- airtable_base_key: null
- airtable_table_name: null
- airtable_record_id: null
- airtable_record_url: null
- freshservice_ticket_id: null
- freshservice_ticket_url: null
- freshservice_task_id: null
- freshservice_task_url: null
- url: https://test.rootly.com/account/incidents/totam-quas-consequatur-aut#nav-action-items
- short_url: null
- created_at: 2025-05-22T06:44:59.472-07:00
- updated_at: 2025-05-22T06:45:02.090-07:00
- summary: Action item summary updated
schema:
- $ref: '#/components/schemas/incident_action_item_response'
- description: incident_action_item updated
+ $ref: '#/components/schemas/form_set_condition_response'
+ description: form_set_condition updated
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Update an incident action item
+ summary: Update a Form Set Condition
tags:
- - IncidentActionItems
+ - FormSetConditions
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/action_items:
+ /v1/form_sets:
get:
- description: List all action items for an organization
- operationId: listAllIncidentActionItems
+ description: List form_sets
+ operationId: listFormSets
parameters:
- explode: true
in: query
@@ -14460,650 +9570,690 @@ paths:
style: form
- explode: true
in: query
- name: "filter[kind]"
+ name: "filter[slug]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[priority]"
+ name: "filter[is_default]"
required: false
schema:
- type: string
+ type: boolean
style: form
- explode: true
in: query
- name: "filter[status]"
+ name: "filter[created_at][gt]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[incident_status]"
+ name: "filter[created_at][gte]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[incident_created_at][gt]"
+ name: "filter[created_at][lt]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[incident_created_at][gte]"
+ name: "filter[created_at][lte]"
required: false
schema:
type: string
style: form
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/form_set_list'
+ description: success
+ security:
+ - bearer_auth: []
+ summary: List Form Sets
+ tags:
+ - FormSets
+ x-accepts:
+ - application/vnd.api+json
+ post:
+ description: Creates a new form_set from provided data
+ operationId: createFormSet
+ parameters: []
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/new_form_set'
+ required: true
+ responses:
+ "201":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/form_set_response'
+ description: form_set created
+ "422":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: invalid request
+ "401":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: responds with unauthorized for invalid token
+ security:
+ - bearer_auth: []
+ summary: Creates a Form Set
+ tags:
+ - FormSets
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/form_sets/{id}:
+ delete:
+ description: Delete a specific form_set by id
+ operationId: deleteFormSet
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ $ref: '#/components/schemas/getAlertField_id_parameter'
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/form_set_response'
+ description: form_set deleted
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Delete a Form Set
+ tags:
+ - FormSets
+ x-accepts:
+ - application/vnd.api+json
+ get:
+ description: Retrieves a specific form_set by id
+ operationId: getFormSet
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ $ref: '#/components/schemas/getAlertField_id_parameter'
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/form_set_response'
+ description: form_set found by slug
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Retrieves a Form Set
+ tags:
+ - FormSets
+ x-accepts:
+ - application/vnd.api+json
+ put:
+ description: Update a specific form_set by id
+ operationId: updateFormSet
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ $ref: '#/components/schemas/getAlertField_id_parameter'
+ style: simple
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/update_form_set'
+ required: true
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/form_set_response'
+ description: form_set updated
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Update a Form Set
+ tags:
+ - FormSets
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/functionalities:
+ get:
+ description: List functionalities
+ operationId: listFunctionalities
+ parameters:
- explode: true
in: query
- name: "filter[incident_created_at][lt]"
+ name: include
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[incident_created_at][lte]"
+ name: "page[number]"
required: false
schema:
- type: string
+ type: integer
style: form
- explode: true
in: query
- name: "filter[due_date][gt]"
+ name: "page[size]"
required: false
schema:
- type: string
+ type: integer
style: form
- explode: true
in: query
- name: "filter[due_date][gte]"
+ name: "filter[search]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[due_date][lt]"
+ name: "filter[name]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[due_date][lte]"
+ name: "filter[backstage_id]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[created_at][gt]"
+ name: "filter[cortex_id]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[created_at][gte]"
+ name: "filter[opslevel_id]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[created_at][lt]"
+ name: "filter[external_id]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[created_at][lte]"
+ name: "filter[slug]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: sort
+ name: "filter[created_at][gt]"
required: false
schema:
type: string
style: form
- responses:
- "200":
- content:
- application/vnd.api+json:
- schema:
- $ref: '#/components/schemas/incident_action_item_list'
- description: success
- security:
- - bearer_auth: []
- summary: List all action items for an organization
- tags:
- - IncidentActionItems
- x-accepts:
- - application/vnd.api+json
- /v1/incidents/{incident_id}/custom_field_selections:
- get:
- deprecated: true
- description: "[DEPRECATED] Use form field endpoints instead. List incident custom\
- \ field selections"
- operationId: listIncidentCustomFieldSelections
- parameters:
- - explode: false
- in: path
- name: incident_id
- required: true
+ - explode: true
+ in: query
+ name: "filter[created_at][gte]"
+ required: false
schema:
type: string
- style: simple
+ style: form
- explode: true
in: query
- name: include
+ name: "filter[created_at][lt]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "page[number]"
+ name: "filter[created_at][lte]"
required: false
schema:
- type: integer
+ type: string
style: form
- explode: true
in: query
- name: "page[size]"
+ name: sort
required: false
schema:
- type: integer
+ type: string
style: form
responses:
"200":
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/incident_custom_field_selection_list'
+ $ref: '#/components/schemas/functionality_list'
description: success
security:
- bearer_auth: []
- summary: "[DEPRECATED] List incident custom field selections"
+ summary: List functionalities
tags:
- - "[DEPRECATED] IncidentCustomFieldSelections"
+ - Functionalities
x-accepts:
- application/vnd.api+json
post:
- deprecated: true
- description: "[DEPRECATED] Use form field endpoints instead. Creates a new incident\
- \ custom field selection from provided data"
- operationId: createIncidentCustomFieldSelection
- parameters:
- - explode: false
- in: path
- name: incident_id
- required: true
- schema:
- type: string
- style: simple
+ description: Creates a new functionality from provided data
+ operationId: createFunctionality
+ parameters: []
requestBody:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/new_incident_custom_field_selection'
+ $ref: '#/components/schemas/new_functionality'
required: true
responses:
"201":
content:
application/vnd.api+json:
- example:
- data:
- id: "2"
- type: incident_custom_field_selections
- attributes:
- custom_field_id: 47
- incident_id: 42d82cb5-2523-4d41-b5c8-f9cffd5b7529
- value: Test custom field
- selected_option_ids: []
schema:
- $ref: '#/components/schemas/incident_custom_field_selection_response'
- description: incident_custom_field_selection created
+ $ref: '#/components/schemas/functionality_response'
+ description: functionality created
"422":
content:
application/vnd.api+json:
- example:
- errors:
- - title: "requires either value or at least one selected option, group,\
- \ service, or user"
- status: "422"
schema:
$ref: '#/components/schemas/errors_list'
description: invalid request
"401":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
description: responds with unauthorized for invalid token
security:
- bearer_auth: []
- summary: "[DEPRECATED] Creates an incident custom field selection"
+ summary: Creates a functionality
tags:
- - "[DEPRECATED] IncidentCustomFieldSelections"
+ - Functionalities
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/incident_custom_field_selections/{id}:
+ /v1/functionalities/{id}:
delete:
- deprecated: true
- description: "[DEPRECATED] Use form field endpoints instead. Delete a specific\
- \ incident custom field selection by id"
- operationId: deleteIncidentCustomFieldSelection
+ description: Delete a specific functionality by id
+ operationId: deleteFunctionality
parameters:
- explode: false
in: path
name: id
required: true
schema:
- type: string
+ $ref: '#/components/schemas/getAlertField_id_parameter'
style: simple
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: "1"
- type: incident_custom_field_selections
- attributes:
- custom_field_id: 46
- incident_id: 42d82cb5-2523-4d41-b5c8-f9cffd5b7529
- value: Eum temporibus rerum totam.
- selected_option_ids: []
schema:
- $ref: '#/components/schemas/incident_custom_field_selection_response'
- description: incident_custom_field_selection deleted
+ $ref: '#/components/schemas/functionality_response'
+ description: functionality deleted
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: "[DEPRECATED] Delete an incident custom field selection"
+ summary: Delete a functionality
tags:
- - "[DEPRECATED] IncidentCustomFieldSelections"
+ - Functionalities
x-accepts:
- application/vnd.api+json
get:
- deprecated: true
- description: "[DEPRECATED] Use form field endpoints instead. Retrieves a specific\
- \ incident custom field selection by id"
- operationId: getIncidentCustomFieldSelection
+ description: Retrieves a specific functionality by id
+ operationId: getFunctionality
parameters:
- explode: false
in: path
name: id
required: true
schema:
- type: string
+ $ref: '#/components/schemas/getAlertField_id_parameter'
style: simple
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: "1"
- type: incident_custom_field_selections
- attributes:
- custom_field_id: 46
- incident_id: 42d82cb5-2523-4d41-b5c8-f9cffd5b7529
- value: Eum temporibus rerum totam.
- selected_option_ids: []
schema:
- $ref: '#/components/schemas/incident_custom_field_selection_response'
- description: incident_custom_field_selection found
+ $ref: '#/components/schemas/functionality_response'
+ description: functionality found
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: "[DEPRECATED] Retrieves an incident custom field selection"
+ summary: Retrieves a functionality
tags:
- - "[DEPRECATED] IncidentCustomFieldSelections"
+ - Functionalities
x-accepts:
- application/vnd.api+json
put:
- deprecated: true
- description: "[DEPRECATED] Use form field endpoints instead. Update a specific\
- \ incident custom field selection by id"
- operationId: updateIncidentCustomFieldSelection
+ description: Update a specific functionality by id
+ operationId: updateFunctionality
parameters:
- explode: false
in: path
name: id
required: true
schema:
- type: string
+ $ref: '#/components/schemas/getAlertField_id_parameter'
style: simple
requestBody:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/update_incident_custom_field_selection'
+ $ref: '#/components/schemas/update_functionality'
required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: "1"
- type: incident_custom_field_selections
- attributes:
- custom_field_id: 46
- incident_id: 42d82cb5-2523-4d41-b5c8-f9cffd5b7529
- value: Test update custom field
- selected_option_ids: []
schema:
- $ref: '#/components/schemas/incident_custom_field_selection_response'
- description: incident_custom_field_selection updated
+ $ref: '#/components/schemas/functionality_response'
+ description: functionality updated
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: "[DEPRECATED] Update an incident custom field selection"
+ summary: Update a functionality
tags:
- - "[DEPRECATED] IncidentCustomFieldSelections"
+ - Functionalities
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/events/{incident_event_id}/functionalities:
+ /v1/functionalities/{id}/incidents_chart:
get:
- description: List incident event functionalities
- operationId: listIncidentEventFunctionalities
+ description: Get functionality incidents chart
+ operationId: getFunctionalityIncidentsChart
parameters:
- explode: false
in: path
- name: incident_event_id
+ name: id
required: true
schema:
- type: string
+ $ref: '#/components/schemas/getAlertField_id_parameter'
style: simple
- explode: true
in: query
- name: include
- required: false
+ name: period
+ required: true
schema:
type: string
style: form
- - explode: true
- in: query
- name: "page[number]"
- required: false
- schema:
- type: integer
- style: form
- - explode: true
- in: query
- name: "page[size]"
- required: false
- schema:
- type: integer
- style: form
responses:
"200":
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/incident_event_functionality_list'
+ $ref: '#/components/schemas/incidents_chart_response'
description: success
- security:
- - bearer_auth: []
- summary: List incident event functionalities
- tags:
- - IncidentEventFunctionalities
- x-accepts:
- - application/vnd.api+json
- post:
- description: Creates a new event functionality from provided data
- operationId: createIncidentEventFunctionality
- parameters:
- - explode: false
- in: path
- name: incident_event_id
- required: true
- schema:
- type: string
- style: simple
- requestBody:
- content:
- application/vnd.api+json:
- schema:
- $ref: '#/components/schemas/new_incident_event_functionality'
- required: true
- responses:
- "201":
- content:
- application/vnd.api+json:
- example:
- data:
- id: 823d2735-69f6-4f8a-9b8b-18609167003c
- type: incident_event_functionalities
- attributes:
- incident_event_id: 675bb1f2-89ea-4421-9a4f-4f4ac71481a1
- functionality_id: 3f2c029e-71fd-4104-aef7-805d5cc3b4cb
- status: partial_outage
- schema:
- $ref: '#/components/schemas/incident_event_functionality_response'
- description: incident_event_functionality created
- "422":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Functionality must exist
- status: "422"
- - title: Functionality can't be blank
- status: "422"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: invalid request
- "401":
+ "404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
- description: responds with unauthorized for invalid token
+ description: resource not found
security:
- bearer_auth: []
- summary: Creates an incident event functionality
+ summary: Get functionality incidents chart
tags:
- - IncidentEventFunctionalities
- x-content-type: application/vnd.api+json
+ - Functionalities
x-accepts:
- application/vnd.api+json
- /v1/incident_event_functionalities/{id}:
- delete:
- description: Delete a specific incident event functionality by id
- operationId: deleteIncidentEventFunctionality
+ /v1/functionalities/{id}/uptime_chart:
+ get:
+ description: Get functionality uptime chart
+ operationId: getFunctionalityUptimeChart
parameters:
- explode: false
in: path
name: id
required: true
schema:
- type: string
+ $ref: '#/components/schemas/getAlertField_id_parameter'
style: simple
+ - explode: true
+ in: query
+ name: period
+ required: false
+ schema:
+ type: string
+ style: form
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 81d47659-4f4f-48b4-a0a3-7e0afe5bff3b
- type: incident_event_functionalities
- attributes:
- incident_event_id: 675bb1f2-89ea-4421-9a4f-4f4ac71481a1
- functionality_id: 1d672b3c-7250-413c-a62a-c3abc9227426
- status: partial_outage
schema:
- $ref: '#/components/schemas/incident_event_functionality_response'
- description: incident_event deleted
+ $ref: '#/components/schemas/uptime_chart_response'
+ description: success
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Delete an incident event functionality
+ summary: Get functionality uptime chart
tags:
- - IncidentEventFunctionalities
+ - Functionalities
x-accepts:
- application/vnd.api+json
+ /v1/functionalities/properties:
get:
- description: Retrieves a specific incident_event_functionality by id
- operationId: getIncidentEventFunctionalities
+ description: List Functionality Catalog Properties
+ operationId: listFunctionalityCatalogProperties
parameters:
- - explode: false
- in: path
- name: id
- required: true
+ - description: "comma separated if needed. eg: catalog"
+ explode: true
+ in: query
+ name: include
+ required: false
schema:
+ enum:
+ - catalog
type: string
- style: simple
+ style: form
+ - description: "comma separated if needed. eg: created_at,updated_at"
+ explode: true
+ in: query
+ name: sort
+ required: false
+ schema:
+ enum:
+ - created_at
+ - -created_at
+ - updated_at
+ - -updated_at
+ - position
+ - -position
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "page[number]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ - explode: true
+ in: query
+ name: "page[size]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ - explode: true
+ in: query
+ name: "filter[slug]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[name]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[kind]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][gt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][gte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][lt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][lte]"
+ required: false
+ schema:
+ type: string
+ style: form
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 81d47659-4f4f-48b4-a0a3-7e0afe5bff3b
- type: incident_event_functionalities
- attributes:
- incident_event_id: 675bb1f2-89ea-4421-9a4f-4f4ac71481a1
- functionality_id: 1d672b3c-7250-413c-a62a-c3abc9227426
- status: partial_outage
- schema:
- $ref: '#/components/schemas/incident_event_functionality_response'
- description: incident_event_functionality found
- "404":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
- $ref: '#/components/schemas/errors_list'
- description: resource not found
+ $ref: '#/components/schemas/catalog_property_list'
+ description: success
security:
- bearer_auth: []
- summary: Retrieves an incident event functionality
+ summary: List Catalog Properties
tags:
- - IncidentEventFunctionalities
+ - Functionalities
x-accepts:
- application/vnd.api+json
- put:
- description: Update a specific incident event functionality by id
- operationId: updateIncidentEventFunctionality
- parameters:
- - explode: false
- in: path
- name: id
- required: true
- schema:
- type: string
- style: simple
+ post:
+ description: Creates a new Catalog Property from provided data
+ operationId: createFunctionalityCatalogProperty
+ parameters: []
requestBody:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/update_incident_event_functionality'
+ $ref: '#/components/schemas/new_catalog_property'
required: true
responses:
- "200":
+ "201":
content:
application/vnd.api+json:
- example:
- data:
- id: 81d47659-4f4f-48b4-a0a3-7e0afe5bff3b
- type: incident_event_functionalities
- attributes:
- incident_event_id: 675bb1f2-89ea-4421-9a4f-4f4ac71481a1
- functionality_id: 1d672b3c-7250-413c-a62a-c3abc9227426
- status: major_outage
schema:
- $ref: '#/components/schemas/incident_event_functionality_response'
- description: incident_event_functionality updated
- "404":
+ $ref: '#/components/schemas/catalog_property_response'
+ description: catalog_property created ignores wrong catalog_type attribute
+ "422":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
- description: resource not found
+ description: exceeds max fields per catalog
+ "401":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: responds with unauthorized for invalid token
security:
- bearer_auth: []
- summary: Update an incident event
+ summary: Creates a Catalog Property
tags:
- - IncidentEventFunctionalities
+ - Functionalities
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/events/{incident_event_id}/services:
+ /v1/workflows/{workflow_id}/workflow_tasks:
get:
- description: List incident event services
- operationId: listIncidentEventServices
+ description: List workflow tasks
+ operationId: listWorkflowTasks
parameters:
- explode: false
in: path
- name: incident_event_id
+ name: workflow_id
required: true
schema:
type: string
@@ -15129,27 +10279,48 @@ paths:
schema:
type: integer
style: form
+ - explode: true
+ in: query
+ name: "filter[search]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[name]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[slug]"
+ required: false
+ schema:
+ type: string
+ style: form
responses:
"200":
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/incident_event_service_list'
+ $ref: '#/components/schemas/workflow_task_list'
description: success
security:
- bearer_auth: []
- summary: List incident event services
+ summary: List workflow tasks
tags:
- - IncidentEventServices
+ - WorkflowTasks
x-accepts:
- application/vnd.api+json
post:
- description: Creates a new event service from provided data
- operationId: createIncidentEventService
+ description: Creates a new workflow task from provided data
+ operationId: createWorkflowTask
parameters:
- explode: false
in: path
- name: incident_event_id
+ name: workflow_id
required: true
schema:
type: string
@@ -15158,57 +10329,33 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/new_incident_event_service'
+ $ref: '#/components/schemas/new_workflow_task'
required: true
responses:
"201":
content:
application/vnd.api+json:
- example:
- data:
- id: cf9418be-085b-4b00-943b-be03326bdce4
- type: incident_event_services
- attributes:
- incident_event_id: dd6279a5-189b-45b3-9b53-34bc33228d98
- service_id: 9f3a8fa5-4010-4f39-b898-faa0a8cb2ac9
- status: partial_outage
- schema:
- $ref: '#/components/schemas/incident_event_service_response'
- description: incident_event_service created
- "422":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Service must exist
- status: "422"
- - title: Service can't be blank
- status: "422"
schema:
- $ref: '#/components/schemas/errors_list'
- description: invalid request
+ $ref: '#/components/schemas/workflow_task_response'
+ description: workflow task created
"401":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
description: responds with unauthorized for invalid token
security:
- bearer_auth: []
- summary: Creates an incident event service
+ summary: Creates a workflow task
tags:
- - IncidentEventServices
+ - WorkflowTasks
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/incident_event_services/{id}:
+ /v1/workflow_tasks/{id}:
delete:
- description: Delete a specific incident event service by id
- operationId: deleteIncidentEventService
+ description: Delete a specific workflow task by id
+ operationId: deleteWorkflowTask
parameters:
- explode: false
in: path
@@ -15221,37 +10368,25 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 4eac8359-84c2-4117-9a71-6920b99e8889
- type: incident_event_services
- attributes:
- incident_event_id: dd6279a5-189b-45b3-9b53-34bc33228d98
- service_id: 025f8dc2-6d4b-46d9-b67c-87f68bc37b22
- status: partial_outage
schema:
- $ref: '#/components/schemas/incident_event_service_response'
- description: incident_event deleted
+ $ref: '#/components/schemas/workflow_task_response'
+ description: workflow_task deleted
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Delete an incident event functionalitu
+ summary: Delete a workflow task
tags:
- - IncidentEventServices
+ - WorkflowTasks
x-accepts:
- application/vnd.api+json
get:
- description: Retrieves a specific incident_event_service by id
- operationId: getIncidentEventServices
+ description: Retrieves a specific workflow_task by id
+ operationId: getWorkflowTask
parameters:
- explode: false
in: path
@@ -15264,37 +10399,25 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 4eac8359-84c2-4117-9a71-6920b99e8889
- type: incident_event_services
- attributes:
- incident_event_id: dd6279a5-189b-45b3-9b53-34bc33228d98
- service_id: 025f8dc2-6d4b-46d9-b67c-87f68bc37b22
- status: partial_outage
schema:
- $ref: '#/components/schemas/incident_event_service_response'
- description: incident_event_service found
+ $ref: '#/components/schemas/workflow_task_response'
+ description: workflow_task found
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Retrieves an incident event service
+ summary: Retrieves a workflow task
tags:
- - IncidentEventServices
+ - WorkflowTasks
x-accepts:
- application/vnd.api+json
put:
- description: Update a specific incident event service by id
- operationId: updateIncidentEventService
+ description: Update a specific workflow task by id
+ operationId: updateWorkflowTask
parameters:
- explode: false
in: path
@@ -15307,49 +10430,39 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/update_incident_event_service'
+ $ref: '#/components/schemas/update_workflow_task'
required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 4eac8359-84c2-4117-9a71-6920b99e8889
- type: incident_event_services
- attributes:
- incident_event_id: dd6279a5-189b-45b3-9b53-34bc33228d98
- service_id: 025f8dc2-6d4b-46d9-b67c-87f68bc37b22
- status: major_outage
schema:
- $ref: '#/components/schemas/incident_event_service_response'
- description: incident_event_service updated
+ $ref: '#/components/schemas/workflow_task_response'
+ description: workflow_task updated
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Update an incident event
+ summary: Update a workflow task
tags:
- - IncidentEventServices
+ - WorkflowTasks
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/incidents/{incident_id}/events:
+ /v1/workflows/{workflow_id}/custom_field_selections:
get:
- description: List incident events
- operationId: listIncidentEvents
+ deprecated: true
+ description: "[DEPRECATED] Use form field endpoints instead. List workflow custom\
+ \ field selections"
+ operationId: listWorkflowCustomFieldSelections
parameters:
- explode: false
in: path
- name: incident_id
+ name: workflow_id
required: true
schema:
type: string
@@ -15380,22 +10493,24 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/incident_event_list'
+ $ref: '#/components/schemas/workflow_custom_field_selection_list'
description: success
security:
- bearer_auth: []
- summary: List incident events
+ summary: "[DEPRECATED] List workflow custom field selections"
tags:
- - IncidentEvents
+ - "[DEPRECATED] WorkflowCustomFieldSelections"
x-accepts:
- application/vnd.api+json
post:
- description: Creates a new event from provided data
- operationId: createIncidentEvent
+ deprecated: true
+ description: "[DEPRECATED] Use form field endpoints instead. Creates a new workflow\
+ \ custom field selection from provided data"
+ operationId: createWorkflowCustomFieldSelection
parameters:
- explode: false
in: path
- name: incident_id
+ name: workflow_id
required: true
schema:
type: string
@@ -15404,64 +10519,35 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/new_incident_event'
+ $ref: '#/components/schemas/new_workflow_custom_field_selection'
required: true
responses:
"201":
content:
application/vnd.api+json:
- example:
- data:
- id: 5b8d12e7-205a-4a72-b75f-a3e3622100e0
- type: incident_events
- attributes:
- event: New Event
- event_raw: New Event
- kind: event
- source: web
- visibility: external
- user_display_name: Rootly
- occurred_at: 2025-05-22T06:45:21.598-07:00
- starred_at: null
- created_at: 2025-05-22T06:45:21.598-07:00
- updated_at: 2025-05-22T06:45:21.598-07:00
- schema:
- $ref: '#/components/schemas/incident_event_response'
- description: incident_event created
- "422":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Event can't be blank
- status: "422"
- - title: Event raw can't be blank
- status: "422"
schema:
- $ref: '#/components/schemas/errors_list'
- description: invalid request
+ $ref: '#/components/schemas/workflow_custom_field_selection_response'
+ description: workflow_custom_field_selection created
"401":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
description: responds with unauthorized for invalid token
security:
- bearer_auth: []
- summary: Creates an incident event
+ summary: "[DEPRECATED] Creates a workflow custom field selection"
tags:
- - IncidentEvents
+ - "[DEPRECATED] WorkflowCustomFieldSelections"
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/events/{id}:
+ /v1/workflow_custom_field_selections/{id}:
delete:
- description: Delete a specific incident event by id
- operationId: deleteIncidentEvent
+ deprecated: true
+ description: "[DEPRECATED] Use form field endpoints instead. Delete a specific\
+ \ workflow custom field selection by id"
+ operationId: deleteWorkflowCustomFieldSelection
parameters:
- explode: false
in: path
@@ -15474,44 +10560,27 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 241539d7-3e29-4e46-b8c0-066667b2d8e5
- type: incident_events
- attributes:
- event: Vero sint quae exercitationem.
- event_raw: Vero sint quae exercitationem.
- kind: event
- source: web
- visibility: internal
- user_display_name: Diego Heaney
- occurred_at: 2025-05-22T06:45:20.817-07:00
- starred_at: null
- created_at: 2025-05-22T06:45:20.817-07:00
- updated_at: 2025-05-22T06:45:24.471-07:00
schema:
- $ref: '#/components/schemas/incident_event_response'
- description: incident_event deleted
+ $ref: '#/components/schemas/workflow_custom_field_selection_response'
+ description: workflow_custom_field_selection deleted
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Delete an incident event
+ summary: "[DEPRECATED] Delete a workflow custom field selection"
tags:
- - IncidentEvents
+ - "[DEPRECATED] WorkflowCustomFieldSelections"
x-accepts:
- application/vnd.api+json
get:
- description: Retrieves a specific incident_event by id
- operationId: getIncidentEvents
+ deprecated: true
+ description: "[DEPRECATED] Use form field endpoints instead. Retrieves a specific\
+ \ workflow custom field selection by id"
+ operationId: getWorkflowCustomFieldSelection
parameters:
- explode: false
in: path
@@ -15524,44 +10593,27 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 241539d7-3e29-4e46-b8c0-066667b2d8e5
- type: incident_events
- attributes:
- event: Vero sint quae exercitationem.
- event_raw: Vero sint quae exercitationem.
- kind: event
- source: web
- visibility: internal
- user_display_name: Diego Heaney
- occurred_at: 2025-05-22T06:45:20.817-07:00
- starred_at: null
- created_at: 2025-05-22T06:45:20.817-07:00
- updated_at: 2025-05-22T06:45:20.817-07:00
schema:
- $ref: '#/components/schemas/incident_event_response'
- description: incident_event found
+ $ref: '#/components/schemas/workflow_custom_field_selection_response'
+ description: workflow_custom_field_selection found
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Retrieves an incident event
+ summary: "[DEPRECATED] Retrieves a workflow custom field selection"
tags:
- - IncidentEvents
+ - "[DEPRECATED] WorkflowCustomFieldSelections"
x-accepts:
- application/vnd.api+json
put:
- description: Update a specific incident event by id
- operationId: updateIncidentEvent
+ deprecated: true
+ description: "[DEPRECATED] Use form field endpoints instead. Update a specific\
+ \ workflow custom field selection by id"
+ operationId: updateWorkflowCustomFieldSelection
parameters:
- explode: false
in: path
@@ -15574,56 +10626,37 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/update_incident_event'
+ $ref: '#/components/schemas/update_workflow_custom_field_selection'
required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 241539d7-3e29-4e46-b8c0-066667b2d8e5
- type: incident_events
- attributes:
- event: Event updated
- event_raw: Event updated
- kind: event
- source: web
- visibility: internal
- user_display_name: Diego Heaney
- occurred_at: 2025-05-22T06:45:20.817-07:00
- starred_at: null
- created_at: 2025-05-22T06:45:20.817-07:00
- updated_at: 2025-05-22T06:45:23.877-07:00
schema:
- $ref: '#/components/schemas/incident_event_response'
- description: incident_event updated
+ $ref: '#/components/schemas/workflow_custom_field_selection_response'
+ description: workflow_custom_field_selection updated
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Update an incident event
+ summary: "[DEPRECATED] Update a workflow custom field selection"
tags:
- - IncidentEvents
+ - "[DEPRECATED] WorkflowCustomFieldSelections"
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/incidents/{incident_id}/feedbacks:
+ /v1/workflows/{workflow_id}/form_field_conditions:
get:
- description: List incident feedbacks
- operationId: listIncidentFeedbacks
+ description: List workflow form field conditions
+ operationId: listWorkflowFormFieldConditions
parameters:
- explode: false
in: path
- name: incident_id
+ name: workflow_id
required: true
schema:
type: string
@@ -15654,22 +10687,22 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/incident_feedback_list'
+ $ref: '#/components/schemas/workflow_form_field_condition_list'
description: success
security:
- bearer_auth: []
- summary: List incident feedbacks
+ summary: List workflow form field conditions
tags:
- - IncidentFeedbacks
+ - WorkflowFormFieldConditions
x-accepts:
- application/vnd.api+json
post:
- description: Creates a new feedback from provided data
- operationId: createIncidentFeedback
+ description: Creates a new workflow form field condition from provided data
+ operationId: createWorkflowFormFieldCondition
parameters:
- explode: false
in: path
- name: incident_id
+ name: workflow_id
required: true
schema:
type: string
@@ -15678,58 +10711,65 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/new_incident_feedback'
+ $ref: '#/components/schemas/new_workflow_form_field_condition'
required: true
responses:
"201":
content:
application/vnd.api+json:
- example:
- data:
- id: 6992134e-c27b-4259-ada6-be8120f4e202
- type: incident_feedbacks
- attributes:
- rating: 4
- rating_humanized: Very satisfied
- feedback: New Feedback
- anonymous: true
- updated_at: 2025-05-22T06:45:27.911-07:00
- created_at: 2025-05-22T06:45:27.911-07:00
schema:
- $ref: '#/components/schemas/incident_feedback_response'
- description: incident_feedback created
- "422":
+ $ref: '#/components/schemas/workflow_form_field_condition_response'
+ description: workflow_form_field_condition created with environment ids
+ for non-environment form field
+ "401":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Feedback can't be blank
- status: "422"
schema:
$ref: '#/components/schemas/errors_list'
- description: invalid request
- "401":
+ description: responds with unauthorized for invalid token
+ security:
+ - bearer_auth: []
+ summary: Creates a workflow form field condition
+ tags:
+ - WorkflowFormFieldConditions
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/workflow_form_field_conditions/{id}:
+ delete:
+ description: Delete a specific workflow form field condition by id
+ operationId: deleteWorkflowFormFieldCondition
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/workflow_form_field_condition_response'
+ description: workflow_form_field_condition deleted
+ "404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
- description: responds with unauthorized for invalid token
+ description: resource not found
security:
- bearer_auth: []
- summary: Creates an incident feedback
+ summary: Delete a workflow_form field condition
tags:
- - IncidentFeedbacks
- x-content-type: application/vnd.api+json
+ - WorkflowFormFieldConditions
x-accepts:
- application/vnd.api+json
- /v1/feedbacks/{id}:
get:
- description: Retrieves a specific incident_feedback by id
- operationId: getIncidentFeedbacks
+ description: Retrieves a specific workflow form field condition by id
+ operationId: getWorkflowFormFieldCondition
parameters:
- explode: false
in: path
@@ -15742,40 +10782,25 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 078a91e6-daaf-46ba-bbdc-1b293f8e2733
- type: incident_feedbacks
- attributes:
- rating: 2
- rating_humanized: Neither satisfied nor dissatisfied
- feedback: Itaque et et sapiente.
- anonymous: false
- updated_at: 2025-05-22T06:45:27.208-07:00
- created_at: 2025-05-22T06:45:27.208-07:00
schema:
- $ref: '#/components/schemas/incident_feedback_response'
- description: incident_feedback found
+ $ref: '#/components/schemas/workflow_form_field_condition_response'
+ description: includes native field ids
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Retrieves an incident feedback
+ summary: Retrieves a workflow form field condition
tags:
- - IncidentFeedbacks
+ - WorkflowFormFieldConditions
x-accepts:
- application/vnd.api+json
put:
- description: Update a specific incident feedback by id
- operationId: updateIncidentFeedback
+ description: Update a specific workflow form field condition by id
+ operationId: updateWorkflowFormFieldCondition
parameters:
- explode: false
in: path
@@ -15788,56 +10813,34 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/update_incident_feedback'
+ $ref: '#/components/schemas/update_workflow_form_field_condition'
required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 078a91e6-daaf-46ba-bbdc-1b293f8e2733
- type: incident_feedbacks
- attributes:
- rating: 3
- rating_humanized: Somewhat satisfied
- feedback: Feedback updated
- anonymous: false
- updated_at: 2025-05-22T06:45:29.429-07:00
- created_at: 2025-05-22T06:45:27.208-07:00
schema:
- $ref: '#/components/schemas/incident_feedback_response'
- description: incident_feedback updated
+ $ref: '#/components/schemas/workflow_form_field_condition_response'
+ description: workflow_form_field_condition updated
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Update an incident feedback
+ summary: Update a workflow form field condition
tags:
- - IncidentFeedbacks
+ - WorkflowFormFieldConditions
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/incidents/{incident_id}/form_field_selections:
+ /v1/workflow_groups:
get:
- description: List incident form field selections
- operationId: listIncidentFormFieldSelections
+ description: List workflow groups
+ operationId: listWorkflowGroups
parameters:
- - explode: false
- in: path
- name: incident_id
- required: true
- schema:
- type: string
- style: simple
- explode: true
in: query
name: include
@@ -15859,167 +10862,103 @@ paths:
schema:
type: integer
style: form
+ - explode: true
+ in: query
+ name: "filter[search]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[name]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[slug]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[kind]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[expanded]"
+ required: false
+ schema:
+ type: boolean
+ style: form
+ - explode: true
+ in: query
+ name: "filter[position]"
+ required: false
+ schema:
+ type: integer
+ style: form
responses:
"200":
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/incident_form_field_selection_list'
+ $ref: '#/components/schemas/workflow_group_list'
description: success
security:
- bearer_auth: []
- summary: List incident form field selections
+ summary: List workflow groups
tags:
- - IncidentFormFieldSelections
+ - WorkflowGroups
x-accepts:
- application/vnd.api+json
post:
- description: Creates a new incident form field selection from provided data
- operationId: createIncidentFormFieldSelection
- parameters:
- - explode: false
- in: path
- name: incident_id
- required: true
- schema:
- type: string
- style: simple
+ description: Creates a new workflow group from provided data
+ operationId: createWorkflowGroup
+ parameters: []
requestBody:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/new_incident_form_field_selection'
+ $ref: '#/components/schemas/new_workflow_group'
required: true
responses:
"201":
content:
application/vnd.api+json:
- example:
- data:
- id: e5a5d5dc-0be9-4734-afcc-ed9b1d50113c
- type: incident_form_field_selections
- attributes:
- incident_id: b8bb5578-3d21-4d0b-9c01-731a236fd5e5
- custom_field_id: 50
- form_field_id: 1227f5a3-3db9-4e1a-b7c8-e783f7dc565f
- form_field:
- id: 1227f5a3-3db9-4e1a-b7c8-e783f7dc565f
- team_id: 151
- slug: ducimus-tempora-odit-numquam
- kind: custom
- input_kind: text
- value_kind: inherit
- value_kind_catalog_id: null
- name: Ducimus tempora odit numquam.
- description: Rem enim vero expedita.
- shown:
- - web_new_incident_form
- - web_update_incident_form
- - slack_new_incident_form
- - slack_update_incident_form
- required: []
- default_values: []
- show_on_incident_details: true
- enabled: true
- updated_at: 2025-05-22T06:45:32.119-07:00
- created_at: 2025-05-22T06:45:32.119-07:00
- options:
- - id: 1928145f-b18b-4e0e-a4d7-b03ad58885b9
- form_field_id: 1227f5a3-3db9-4e1a-b7c8-e783f7dc565f
- value: Harum qui omnis rerum.
- color: '#FBE4A0'
- default: false
- position: 1
- updated_at: 2025-05-22T06:45:32.200-07:00
- created_at: 2025-05-22T06:45:32.200-07:00
- - id: 76d4961f-5f02-4acd-8e79-36cb85a1edff
- form_field_id: 1227f5a3-3db9-4e1a-b7c8-e783f7dc565f
- value: Qui et ut totam.
- color: '#FBE4A0'
- default: false
- position: 2
- updated_at: 2025-05-22T06:45:32.204-07:00
- created_at: 2025-05-22T06:45:32.204-07:00
- positions:
- - id: 29bd3cfc-aa7e-4e4e-b54f-7a369b3c4ff9
- form_field_id: 1227f5a3-3db9-4e1a-b7c8-e783f7dc565f
- form: slack_new_incident_form
- position: 2
- - id: 4f823cfe-9ed4-47ea-aab5-0ed555a9a7b6
- form_field_id: 1227f5a3-3db9-4e1a-b7c8-e783f7dc565f
- form: web_update_incident_form
- position: 2
- - id: 116ea986-67c2-4526-8299-9687073c3c25
- form_field_id: 1227f5a3-3db9-4e1a-b7c8-e783f7dc565f
- form: slack_update_incident_form
- position: 2
- - id: 14151972-07a9-4f15-b8e2-60a9b2d339b1
- form_field_id: 1227f5a3-3db9-4e1a-b7c8-e783f7dc565f
- form: web_new_incident_form
- position: 2
- value: Test custom field
- selected_group_ids: []
- selected_groups:
- id: null
- value: Test custom field
- selected_option_ids: []
- selected_options:
- id: null
- value: Test custom field
- selected_service_ids: []
- selected_services:
- id: null
- value: Test custom field
- selected_functionality_ids: []
- selected_functionalities:
- id: null
- value: Test custom field
- selected_catalog_entity_ids: []
- selected_catalog_entities:
- id: null
- value: Test custom field
- selected_user_ids: []
- selected_users:
- id: null
- value: Test custom field
schema:
- $ref: '#/components/schemas/incident_form_field_selection_response'
- description: incident_form_field_selection created
+ $ref: '#/components/schemas/workflow_group_response'
+ description: workflow group created
"422":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Form field must exist
- status: "422"
- - title: "requires either value or at least one selected option, group,\
- \ service, or user"
- status: "422"
schema:
$ref: '#/components/schemas/errors_list'
description: invalid request
"401":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
- description: responds with unauthorized for invalid token
+ description: resource not found
security:
- bearer_auth: []
- summary: Creates an incident form field selection
+ summary: Creates a workflow group
tags:
- - IncidentFormFieldSelections
+ - WorkflowGroups
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/incident_form_field_selections/{id}:
+ /v1/workflow_groups/{id}:
delete:
- description: Delete a specific incident form field selection by id
- operationId: deleteIncidentFormFieldSelection
+ description: Delete a specific workflow group by id
+ operationId: deleteWorkflowGroup
parameters:
- explode: false
in: path
@@ -16032,117 +10971,25 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 6ffd1a68-901b-4762-91ce-758c394002d3
- type: incident_form_field_selections
- attributes:
- incident_id: b8bb5578-3d21-4d0b-9c01-731a236fd5e5
- custom_field_id: 49
- form_field_id: 984a0b99-048e-4c18-8ce8-e8d8ea856c2f
- form_field:
- id: 984a0b99-048e-4c18-8ce8-e8d8ea856c2f
- team_id: 151
- slug: eum-praesentium-ratione-cum
- kind: custom
- input_kind: text
- value_kind: inherit
- value_kind_catalog_id: null
- name: Eum praesentium ratione cum.
- description: Tempore amet et neque.
- shown:
- - web_new_incident_form
- - web_update_incident_form
- - slack_new_incident_form
- - slack_update_incident_form
- required: []
- default_values: []
- show_on_incident_details: true
- enabled: true
- updated_at: 2025-05-22T06:45:32.040-07:00
- created_at: 2025-05-22T06:45:32.040-07:00
- options:
- - id: 4122e0a2-e13f-49f1-b33b-0cff358586bb
- form_field_id: 984a0b99-048e-4c18-8ce8-e8d8ea856c2f
- value: Amet quis natus ut.
- color: '#FBE4A0'
- default: false
- position: 1
- updated_at: 2025-05-22T06:45:32.109-07:00
- created_at: 2025-05-22T06:45:32.109-07:00
- - id: 82295dbb-7964-43c8-a7c8-3d790f778cd6
- form_field_id: 984a0b99-048e-4c18-8ce8-e8d8ea856c2f
- value: Qui veritatis rerum magnam.
- color: '#FBE4A0'
- default: false
- position: 2
- updated_at: 2025-05-22T06:45:32.113-07:00
- created_at: 2025-05-22T06:45:32.113-07:00
- positions:
- - id: 733d1096-c5ad-481e-b38b-0b5a78764513
- form_field_id: 984a0b99-048e-4c18-8ce8-e8d8ea856c2f
- form: slack_new_incident_form
- position: 1
- - id: 00ffda51-d807-4ea9-8555-1dda42ea9706
- form_field_id: 984a0b99-048e-4c18-8ce8-e8d8ea856c2f
- form: web_update_incident_form
- position: 1
- - id: fb3dc8bc-a4de-4c40-abd6-cfdcfae83077
- form_field_id: 984a0b99-048e-4c18-8ce8-e8d8ea856c2f
- form: slack_update_incident_form
- position: 1
- - id: a48aae43-873d-4bcf-90bd-3946b1fd3071
- form_field_id: 984a0b99-048e-4c18-8ce8-e8d8ea856c2f
- form: web_new_incident_form
- position: 1
- value: Suscipit est aliquam quia.
- selected_group_ids: []
- selected_groups:
- id: null
- value: Suscipit est aliquam quia.
- selected_option_ids: []
- selected_options:
- id: null
- value: Suscipit est aliquam quia.
- selected_service_ids: []
- selected_services:
- id: null
- value: Suscipit est aliquam quia.
- selected_functionality_ids: []
- selected_functionalities:
- id: null
- value: Suscipit est aliquam quia.
- selected_catalog_entity_ids: []
- selected_catalog_entities:
- id: null
- value: Suscipit est aliquam quia.
- selected_user_ids: []
- selected_users:
- id: null
- value: Suscipit est aliquam quia.
schema:
- $ref: '#/components/schemas/incident_form_field_selection_response'
- description: incident_form_field_selection deleted
+ $ref: '#/components/schemas/workflow_group_response'
+ description: workflow group deleted
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Delete an incident form field selection
+ summary: Delete a workflow_group
tags:
- - IncidentFormFieldSelections
+ - WorkflowGroups
x-accepts:
- application/vnd.api+json
get:
- description: Retrieves a specific incident form field selection by id
- operationId: getIncidentFormFieldSelection
+ description: Retrieves a specific workflow group by id
+ operationId: getWorkflowGroup
parameters:
- explode: false
in: path
@@ -16155,117 +11002,25 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 6ffd1a68-901b-4762-91ce-758c394002d3
- type: incident_form_field_selections
- attributes:
- incident_id: b8bb5578-3d21-4d0b-9c01-731a236fd5e5
- custom_field_id: 49
- form_field_id: 984a0b99-048e-4c18-8ce8-e8d8ea856c2f
- form_field:
- id: 984a0b99-048e-4c18-8ce8-e8d8ea856c2f
- team_id: 151
- slug: eum-praesentium-ratione-cum
- kind: custom
- input_kind: text
- value_kind: inherit
- value_kind_catalog_id: null
- name: Eum praesentium ratione cum.
- description: Tempore amet et neque.
- shown:
- - web_new_incident_form
- - web_update_incident_form
- - slack_new_incident_form
- - slack_update_incident_form
- required: []
- default_values: []
- show_on_incident_details: true
- enabled: true
- updated_at: 2025-05-22T06:45:32.040-07:00
- created_at: 2025-05-22T06:45:32.040-07:00
- options:
- - id: 4122e0a2-e13f-49f1-b33b-0cff358586bb
- form_field_id: 984a0b99-048e-4c18-8ce8-e8d8ea856c2f
- value: Amet quis natus ut.
- color: '#FBE4A0'
- default: false
- position: 1
- updated_at: 2025-05-22T06:45:32.109-07:00
- created_at: 2025-05-22T06:45:32.109-07:00
- - id: 82295dbb-7964-43c8-a7c8-3d790f778cd6
- form_field_id: 984a0b99-048e-4c18-8ce8-e8d8ea856c2f
- value: Qui veritatis rerum magnam.
- color: '#FBE4A0'
- default: false
- position: 2
- updated_at: 2025-05-22T06:45:32.113-07:00
- created_at: 2025-05-22T06:45:32.113-07:00
- positions:
- - id: 733d1096-c5ad-481e-b38b-0b5a78764513
- form_field_id: 984a0b99-048e-4c18-8ce8-e8d8ea856c2f
- form: slack_new_incident_form
- position: 1
- - id: 00ffda51-d807-4ea9-8555-1dda42ea9706
- form_field_id: 984a0b99-048e-4c18-8ce8-e8d8ea856c2f
- form: web_update_incident_form
- position: 1
- - id: fb3dc8bc-a4de-4c40-abd6-cfdcfae83077
- form_field_id: 984a0b99-048e-4c18-8ce8-e8d8ea856c2f
- form: slack_update_incident_form
- position: 1
- - id: a48aae43-873d-4bcf-90bd-3946b1fd3071
- form_field_id: 984a0b99-048e-4c18-8ce8-e8d8ea856c2f
- form: web_new_incident_form
- position: 1
- value: Suscipit est aliquam quia.
- selected_group_ids: []
- selected_groups:
- id: null
- value: Suscipit est aliquam quia.
- selected_option_ids: []
- selected_options:
- id: null
- value: Suscipit est aliquam quia.
- selected_service_ids: []
- selected_services:
- id: null
- value: Suscipit est aliquam quia.
- selected_functionality_ids: []
- selected_functionalities:
- id: null
- value: Suscipit est aliquam quia.
- selected_catalog_entity_ids: []
- selected_catalog_entities:
- id: null
- value: Suscipit est aliquam quia.
- selected_user_ids: []
- selected_users:
- id: null
- value: Suscipit est aliquam quia.
schema:
- $ref: '#/components/schemas/incident_form_field_selection_response'
- description: incident_form_field_selection found
+ $ref: '#/components/schemas/workflow_group_response'
+ description: workflow group found
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Retrieves an incident form field selection
+ summary: Retrieves a workflow group
tags:
- - IncidentFormFieldSelections
+ - WorkflowGroups
x-accepts:
- application/vnd.api+json
put:
- description: Update a specific incident form field selection by id
- operationId: updateIncidentFormFieldSelection
+ description: Update a specific workflow group by id
+ operationId: updateWorkflowGroup
parameters:
- explode: false
in: path
@@ -16278,138 +11033,49 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/update_incident_form_field_selection'
+ $ref: '#/components/schemas/update_workflow_group'
required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 6ffd1a68-901b-4762-91ce-758c394002d3
- type: incident_form_field_selections
- attributes:
- incident_id: b8bb5578-3d21-4d0b-9c01-731a236fd5e5
- custom_field_id: 49
- form_field_id: 984a0b99-048e-4c18-8ce8-e8d8ea856c2f
- form_field:
- id: 984a0b99-048e-4c18-8ce8-e8d8ea856c2f
- team_id: 151
- slug: eum-praesentium-ratione-cum
- kind: custom
- input_kind: text
- value_kind: inherit
- value_kind_catalog_id: null
- name: Eum praesentium ratione cum.
- description: Tempore amet et neque.
- shown:
- - web_new_incident_form
- - web_update_incident_form
- - slack_new_incident_form
- - slack_update_incident_form
- required: []
- default_values: []
- show_on_incident_details: true
- enabled: true
- updated_at: 2025-05-22T06:45:32.040-07:00
- created_at: 2025-05-22T06:45:32.040-07:00
- options:
- - id: 4122e0a2-e13f-49f1-b33b-0cff358586bb
- form_field_id: 984a0b99-048e-4c18-8ce8-e8d8ea856c2f
- value: Amet quis natus ut.
- color: '#FBE4A0'
- default: false
- position: 1
- updated_at: 2025-05-22T06:45:32.109-07:00
- created_at: 2025-05-22T06:45:32.109-07:00
- - id: 82295dbb-7964-43c8-a7c8-3d790f778cd6
- form_field_id: 984a0b99-048e-4c18-8ce8-e8d8ea856c2f
- value: Qui veritatis rerum magnam.
- color: '#FBE4A0'
- default: false
- position: 2
- updated_at: 2025-05-22T06:45:32.113-07:00
- created_at: 2025-05-22T06:45:32.113-07:00
- positions:
- - id: 733d1096-c5ad-481e-b38b-0b5a78764513
- form_field_id: 984a0b99-048e-4c18-8ce8-e8d8ea856c2f
- form: slack_new_incident_form
- position: 1
- - id: 00ffda51-d807-4ea9-8555-1dda42ea9706
- form_field_id: 984a0b99-048e-4c18-8ce8-e8d8ea856c2f
- form: web_update_incident_form
- position: 1
- - id: fb3dc8bc-a4de-4c40-abd6-cfdcfae83077
- form_field_id: 984a0b99-048e-4c18-8ce8-e8d8ea856c2f
- form: slack_update_incident_form
- position: 1
- - id: a48aae43-873d-4bcf-90bd-3946b1fd3071
- form_field_id: 984a0b99-048e-4c18-8ce8-e8d8ea856c2f
- form: web_new_incident_form
- position: 1
- value: Test update custom field
- selected_group_ids: []
- selected_groups:
- id: null
- value: Test update custom field
- selected_option_ids: []
- selected_options:
- id: null
- value: Test update custom field
- selected_service_ids: []
- selected_services:
- id: null
- value: Test update custom field
- selected_functionality_ids: []
- selected_functionalities:
- id: null
- value: Test update custom field
- selected_catalog_entity_ids: []
- selected_catalog_entities:
- id: null
- value: Test update custom field
- selected_user_ids: []
- selected_users:
- id: null
- value: Test update custom field
schema:
- $ref: '#/components/schemas/incident_form_field_selection_response'
- description: incident_form_field_selection updated
+ $ref: '#/components/schemas/workflow_group_response'
+ description: workflow group updated
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Update an incident form field selection
+ summary: Update a workflow group
tags:
- - IncidentFormFieldSelections
+ - WorkflowGroups
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/incident_permission_sets/{incident_permission_set_id}/booleans:
+ /v1/workflows/{workflow_id}/workflow_runs:
get:
- description: List incident_permission_set_booleans
- operationId: listIncidentPermissionSetBooleans
+ description: List workflow runs
+ operationId: ListWorkflowRuns
parameters:
- explode: false
in: path
- name: incident_permission_set_id
+ name: workflow_id
required: true
schema:
type: string
style: simple
- - explode: true
+ - description: "comma separated if needed. eg: genius_task_runs"
+ explode: true
in: query
name: include
required: false
schema:
+ enum:
+ - genius_task_runs
type: string
style: form
- explode: true
@@ -16426,13 +11092,6 @@ paths:
schema:
type: integer
style: form
- - explode: true
- in: query
- name: "filter[kind]"
- required: false
- schema:
- type: string
- style: form
- explode: true
in: query
name: "filter[created_at][gt]"
@@ -16461,34 +11120,27 @@ paths:
schema:
type: string
style: form
- - explode: true
- in: query
- name: sort
- required: false
- schema:
- type: string
- style: form
responses:
"200":
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/incident_permission_set_boolean_list'
- description: success
+ $ref: '#/components/schemas/workflow_runs_list'
+ description: success with date filters using gte with timezone
security:
- bearer_auth: []
- summary: List incident_permission_set_booleans
+ summary: List workflow runs
tags:
- - IncidentPermissionSetBooleans
+ - WorkflowRuns
x-accepts:
- application/vnd.api+json
post:
- description: Creates a new incident_permission_set_boolean from provided data
- operationId: createIncidentPermissionSetBoolean
+ description: Creates a new workflow run from provided data
+ operationId: createWorkflowRun
parameters:
- explode: false
in: path
- name: incident_permission_set_id
+ name: workflow_id
required: true
schema:
type: string
@@ -16497,217 +11149,66 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/new_incident_permission_set_boolean'
+ $ref: '#/components/schemas/new_workflow_run'
required: true
responses:
"201":
content:
application/vnd.api+json:
- example:
- data:
- id: 2e12cbf1-2469-435c-8685-ff9c44afefd4
- type: incident_permission_set_booleans
- attributes:
- incident_permission_set_id: 835e0d60-0a80-4873-8bab-c780f81e85a1
- kind: update_summary
- private: false
- enabled: false
- updated_at: 2025-05-22T06:45:36.811-07:00
- created_at: 2025-05-22T06:45:36.811-07:00
schema:
- $ref: '#/components/schemas/incident_permission_set_boolean_response'
- description: incident_permission_set_boolean created
+ $ref: '#/components/schemas/workflow_run_response'
+ description: workflow run created
"422":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Kind can't be blank
- status: "422"
schema:
$ref: '#/components/schemas/errors_list'
- description: invalid request
+ description: workflow run not created
"401":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
description: responds with unauthorized for invalid token
security:
- bearer_auth: []
- summary: Creates an incident_permission_set_boolean
- tags:
- - IncidentPermissionSetBooleans
- x-content-type: application/vnd.api+json
- x-accepts:
- - application/vnd.api+json
- /v1/incident_permission_set_booleans/{id}:
- delete:
- description: Delete a specific incident_permission_set_boolean by id
- operationId: deleteIncidentPermissionSetBoolean
- parameters:
- - explode: false
- in: path
- name: id
- required: true
- schema:
- type: string
- style: simple
- responses:
- "200":
- content:
- application/vnd.api+json:
- example:
- data:
- id: a6da9540-ff71-4037-bd8a-0c40814813df
- type: incident_permission_set_booleans
- attributes:
- incident_permission_set_id: b626aab0-48ae-4bac-b6e0-0a50c0d3e5ac
- kind: update_summary
- private: false
- enabled: false
- updated_at: 2025-05-22T06:45:45.743-07:00
- created_at: 2025-05-22T06:45:45.743-07:00
- schema:
- $ref: '#/components/schemas/incident_permission_set_boolean_response'
- description: incident_permission_set_boolean deleted
- "404":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: resource not found
- security:
- - bearer_auth: []
- summary: Delete an incident_permission_set_boolean
- tags:
- - IncidentPermissionSetBooleans
- x-accepts:
- - application/vnd.api+json
- get:
- description: Retrieves a specific incident_permission_set_boolean by id
- operationId: getIncidentPermissionSetBoolean
- parameters:
- - explode: false
- in: path
- name: id
- required: true
- schema:
- type: string
- style: simple
- responses:
- "200":
- content:
- application/vnd.api+json:
- example:
- data:
- id: d1d975ce-6b24-43a2-940a-76abc796c2de
- type: incident_permission_set_booleans
- attributes:
- incident_permission_set_id: baa83094-0a9b-45c2-b5f3-350fed4f0964
- kind: update_summary
- private: false
- enabled: false
- updated_at: 2025-05-22T06:45:39.656-07:00
- created_at: 2025-05-22T06:45:39.656-07:00
- schema:
- $ref: '#/components/schemas/incident_permission_set_boolean_response'
- description: incident_permission_set_boolean found
- "404":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: resource not found
- security:
- - bearer_auth: []
- summary: Retrieves an incident_permission_set_boolean
- tags:
- - IncidentPermissionSetBooleans
- x-accepts:
- - application/vnd.api+json
- put:
- description: Update a specific incident_permission_set_boolean by id
- operationId: updateIncidentPermissionSetBoolean
- parameters:
- - explode: false
- in: path
- name: id
- required: true
- schema:
- type: string
- style: simple
- requestBody:
- content:
- application/vnd.api+json:
- schema:
- $ref: '#/components/schemas/update_incident_permission_set_boolean'
- required: true
- responses:
- "200":
- content:
- application/vnd.api+json:
- example:
- data:
- id: 834c45f4-6a26-40ea-8a88-0dc54c256169
- type: incident_permission_set_booleans
- attributes:
- incident_permission_set_id: 71eda502-90e0-481e-8c55-5480b9df35db
- kind: update_timeline
- private: false
- enabled: false
- updated_at: 2025-05-22T06:45:42.537-07:00
- created_at: 2025-05-22T06:45:42.360-07:00
- schema:
- $ref: '#/components/schemas/incident_permission_set_boolean_response'
- description: incident_permission_set_boolean updated
- "404":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: resource not found
- security:
- - bearer_auth: []
- summary: Update an incident_permission_set_boolean
+ summary: Creates a workflow run
tags:
- - IncidentPermissionSetBooleans
+ - WorkflowRuns
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/incident_permission_sets/{incident_permission_set_id}/resources:
+ /v1/workflows:
get:
- description: List incident_permission_set_resources
- operationId: listIncidentPermissionSetResources
+ description: List workflows
+ operationId: listWorkflows
parameters:
- - explode: false
- in: path
- name: incident_permission_set_id
- required: true
+ - description: "comma separated if needed. eg: form_field_conditions,alert_field_conditions"
+ explode: true
+ in: query
+ name: include
+ required: false
schema:
+ enum:
+ - form_field_conditions
+ - alert_field_conditions
+ - genius_tasks
+ - genius_workflow_runs
type: string
- style: simple
- - explode: true
+ style: form
+ - description: "comma separated if needed. eg: created_at,updated_at"
+ explode: true
in: query
- name: include
+ name: sort
required: false
schema:
+ enum:
+ - created_at
+ - -created_at
+ - updated_at
+ - -updated_at
+ - position
+ - -position
type: string
style: form
- explode: true
@@ -16726,42 +11227,49 @@ paths:
style: form
- explode: true
in: query
- name: "filter[kind]"
+ name: "filter[search]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[created_at][gt]"
+ name: "filter[name]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[created_at][gte]"
+ name: "filter[slug]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[created_at][lt]"
+ name: "filter[created_at][gt]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[created_at][lte]"
+ name: "filter[created_at][gte]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: sort
+ name: "filter[created_at][lt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][lte]"
required: false
schema:
type: string
@@ -16771,236 +11279,205 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/incident_permission_set_resource_list'
+ $ref: '#/components/schemas/workflow_list'
description: success
security:
- bearer_auth: []
- summary: List incident_permission_set_resources
+ summary: List workflows
tags:
- - IncidentPermissionSetResources
+ - Workflows
x-accepts:
- application/vnd.api+json
post:
- description: Creates a new incident_permission_set_resource from provided data
- operationId: createIncidentPermissionSetResource
- parameters:
- - explode: false
- in: path
- name: incident_permission_set_id
- required: true
- schema:
- type: string
- style: simple
+ description: Creates a new workflow from provided data
+ operationId: createWorkflow
+ parameters: []
requestBody:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/new_incident_permission_set_resource'
+ $ref: '#/components/schemas/new_workflow'
required: true
responses:
"201":
content:
application/vnd.api+json:
- example:
- data:
- id: 9bbb8982-a921-4a53-b4ac-68758bfdb73c
- type: incident_permission_set_resources
- attributes:
- incident_permission_set_id: 4f0e41e3-b1d4-4a79-b8b8-8a6386fe931c
- kind: incident_types
- private: false
- resource_id: 9145be4b-2036-4eb7-b2e3-9c256c604de3
- resource_type: IncidentType
- updated_at: 2025-05-22T06:45:49.537-07:00
- created_at: 2025-05-22T06:45:49.537-07:00
schema:
- $ref: '#/components/schemas/incident_permission_set_resource_response'
- description: incident_permission_set_resource created
- "422":
+ $ref: '#/components/schemas/workflow_response'
+ description: ignores alert field conditions in create request
+ "401":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Resource must exist
- status: "422"
- - title: Kind can't be blank
- status: "422"
- - title: Kind is not included in the list
- status: "422"
schema:
$ref: '#/components/schemas/errors_list'
- description: invalid request
- "401":
+ description: responds with unauthorized for invalid token
+ "403":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
- description: responds with unauthorized for invalid token
+ description: non-admins can't set 'locked' while creating a workflow
security:
- bearer_auth: []
- summary: Creates an incident_permission_set_resource
+ summary: Creates a workflow
tags:
- - IncidentPermissionSetResources
+ - Workflows
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/incident_permission_set_resources/{id}:
+ /v1/workflows/{id}:
delete:
- description: Delete a specific incident_permission_set_resource by id
- operationId: deleteIncidentPermissionSetResource
+ description: Delete a specific workflow by id
+ operationId: deleteWorkflow
parameters:
- explode: false
in: path
name: id
required: true
schema:
- type: string
+ $ref: '#/components/schemas/getAlertField_id_parameter'
style: simple
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 258fd666-7168-47cd-aceb-485031f8aa54
- type: incident_permission_set_resources
- attributes:
- incident_permission_set_id: d47e5636-e7e5-4c47-9345-74f29f537368
- kind: incident_types
- private: false
- resource_id: 9e9bf5f5-9eaf-4572-88a5-2006aa2f0426
- resource_type: IncidentType
- updated_at: 2025-05-22T06:45:58.490-07:00
- created_at: 2025-05-22T06:45:58.490-07:00
schema:
- $ref: '#/components/schemas/incident_permission_set_resource_response'
- description: incident_permission_set_resource deleted
+ $ref: '#/components/schemas/workflow_response'
+ description: admin can destroy locked workflow
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
- description: resource not found
+ description: non-admin can't destroy locked workflow
security:
- bearer_auth: []
- summary: Delete an incident_permission_set_resource
+ summary: Delete a workflow
tags:
- - IncidentPermissionSetResources
+ - Workflows
x-accepts:
- application/vnd.api+json
get:
- description: Retrieves a specific incident_permission_set_resource by id
- operationId: getIncidentPermissionSetResource
+ description: Retrieves a specific workflow by id
+ operationId: getWorkflow
parameters:
- explode: false
in: path
name: id
required: true
schema:
- type: string
+ $ref: '#/components/schemas/getAlertField_id_parameter'
style: simple
+ - description: "comma separated if needed. eg: form_field_conditions,alert_field_conditions"
+ explode: true
+ in: query
+ name: include
+ required: false
+ schema:
+ enum:
+ - form_field_conditions
+ - alert_field_conditions
+ - genius_tasks
+ - genius_workflow_runs
+ type: string
+ style: form
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 21489a79-72ae-46e3-9288-959f5d6cf747
- type: incident_permission_set_resources
- attributes:
- incident_permission_set_id: 754f6ae9-8774-4f97-aaec-d38e9c1fdd29
- kind: incident_types
- private: false
- resource_id: edb6d211-1d50-4a61-ac53-bc74d3a5b677
- resource_type: IncidentType
- updated_at: 2025-05-22T06:45:52.372-07:00
- created_at: 2025-05-22T06:45:52.372-07:00
schema:
- $ref: '#/components/schemas/incident_permission_set_resource_response'
- description: incident_permission_set_resource found
+ $ref: '#/components/schemas/workflow_response'
+ description: does not serialize alert field conditions
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Retrieves an incident_permission_set_resource
+ summary: Retrieves a workflow
tags:
- - IncidentPermissionSetResources
+ - Workflows
x-accepts:
- application/vnd.api+json
put:
- description: Update a specific incident_permission_set_resource by id
- operationId: updateIncidentPermissionSetResource
+ description: Update a specific workflow by id
+ operationId: updateWorkflow
parameters:
- explode: false
in: path
name: id
required: true
schema:
- type: string
+ $ref: '#/components/schemas/getAlertField_id_parameter'
style: simple
requestBody:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/update_incident_permission_set_resource'
+ $ref: '#/components/schemas/update_workflow'
required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 0cd4327f-3789-4a29-97cb-bf4211d93e4d
- type: incident_permission_set_resources
- attributes:
- incident_permission_set_id: 4f4124e7-dd37-48ef-af87-ed313cea3db1
- kind: statuses
- private: false
- resource_id: 58fd7b60-9149-4432-823a-a9fda44a54b3
- resource_type: IncidentType
- updated_at: 2025-05-22T06:45:55.240-07:00
- created_at: 2025-05-22T06:45:55.073-07:00
schema:
- $ref: '#/components/schemas/incident_permission_set_resource_response'
- description: incident_permission_set_resource updated
+ $ref: '#/components/schemas/workflow_response'
+ description: preserves repeat_condition_* fields when omitted from PATCH
+ payload
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
- description: resource not found
+ description: non-admin can't update locked workflow
+ "403":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: non-admin can't update 'locked' attribute
security:
- bearer_auth: []
- summary: Update an incident_permission_set_resource
+ summary: Update a workflow
tags:
- - IncidentPermissionSetResources
+ - Workflows
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/incident_permission_sets:
+ /v1/heartbeats/{heartbeat_id}/ping:
+ post:
+ description: Ping a specific heartbeat by id
+ operationId: pingHeartbeat
+ parameters:
+ - explode: false
+ in: path
+ name: heartbeat_id
+ required: true
+ schema:
+ type: string
+ style: simple
+ responses:
+ "204":
+ description: create ping
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Ping a heartbeat
+ tags:
+ - Heartbeats
+ x-accepts:
+ - application/vnd.api+json
+ /v1/heartbeats:
get:
- description: List incident_permission_sets
- operationId: listIncidentPermissionSets
+ description: List heartbeats
+ operationId: listHeartbeats
parameters:
- explode: true
in: query
@@ -17072,250 +11549,176 @@ paths:
schema:
type: string
style: form
- - explode: true
- in: query
- name: sort
- required: false
- schema:
- type: string
- style: form
responses:
"200":
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/incident_permission_set_list'
- description: success
+ $ref: '#/components/schemas/heartbeat_list'
+ description: filter by name
security:
- bearer_auth: []
- summary: List incident_permission_sets
+ summary: List heartbeats
tags:
- - IncidentPermissionSets
+ - Heartbeats
x-accepts:
- application/vnd.api+json
post:
- description: Creates a new incident_permission_set from provided data
- operationId: createIncidentPermissionSet
+ description: Creates a new heartbeat from provided data
+ operationId: createHeartbeat
parameters: []
requestBody:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/new_incident_permission_set'
+ $ref: '#/components/schemas/new_heartbeat'
required: true
responses:
"201":
content:
application/vnd.api+json:
- example:
- data:
- id: f651ae34-04ca-4fb3-9748-9e937f60eb1a
- type: incident_permission_sets
- attributes:
- team_id: 189
- name: Infrastructure
- slug: infrastructure
- description: null
- private_incident_permissions:
- - read
- public_incident_permissions:
- - read
- updated_at: 2025-05-22T06:46:04.297-07:00
- created_at: 2025-05-22T06:46:04.297-07:00
schema:
- $ref: '#/components/schemas/incident_permission_set_response'
- description: incident_permission_set created
+ $ref: '#/components/schemas/heartbeat_response'
+ description: heartbeat created
"422":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Name can't be blank
- status: "422"
schema:
$ref: '#/components/schemas/errors_list'
- description: invalid request
+ description: interval less than 60 seconds
"401":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
description: responds with unauthorized for invalid token
security:
- bearer_auth: []
- summary: Creates an incident_permission_set
+ summary: Creates a heartbeat
tags:
- - IncidentPermissionSets
+ - Heartbeats
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/incident_permission_sets/{id}:
+ /v1/heartbeats/{id}:
delete:
- description: Delete a specific incident_permission_set by id
- operationId: deleteIncidentPermissionSet
+ description: Delete a specific heartbeat by id
+ operationId: deleteHeartbeat
parameters:
- explode: false
in: path
name: id
required: true
schema:
- type: string
+ $ref: '#/components/schemas/getAlertField_id_parameter'
style: simple
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: dbc5a339-77b8-40f4-8497-923c8623b80d
- type: incident_permission_sets
- attributes:
- team_id: 200
- name: Quis placeat atque pariatur.
- slug: quis-placeat-atque-pariatur
- description: Iure facilis aliquid dolore.
- private_incident_permissions:
- - read
- public_incident_permissions:
- - read
- updated_at: 2025-05-22T06:46:12.885-07:00
- created_at: 2025-05-22T06:46:12.585-07:00
schema:
- $ref: '#/components/schemas/incident_permission_set_response'
- description: incident_permission_set deleted
+ $ref: '#/components/schemas/heartbeat_response'
+ description: heartbeat deleted
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Delete an incident_permission_set
+ summary: Delete a heartbeat
tags:
- - IncidentPermissionSets
+ - Heartbeats
x-accepts:
- application/vnd.api+json
get:
- description: Retrieves a specific incident_permission_set by id
- operationId: getIncidentPermissionSet
+ description: Retrieves a specific heartbeat by id
+ operationId: getHeartbeat
parameters:
- explode: false
in: path
name: id
required: true
schema:
- type: string
+ $ref: '#/components/schemas/getAlertField_id_parameter'
style: simple
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: df2250dc-b1ee-47e0-a9e8-b9ed182e23bd
- type: incident_permission_sets
- attributes:
- team_id: 192
- name: Magni aut voluptatem et.
- slug: magni-aut-voluptatem-et
- description: Architecto itaque enim consequatur.
- private_incident_permissions:
- - read
- public_incident_permissions:
- - read
- updated_at: 2025-05-22T06:46:06.404-07:00
- created_at: 2025-05-22T06:46:06.404-07:00
schema:
- $ref: '#/components/schemas/incident_permission_set_response'
- description: incident_permission_set found
+ $ref: '#/components/schemas/heartbeat_response'
+ description: heartbeat found by slug
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Retrieves an incident_permission_set
+ summary: Retrieves a heartbeat
tags:
- - IncidentPermissionSets
+ - Heartbeats
x-accepts:
- application/vnd.api+json
put:
- description: Update a specific incident_permission_set by id
- operationId: updateIncidentPermissionSet
+ description: Update a specific heartbeat by id
+ operationId: updateHeartbeat
parameters:
- explode: false
in: path
name: id
required: true
schema:
- type: string
+ $ref: '#/components/schemas/getAlertField_id_parameter'
style: simple
requestBody:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/update_incident_permission_set'
+ $ref: '#/components/schemas/update_heartbeat'
required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 02100c59-4ea0-4e84-b693-5ed577276cd9
- type: incident_permission_sets
- attributes:
- team_id: 196
- name: Security
- slug: nesciunt-ab-aut-non
- description: Autem et distinctio recusandae.
- private_incident_permissions:
- - read
- public_incident_permissions:
- - read
- updated_at: 2025-05-22T06:46:10.069-07:00
- created_at: 2025-05-22T06:46:09.826-07:00
schema:
- $ref: '#/components/schemas/incident_permission_set_response'
- description: incident_permission_set updated
+ $ref: '#/components/schemas/heartbeat_response'
+ description: heartbeat updated
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
+ "422":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: invalid enum value
security:
- bearer_auth: []
- summary: Update an incident_permission_set
+ summary: Update a heartbeat
tags:
- - IncidentPermissionSets
+ - Heartbeats
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/post_mortems:
+ /v1/incidents/{incident_id}/action_items:
get:
- description: List incident retrospectives
- operationId: listIncidentPostMortems
+ description: List incident action items
+ operationId: listIncidentActionItems
parameters:
+ - explode: false
+ in: path
+ name: incident_id
+ required: true
+ schema:
+ type: string
+ style: simple
- explode: true
in: query
name: include
@@ -17337,275 +11740,425 @@ paths:
schema:
type: integer
style: form
- - explode: true
- in: query
- name: "filter[search]"
- required: false
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/incident_action_item_list'
+ description: success
+ security:
+ - bearer_auth: []
+ summary: List incident action items
+ tags:
+ - IncidentActionItems
+ x-accepts:
+ - application/vnd.api+json
+ post:
+ description: Creates a new action item from provided data
+ operationId: createIncidentActionItem
+ parameters:
+ - explode: false
+ in: path
+ name: incident_id
+ required: true
schema:
type: string
- style: form
- - explode: true
- in: query
- name: "filter[status]"
- required: false
+ style: simple
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/new_incident_action_item'
+ required: true
+ responses:
+ "201":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/incident_action_item_response'
+ description: incident_action_item created
+ "422":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: invalid request
+ "401":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: responds with unauthorized for invalid token
+ security:
+ - bearer_auth: []
+ summary: Creates an incident action item
+ tags:
+ - IncidentActionItems
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/action_items/{id}:
+ delete:
+ description: Delete a specific incident action item by id
+ operationId: deleteIncidentActionItem
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
schema:
type: string
- style: form
- - explode: true
- in: query
- name: "filter[severity]"
- required: false
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/incident_action_item_response'
+ description: incident_action_item deleted
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Delete an incident action item
+ tags:
+ - IncidentActionItems
+ x-accepts:
+ - application/vnd.api+json
+ get:
+ description: Retrieves a specific incident_action_item by id
+ operationId: getIncidentActionItems
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
schema:
type: string
- style: form
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/incident_action_item_response'
+ description: incident_action_item found
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Retrieves an incident action item
+ tags:
+ - IncidentActionItems
+ x-accepts:
+ - application/vnd.api+json
+ put:
+ description: Update a specific incident action item by id
+ operationId: updateIncidentActionItem
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/update_incident_action_item'
+ required: true
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/incident_action_item_response'
+ description: incident_action_item updated
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Update an incident action item
+ tags:
+ - IncidentActionItems
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/action_items:
+ get:
+ description: List all action items for an organization
+ operationId: listAllIncidentActionItems
+ parameters:
- explode: true
in: query
- name: "filter[type]"
+ name: include
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[user_id]"
+ name: "page[number]"
required: false
schema:
type: integer
style: form
- explode: true
in: query
- name: "filter[environments]"
+ name: "page[size]"
required: false
schema:
- type: string
+ type: integer
style: form
- explode: true
in: query
- name: "filter[functionalities]"
+ name: "filter[kind]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[services]"
+ name: "filter[priority]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[teams]"
+ name: "filter[status]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[created_at][gt]"
+ name: "filter[incident_status]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[created_at][gte]"
+ name: "filter[incident_created_at][gt]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[created_at][lt]"
+ name: "filter[incident_created_at][gte]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[created_at][lte]"
+ name: "filter[incident_created_at][lt]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[started_at][gt]"
+ name: "filter[incident_created_at][lte]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[started_at][gte]"
+ name: "filter[due_date][gt]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[started_at][lt]"
+ name: "filter[due_date][gte]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[started_at][lte]"
+ name: "filter[due_date][lt]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[mitigated_at][gt]"
+ name: "filter[due_date][lte]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[mitigated_at][gte]"
+ name: "filter[created_at][gt]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[mitigated_at][lt]"
+ name: "filter[created_at][gte]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[mitigated_at][lte]"
+ name: "filter[created_at][lt]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[resolved_at][gt]"
+ name: "filter[created_at][lte]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[resolved_at][gte]"
+ name: sort
required: false
schema:
type: string
style: form
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/incident_action_item_list'
+ description: success
+ security:
+ - bearer_auth: []
+ summary: List all action items for an organization
+ tags:
+ - IncidentActionItems
+ x-accepts:
+ - application/vnd.api+json
+ /v1/incidents/{incident_id}/custom_field_selections:
+ get:
+ deprecated: true
+ description: "[DEPRECATED] Use form field endpoints instead. List incident custom\
+ \ field selections"
+ operationId: listIncidentCustomFieldSelections
+ parameters:
+ - explode: false
+ in: path
+ name: incident_id
+ required: true
+ schema:
+ type: string
+ style: simple
- explode: true
in: query
- name: "filter[resolved_at][lt]"
+ name: include
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[resolved_at][lte]"
+ name: "page[number]"
required: false
schema:
- type: string
+ type: integer
style: form
- explode: true
in: query
- name: sort
+ name: "page[size]"
required: false
schema:
- type: string
+ type: integer
style: form
responses:
"200":
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/incident_post_mortem_list'
+ $ref: '#/components/schemas/incident_custom_field_selection_list'
description: success
security:
- bearer_auth: []
- summary: List incident retrospectives
+ summary: "[DEPRECATED] List incident custom field selections"
tags:
- - IncidentRetrospectives
+ - "[DEPRECATED] IncidentCustomFieldSelections"
x-accepts:
- application/vnd.api+json
- /v1/post_mortems/{id}:
- get:
- description: List incidents retrospectives
- operationId: ListIncidentPostmortem
+ post:
+ deprecated: true
+ description: "[DEPRECATED] Use form field endpoints instead. Creates a new incident\
+ \ custom field selection from provided data"
+ operationId: createIncidentCustomFieldSelection
parameters:
- explode: false
in: path
- name: id
+ name: incident_id
required: true
schema:
type: string
style: simple
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/new_incident_custom_field_selection'
+ required: true
responses:
- "200":
+ "201":
content:
application/vnd.api+json:
- example:
- data:
- id: 57832657-a5c2-4950-aa35-bcd96b2cbb2a
- type: incident_post_mortems
- attributes:
- incident_id: 6d18d07b-2e95-461e-9711-e29893cd34c9
- title: Quaerat eos quia et.
- status: draft
- url: https://test.rootly.com/account/post_mortems/quaerat-eos-quia-et
- short_url: null
- content: null
- published_at: null
- started_at: 2025-05-22T06:46:16.457-07:00
- mitigated_at: null
- resolved_at: null
- cancelled_at: null
- show_timeline: true
- show_timeline_starred_only: false
- show_timeline_genius: true
- show_timeline_trail: true
- show_timeline_tasks: true
- show_timeline_action_items: true
- show_timeline_order: desc
- show_functionalities_impacted: true
- show_services_impacted: true
- show_groups_impacted: true
- show_action_items: true
- created_at: 2025-05-22T06:46:17.104-07:00
- updated_at: 2025-05-22T06:46:17.111-07:00
- relationships:
- incident_retrospective_steps:
- data:
- - id: 8faac01e-d580-436a-8a84-bc62c9ff6d7d
- type: incident_retrospective_steps
schema:
- $ref: '#/components/schemas/incident_post_mortem_response'
- description: incident_post_mortem found
- "404":
+ $ref: '#/components/schemas/incident_custom_field_selection_response'
+ description: incident_custom_field_selection created
+ "422":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
- description: resource not found
+ description: invalid request
+ "401":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: responds with unauthorized for invalid token
security:
- bearer_auth: []
- summary: Retrieves an incident retrospective
+ summary: "[DEPRECATED] Creates an incident custom field selection"
tags:
- - IncidentRetrospectives
+ - "[DEPRECATED] IncidentCustomFieldSelections"
+ x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- put:
- description: Update a specific incident retrospective by id
- operationId: updateIncidentPostmortem
+ /v1/incident_custom_field_selections/{id}:
+ delete:
+ deprecated: true
+ description: "[DEPRECATED] Use form field endpoints instead. Delete a specific\
+ \ incident custom field selection by id"
+ operationId: deleteIncidentCustomFieldSelection
parameters:
- explode: false
in: path
@@ -17614,73 +12167,31 @@ paths:
schema:
type: string
style: simple
- requestBody:
- content:
- application/vnd.api+json:
- schema:
- $ref: '#/components/schemas/update_incident_post_mortem'
- required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 57832657-a5c2-4950-aa35-bcd96b2cbb2a
- type: incident_post_mortems
- attributes:
- incident_id: 6d18d07b-2e95-461e-9711-e29893cd34c9
- title: Retrospective updated
- status: draft
- url: https://test.rootly.com/account/post_mortems/quaerat-eos-quia-et
- short_url: null
- content: null
- published_at: null
- started_at: 2025-05-22T06:46:16.457-07:00
- mitigated_at: null
- resolved_at: null
- cancelled_at: null
- show_timeline: false
- show_timeline_starred_only: false
- show_timeline_genius: true
- show_timeline_trail: true
- show_timeline_tasks: true
- show_timeline_action_items: true
- show_timeline_order: desc
- show_functionalities_impacted: true
- show_services_impacted: true
- show_groups_impacted: true
- show_action_items: true
- created_at: 2025-05-22T06:46:17.104-07:00
- updated_at: 2025-05-22T06:46:31.720-07:00
- relationships:
- incident_retrospective_steps:
- data: []
schema:
- $ref: '#/components/schemas/incident_post_mortem_response'
- description: incident_post_mortem updated
+ $ref: '#/components/schemas/incident_custom_field_selection_response'
+ description: incident_custom_field_selection deleted
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Update an incident retrospective
+ summary: "[DEPRECATED] Delete an incident custom field selection"
tags:
- - IncidentRetrospectives
- x-content-type: application/vnd.api+json
+ - "[DEPRECATED] IncidentCustomFieldSelections"
x-accepts:
- application/vnd.api+json
- /v1/incident_retrospective_steps/{id}:
get:
- description: Retrieves a specific incident retrospective step by id
- operationId: getIncidentRetrospectiveStep
+ deprecated: true
+ description: "[DEPRECATED] Use form field endpoints instead. Retrieves a specific\
+ \ incident custom field selection by id"
+ operationId: getIncidentCustomFieldSelection
parameters:
- explode: false
in: path
@@ -17693,48 +12204,27 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: c5b31007-82f2-4418-8eb2-539aca0ae15e
- type: incident_retrospective_steps
- attributes:
- retrospective_step_id: 257ceea8-acc9-4d6f-86a0-489bc513f6ed
- incident_id: c2403b3d-2f93-48d9-8270-3bee85d4ef9d
- title: Step 4
- description: null
- due_date: null
- user_id: null
- kind: custom
- position: 1
- skippable: false
- status: todo
- status_changed_at: null
- status_changed_by_id: null
- created_at: 2025-05-22T06:46:33.809-07:00
- updated_at: 2025-05-22T06:46:33.809-07:00
schema:
- $ref: '#/components/schemas/incident_retrospective_step_response'
- description: incident retrospective_step found
+ $ref: '#/components/schemas/incident_custom_field_selection_response'
+ description: incident_custom_field_selection found
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Retrieves an incident retrospective step
+ summary: "[DEPRECATED] Retrieves an incident custom field selection"
tags:
- - IncidentRetrospectiveSteps
+ - "[DEPRECATED] IncidentCustomFieldSelections"
x-accepts:
- application/vnd.api+json
put:
- description: Update a specific incident retrospective step by id
- operationId: updateIncidentRetrospectiveStep
+ deprecated: true
+ description: "[DEPRECATED] Use form field endpoints instead. Update a specific\
+ \ incident custom field selection by id"
+ operationId: updateIncidentCustomFieldSelection
parameters:
- explode: false
in: path
@@ -17747,60 +12237,37 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/update_incident_retrospective_step'
+ $ref: '#/components/schemas/update_incident_custom_field_selection'
required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: c5b31007-82f2-4418-8eb2-539aca0ae15e
- type: incident_retrospective_steps
- attributes:
- retrospective_step_id: 257ceea8-acc9-4d6f-86a0-489bc513f6ed
- incident_id: c2403b3d-2f93-48d9-8270-3bee85d4ef9d
- title: Step 2
- description: Step 2 description
- due_date: 2024-12-05T08:10:58.323-08:00
- user_id: null
- kind: custom
- position: 2
- skippable: true
- status: todo
- status_changed_at: null
- status_changed_by_id: null
- created_at: 2025-05-22T06:46:33.809-07:00
- updated_at: 2025-05-22T06:46:34.556-07:00
schema:
- $ref: '#/components/schemas/incident_retrospective_step_response'
- description: incident_retrospective_step updated
+ $ref: '#/components/schemas/incident_custom_field_selection_response'
+ description: incident_custom_field_selection updated
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Update an incident retrospective step
+ summary: "[DEPRECATED] Update an incident custom field selection"
tags:
- - IncidentRetrospectiveSteps
+ - "[DEPRECATED] IncidentCustomFieldSelections"
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/incident_roles/{incident_role_id}/incident_role_tasks:
+ /v1/events/{incident_event_id}/functionalities:
get:
- description: List incident_role tasks
- operationId: listIncidentRoleTasks
+ description: List incident event functionalities
+ operationId: listIncidentEventFunctionalities
parameters:
- explode: false
in: path
- name: incident_role_id
+ name: incident_event_id
required: true
schema:
type: string
@@ -17831,22 +12298,22 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/incident_role_task_list'
+ $ref: '#/components/schemas/incident_event_functionality_list'
description: success
security:
- bearer_auth: []
- summary: List incident role tasks
+ summary: List incident event functionalities
tags:
- - IncidentRoleTasks
+ - IncidentEventFunctionalities
x-accepts:
- application/vnd.api+json
post:
- description: Creates a new task from provided data
- operationId: createIncidentRoleTask
+ description: Creates a new event functionality from provided data
+ operationId: createIncidentEventFunctionality
parameters:
- explode: false
in: path
- name: incident_role_id
+ name: incident_event_id
required: true
schema:
type: string
@@ -17855,58 +12322,39 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/new_incident_role_task'
+ $ref: '#/components/schemas/new_incident_event_functionality'
required: true
responses:
"201":
content:
application/vnd.api+json:
- example:
- data:
- id: e753da0c-7c36-4834-9e07-ac7f13f0e8aa
- type: incident_role_tasks
- attributes:
- incident_role_id: 174d37fb-80da-4ca4-bbb9-04ec75b915f3
- task: New task
- description: New task description
- priority: high
- created_at: 2025-05-22T06:46:36.158-07:00
- updated_at: 2025-05-22T06:46:36.158-07:00
schema:
- $ref: '#/components/schemas/incident_role_task_response'
- description: incident_role_task created
+ $ref: '#/components/schemas/incident_event_functionality_response'
+ description: incident_event_functionality created
"422":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Task can't be blank
- status: "422"
schema:
$ref: '#/components/schemas/errors_list'
description: invalid request
"401":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
description: responds with unauthorized for invalid token
security:
- bearer_auth: []
- summary: Creates an incident role task
+ summary: Creates an incident event functionality
tags:
- - IncidentRoleTasks
+ - IncidentEventFunctionalities
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/incident_role_tasks/{id}:
+ /v1/incident_event_functionalities/{id}:
delete:
- description: Delete a specific incident_role task by id
- operationId: deleteIncidentRoleTask
+ description: Delete a specific incident event functionality by id
+ operationId: deleteIncidentEventFunctionality
parameters:
- explode: false
in: path
@@ -17919,40 +12367,25 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 1d18ae80-75d7-48b2-9dac-d759baddcc47
- type: incident_role_tasks
- attributes:
- incident_role_id: 174d37fb-80da-4ca4-bbb9-04ec75b915f3
- task: Dolorum autem aut hic.
- description: Voluptatem dolor molestiae rerum.
- priority: medium
- created_at: 2025-05-22T06:46:35.979-07:00
- updated_at: 2025-05-22T06:46:37.956-07:00
schema:
- $ref: '#/components/schemas/incident_role_task_response'
- description: incident_role_task deleted
+ $ref: '#/components/schemas/incident_event_functionality_response'
+ description: incident_event deleted
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Delete an incident role task
+ summary: Delete an incident event functionality
tags:
- - IncidentRoleTasks
+ - IncidentEventFunctionalities
x-accepts:
- application/vnd.api+json
get:
- description: Retrieves a specific incident_role_task by id
- operationId: getIncidentRoleTask
+ description: Retrieves a specific incident_event_functionality by id
+ operationId: getIncidentEventFunctionalities
parameters:
- explode: false
in: path
@@ -17965,40 +12398,25 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 1d18ae80-75d7-48b2-9dac-d759baddcc47
- type: incident_role_tasks
- attributes:
- incident_role_id: 174d37fb-80da-4ca4-bbb9-04ec75b915f3
- task: Dolorum autem aut hic.
- description: Voluptatem dolor molestiae rerum.
- priority: medium
- created_at: 2025-05-22T06:46:35.979-07:00
- updated_at: 2025-05-22T06:46:35.989-07:00
schema:
- $ref: '#/components/schemas/incident_role_task_response'
- description: incident_role_task found
+ $ref: '#/components/schemas/incident_event_functionality_response'
+ description: incident_event_functionality found
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Retrieves an incident role task
+ summary: Retrieves an incident event functionality
tags:
- - IncidentRoleTasks
+ - IncidentEventFunctionalities
x-accepts:
- application/vnd.api+json
put:
- description: Update a specific incident_role task by id
- operationId: updateIncidentRoleTask
+ description: Update a specific incident event functionality by id
+ operationId: updateIncidentEventFunctionality
parameters:
- explode: false
in: path
@@ -18011,49 +12429,41 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/update_incident_role_task'
+ $ref: '#/components/schemas/update_incident_event_functionality'
required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 1d18ae80-75d7-48b2-9dac-d759baddcc47
- type: incident_role_tasks
- attributes:
- incident_role_id: 174d37fb-80da-4ca4-bbb9-04ec75b915f3
- task: Task updated
- description: Task description updated
- priority: medium
- created_at: 2025-05-22T06:46:35.979-07:00
- updated_at: 2025-05-22T06:46:37.399-07:00
schema:
- $ref: '#/components/schemas/incident_role_task_response'
- description: incident_role_task updated
+ $ref: '#/components/schemas/incident_event_functionality_response'
+ description: incident_event_functionality updated
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Update an incident role task
+ summary: Update an incident event
tags:
- - IncidentRoleTasks
+ - IncidentEventFunctionalities
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/incident_roles:
+ /v1/events/{incident_event_id}/services:
get:
- description: List incident roles
- operationId: listIncidentRoles
+ description: List incident event services
+ operationId: listIncidentEventServices
parameters:
+ - explode: false
+ in: path
+ name: incident_event_id
+ required: true
+ schema:
+ type: string
+ style: simple
- explode: true
in: query
name: include
@@ -18075,147 +12485,68 @@ paths:
schema:
type: integer
style: form
- - explode: true
- in: query
- name: "filter[search]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[slug]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[name]"
- required: false
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/incident_event_service_list'
+ description: success
+ security:
+ - bearer_auth: []
+ summary: List incident event services
+ tags:
+ - IncidentEventServices
+ x-accepts:
+ - application/vnd.api+json
+ post:
+ description: Creates a new event service from provided data
+ operationId: createIncidentEventService
+ parameters:
+ - explode: false
+ in: path
+ name: incident_event_id
+ required: true
schema:
type: string
- style: form
- - explode: true
- in: query
- name: "filter[enabled]"
- required: false
- schema:
- type: boolean
- style: form
- - explode: true
- in: query
- name: "filter[created_at][gt]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[created_at][gte]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[created_at][lt]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[created_at][lte]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: sort
- required: false
- schema:
- type: string
- style: form
- responses:
- "200":
- content:
- application/vnd.api+json:
- schema:
- $ref: '#/components/schemas/incident_role_list'
- description: success
- security:
- - bearer_auth: []
- summary: List incident roles
- tags:
- - IncidentRoles
- x-accepts:
- - application/vnd.api+json
- post:
- description: Creates a new incident role from provided data
- operationId: createIncidentRole
- parameters: []
+ style: simple
requestBody:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/new_incident_role'
+ $ref: '#/components/schemas/new_incident_event_service'
required: true
responses:
"201":
content:
application/vnd.api+json:
- example:
- data:
- id: 2a8093eb-ad86-4675-adbe-08bd7829eff3
- type: incident_roles
- attributes:
- slug: my-incident-role
- name: My Incident Role
- summary: My Incident Role summary
- description: My Incident Role description
- position: 1
- optional: false
- enabled: true
- allow_multi_user_assignment: true
- created_at: 2025-05-22T06:46:42.260-07:00
- updated_at: 2025-05-22T06:46:42.260-07:00
schema:
- $ref: '#/components/schemas/incident_role_response'
- description: incident_role created
+ $ref: '#/components/schemas/incident_event_service_response'
+ description: incident_event_service created
"422":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Name can't be blank
- status: "422"
schema:
$ref: '#/components/schemas/errors_list'
description: invalid request
"401":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
description: responds with unauthorized for invalid token
security:
- bearer_auth: []
- summary: Creates an incident role
+ summary: Creates an incident event service
tags:
- - IncidentRoles
+ - IncidentEventServices
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/incident_roles/{id}:
+ /v1/incident_event_services/{id}:
delete:
- description: Delete a specific incident_role by id
- operationId: deleteIncidentRole
+ description: Delete a specific incident event service by id
+ operationId: deleteIncidentEventService
parameters:
- explode: false
in: path
@@ -18228,44 +12559,25 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 5223ce3b-075a-4021-a8ad-3086bf8ff0f1
- type: incident_roles
- attributes:
- slug: ut-saepe-accusamus-modi
- name: Ut saepe accusamus modi.
- summary: null
- description: null
- position: 1
- optional: false
- enabled: true
- allow_multi_user_assignment: false
- created_at: 2025-05-22T06:46:40.019-07:00
- updated_at: 2025-05-22T06:46:44.157-07:00
schema:
- $ref: '#/components/schemas/incident_role_response'
- description: incident_role deleted
+ $ref: '#/components/schemas/incident_event_service_response'
+ description: incident_event deleted
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Delete an incident role
+ summary: Delete an incident event functionalitu
tags:
- - IncidentRoles
+ - IncidentEventServices
x-accepts:
- application/vnd.api+json
get:
- description: Retrieves a specific incident_role by id
- operationId: getIncidentRole
+ description: Retrieves a specific incident_event_service by id
+ operationId: getIncidentEventServices
parameters:
- explode: false
in: path
@@ -18278,44 +12590,25 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 5223ce3b-075a-4021-a8ad-3086bf8ff0f1
- type: incident_roles
- attributes:
- slug: ut-saepe-accusamus-modi
- name: Ut saepe accusamus modi.
- summary: null
- description: null
- position: 1
- optional: false
- enabled: true
- allow_multi_user_assignment: false
- created_at: 2025-05-22T06:46:40.019-07:00
- updated_at: 2025-05-22T06:46:40.019-07:00
schema:
- $ref: '#/components/schemas/incident_role_response'
- description: incident_role found
+ $ref: '#/components/schemas/incident_event_service_response'
+ description: incident_event_service found
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Retrieves an incident role
+ summary: Retrieves an incident event service
tags:
- - IncidentRoles
+ - IncidentEventServices
x-accepts:
- application/vnd.api+json
put:
- description: Update a specific incident_role by id
- operationId: updateIncidentRole
+ description: Update a specific incident event service by id
+ operationId: updateIncidentEventService
parameters:
- explode: false
in: path
@@ -18328,52 +12621,33 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/update_incident_role'
+ $ref: '#/components/schemas/update_incident_event_service'
required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 5223ce3b-075a-4021-a8ad-3086bf8ff0f1
- type: incident_roles
- attributes:
- slug: my-incident-role-updated
- name: My Incident Role Updated
- summary: My Incident Role Summary Updated
- description: My Incident Role Description Updated
- position: 2
- optional: true
- enabled: true
- allow_multi_user_assignment: false
- created_at: 2025-05-22T06:46:40.019-07:00
- updated_at: 2025-05-22T06:46:43.583-07:00
schema:
- $ref: '#/components/schemas/incident_role_response'
- description: incident_role updated
+ $ref: '#/components/schemas/incident_event_service_response'
+ description: incident_event_service updated
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Update an incident role
+ summary: Update an incident event
tags:
- - IncidentRoles
+ - IncidentEventServices
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/incidents/{incident_id}/status-page-events:
+ /v1/incidents/{incident_id}/events:
get:
- description: List incident status page events
- operationId: listIncidentStatusPages
+ description: List incident events
+ operationId: listIncidentEvents
parameters:
- explode: false
in: path
@@ -18408,18 +12682,18 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/incident_status_page_event_list'
+ $ref: '#/components/schemas/incident_event_list'
description: success
security:
- bearer_auth: []
- summary: List incident status page events
+ summary: List incident events
tags:
- - IncidentStatusPageEvents
+ - IncidentEvents
x-accepts:
- application/vnd.api+json
post:
description: Creates a new event from provided data
- operationId: createIncidentStatusPage
+ operationId: createIncidentEvent
parameters:
- explode: false
in: path
@@ -18432,63 +12706,39 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/new_incident_status_page_event'
+ $ref: '#/components/schemas/new_incident_event'
required: true
responses:
"201":
content:
application/vnd.api+json:
- example:
- data:
- id: 0878a132-9d31-479a-9743-e89e4e7a1583
- type: incident_status_page_events
- attributes:
- incident_id: 22f6ab3d-b253-49be-be8d-f98118177d22
- status_page_id: 18c19c19-de7b-432a-8e33-c63e65279ae6
- status: investigating
- notify_subscribers: true
- should_tweet: false
- started_at: 2025-05-22T06:46:46.578-07:00
- created_at: 2025-05-22T06:46:46.578-07:00
- updated_at: 2025-05-22T06:46:46.578-07:00
- event: New Event
schema:
- $ref: '#/components/schemas/incident_status_page_event_response'
- description: incident_status_page_event created
+ $ref: '#/components/schemas/incident_event_response'
+ description: incident_event created
"422":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Status page must exist
- status: "422"
- - title: Event can't be blank
- status: "422"
schema:
$ref: '#/components/schemas/errors_list'
description: invalid request
"401":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
description: responds with unauthorized for invalid token
security:
- bearer_auth: []
- summary: Creates an incident status page event
+ summary: Creates an incident event
tags:
- - IncidentStatusPageEvents
+ - IncidentEvents
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/status-page-events/{id}:
+ /v1/events/{id}:
delete:
- description: Delete a specific incident status page event by id
- operationId: deleteIncidentStatusPage
+ description: Delete a specific incident event by id
+ operationId: deleteIncidentEvent
parameters:
- explode: false
in: path
@@ -18501,43 +12751,25 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: bb5b18fa-e416-4d27-b1fe-0c5975eb21bc
- type: incident_status_page_events
- attributes:
- incident_id: 22f6ab3d-b253-49be-be8d-f98118177d22
- status_page_id: 18c19c19-de7b-432a-8e33-c63e65279ae6
- status: investigating
- notify_subscribers: false
- should_tweet: false
- started_at: 2025-05-22T06:46:46.184-07:00
- created_at: 2025-05-22T06:46:46.184-07:00
- updated_at: 2025-05-22T06:46:48.888-07:00
- event: Et temporibus quia enim.
schema:
- $ref: '#/components/schemas/incident_status_page_event_response'
- description: incident_status_page_event deleted
+ $ref: '#/components/schemas/incident_event_response'
+ description: incident_event deleted
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Delete an incident status page event
+ summary: Delete an incident event
tags:
- - IncidentStatusPageEvents
+ - IncidentEvents
x-accepts:
- application/vnd.api+json
get:
- description: Retrieves a specific incident_status_page_event by id
- operationId: getIncidentStatusPages
+ description: Retrieves a specific incident_event by id
+ operationId: getIncidentEvents
parameters:
- explode: false
in: path
@@ -18550,43 +12782,25 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: bb5b18fa-e416-4d27-b1fe-0c5975eb21bc
- type: incident_status_page_events
- attributes:
- incident_id: 22f6ab3d-b253-49be-be8d-f98118177d22
- status_page_id: 18c19c19-de7b-432a-8e33-c63e65279ae6
- status: investigating
- notify_subscribers: false
- should_tweet: false
- started_at: 2025-05-22T06:46:46.184-07:00
- created_at: 2025-05-22T06:46:46.184-07:00
- updated_at: 2025-05-22T06:46:46.184-07:00
- event: Et temporibus quia enim.
schema:
- $ref: '#/components/schemas/incident_status_page_event_response'
- description: incident_status_page_event found
+ $ref: '#/components/schemas/incident_event_response'
+ description: incident_event found
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Retrieves an incident status page event
+ summary: Retrieves an incident event
tags:
- - IncidentStatusPageEvents
+ - IncidentEvents
x-accepts:
- application/vnd.api+json
put:
- description: Update a specific incident status page event by id
- operationId: updateIncidentStatusPage
+ description: Update a specific incident event by id
+ operationId: updateIncidentEvent
parameters:
- explode: false
in: path
@@ -18599,51 +12813,33 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/update_incident_status_page_event'
+ $ref: '#/components/schemas/update_incident_event'
required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: bb5b18fa-e416-4d27-b1fe-0c5975eb21bc
- type: incident_status_page_events
- attributes:
- incident_id: 22f6ab3d-b253-49be-be8d-f98118177d22
- status_page_id: ef400f0b-bd32-4240-bd6a-2a076b4053c2
- status: investigating
- notify_subscribers: false
- should_tweet: false
- started_at: 2025-05-22T06:46:46.184-07:00
- created_at: 2025-05-22T06:46:46.184-07:00
- updated_at: 2025-05-22T06:46:48.162-07:00
- event: Event updated
schema:
- $ref: '#/components/schemas/incident_status_page_event_response'
- description: incident_status_page_event updated
+ $ref: '#/components/schemas/incident_event_response'
+ description: incident_event updated
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Update an incident status page event
+ summary: Update an incident event
tags:
- - IncidentStatusPageEvents
+ - IncidentEvents
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/incidents/{incident_id}/sub_statuses:
+ /v1/incidents/{incident_id}/feedbacks:
get:
- description: List incident_sub_statuses
- operationId: listIncidentSubStatuses
+ description: List incident feedbacks
+ operationId: listIncidentFeedbacks
parameters:
- explode: false
in: path
@@ -18652,30 +12848,11 @@ paths:
schema:
type: string
style: simple
- - description: "comma separated if needed. eg: sub_status,assigned_by_user"
- explode: true
+ - explode: true
in: query
name: include
required: false
schema:
- enum:
- - sub_status
- - assigned_by_user
- type: string
- style: form
- - description: "comma separated if needed. eg: created_at,updated_at"
- explode: true
- in: query
- name: sort
- required: false
- schema:
- enum:
- - created_at
- - -created_at
- - updated_at
- - -updated_at
- - assigned_at
- - -assigned_at
type: string
style: form
- explode: true
@@ -18692,58 +12869,23 @@ paths:
schema:
type: integer
style: form
- - explode: true
- in: query
- name: "filter[sub_status_id]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[assigned_at][gt]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[assigned_at][gte]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[assigned_at][lt]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[assigned_at][lte]"
- required: false
- schema:
- type: string
- style: form
responses:
"200":
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/incident_sub_status_list'
+ $ref: '#/components/schemas/incident_feedback_list'
description: success
security:
- bearer_auth: []
- summary: List incident_sub_statuses
+ summary: List incident feedbacks
tags:
- - IncidentSubStatuses
+ - IncidentFeedbacks
x-accepts:
- application/vnd.api+json
post:
- description: Creates a new sub-status assignment from provided data
- operationId: createIncidentSubStatus
+ description: Creates a new feedback from provided data
+ operationId: createIncidentFeedback
parameters:
- explode: false
in: path
@@ -18756,53 +12898,39 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/new_incident_sub_status'
+ $ref: '#/components/schemas/new_incident_feedback'
required: true
responses:
"201":
content:
application/vnd.api+json:
- example:
- data:
- id: 7d9446a6-5692-4a21-9cfd-0aee9edd1a49
- type: incident_sub_statuses
- attributes:
- sub_status_id: 0f35cfae-189b-421b-8a23-6be0a9789245
- incident_id: 89308391-3b55-4db3-b84c-011069200be8
- assigned_at: 2025-05-22T06:46:50.000-07:00
- assigned_by_user_id: null
- relationships:
- sub_status:
- data:
- id: 0f35cfae-189b-421b-8a23-6be0a9789245
- type: sub_statuses
- assigned_by_user:
- data: null
schema:
- $ref: '#/components/schemas/incident_sub_status_response'
- description: incident_sub_status created
+ $ref: '#/components/schemas/incident_feedback_response'
+ description: incident_feedback created
+ "422":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: invalid request
"401":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
description: responds with unauthorized for invalid token
security:
- bearer_auth: []
- summary: Creates a sub-status assignment
+ summary: Creates an incident feedback
tags:
- - IncidentSubStatuses
+ - IncidentFeedbacks
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/incident_sub_statuses/{id}:
- delete:
- description: Delete a specific incident_sub_status by id
- operationId: deleteIncidentSubStatus
+ /v1/feedbacks/{id}:
+ get:
+ description: Retrieves a specific incident_feedback by id
+ operationId: getIncidentFeedbacks
parameters:
- explode: false
in: path
@@ -18815,101 +12943,25 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 0b28a79f-2ce1-4629-a06d-5ab593b77fad
- type: incident_sub_statuses
- attributes:
- sub_status_id: 58f38e9e-263e-43bd-8b4b-b1d8eb733246
- incident_id: 89308391-3b55-4db3-b84c-011069200be8
- assigned_at: 2025-05-22T06:46:50.720-07:00
- assigned_by_user_id: 286
- relationships:
- sub_status:
- data:
- id: 58f38e9e-263e-43bd-8b4b-b1d8eb733246
- type: sub_statuses
- assigned_by_user:
- data:
- id: "286"
- type: users
schema:
- $ref: '#/components/schemas/incident_sub_status_response'
- description: incident_sub_status deleted
+ $ref: '#/components/schemas/incident_feedback_response'
+ description: incident_feedback found
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Delete an incident_sub_status
- tags:
- - IncidentSubStatuses
- x-accepts:
- - application/vnd.api+json
- get:
- description: Retrieves a specific incident_sub_status by id
- operationId: getIncidentSubStatus
- parameters:
- - explode: false
- in: path
- name: id
- required: true
- schema:
- type: string
- style: simple
- - description: "comma separated if needed. eg: sub_status,assigned_by_user"
- explode: true
- in: query
- name: include
- required: false
- schema:
- enum:
- - sub_status
- - assigned_by_user
- type: string
- style: form
- responses:
- "200":
- content:
- application/vnd.api+json:
- example:
- data:
- id: 0b28a79f-2ce1-4629-a06d-5ab593b77fad
- type: incident_sub_statuses
- attributes:
- sub_status_id: 58f38e9e-263e-43bd-8b4b-b1d8eb733246
- incident_id: 89308391-3b55-4db3-b84c-011069200be8
- assigned_at: 2025-05-22T06:46:50.720-07:00
- assigned_by_user_id: 286
- relationships:
- sub_status:
- data:
- id: 58f38e9e-263e-43bd-8b4b-b1d8eb733246
- type: sub_statuses
- assigned_by_user:
- data:
- id: "286"
- type: users
- schema:
- $ref: '#/components/schemas/incident_sub_status_response'
- description: sub_status found
- security:
- - bearer_auth: []
- summary: Retrieves incident_sub_status
+ summary: Retrieves an incident feedback
tags:
- - IncidentSubStatuses
+ - IncidentFeedbacks
x-accepts:
- application/vnd.api+json
put:
- description: Update a specific incident_sub_status by id
- operationId: updateIncidentSubStatus
+ description: Update a specific incident feedback by id
+ operationId: updateIncidentFeedback
parameters:
- explode: false
in: path
@@ -18922,46 +12974,41 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/update_incident_sub_status'
+ $ref: '#/components/schemas/update_incident_feedback'
required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 0b28a79f-2ce1-4629-a06d-5ab593b77fad
- type: incident_sub_statuses
- attributes:
- sub_status_id: 58f38e9e-263e-43bd-8b4b-b1d8eb733246
- incident_id: 89308391-3b55-4db3-b84c-011069200be8
- assigned_at: 2025-05-22T06:46:52.000-07:00
- assigned_by_user_id: 286
- relationships:
- sub_status:
- data:
- id: 58f38e9e-263e-43bd-8b4b-b1d8eb733246
- type: sub_statuses
- assigned_by_user:
- data:
- id: "286"
- type: users
schema:
- $ref: '#/components/schemas/incident_sub_status_response'
- description: incident_sub_status updated
+ $ref: '#/components/schemas/incident_feedback_response'
+ description: incident_feedback updated
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
security:
- bearer_auth: []
- summary: Update incident_sub_status
+ summary: Update an incident feedback
tags:
- - IncidentSubStatuses
+ - IncidentFeedbacks
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/incident_types:
+ /v1/incidents/{incident_id}/form_field_selections:
get:
- description: List incident types
- operationId: listIncident Types
+ description: List incident form field selections
+ operationId: listIncidentFormFieldSelections
parameters:
+ - explode: false
+ in: path
+ name: incident_id
+ required: true
+ schema:
+ type: string
+ style: simple
- explode: true
in: query
name: include
@@ -18983,146 +13030,68 @@ paths:
schema:
type: integer
style: form
- - explode: true
- in: query
- name: "filter[slug]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[name]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[color]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[created_at][gt]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[created_at][gte]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[created_at][lt]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[created_at][lte]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: sort
- required: false
- schema:
- type: string
- style: form
responses:
"200":
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/incident_type_list'
+ $ref: '#/components/schemas/incident_form_field_selection_list'
description: success
security:
- bearer_auth: []
- summary: List incident types
+ summary: List incident form field selections
tags:
- - IncidentTypes
+ - IncidentFormFieldSelections
x-accepts:
- application/vnd.api+json
post:
- description: Creates a new incident_type from provided data
- operationId: createIncidentType
- parameters: []
+ description: Creates a new incident form field selection from provided data
+ operationId: createIncidentFormFieldSelection
+ parameters:
+ - explode: false
+ in: path
+ name: incident_id
+ required: true
+ schema:
+ type: string
+ style: simple
requestBody:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/new_incident_type'
+ $ref: '#/components/schemas/new_incident_form_field_selection'
required: true
responses:
"201":
content:
application/vnd.api+json:
- example:
- data:
- id: b7ee8200-0a22-45af-814a-4e3a5a5257aa
- type: incident_types
- attributes:
- slug: bug
- name: Bug
- description: Bug caused by a human
- color: '#FFF'
- position: 1
- notify_emails:
- - hello@rootly.com
- - world@rootly.com
- slack_channels:
- - id: C03MKDSEJE8
- name: elastisearch
- slack_aliases:
- - id: S03F7QUV7F1
- name: leadership
- created_at: 2025-05-22T06:46:57.100-07:00
- updated_at: 2025-05-22T06:46:57.100-07:00
schema:
- $ref: '#/components/schemas/incident_type_response'
- description: incident_type created
+ $ref: '#/components/schemas/incident_form_field_selection_response'
+ description: incident_form_field_selection created
"422":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Name can't be blank
- status: "422"
schema:
$ref: '#/components/schemas/errors_list'
description: invalid request
"401":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
- description: resource not found
+ description: responds with unauthorized for invalid token
security:
- bearer_auth: []
- summary: Creates an incident type
+ summary: Creates an incident form field selection
tags:
- - IncidentTypes
+ - IncidentFormFieldSelections
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/incident_types/{id}:
+ /v1/incident_form_field_selections/{id}:
delete:
- description: Delete a specific incident_type by id
- operationId: deleteIncidentType
+ description: Delete a specific incident form field selection by id
+ operationId: deleteIncidentFormFieldSelection
parameters:
- explode: false
in: path
@@ -19135,44 +13104,25 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 85408920-920c-4a10-a732-a8a235c1614a
- type: incident_types
- attributes:
- slug: libero-modi-perferendis-officia
- name: Libero modi perferendis officia.
- description: Temporibus delectus quo tempore.
- color: '#D7E7F5'
- position: 1
- notify_emails: []
- slack_channels: []
- slack_aliases: []
- created_at: 2025-05-22T06:46:54.845-07:00
- updated_at: 2025-05-22T06:46:58.972-07:00
schema:
- $ref: '#/components/schemas/incident_type_response'
- description: incident_type deleted
+ $ref: '#/components/schemas/incident_form_field_selection_response'
+ description: incident_form_field_selection deleted
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Delete an incident type
+ summary: Delete an incident form field selection
tags:
- - IncidentTypes
+ - IncidentFormFieldSelections
x-accepts:
- application/vnd.api+json
get:
- description: Retrieves a specific incident_type by id
- operationId: getIncidentType
+ description: Retrieves a specific incident form field selection by id
+ operationId: getIncidentFormFieldSelection
parameters:
- explode: false
in: path
@@ -19185,44 +13135,25 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 85408920-920c-4a10-a732-a8a235c1614a
- type: incident_types
- attributes:
- slug: libero-modi-perferendis-officia
- name: Libero modi perferendis officia.
- description: Temporibus delectus quo tempore.
- color: '#D7E7F5'
- position: 1
- notify_emails: []
- slack_channels: []
- slack_aliases: []
- created_at: 2025-05-22T06:46:54.845-07:00
- updated_at: 2025-05-22T06:46:54.845-07:00
schema:
- $ref: '#/components/schemas/incident_type_response'
- description: incident_type found
+ $ref: '#/components/schemas/incident_form_field_selection_response'
+ description: incident_form_field_selection found
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Retrieves an incident type
+ summary: Retrieves an incident form field selection
tags:
- - IncidentTypes
+ - IncidentFormFieldSelections
x-accepts:
- application/vnd.api+json
put:
- description: Update a specific incident_type by id
- operationId: updateIncidentType
+ description: Update a specific incident form field selection by id
+ operationId: updateIncidentFormFieldSelection
parameters:
- explode: false
in: path
@@ -19235,73 +13166,61 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/update_incident_type'
+ $ref: '#/components/schemas/update_incident_form_field_selection'
required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 85408920-920c-4a10-a732-a8a235c1614a
- type: incident_types
- attributes:
- slug: p1
- name: P1
- description: Medium Priority
- color: '#000'
- position: 2
- notify_emails: []
- slack_channels: []
- slack_aliases: []
- created_at: 2025-05-22T06:46:54.845-07:00
- updated_at: 2025-05-22T06:46:58.400-07:00
schema:
- $ref: '#/components/schemas/incident_type_response'
- description: incident_type updated
+ $ref: '#/components/schemas/incident_form_field_selection_response'
+ description: incident_form_field_selection updated
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Update an incident type
+ summary: Update an incident form field selection
tags:
- - IncidentTypes
+ - IncidentFormFieldSelections
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/incidents:
+ /v1/incident_permission_sets/{incident_permission_set_id}/booleans:
get:
- description: List incidents
- operationId: listIncidents
+ description: List incident_permission_set_booleans
+ operationId: listIncidentPermissionSetBooleans
parameters:
+ - explode: false
+ in: path
+ name: incident_permission_set_id
+ required: true
+ schema:
+ type: string
+ style: simple
- explode: true
in: query
- name: "page[number]"
+ name: include
required: false
schema:
- type: integer
+ type: string
style: form
- explode: true
in: query
- name: "page[size]"
+ name: "page[number]"
required: false
schema:
type: integer
style: form
- explode: true
in: query
- name: "filter[search]"
+ name: "page[size]"
required: false
schema:
- type: string
+ type: integer
style: form
- explode: true
in: query
@@ -19312,133 +13231,234 @@ paths:
style: form
- explode: true
in: query
- name: "filter[status]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[private]"
+ name: "filter[created_at][gt]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[user_id]"
- required: false
- schema:
- type: integer
- style: form
- - explode: true
- in: query
- name: "filter[severity]"
+ name: "filter[created_at][gte]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[severity_id]"
+ name: "filter[created_at][lt]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[labels]"
+ name: "filter[created_at][lte]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[types]"
+ name: sort
required: false
schema:
type: string
style: form
- - explode: true
- in: query
- name: "filter[type_ids]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[environments]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[environment_ids]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[functionalities]"
- required: false
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/incident_permission_set_boolean_list'
+ description: success
+ security:
+ - bearer_auth: []
+ summary: List incident_permission_set_booleans
+ tags:
+ - IncidentPermissionSetBooleans
+ x-accepts:
+ - application/vnd.api+json
+ post:
+ description: Creates a new incident_permission_set_boolean from provided data
+ operationId: createIncidentPermissionSetBoolean
+ parameters:
+ - explode: false
+ in: path
+ name: incident_permission_set_id
+ required: true
schema:
type: string
- style: form
- - explode: true
- in: query
- name: "filter[functionality_ids]"
- required: false
+ style: simple
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/new_incident_permission_set_boolean'
+ required: true
+ responses:
+ "201":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/incident_permission_set_boolean_response'
+ description: incident_permission_set_boolean created
+ "422":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: invalid request
+ "401":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: responds with unauthorized for invalid token
+ security:
+ - bearer_auth: []
+ summary: Creates an incident_permission_set_boolean
+ tags:
+ - IncidentPermissionSetBooleans
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/incident_permission_set_booleans/{id}:
+ delete:
+ description: Delete a specific incident_permission_set_boolean by id
+ operationId: deleteIncidentPermissionSetBoolean
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
schema:
type: string
- style: form
- - explode: true
- in: query
- name: "filter[services]"
- required: false
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/incident_permission_set_boolean_response'
+ description: incident_permission_set_boolean deleted
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Delete an incident_permission_set_boolean
+ tags:
+ - IncidentPermissionSetBooleans
+ x-accepts:
+ - application/vnd.api+json
+ get:
+ description: Retrieves a specific incident_permission_set_boolean by id
+ operationId: getIncidentPermissionSetBoolean
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
schema:
type: string
- style: form
- - explode: true
- in: query
- name: "filter[service_ids]"
- required: false
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/incident_permission_set_boolean_response'
+ description: incident_permission_set_boolean found
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Retrieves an incident_permission_set_boolean
+ tags:
+ - IncidentPermissionSetBooleans
+ x-accepts:
+ - application/vnd.api+json
+ put:
+ description: Update a specific incident_permission_set_boolean by id
+ operationId: updateIncidentPermissionSetBoolean
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
schema:
type: string
- style: form
- - explode: true
- in: query
- name: "filter[teams]"
- required: false
+ style: simple
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/update_incident_permission_set_boolean'
+ required: true
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/incident_permission_set_boolean_response'
+ description: incident_permission_set_boolean updated
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Update an incident_permission_set_boolean
+ tags:
+ - IncidentPermissionSetBooleans
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/incident_permission_sets/{incident_permission_set_id}/resources:
+ get:
+ description: List incident_permission_set_resources
+ operationId: listIncidentPermissionSetResources
+ parameters:
+ - explode: false
+ in: path
+ name: incident_permission_set_id
+ required: true
schema:
type: string
- style: form
+ style: simple
- explode: true
in: query
- name: "filter[team_ids]"
+ name: include
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[cause]"
+ name: "page[number]"
required: false
schema:
- type: string
+ type: integer
style: form
- explode: true
in: query
- name: "filter[cause_ids]"
+ name: "page[size]"
required: false
schema:
- type: string
+ type: integer
style: form
- explode: true
in: query
- name: "filter[custom_field_selected_option_ids]"
+ name: "filter[kind]"
required: false
schema:
type: string
@@ -19473,263 +13493,678 @@ paths:
style: form
- explode: true
in: query
- name: "filter[updated_at][gt]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[updated_at][gte]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[updated_at][lt]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[updated_at][lte]"
+ name: sort
required: false
schema:
type: string
style: form
- - explode: true
- in: query
- name: "filter[started_at][gt]"
- required: false
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/incident_permission_set_resource_list'
+ description: success
+ security:
+ - bearer_auth: []
+ summary: List incident_permission_set_resources
+ tags:
+ - IncidentPermissionSetResources
+ x-accepts:
+ - application/vnd.api+json
+ post:
+ description: Creates a new incident_permission_set_resource from provided data
+ operationId: createIncidentPermissionSetResource
+ parameters:
+ - explode: false
+ in: path
+ name: incident_permission_set_id
+ required: true
schema:
type: string
- style: form
- - explode: true
- in: query
- name: "filter[started_at][gte]"
- required: false
+ style: simple
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/new_incident_permission_set_resource'
+ required: true
+ responses:
+ "201":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/incident_permission_set_resource_response'
+ description: incident_permission_set_resource created
+ "422":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: invalid request
+ "401":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: responds with unauthorized for invalid token
+ security:
+ - bearer_auth: []
+ summary: Creates an incident_permission_set_resource
+ tags:
+ - IncidentPermissionSetResources
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/incident_permission_set_resources/{id}:
+ delete:
+ description: Delete a specific incident_permission_set_resource by id
+ operationId: deleteIncidentPermissionSetResource
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
schema:
type: string
- style: form
- - explode: true
- in: query
- name: "filter[started_at][lt]"
- required: false
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/incident_permission_set_resource_response'
+ description: incident_permission_set_resource deleted
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Delete an incident_permission_set_resource
+ tags:
+ - IncidentPermissionSetResources
+ x-accepts:
+ - application/vnd.api+json
+ get:
+ description: Retrieves a specific incident_permission_set_resource by id
+ operationId: getIncidentPermissionSetResource
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
schema:
type: string
- style: form
- - explode: true
- in: query
- name: "filter[started_at][lte]"
- required: false
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/incident_permission_set_resource_response'
+ description: incident_permission_set_resource found
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Retrieves an incident_permission_set_resource
+ tags:
+ - IncidentPermissionSetResources
+ x-accepts:
+ - application/vnd.api+json
+ put:
+ description: Update a specific incident_permission_set_resource by id
+ operationId: updateIncidentPermissionSetResource
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
schema:
type: string
- style: form
+ style: simple
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/update_incident_permission_set_resource'
+ required: true
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/incident_permission_set_resource_response'
+ description: incident_permission_set_resource updated
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Update an incident_permission_set_resource
+ tags:
+ - IncidentPermissionSetResources
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/incident_permission_sets:
+ get:
+ description: List incident_permission_sets
+ operationId: listIncidentPermissionSets
+ parameters:
- explode: true
in: query
- name: "filter[detected_at][gt]"
+ name: include
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[detected_at][gte]"
+ name: "page[number]"
required: false
schema:
- type: string
+ type: integer
style: form
- explode: true
in: query
- name: "filter[detected_at][lt]"
+ name: "page[size]"
required: false
schema:
- type: string
+ type: integer
style: form
- explode: true
in: query
- name: "filter[detected_at][lte]"
+ name: "filter[search]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[acknowledged_at][gt]"
+ name: "filter[slug]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[acknowledged_at][gte]"
+ name: "filter[name]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[acknowledged_at][lt]"
+ name: "filter[created_at][gt]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[acknowledged_at][lte]"
+ name: "filter[created_at][gte]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[mitigated_at][gt]"
+ name: "filter[created_at][lt]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[mitigated_at][gte]"
+ name: "filter[created_at][lte]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[mitigated_at][lt]"
+ name: sort
required: false
schema:
type: string
style: form
- - explode: true
- in: query
- name: "filter[mitigated_at][lte]"
- required: false
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/incident_permission_set_list'
+ description: success
+ security:
+ - bearer_auth: []
+ summary: List incident_permission_sets
+ tags:
+ - IncidentPermissionSets
+ x-accepts:
+ - application/vnd.api+json
+ post:
+ description: Creates a new incident_permission_set from provided data
+ operationId: createIncidentPermissionSet
+ parameters: []
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/new_incident_permission_set'
+ required: true
+ responses:
+ "201":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/incident_permission_set_response'
+ description: incident_permission_set created
+ "422":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: invalid request
+ "401":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: responds with unauthorized for invalid token
+ security:
+ - bearer_auth: []
+ summary: Creates an incident_permission_set
+ tags:
+ - IncidentPermissionSets
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/incident_permission_sets/{id}:
+ delete:
+ description: Delete a specific incident_permission_set by id
+ operationId: deleteIncidentPermissionSet
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[resolved_at][gt]"
- required: false
+ $ref: '#/components/schemas/getAlertField_id_parameter'
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/incident_permission_set_response'
+ description: incident_permission_set deleted
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Delete an incident_permission_set
+ tags:
+ - IncidentPermissionSets
+ x-accepts:
+ - application/vnd.api+json
+ get:
+ description: Retrieves a specific incident_permission_set by id
+ operationId: getIncidentPermissionSet
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ $ref: '#/components/schemas/getAlertField_id_parameter'
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/incident_permission_set_response'
+ description: incident_permission_set found
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Retrieves an incident_permission_set
+ tags:
+ - IncidentPermissionSets
+ x-accepts:
+ - application/vnd.api+json
+ put:
+ description: Update a specific incident_permission_set by id
+ operationId: updateIncidentPermissionSet
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ $ref: '#/components/schemas/getAlertField_id_parameter'
+ style: simple
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/update_incident_permission_set'
+ required: true
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/incident_permission_set_response'
+ description: incident_permission_set updated
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Update an incident_permission_set
+ tags:
+ - IncidentPermissionSets
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/post_mortems:
+ get:
+ description: List incident retrospectives
+ operationId: listIncidentPostMortems
+ parameters:
+ - explode: true
+ in: query
+ name: include
+ required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[resolved_at][gte]"
+ name: "page[number]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ - explode: true
+ in: query
+ name: "page[size]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ - explode: true
+ in: query
+ name: "filter[search]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[resolved_at][lt]"
+ name: "filter[status]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[resolved_at][lte]"
+ name: "filter[severity]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[closed_at][gt]"
+ name: "filter[type]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[closed_at][gte]"
+ name: "filter[user_id]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ - description: Filter by incident type slugs
+ explode: true
+ in: query
+ name: "filter[types]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - description: Filter by incident type IDs (UUIDs)
+ explode: true
+ in: query
+ name: "filter[type_ids]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - description: Filter by environment slugs
+ explode: true
+ in: query
+ name: "filter[environments]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - description: Filter by environment IDs (UUIDs)
+ explode: true
+ in: query
+ name: "filter[environment_ids]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - description: Filter by functionality slugs
+ explode: true
+ in: query
+ name: "filter[functionalities]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - description: Filter by functionality IDs (UUIDs)
+ explode: true
+ in: query
+ name: "filter[functionality_ids]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - description: Filter by service slugs
+ explode: true
+ in: query
+ name: "filter[services]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - description: Filter by service IDs (UUIDs)
+ explode: true
+ in: query
+ name: "filter[service_ids]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - description: Filter by team/group slugs
+ explode: true
+ in: query
+ name: "filter[teams]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - description: Filter by team/group IDs (UUIDs)
+ explode: true
+ in: query
+ name: "filter[team_ids]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - description: Filter by cause slugs
+ explode: true
+ in: query
+ name: "filter[causes]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - description: Filter by cause IDs (UUIDs)
+ explode: true
+ in: query
+ name: "filter[cause_ids]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[closed_at][lt]"
+ name: "filter[created_at][gt]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[closed_at][lte]"
+ name: "filter[created_at][gte]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[in_triage_at][gt]"
+ name: "filter[created_at][lt]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[in_triage_at][gte]"
+ name: "filter[created_at][lte]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[in_triage_at][lt]"
+ name: "filter[started_at][gt]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[in_triage_at][lte]"
+ name: "filter[started_at][gte]"
required: false
schema:
type: string
style: form
- - description: "comma separated if needed. eg: created_at,updated_at"
- explode: true
+ - explode: true
in: query
- name: sort
+ name: "filter[started_at][lt]"
required: false
schema:
- enum:
- - created_at
- - -created_at
- - updated_at
- - -updated_at
type: string
style: form
- - description: "comma separated if needed. eg: sub_statuses,causes,subscribers"
- explode: true
+ - explode: true
in: query
- name: include
+ name: "filter[started_at][lte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[mitigated_at][gt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[mitigated_at][gte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[mitigated_at][lt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[mitigated_at][lte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[resolved_at][gt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[resolved_at][gte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[resolved_at][lt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[resolved_at][lte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: sort
required: false
schema:
- enum:
- - sub_statuses
- - causes
- - subscribers
- - roles
- - slack_messages
- - environments
- - incident_types
- - services
- - functionalities
- - groups
- - events
- - action_items
- - custom_field_selections
- - feedbacks
- - incident_post_mortem
type: string
style: form
responses:
@@ -19737,1214 +14172,89 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/incident_list'
+ $ref: '#/components/schemas/incident_post_mortem_list'
description: success
security:
- bearer_auth: []
- summary: List incidents
+ summary: List incident retrospectives
tags:
- - Incidents
+ - IncidentRetrospectives
x-accepts:
- application/vnd.api+json
- post:
- description: Creates a new incident from provided data
- operationId: createIncident
- parameters: []
- requestBody:
- content:
- application/vnd.api+json:
- schema:
- $ref: '#/components/schemas/new_incident'
+ /v1/post_mortems/{id}:
+ get:
+ description: List incidents retrospectives
+ operationId: ListIncidentPostmortem
+ parameters:
+ - explode: false
+ in: path
+ name: id
required: true
+ schema:
+ $ref: '#/components/schemas/getAlertField_id_parameter'
+ style: simple
responses:
- "201":
- content:
- application/vnd.api+json:
- example:
- data:
- id: c3e81255-3620-43a8-a260-7e2834a3d600
- type: incidents
- attributes:
- parent_incident_id: null
- sequential_id: 11
- title: Oh no! Something is broken
- slug: oh-no-something-is-broken
- kind: normal
- private: false
- summary: |-
- this is the description and there are new lines
-
- this is the next line
-
- this is the 3rd line
- status: started
- source: api
- url: http://localhost:3001/account/incidents/11-oh-no-something-is-broken
- short_url: null
- user:
- data:
- id: "289"
- type: users
- attributes:
- name: Annita Wolff
- email: sandy@weimann.example
- phone: null
- phone_2: null
- first_name: Annita
- last_name: Wolff
- full_name: Annita Wolff
- full_name_with_team: "[Schmeler-Denesik] Annita Wolff"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:47:15.698-07:00
- created_at: 2025-05-22T06:46:59.395-07:00
- relationships:
- email_addresses:
- data:
- - id: 85183e4a-ff2f-433e-828a-fbe9d3ffeabb
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: 070850d3-910f-42f7-ac8e-881e3d1cf114
- created_at: 2025-05-22T06:46:59.584-07:00
- updated_at: 2025-05-22T06:46:59.584-07:00
- display_order: 2
- api_keys_permissions:
- - create
- - update
- - read
- - delete
- billing_permissions: []
- environments_permissions:
- - create
- - read
- - update
- - delete
- functionalities_permissions:
- - create
- - read
- - update
- - delete
- groups_permissions:
- - create
- - read
- - update
- - delete
- incident_causes_permissions:
- - create
- - read
- - update
- - delete
- incident_roles_permissions:
- - create
- - read
- - update
- - delete
- incident_types_permissions:
- - create
- - read
- - update
- - delete
- incidents_permissions:
- - create
- - read
- - update
- - delete
- private_incidents_permissions: []
- invitations_permissions:
- - create
- - read
- - update
- - delete
- playbooks_permissions:
- - create
- - read
- - update
- - delete
- retrospective_permissions:
- - create
- - read
- - update
- - delete
- roles_permissions: []
- services_permissions:
- - create
- - read
- - update
- - delete
- severities_permissions:
- - create
- - read
- - update
- - delete
- status_pages_permissions:
- - create
- - read
- - update
- - delete
- workflows_permissions:
- - create
- - read
- - update
- - delete
- team_id: 235
- name: user
- slug: user
- is_editable: true
- is_deletable: false
- incident_feedbacks_permissions:
- - read
- - create
- - update
- form_fields_permissions:
- - create
- - read
- - update
- - delete
- webhooks_permissions: []
- audits_permissions: []
- secrets_permissions:
- - create
- - read
- - update
- - delete
- deleted_at: null
- incident_permission_set_id: ce8e0129-ae20-4109-9ce5-9ce632b86933
- pulses_permissions:
- - create
- - update
- - read
- alerts_permissions:
- - create
- - read
- paging_permissions:
- - create
- - read
- - update
- - delete
- sub_statuses_permissions:
- - read
- catalogs_permissions:
- - create
- - read
- - update
- - delete
- communication_permissions:
- - read
- incident_communication_permissions:
- - read
- integrations_permissions: []
- on_call_role:
- data:
- id: 9817be29-441f-481c-88af-391816fec02b
- team_id: 235
- name: None
- slug: none
- system_role: no_access
- deleted_at: null
- created_at: 2025-05-22T06:46:59.607-07:00
- updated_at: 2025-05-22T06:46:59.607-07:00
- alerts_permissions: []
- api_keys_permissions: []
- audits_permissions: []
- escalation_policies_permissions: []
- groups_permissions: []
- integrations_permissions: []
- invitations_permissions: []
- on_call_roles_permissions: []
- schedules_permissions: []
- services_permissions: []
- shift_overrides_permissions: []
- workflows_permissions: []
- contacts_permissions: []
- live_call_routing_permissions: []
- heartbeats_permissions: []
- alert_urgency_permissions: []
- schedule_override_permissions: []
- webhooks_permissions: []
- alert_sources_permissions: []
- on_call_readiness_report_permissions: []
- alert_routing_rules_permissions: []
- severity:
- data:
- id: 84315fdd-923b-45e7-ad8e-cce567cb5b84
- type: severities
- attributes:
- name: 5uuzs
- slug: 5uuzs
- description: Sit dignissimos molestias voluptas.
- severity: medium
- color: '#E58A1F'
- position: 1
- notify_emails: []
- slack_channels: []
- slack_aliases: []
- created_at: 2025-05-22T06:47:07.337-07:00
- updated_at: 2025-05-22T06:47:07.337-07:00
- in_triage_by: null
- started_by:
- data:
- id: "289"
- type: users
- attributes:
- name: Annita Wolff
- email: sandy@weimann.example
- phone: null
- phone_2: null
- first_name: Annita
- last_name: Wolff
- full_name: Annita Wolff
- full_name_with_team: "[Schmeler-Denesik] Annita Wolff"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:47:15.698-07:00
- created_at: 2025-05-22T06:46:59.395-07:00
- relationships:
- email_addresses:
- data:
- - id: 85183e4a-ff2f-433e-828a-fbe9d3ffeabb
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: 070850d3-910f-42f7-ac8e-881e3d1cf114
- created_at: 2025-05-22T06:46:59.584-07:00
- updated_at: 2025-05-22T06:46:59.584-07:00
- display_order: 2
- api_keys_permissions:
- - create
- - update
- - read
- - delete
- billing_permissions: []
- environments_permissions:
- - create
- - read
- - update
- - delete
- functionalities_permissions:
- - create
- - read
- - update
- - delete
- groups_permissions:
- - create
- - read
- - update
- - delete
- incident_causes_permissions:
- - create
- - read
- - update
- - delete
- incident_roles_permissions:
- - create
- - read
- - update
- - delete
- incident_types_permissions:
- - create
- - read
- - update
- - delete
- incidents_permissions:
- - create
- - read
- - update
- - delete
- private_incidents_permissions: []
- invitations_permissions:
- - create
- - read
- - update
- - delete
- playbooks_permissions:
- - create
- - read
- - update
- - delete
- retrospective_permissions:
- - create
- - read
- - update
- - delete
- roles_permissions: []
- services_permissions:
- - create
- - read
- - update
- - delete
- severities_permissions:
- - create
- - read
- - update
- - delete
- status_pages_permissions:
- - create
- - read
- - update
- - delete
- workflows_permissions:
- - create
- - read
- - update
- - delete
- team_id: 235
- name: user
- slug: user
- is_editable: true
- is_deletable: false
- incident_feedbacks_permissions:
- - read
- - create
- - update
- form_fields_permissions:
- - create
- - read
- - update
- - delete
- webhooks_permissions: []
- audits_permissions: []
- secrets_permissions:
- - create
- - read
- - update
- - delete
- deleted_at: null
- incident_permission_set_id: ce8e0129-ae20-4109-9ce5-9ce632b86933
- pulses_permissions:
- - create
- - update
- - read
- alerts_permissions:
- - create
- - read
- paging_permissions:
- - create
- - read
- - update
- - delete
- sub_statuses_permissions:
- - read
- catalogs_permissions:
- - create
- - read
- - update
- - delete
- communication_permissions:
- - read
- incident_communication_permissions:
- - read
- integrations_permissions: []
- on_call_role:
- data:
- id: 9817be29-441f-481c-88af-391816fec02b
- team_id: 235
- name: None
- slug: none
- system_role: no_access
- deleted_at: null
- created_at: 2025-05-22T06:46:59.607-07:00
- updated_at: 2025-05-22T06:46:59.607-07:00
- alerts_permissions: []
- api_keys_permissions: []
- audits_permissions: []
- escalation_policies_permissions: []
- groups_permissions: []
- integrations_permissions: []
- invitations_permissions: []
- on_call_roles_permissions: []
- schedules_permissions: []
- services_permissions: []
- shift_overrides_permissions: []
- workflows_permissions: []
- contacts_permissions: []
- live_call_routing_permissions: []
- heartbeats_permissions: []
- alert_urgency_permissions: []
- schedule_override_permissions: []
- webhooks_permissions: []
- alert_sources_permissions: []
- on_call_readiness_report_permissions: []
- alert_routing_rules_permissions: []
- mitigated_by: null
- resolved_by: null
- closed_by: null
- cancelled_by: null
- mitigation_message: null
- resolution_message: null
- cancellation_message: null
- public_title: null
- duplicate_incident_id: null
- retrospective_progress_status: not_started
- zoom_meeting_id: null
- zoom_meeting_start_url: null
- zoom_meeting_join_url: null
- zoom_meeting_password: null
- zoom_meeting_pstn_password: null
- zoom_meeting_h323_password: null
- zoom_meeting_global_dial_in_numbers: []
- shortcut_story_id: null
- shortcut_story_url: null
- shortcut_task_id: null
- shortcut_task_url: null
- asana_task_id: null
- asana_task_url: null
- github_issue_id: null
- github_issue_url: null
- gitlab_issue_id: null
- gitlab_issue_url: null
- jira_issue_key: null
- jira_issue_id: null
- jira_issue_url: null
- google_meeting_id: null
- google_meeting_url: null
- trello_card_id: null
- trello_card_url: null
- linear_issue_id: null
- linear_issue_url: null
- zendesk_ticket_id: null
- zendesk_ticket_url: null
- motion_task_id: null
- motion_task_url: null
- clickup_task_id: null
- clickup_task_url: null
- slack_channel_name: null
- slack_channel_id: null
- slack_channel_url: null
- slack_channel_short_url: null
- slack_channel_deep_link: null
- slack_channel_archived: false
- slack_last_message_ts: null
- service_now_incident_id: null
- service_now_incident_key: null
- service_now_incident_url: null
- opsgenie_incident_id: null
- opsgenie_incident_url: null
- opsgenie_alert_id: null
- opsgenie_alert_url: null
- victor_ops_incident_id: null
- victor_ops_incident_url: null
- pagerduty_incident_id: null
- pagerduty_incident_number: null
- pagerduty_incident_url: null
- mattermost_channel_id: null
- mattermost_channel_name: null
- mattermost_channel_url: null
- confluence_page_id: null
- confluence_page_url: null
- quip_page_id: null
- quip_page_url: null
- airtable_base_key: null
- airtable_table_name: null
- airtable_record_id: null
- airtable_record_url: null
- google_drive_id: null
- google_drive_parent_id: null
- google_drive_url: null
- sharepoint_page_id: null
- sharepoint_page_url: null
- datadog_notebook_id: null
- datadog_notebook_url: null
- freshservice_ticket_id: null
- freshservice_ticket_url: null
- freshservice_task_id: null
- freshservice_task_url: null
- scheduled_for: null
- scheduled_until: null
- in_triage_at: null
- started_at: 2025-05-22T06:47:15.898-07:00
- detected_at: null
- acknowledged_at: null
- mitigated_at: null
- resolved_at: null
- closed_at: null
- cancelled_at: null
- created_at: 2025-05-22T06:47:15.965-07:00
- updated_at: 2025-05-22T06:47:16.138-07:00
- labels:
- platform: windows
- version: "1.12"
- CaseSensitive: preserve
- relationships:
- causes:
- data:
- - id: e4bd38d3-a915-4d3f-bd4a-c5e191d4ac2e
- type: causes
- - id: c60ff767-e655-4eaf-9426-236f0dd72476
- type: causes
- subscribers:
- data: []
- roles:
- data:
- - id: 6dc55aa9-6a3e-4bf6-bc6d-c79ae32fed2a
- type: incident_role_assignments
- environments:
- data:
- - id: c9ba5b1c-b5d7-4662-87b4-a60b5d47d40e
- type: environments
- - id: 7712251d-c1d9-44e5-b955-040da262aa9a
- type: environments
- incident_types:
- data:
- - id: 3367b5d8-34f0-4705-b974-15e6bf19583d
- type: incident_types
- - id: e47a23ab-732e-4aae-9c02-34bc081d2a9a
- type: incident_types
- services:
- data:
- - id: 3ba40030-ecfe-4640-b80a-0ef69e208d0d
- type: services
- - id: 89c303f5-7d62-4616-a289-6de761a618ef
- type: services
- functionalities:
- data:
- - id: fe1625b9-d4c2-4c5f-a41f-fb0a61cce861
- type: functionalities
- - id: 3f463171-a940-412b-b251-281ecbc3a2b2
- type: functionalities
- groups:
- data:
- - id: 95924bb5-05a8-4dc2-aa16-9113c2b9a094
- type: groups
- - id: 1c45d310-dd63-410b-a3c7-d4244124e1e5
- type: groups
- events:
- data:
- - id: 5ed5442e-eb8e-4c51-9f6c-178a2f54bebd
- type: incident_events
- - id: a8392ffa-384e-4506-b28f-4ad28386f0a0
- type: incident_events
- - id: c42d9717-074a-4435-a425-108c9c80b92c
- type: incident_events
- - id: 5674e014-8be0-4a55-bb3a-6bd6190b3723
- type: incident_events
- action_items:
- data: []
- custom_field_selections:
- data: []
- feedbacks:
- data: []
- attachments:
- data: []
- slack_messages:
- data: []
- schema:
- $ref: '#/components/schemas/incident_response'
- description: incident created
- "422":
+ "200":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Detected at can not be before Started time
- status: "422"
schema:
- $ref: '#/components/schemas/errors_list'
- description: invalid causes association
- "401":
+ $ref: '#/components/schemas/incident_post_mortem_response'
+ description: incident_post_mortem found
+ "404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
- description: responds with unauthorized for invalid token
+ description: resource not found
security:
- bearer_auth: []
- summary: Creates an incident
+ summary: Retrieves an incident retrospective
tags:
- - Incidents
- x-content-type: application/vnd.api+json
+ - IncidentRetrospectives
x-accepts:
- application/vnd.api+json
- /v1/incidents/{id}:
- delete:
- description: Delete a specific incident by id
- operationId: deleteIncident
+ put:
+ description: Update a specific incident retrospective by id
+ operationId: updateIncidentPostmortem
parameters:
- explode: false
in: path
name: id
required: true
schema:
- type: string
+ $ref: '#/components/schemas/getAlertField_id_parameter'
style: simple
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/update_incident_post_mortem'
+ required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 3df2515f-3cc3-4285-98c4-2168f7a76c56
- type: incidents
- attributes:
- parent_incident_id: null
- sequential_id: 1
- title: Odit ut ut aliquid.
- slug: odit-ut-ut-aliquid
- kind: normal
- private: false
- summary: Assumenda provident aut. Assumenda occaecati explicabo.
- Non inventore voluptatum.
- status: started
- source: web
- url: http://localhost:3001/account/incidents/1-odit-ut-ut-aliquid
- short_url: null
- user:
- data:
- id: "291"
- type: users
- attributes:
- name: Ike Klein
- email: barbara@langosh-torphy.example
- phone: null
- phone_2: null
- first_name: Ike
- last_name: Klein
- full_name: Ike Klein
- full_name_with_team: "[Schmeler-Denesik] Ike Klein"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:47:00.856-07:00
- created_at: 2025-05-22T06:47:00.386-07:00
- relationships:
- email_addresses:
- data:
- - id: 75e899ca-99db-464b-b9d1-a3ed30b34a07
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: 070850d3-910f-42f7-ac8e-881e3d1cf114
- created_at: 2025-05-22T06:46:59.584-07:00
- updated_at: 2025-05-22T06:46:59.584-07:00
- display_order: 2
- api_keys_permissions:
- - create
- - update
- - read
- - delete
- billing_permissions: []
- environments_permissions:
- - create
- - read
- - update
- - delete
- functionalities_permissions:
- - create
- - read
- - update
- - delete
- groups_permissions:
- - create
- - read
- - update
- - delete
- incident_causes_permissions:
- - create
- - read
- - update
- - delete
- incident_roles_permissions:
- - create
- - read
- - update
- - delete
- incident_types_permissions:
- - create
- - read
- - update
- - delete
- incidents_permissions:
- - create
- - read
- - update
- - delete
- private_incidents_permissions: []
- invitations_permissions:
- - create
- - read
- - update
- - delete
- playbooks_permissions:
- - create
- - read
- - update
- - delete
- retrospective_permissions:
- - create
- - read
- - update
- - delete
- roles_permissions: []
- services_permissions:
- - create
- - read
- - update
- - delete
- severities_permissions:
- - create
- - read
- - update
- - delete
- status_pages_permissions:
- - create
- - read
- - update
- - delete
- workflows_permissions:
- - create
- - read
- - update
- - delete
- team_id: 235
- name: user
- slug: user
- is_editable: true
- is_deletable: false
- incident_feedbacks_permissions:
- - read
- - create
- - update
- form_fields_permissions:
- - create
- - read
- - update
- - delete
- webhooks_permissions: []
- audits_permissions: []
- secrets_permissions:
- - create
- - read
- - update
- - delete
- deleted_at: null
- incident_permission_set_id: ce8e0129-ae20-4109-9ce5-9ce632b86933
- pulses_permissions:
- - create
- - update
- - read
- alerts_permissions:
- - create
- - read
- paging_permissions:
- - create
- - read
- - update
- - delete
- sub_statuses_permissions:
- - read
- catalogs_permissions:
- - create
- - read
- - update
- - delete
- communication_permissions:
- - read
- incident_communication_permissions:
- - read
- integrations_permissions: []
- on_call_role:
- data:
- id: 9817be29-441f-481c-88af-391816fec02b
- team_id: 235
- name: None
- slug: none
- system_role: no_access
- deleted_at: null
- created_at: 2025-05-22T06:46:59.607-07:00
- updated_at: 2025-05-22T06:46:59.607-07:00
- alerts_permissions: []
- api_keys_permissions: []
- audits_permissions: []
- escalation_policies_permissions: []
- groups_permissions: []
- integrations_permissions: []
- invitations_permissions: []
- on_call_roles_permissions: []
- schedules_permissions: []
- services_permissions: []
- shift_overrides_permissions: []
- workflows_permissions: []
- contacts_permissions: []
- live_call_routing_permissions: []
- heartbeats_permissions: []
- alert_urgency_permissions: []
- schedule_override_permissions: []
- webhooks_permissions: []
- alert_sources_permissions: []
- on_call_readiness_report_permissions: []
- alert_routing_rules_permissions: []
- severity:
- data:
- id: 37a51805-7c23-4dab-af67-405fe2c43393
- type: severities
- attributes:
- name: j0po1
- slug: j0po1
- description: Aut alias totam consequuntur.
- severity: medium
- color: '#E58A1F'
- position: 1
- notify_emails: []
- slack_channels: []
- slack_aliases: []
- created_at: 2025-05-22T06:47:00.817-07:00
- updated_at: 2025-05-22T06:47:00.817-07:00
- in_triage_by: null
- started_by:
- data:
- id: "291"
- type: users
- attributes:
- name: Ike Klein
- email: barbara@langosh-torphy.example
- phone: null
- phone_2: null
- first_name: Ike
- last_name: Klein
- full_name: Ike Klein
- full_name_with_team: "[Schmeler-Denesik] Ike Klein"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:47:00.856-07:00
- created_at: 2025-05-22T06:47:00.386-07:00
- relationships:
- email_addresses:
- data:
- - id: 75e899ca-99db-464b-b9d1-a3ed30b34a07
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: 070850d3-910f-42f7-ac8e-881e3d1cf114
- created_at: 2025-05-22T06:46:59.584-07:00
- updated_at: 2025-05-22T06:46:59.584-07:00
- display_order: 2
- api_keys_permissions:
- - create
- - update
- - read
- - delete
- billing_permissions: []
- environments_permissions:
- - create
- - read
- - update
- - delete
- functionalities_permissions:
- - create
- - read
- - update
- - delete
- groups_permissions:
- - create
- - read
- - update
- - delete
- incident_causes_permissions:
- - create
- - read
- - update
- - delete
- incident_roles_permissions:
- - create
- - read
- - update
- - delete
- incident_types_permissions:
- - create
- - read
- - update
- - delete
- incidents_permissions:
- - create
- - read
- - update
- - delete
- private_incidents_permissions: []
- invitations_permissions:
- - create
- - read
- - update
- - delete
- playbooks_permissions:
- - create
- - read
- - update
- - delete
- retrospective_permissions:
- - create
- - read
- - update
- - delete
- roles_permissions: []
- services_permissions:
- - create
- - read
- - update
- - delete
- severities_permissions:
- - create
- - read
- - update
- - delete
- status_pages_permissions:
- - create
- - read
- - update
- - delete
- workflows_permissions:
- - create
- - read
- - update
- - delete
- team_id: 235
- name: user
- slug: user
- is_editable: true
- is_deletable: false
- incident_feedbacks_permissions:
- - read
- - create
- - update
- form_fields_permissions:
- - create
- - read
- - update
- - delete
- webhooks_permissions: []
- audits_permissions: []
- secrets_permissions:
- - create
- - read
- - update
- - delete
- deleted_at: null
- incident_permission_set_id: ce8e0129-ae20-4109-9ce5-9ce632b86933
- pulses_permissions:
- - create
- - update
- - read
- alerts_permissions:
- - create
- - read
- paging_permissions:
- - create
- - read
- - update
- - delete
- sub_statuses_permissions:
- - read
- catalogs_permissions:
- - create
- - read
- - update
- - delete
- communication_permissions:
- - read
- incident_communication_permissions:
- - read
- integrations_permissions: []
- on_call_role:
- data:
- id: 9817be29-441f-481c-88af-391816fec02b
- team_id: 235
- name: None
- slug: none
- system_role: no_access
- deleted_at: null
- created_at: 2025-05-22T06:46:59.607-07:00
- updated_at: 2025-05-22T06:46:59.607-07:00
- alerts_permissions: []
- api_keys_permissions: []
- audits_permissions: []
- escalation_policies_permissions: []
- groups_permissions: []
- integrations_permissions: []
- invitations_permissions: []
- on_call_roles_permissions: []
- schedules_permissions: []
- services_permissions: []
- shift_overrides_permissions: []
- workflows_permissions: []
- contacts_permissions: []
- live_call_routing_permissions: []
- heartbeats_permissions: []
- alert_urgency_permissions: []
- schedule_override_permissions: []
- webhooks_permissions: []
- alert_sources_permissions: []
- on_call_readiness_report_permissions: []
- alert_routing_rules_permissions: []
- mitigated_by: null
- resolved_by: null
- closed_by: null
- cancelled_by: null
- mitigation_message: null
- resolution_message: null
- cancellation_message: null
- public_title: null
- duplicate_incident_id: null
- retrospective_progress_status: not_started
- zoom_meeting_id: null
- zoom_meeting_start_url: null
- zoom_meeting_join_url: null
- zoom_meeting_password: null
- zoom_meeting_pstn_password: null
- zoom_meeting_h323_password: null
- zoom_meeting_global_dial_in_numbers: []
- shortcut_story_id: null
- shortcut_story_url: null
- shortcut_task_id: null
- shortcut_task_url: null
- asana_task_id: null
- asana_task_url: null
- github_issue_id: null
- github_issue_url: null
- gitlab_issue_id: null
- gitlab_issue_url: null
- jira_issue_key: null
- jira_issue_id: null
- jira_issue_url: null
- google_meeting_id: null
- google_meeting_url: null
- trello_card_id: null
- trello_card_url: null
- linear_issue_id: null
- linear_issue_url: null
- zendesk_ticket_id: null
- zendesk_ticket_url: null
- motion_task_id: null
- motion_task_url: null
- clickup_task_id: null
- clickup_task_url: null
- slack_channel_name: null
- slack_channel_id: null
- slack_channel_url: null
- slack_channel_short_url: null
- slack_channel_deep_link: null
- slack_channel_archived: false
- slack_last_message_ts: null
- service_now_incident_id: null
- service_now_incident_key: null
- service_now_incident_url: null
- opsgenie_incident_id: null
- opsgenie_incident_url: null
- opsgenie_alert_id: null
- opsgenie_alert_url: null
- victor_ops_incident_id: null
- victor_ops_incident_url: null
- pagerduty_incident_id: null
- pagerduty_incident_number: null
- pagerduty_incident_url: null
- mattermost_channel_id: null
- mattermost_channel_name: null
- mattermost_channel_url: null
- confluence_page_id: null
- confluence_page_url: null
- quip_page_id: null
- quip_page_url: null
- airtable_base_key: null
- airtable_table_name: null
- airtable_record_id: null
- airtable_record_url: null
- google_drive_id: null
- google_drive_parent_id: null
- google_drive_url: null
- sharepoint_page_id: null
- sharepoint_page_url: null
- datadog_notebook_id: null
- datadog_notebook_url: null
- freshservice_ticket_id: null
- freshservice_ticket_url: null
- freshservice_task_id: null
- freshservice_task_url: null
- scheduled_for: null
- scheduled_until: null
- in_triage_at: null
- started_at: 2025-05-22T06:47:00.825-07:00
- detected_at: null
- acknowledged_at: null
- mitigated_at: null
- resolved_at: null
- closed_at: null
- cancelled_at: null
- created_at: 2025-05-22T06:47:00.825-07:00
- updated_at: 2025-05-22T06:47:21.436-07:00
- labels: {}
- relationships:
- causes:
- data: []
- subscribers:
- data: []
- roles:
- data: []
- environments:
- data: []
- incident_types:
- data: []
- services:
- data: []
- functionalities:
- data: []
- groups:
- data: []
- events:
- data:
- - id: d843dae2-84f1-4d33-8b1b-adf5c0451dea
- type: incident_events
- - id: b6699095-08a1-4df9-b271-e3b9c5dfc395
- type: incident_events
- action_items:
- data: []
- custom_field_selections:
- data: []
- feedbacks:
- data: []
- attachments:
- data: []
- slack_messages:
- data: []
schema:
- $ref: '#/components/schemas/incident_response'
- description: incident deleted
+ $ref: '#/components/schemas/incident_post_mortem_response'
+ description: incident_post_mortem updated
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Delete an incident
+ summary: Update an incident retrospective
tags:
- - Incidents
+ - IncidentRetrospectives
+ x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
+ /v1/incident_retrospective_steps/{id}:
get:
- description: Retrieves a specific incident by id
- operationId: getIncident
+ description: Retrieves a specific incident retrospective step by id
+ operationId: getIncidentRetrospectiveStep
parameters:
- explode: false
in: path
@@ -20953,596 +14263,29 @@ paths:
schema:
type: string
style: simple
- - description: "comma separated if needed. eg: sub_statuses,causes,subscribers"
- explode: true
- in: query
- name: include
- required: false
- schema:
- enum:
- - sub_statuses
- - causes
- - subscribers
- - roles
- - slack_messages
- - environments
- - incident_types
- - services
- - functionalities
- - groups
- - events
- - action_items
- - custom_field_selections
- - feedbacks
- - incident_post_mortem
- type: string
- style: form
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 3df2515f-3cc3-4285-98c4-2168f7a76c56
- type: incidents
- attributes:
- parent_incident_id: null
- sequential_id: 1
- title: Odit ut ut aliquid.
- slug: odit-ut-ut-aliquid
- kind: normal
- private: false
- summary: Assumenda provident aut. Assumenda occaecati explicabo.
- Non inventore voluptatum.
- status: started
- source: web
- url: http://localhost:3001/account/incidents/1-odit-ut-ut-aliquid
- short_url: null
- user:
- data:
- id: "291"
- type: users
- attributes:
- name: Ike Klein
- email: barbara@langosh-torphy.example
- phone: null
- phone_2: null
- first_name: Ike
- last_name: Klein
- full_name: Ike Klein
- full_name_with_team: "[Schmeler-Denesik] Ike Klein"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:47:00.856-07:00
- created_at: 2025-05-22T06:47:00.386-07:00
- relationships:
- email_addresses:
- data:
- - id: 75e899ca-99db-464b-b9d1-a3ed30b34a07
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: 070850d3-910f-42f7-ac8e-881e3d1cf114
- created_at: 2025-05-22T06:46:59.584-07:00
- updated_at: 2025-05-22T06:46:59.584-07:00
- display_order: 2
- api_keys_permissions:
- - create
- - update
- - read
- - delete
- billing_permissions: []
- environments_permissions:
- - create
- - read
- - update
- - delete
- functionalities_permissions:
- - create
- - read
- - update
- - delete
- groups_permissions:
- - create
- - read
- - update
- - delete
- incident_causes_permissions:
- - create
- - read
- - update
- - delete
- incident_roles_permissions:
- - create
- - read
- - update
- - delete
- incident_types_permissions:
- - create
- - read
- - update
- - delete
- incidents_permissions:
- - create
- - read
- - update
- - delete
- private_incidents_permissions: []
- invitations_permissions:
- - create
- - read
- - update
- - delete
- playbooks_permissions:
- - create
- - read
- - update
- - delete
- retrospective_permissions:
- - create
- - read
- - update
- - delete
- roles_permissions: []
- services_permissions:
- - create
- - read
- - update
- - delete
- severities_permissions:
- - create
- - read
- - update
- - delete
- status_pages_permissions:
- - create
- - read
- - update
- - delete
- workflows_permissions:
- - create
- - read
- - update
- - delete
- team_id: 235
- name: user
- slug: user
- is_editable: true
- is_deletable: false
- incident_feedbacks_permissions:
- - read
- - create
- - update
- form_fields_permissions:
- - create
- - read
- - update
- - delete
- webhooks_permissions: []
- audits_permissions: []
- secrets_permissions:
- - create
- - read
- - update
- - delete
- deleted_at: null
- incident_permission_set_id: ce8e0129-ae20-4109-9ce5-9ce632b86933
- pulses_permissions:
- - create
- - update
- - read
- alerts_permissions:
- - create
- - read
- paging_permissions:
- - create
- - read
- - update
- - delete
- sub_statuses_permissions:
- - read
- catalogs_permissions:
- - create
- - read
- - update
- - delete
- communication_permissions:
- - read
- incident_communication_permissions:
- - read
- integrations_permissions: []
- on_call_role:
- data:
- id: 9817be29-441f-481c-88af-391816fec02b
- team_id: 235
- name: None
- slug: none
- system_role: no_access
- deleted_at: null
- created_at: 2025-05-22T06:46:59.607-07:00
- updated_at: 2025-05-22T06:46:59.607-07:00
- alerts_permissions: []
- api_keys_permissions: []
- audits_permissions: []
- escalation_policies_permissions: []
- groups_permissions: []
- integrations_permissions: []
- invitations_permissions: []
- on_call_roles_permissions: []
- schedules_permissions: []
- services_permissions: []
- shift_overrides_permissions: []
- workflows_permissions: []
- contacts_permissions: []
- live_call_routing_permissions: []
- heartbeats_permissions: []
- alert_urgency_permissions: []
- schedule_override_permissions: []
- webhooks_permissions: []
- alert_sources_permissions: []
- on_call_readiness_report_permissions: []
- alert_routing_rules_permissions: []
- severity:
- data:
- id: 37a51805-7c23-4dab-af67-405fe2c43393
- type: severities
- attributes:
- name: j0po1
- slug: j0po1
- description: Aut alias totam consequuntur.
- severity: medium
- color: '#E58A1F'
- position: 1
- notify_emails: []
- slack_channels: []
- slack_aliases: []
- created_at: 2025-05-22T06:47:00.817-07:00
- updated_at: 2025-05-22T06:47:00.817-07:00
- in_triage_by: null
- started_by:
- data:
- id: "291"
- type: users
- attributes:
- name: Ike Klein
- email: barbara@langosh-torphy.example
- phone: null
- phone_2: null
- first_name: Ike
- last_name: Klein
- full_name: Ike Klein
- full_name_with_team: "[Schmeler-Denesik] Ike Klein"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:47:00.856-07:00
- created_at: 2025-05-22T06:47:00.386-07:00
- relationships:
- email_addresses:
- data:
- - id: 75e899ca-99db-464b-b9d1-a3ed30b34a07
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: 070850d3-910f-42f7-ac8e-881e3d1cf114
- created_at: 2025-05-22T06:46:59.584-07:00
- updated_at: 2025-05-22T06:46:59.584-07:00
- display_order: 2
- api_keys_permissions:
- - create
- - update
- - read
- - delete
- billing_permissions: []
- environments_permissions:
- - create
- - read
- - update
- - delete
- functionalities_permissions:
- - create
- - read
- - update
- - delete
- groups_permissions:
- - create
- - read
- - update
- - delete
- incident_causes_permissions:
- - create
- - read
- - update
- - delete
- incident_roles_permissions:
- - create
- - read
- - update
- - delete
- incident_types_permissions:
- - create
- - read
- - update
- - delete
- incidents_permissions:
- - create
- - read
- - update
- - delete
- private_incidents_permissions: []
- invitations_permissions:
- - create
- - read
- - update
- - delete
- playbooks_permissions:
- - create
- - read
- - update
- - delete
- retrospective_permissions:
- - create
- - read
- - update
- - delete
- roles_permissions: []
- services_permissions:
- - create
- - read
- - update
- - delete
- severities_permissions:
- - create
- - read
- - update
- - delete
- status_pages_permissions:
- - create
- - read
- - update
- - delete
- workflows_permissions:
- - create
- - read
- - update
- - delete
- team_id: 235
- name: user
- slug: user
- is_editable: true
- is_deletable: false
- incident_feedbacks_permissions:
- - read
- - create
- - update
- form_fields_permissions:
- - create
- - read
- - update
- - delete
- webhooks_permissions: []
- audits_permissions: []
- secrets_permissions:
- - create
- - read
- - update
- - delete
- deleted_at: null
- incident_permission_set_id: ce8e0129-ae20-4109-9ce5-9ce632b86933
- pulses_permissions:
- - create
- - update
- - read
- alerts_permissions:
- - create
- - read
- paging_permissions:
- - create
- - read
- - update
- - delete
- sub_statuses_permissions:
- - read
- catalogs_permissions:
- - create
- - read
- - update
- - delete
- communication_permissions:
- - read
- incident_communication_permissions:
- - read
- integrations_permissions: []
- on_call_role:
- data:
- id: 9817be29-441f-481c-88af-391816fec02b
- team_id: 235
- name: None
- slug: none
- system_role: no_access
- deleted_at: null
- created_at: 2025-05-22T06:46:59.607-07:00
- updated_at: 2025-05-22T06:46:59.607-07:00
- alerts_permissions: []
- api_keys_permissions: []
- audits_permissions: []
- escalation_policies_permissions: []
- groups_permissions: []
- integrations_permissions: []
- invitations_permissions: []
- on_call_roles_permissions: []
- schedules_permissions: []
- services_permissions: []
- shift_overrides_permissions: []
- workflows_permissions: []
- contacts_permissions: []
- live_call_routing_permissions: []
- heartbeats_permissions: []
- alert_urgency_permissions: []
- schedule_override_permissions: []
- webhooks_permissions: []
- alert_sources_permissions: []
- on_call_readiness_report_permissions: []
- alert_routing_rules_permissions: []
- mitigated_by: null
- resolved_by: null
- closed_by: null
- cancelled_by: null
- mitigation_message: null
- resolution_message: null
- cancellation_message: null
- public_title: null
- duplicate_incident_id: null
- retrospective_progress_status: not_started
- zoom_meeting_id: null
- zoom_meeting_start_url: null
- zoom_meeting_join_url: null
- zoom_meeting_password: null
- zoom_meeting_pstn_password: null
- zoom_meeting_h323_password: null
- zoom_meeting_global_dial_in_numbers: []
- shortcut_story_id: null
- shortcut_story_url: null
- shortcut_task_id: null
- shortcut_task_url: null
- asana_task_id: null
- asana_task_url: null
- github_issue_id: null
- github_issue_url: null
- gitlab_issue_id: null
- gitlab_issue_url: null
- jira_issue_key: null
- jira_issue_id: null
- jira_issue_url: null
- google_meeting_id: null
- google_meeting_url: null
- trello_card_id: null
- trello_card_url: null
- linear_issue_id: null
- linear_issue_url: null
- zendesk_ticket_id: null
- zendesk_ticket_url: null
- motion_task_id: null
- motion_task_url: null
- clickup_task_id: null
- clickup_task_url: null
- slack_channel_name: null
- slack_channel_id: null
- slack_channel_url: null
- slack_channel_short_url: null
- slack_channel_deep_link: null
- slack_channel_archived: false
- slack_last_message_ts: null
- service_now_incident_id: null
- service_now_incident_key: null
- service_now_incident_url: null
- opsgenie_incident_id: null
- opsgenie_incident_url: null
- opsgenie_alert_id: null
- opsgenie_alert_url: null
- victor_ops_incident_id: null
- victor_ops_incident_url: null
- pagerduty_incident_id: null
- pagerduty_incident_number: null
- pagerduty_incident_url: null
- mattermost_channel_id: null
- mattermost_channel_name: null
- mattermost_channel_url: null
- confluence_page_id: null
- confluence_page_url: null
- quip_page_id: null
- quip_page_url: null
- airtable_base_key: null
- airtable_table_name: null
- airtable_record_id: null
- airtable_record_url: null
- google_drive_id: null
- google_drive_parent_id: null
- google_drive_url: null
- sharepoint_page_id: null
- sharepoint_page_url: null
- datadog_notebook_id: null
- datadog_notebook_url: null
- freshservice_ticket_id: null
- freshservice_ticket_url: null
- freshservice_task_id: null
- freshservice_task_url: null
- scheduled_for: null
- scheduled_until: null
- in_triage_at: null
- started_at: 2025-05-22T06:47:00.825-07:00
- detected_at: null
- acknowledged_at: null
- mitigated_at: null
- resolved_at: null
- closed_at: null
- cancelled_at: null
- created_at: 2025-05-22T06:47:00.825-07:00
- updated_at: 2025-05-22T06:47:00.911-07:00
- labels: {}
- relationships:
- causes:
- data: []
- subscribers:
- data: []
- roles:
- data: []
- environments:
- data: []
- incident_types:
- data: []
- services:
- data: []
- functionalities:
- data: []
- groups:
- data: []
- events:
- data:
- - id: d843dae2-84f1-4d33-8b1b-adf5c0451dea
- type: incident_events
- - id: b6699095-08a1-4df9-b271-e3b9c5dfc395
- type: incident_events
- action_items:
- data: []
- custom_field_selections:
- data: []
- feedbacks:
- data: []
- attachments:
- data: []
- slack_messages:
- data: []
schema:
- $ref: '#/components/schemas/incident_response'
- description: incident found
+ $ref: '#/components/schemas/incident_retrospective_step_response'
+ description: incident retrospective_step found
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Retrieves an incident
+ summary: Retrieves an incident retrospective step
tags:
- - Incidents
+ - IncidentRetrospectiveSteps
x-accepts:
- application/vnd.api+json
put:
- description: Update a specific incident by id
- operationId: updateIncident
+ description: Update a specific incident retrospective step by id
+ operationId: updateIncidentRetrospectiveStep
parameters:
- explode: false
in: path
@@ -21555,1360 +14298,83 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/update_incident'
+ $ref: '#/components/schemas/update_incident_retrospective_step'
required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 3df2515f-3cc3-4285-98c4-2168f7a76c56
- type: incidents
- attributes:
- parent_incident_id: null
- sequential_id: 1
- title: Oh no! Something is broken again
- slug: odit-ut-ut-aliquid
- kind: normal
- private: true
- summary: What could it be again?
- status: started
- source: web
- url: http://localhost:3001/account/incidents/1-odit-ut-ut-aliquid
- short_url: null
- user:
- data:
- id: "291"
- type: users
- attributes:
- name: Ike Klein
- email: barbara@langosh-torphy.example
- phone: null
- phone_2: null
- first_name: Ike
- last_name: Klein
- full_name: Ike Klein
- full_name_with_team: "[Schmeler-Denesik] Ike Klein"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:47:00.856-07:00
- created_at: 2025-05-22T06:47:00.386-07:00
- relationships:
- email_addresses:
- data:
- - id: 75e899ca-99db-464b-b9d1-a3ed30b34a07
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: 070850d3-910f-42f7-ac8e-881e3d1cf114
- created_at: 2025-05-22T06:46:59.584-07:00
- updated_at: 2025-05-22T06:46:59.584-07:00
- display_order: 2
- api_keys_permissions:
- - create
- - update
- - read
- - delete
- billing_permissions: []
- environments_permissions:
- - create
- - read
- - update
- - delete
- functionalities_permissions:
- - create
- - read
- - update
- - delete
- groups_permissions:
- - create
- - read
- - update
- - delete
- incident_causes_permissions:
- - create
- - read
- - update
- - delete
- incident_roles_permissions:
- - create
- - read
- - update
- - delete
- incident_types_permissions:
- - create
- - read
- - update
- - delete
- incidents_permissions:
- - create
- - read
- - update
- - delete
- private_incidents_permissions: []
- invitations_permissions:
- - create
- - read
- - update
- - delete
- playbooks_permissions:
- - create
- - read
- - update
- - delete
- retrospective_permissions:
- - create
- - read
- - update
- - delete
- roles_permissions: []
- services_permissions:
- - create
- - read
- - update
- - delete
- severities_permissions:
- - create
- - read
- - update
- - delete
- status_pages_permissions:
- - create
- - read
- - update
- - delete
- workflows_permissions:
- - create
- - read
- - update
- - delete
- team_id: 235
- name: user
- slug: user
- is_editable: true
- is_deletable: false
- incident_feedbacks_permissions:
- - read
- - create
- - update
- form_fields_permissions:
- - create
- - read
- - update
- - delete
- webhooks_permissions: []
- audits_permissions: []
- secrets_permissions:
- - create
- - read
- - update
- - delete
- deleted_at: null
- incident_permission_set_id: ce8e0129-ae20-4109-9ce5-9ce632b86933
- pulses_permissions:
- - create
- - update
- - read
- alerts_permissions:
- - create
- - read
- paging_permissions:
- - create
- - read
- - update
- - delete
- sub_statuses_permissions:
- - read
- catalogs_permissions:
- - create
- - read
- - update
- - delete
- communication_permissions:
- - read
- incident_communication_permissions:
- - read
- integrations_permissions: []
- on_call_role:
- data:
- id: 9817be29-441f-481c-88af-391816fec02b
- team_id: 235
- name: None
- slug: none
- system_role: no_access
- deleted_at: null
- created_at: 2025-05-22T06:46:59.607-07:00
- updated_at: 2025-05-22T06:46:59.607-07:00
- alerts_permissions: []
- api_keys_permissions: []
- audits_permissions: []
- escalation_policies_permissions: []
- groups_permissions: []
- integrations_permissions: []
- invitations_permissions: []
- on_call_roles_permissions: []
- schedules_permissions: []
- services_permissions: []
- shift_overrides_permissions: []
- workflows_permissions: []
- contacts_permissions: []
- live_call_routing_permissions: []
- heartbeats_permissions: []
- alert_urgency_permissions: []
- schedule_override_permissions: []
- webhooks_permissions: []
- alert_sources_permissions: []
- on_call_readiness_report_permissions: []
- alert_routing_rules_permissions: []
- severity:
- data:
- id: 37a51805-7c23-4dab-af67-405fe2c43393
- type: severities
- attributes:
- name: j0po1
- slug: j0po1
- description: Aut alias totam consequuntur.
- severity: medium
- color: '#E58A1F'
- position: 1
- notify_emails: []
- slack_channels: []
- slack_aliases: []
- created_at: 2025-05-22T06:47:00.817-07:00
- updated_at: 2025-05-22T06:47:00.817-07:00
- in_triage_by: null
- started_by:
- data:
- id: "291"
- type: users
- attributes:
- name: Ike Klein
- email: barbara@langosh-torphy.example
- phone: null
- phone_2: null
- first_name: Ike
- last_name: Klein
- full_name: Ike Klein
- full_name_with_team: "[Schmeler-Denesik] Ike Klein"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:47:00.856-07:00
- created_at: 2025-05-22T06:47:00.386-07:00
- relationships:
- email_addresses:
- data:
- - id: 75e899ca-99db-464b-b9d1-a3ed30b34a07
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: 070850d3-910f-42f7-ac8e-881e3d1cf114
- created_at: 2025-05-22T06:46:59.584-07:00
- updated_at: 2025-05-22T06:46:59.584-07:00
- display_order: 2
- api_keys_permissions:
- - create
- - update
- - read
- - delete
- billing_permissions: []
- environments_permissions:
- - create
- - read
- - update
- - delete
- functionalities_permissions:
- - create
- - read
- - update
- - delete
- groups_permissions:
- - create
- - read
- - update
- - delete
- incident_causes_permissions:
- - create
- - read
- - update
- - delete
- incident_roles_permissions:
- - create
- - read
- - update
- - delete
- incident_types_permissions:
- - create
- - read
- - update
- - delete
- incidents_permissions:
- - create
- - read
- - update
- - delete
- private_incidents_permissions: []
- invitations_permissions:
- - create
- - read
- - update
- - delete
- playbooks_permissions:
- - create
- - read
- - update
- - delete
- retrospective_permissions:
- - create
- - read
- - update
- - delete
- roles_permissions: []
- services_permissions:
- - create
- - read
- - update
- - delete
- severities_permissions:
- - create
- - read
- - update
- - delete
- status_pages_permissions:
- - create
- - read
- - update
- - delete
- workflows_permissions:
- - create
- - read
- - update
- - delete
- team_id: 235
- name: user
- slug: user
- is_editable: true
- is_deletable: false
- incident_feedbacks_permissions:
- - read
- - create
- - update
- form_fields_permissions:
- - create
- - read
- - update
- - delete
- webhooks_permissions: []
- audits_permissions: []
- secrets_permissions:
- - create
- - read
- - update
- - delete
- deleted_at: null
- incident_permission_set_id: ce8e0129-ae20-4109-9ce5-9ce632b86933
- pulses_permissions:
- - create
- - update
- - read
- alerts_permissions:
- - create
- - read
- paging_permissions:
- - create
- - read
- - update
- - delete
- sub_statuses_permissions:
- - read
- catalogs_permissions:
- - create
- - read
- - update
- - delete
- communication_permissions:
- - read
- incident_communication_permissions:
- - read
- integrations_permissions: []
- on_call_role:
- data:
- id: 9817be29-441f-481c-88af-391816fec02b
- team_id: 235
- name: None
- slug: none
- system_role: no_access
- deleted_at: null
- created_at: 2025-05-22T06:46:59.607-07:00
- updated_at: 2025-05-22T06:46:59.607-07:00
- alerts_permissions: []
- api_keys_permissions: []
- audits_permissions: []
- escalation_policies_permissions: []
- groups_permissions: []
- integrations_permissions: []
- invitations_permissions: []
- on_call_roles_permissions: []
- schedules_permissions: []
- services_permissions: []
- shift_overrides_permissions: []
- workflows_permissions: []
- contacts_permissions: []
- live_call_routing_permissions: []
- heartbeats_permissions: []
- alert_urgency_permissions: []
- schedule_override_permissions: []
- webhooks_permissions: []
- alert_sources_permissions: []
- on_call_readiness_report_permissions: []
- alert_routing_rules_permissions: []
- mitigated_by: null
- resolved_by: null
- closed_by: null
- cancelled_by: null
- mitigation_message: null
- resolution_message: null
- cancellation_message: null
- public_title: null
- duplicate_incident_id: null
- retrospective_progress_status: not_started
- zoom_meeting_id: null
- zoom_meeting_start_url: null
- zoom_meeting_join_url: null
- zoom_meeting_password: null
- zoom_meeting_pstn_password: null
- zoom_meeting_h323_password: null
- zoom_meeting_global_dial_in_numbers: []
- shortcut_story_id: null
- shortcut_story_url: null
- shortcut_task_id: null
- shortcut_task_url: null
- asana_task_id: null
- asana_task_url: null
- github_issue_id: null
- github_issue_url: null
- gitlab_issue_id: null
- gitlab_issue_url: null
- jira_issue_key: null
- jira_issue_id: null
- jira_issue_url: null
- google_meeting_id: null
- google_meeting_url: null
- trello_card_id: null
- trello_card_url: null
- linear_issue_id: null
- linear_issue_url: null
- zendesk_ticket_id: null
- zendesk_ticket_url: null
- motion_task_id: null
- motion_task_url: null
- clickup_task_id: null
- clickup_task_url: null
- slack_channel_name: null
- slack_channel_id: null
- slack_channel_url: null
- slack_channel_short_url: null
- slack_channel_deep_link: null
- slack_channel_archived: false
- slack_last_message_ts: null
- service_now_incident_id: null
- service_now_incident_key: null
- service_now_incident_url: null
- opsgenie_incident_id: null
- opsgenie_incident_url: null
- opsgenie_alert_id: null
- opsgenie_alert_url: null
- victor_ops_incident_id: null
- victor_ops_incident_url: null
- pagerduty_incident_id: null
- pagerduty_incident_number: null
- pagerduty_incident_url: null
- mattermost_channel_id: null
- mattermost_channel_name: null
- mattermost_channel_url: null
- confluence_page_id: null
- confluence_page_url: null
- quip_page_id: null
- quip_page_url: null
- airtable_base_key: null
- airtable_table_name: null
- airtable_record_id: null
- airtable_record_url: null
- google_drive_id: null
- google_drive_parent_id: null
- google_drive_url: null
- sharepoint_page_id: null
- sharepoint_page_url: null
- datadog_notebook_id: null
- datadog_notebook_url: null
- freshservice_ticket_id: null
- freshservice_ticket_url: null
- freshservice_task_id: null
- freshservice_task_url: null
- scheduled_for: null
- scheduled_until: null
- in_triage_at: null
- started_at: 2025-05-22T06:47:00.825-07:00
- detected_at: null
- acknowledged_at: null
- mitigated_at: null
- resolved_at: null
- closed_at: null
- cancelled_at: null
- created_at: 2025-05-22T06:47:00.825-07:00
- updated_at: 2025-05-22T06:47:20.365-07:00
- labels: {}
- relationships:
- causes:
- data: []
- subscribers:
- data: []
- roles:
- data: []
- environments:
- data: []
- incident_types:
- data: []
- services:
- data: []
- functionalities:
- data: []
- groups:
- data: []
- events:
- data:
- - id: 82630049-658d-4ef8-84d9-777ed28ca52f
- type: incident_events
- - id: 0fd45cdf-79f1-4b27-9c52-c8e6ee6c16f2
- type: incident_events
- - id: d843dae2-84f1-4d33-8b1b-adf5c0451dea
- type: incident_events
- - id: b6699095-08a1-4df9-b271-e3b9c5dfc395
- type: incident_events
- action_items:
- data: []
- custom_field_selections:
- data: []
- feedbacks:
- data: []
- attachments:
- data: []
- slack_messages:
- data: []
schema:
- $ref: '#/components/schemas/incident_response'
- description: incident updated
+ $ref: '#/components/schemas/incident_retrospective_step_response'
+ description: incident_retrospective_step updated
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Update an incident
+ summary: Update an incident retrospective step
tags:
- - Incidents
+ - IncidentRetrospectiveSteps
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/incidents/{id}/mitigate:
- put:
- description: Mitigate a specific incident by id
- operationId: mitigateIncident
+ /v1/incident_roles/{incident_role_id}/incident_role_tasks:
+ get:
+ description: List incident_role tasks
+ operationId: listIncidentRoleTasks
parameters:
- explode: false
in: path
- name: id
+ name: incident_role_id
required: true
schema:
type: string
style: simple
- requestBody:
- content:
- application/vnd.api+json:
- schema:
- $ref: '#/components/schemas/mitigate_incident'
- required: true
+ - explode: true
+ in: query
+ name: include
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "page[number]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ - explode: true
+ in: query
+ name: "page[size]"
+ required: false
+ schema:
+ type: integer
+ style: form
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 3df2515f-3cc3-4285-98c4-2168f7a76c56
- type: incidents
- attributes:
- parent_incident_id: null
- sequential_id: 1
- title: Odit ut ut aliquid.
- slug: odit-ut-ut-aliquid
- kind: normal
- private: false
- summary: Assumenda provident aut. Assumenda occaecati explicabo.
- Non inventore voluptatum.
- status: mitigated
- source: web
- url: http://localhost:3001/account/incidents/1-odit-ut-ut-aliquid
- short_url: null
- user:
- data:
- id: "291"
- type: users
- attributes:
- name: Ike Klein
- email: barbara@langosh-torphy.example
- phone: null
- phone_2: null
- first_name: Ike
- last_name: Klein
- full_name: Ike Klein
- full_name_with_team: "[Schmeler-Denesik] Ike Klein"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:47:00.856-07:00
- created_at: 2025-05-22T06:47:00.386-07:00
- relationships:
- email_addresses:
- data:
- - id: 75e899ca-99db-464b-b9d1-a3ed30b34a07
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: 070850d3-910f-42f7-ac8e-881e3d1cf114
- created_at: 2025-05-22T06:46:59.584-07:00
- updated_at: 2025-05-22T06:46:59.584-07:00
- display_order: 2
- api_keys_permissions:
- - create
- - update
- - read
- - delete
- billing_permissions: []
- environments_permissions:
- - create
- - read
- - update
- - delete
- functionalities_permissions:
- - create
- - read
- - update
- - delete
- groups_permissions:
- - create
- - read
- - update
- - delete
- incident_causes_permissions:
- - create
- - read
- - update
- - delete
- incident_roles_permissions:
- - create
- - read
- - update
- - delete
- incident_types_permissions:
- - create
- - read
- - update
- - delete
- incidents_permissions:
- - create
- - read
- - update
- - delete
- private_incidents_permissions: []
- invitations_permissions:
- - create
- - read
- - update
- - delete
- playbooks_permissions:
- - create
- - read
- - update
- - delete
- retrospective_permissions:
- - create
- - read
- - update
- - delete
- roles_permissions: []
- services_permissions:
- - create
- - read
- - update
- - delete
- severities_permissions:
- - create
- - read
- - update
- - delete
- status_pages_permissions:
- - create
- - read
- - update
- - delete
- workflows_permissions:
- - create
- - read
- - update
- - delete
- team_id: 235
- name: user
- slug: user
- is_editable: true
- is_deletable: false
- incident_feedbacks_permissions:
- - read
- - create
- - update
- form_fields_permissions:
- - create
- - read
- - update
- - delete
- webhooks_permissions: []
- audits_permissions: []
- secrets_permissions:
- - create
- - read
- - update
- - delete
- deleted_at: null
- incident_permission_set_id: ce8e0129-ae20-4109-9ce5-9ce632b86933
- pulses_permissions:
- - create
- - update
- - read
- alerts_permissions:
- - create
- - read
- paging_permissions:
- - create
- - read
- - update
- - delete
- sub_statuses_permissions:
- - read
- catalogs_permissions:
- - create
- - read
- - update
- - delete
- communication_permissions:
- - read
- incident_communication_permissions:
- - read
- integrations_permissions: []
- on_call_role:
- data:
- id: 9817be29-441f-481c-88af-391816fec02b
- team_id: 235
- name: None
- slug: none
- system_role: no_access
- deleted_at: null
- created_at: 2025-05-22T06:46:59.607-07:00
- updated_at: 2025-05-22T06:46:59.607-07:00
- alerts_permissions: []
- api_keys_permissions: []
- audits_permissions: []
- escalation_policies_permissions: []
- groups_permissions: []
- integrations_permissions: []
- invitations_permissions: []
- on_call_roles_permissions: []
- schedules_permissions: []
- services_permissions: []
- shift_overrides_permissions: []
- workflows_permissions: []
- contacts_permissions: []
- live_call_routing_permissions: []
- heartbeats_permissions: []
- alert_urgency_permissions: []
- schedule_override_permissions: []
- webhooks_permissions: []
- alert_sources_permissions: []
- on_call_readiness_report_permissions: []
- alert_routing_rules_permissions: []
- severity:
- data:
- id: 37a51805-7c23-4dab-af67-405fe2c43393
- type: severities
- attributes:
- name: j0po1
- slug: j0po1
- description: Aut alias totam consequuntur.
- severity: medium
- color: '#E58A1F'
- position: 1
- notify_emails: []
- slack_channels: []
- slack_aliases: []
- created_at: 2025-05-22T06:47:00.817-07:00
- updated_at: 2025-05-22T06:47:00.817-07:00
- in_triage_by: null
- started_by:
- data:
- id: "291"
- type: users
- attributes:
- name: Ike Klein
- email: barbara@langosh-torphy.example
- phone: null
- phone_2: null
- first_name: Ike
- last_name: Klein
- full_name: Ike Klein
- full_name_with_team: "[Schmeler-Denesik] Ike Klein"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:47:00.856-07:00
- created_at: 2025-05-22T06:47:00.386-07:00
- relationships:
- email_addresses:
- data:
- - id: 75e899ca-99db-464b-b9d1-a3ed30b34a07
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: 070850d3-910f-42f7-ac8e-881e3d1cf114
- created_at: 2025-05-22T06:46:59.584-07:00
- updated_at: 2025-05-22T06:46:59.584-07:00
- display_order: 2
- api_keys_permissions:
- - create
- - update
- - read
- - delete
- billing_permissions: []
- environments_permissions:
- - create
- - read
- - update
- - delete
- functionalities_permissions:
- - create
- - read
- - update
- - delete
- groups_permissions:
- - create
- - read
- - update
- - delete
- incident_causes_permissions:
- - create
- - read
- - update
- - delete
- incident_roles_permissions:
- - create
- - read
- - update
- - delete
- incident_types_permissions:
- - create
- - read
- - update
- - delete
- incidents_permissions:
- - create
- - read
- - update
- - delete
- private_incidents_permissions: []
- invitations_permissions:
- - create
- - read
- - update
- - delete
- playbooks_permissions:
- - create
- - read
- - update
- - delete
- retrospective_permissions:
- - create
- - read
- - update
- - delete
- roles_permissions: []
- services_permissions:
- - create
- - read
- - update
- - delete
- severities_permissions:
- - create
- - read
- - update
- - delete
- status_pages_permissions:
- - create
- - read
- - update
- - delete
- workflows_permissions:
- - create
- - read
- - update
- - delete
- team_id: 235
- name: user
- slug: user
- is_editable: true
- is_deletable: false
- incident_feedbacks_permissions:
- - read
- - create
- - update
- form_fields_permissions:
- - create
- - read
- - update
- - delete
- webhooks_permissions: []
- audits_permissions: []
- secrets_permissions:
- - create
- - read
- - update
- - delete
- deleted_at: null
- incident_permission_set_id: ce8e0129-ae20-4109-9ce5-9ce632b86933
- pulses_permissions:
- - create
- - update
- - read
- alerts_permissions:
- - create
- - read
- paging_permissions:
- - create
- - read
- - update
- - delete
- sub_statuses_permissions:
- - read
- catalogs_permissions:
- - create
- - read
- - update
- - delete
- communication_permissions:
- - read
- incident_communication_permissions:
- - read
- integrations_permissions: []
- on_call_role:
- data:
- id: 9817be29-441f-481c-88af-391816fec02b
- team_id: 235
- name: None
- slug: none
- system_role: no_access
- deleted_at: null
- created_at: 2025-05-22T06:46:59.607-07:00
- updated_at: 2025-05-22T06:46:59.607-07:00
- alerts_permissions: []
- api_keys_permissions: []
- audits_permissions: []
- escalation_policies_permissions: []
- groups_permissions: []
- integrations_permissions: []
- invitations_permissions: []
- on_call_roles_permissions: []
- schedules_permissions: []
- services_permissions: []
- shift_overrides_permissions: []
- workflows_permissions: []
- contacts_permissions: []
- live_call_routing_permissions: []
- heartbeats_permissions: []
- alert_urgency_permissions: []
- schedule_override_permissions: []
- webhooks_permissions: []
- alert_sources_permissions: []
- on_call_readiness_report_permissions: []
- alert_routing_rules_permissions: []
- mitigated_by:
- data:
- id: "289"
- type: users
- attributes:
- name: Annita Wolff
- email: sandy@weimann.example
- phone: null
- phone_2: null
- first_name: Annita
- last_name: Wolff
- full_name: Annita Wolff
- full_name_with_team: "[Schmeler-Denesik] Annita Wolff"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:47:22.313-07:00
- created_at: 2025-05-22T06:46:59.395-07:00
- relationships:
- email_addresses:
- data:
- - id: 85183e4a-ff2f-433e-828a-fbe9d3ffeabb
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: 070850d3-910f-42f7-ac8e-881e3d1cf114
- created_at: 2025-05-22T06:46:59.584-07:00
- updated_at: 2025-05-22T06:46:59.584-07:00
- display_order: 2
- api_keys_permissions:
- - create
- - update
- - read
- - delete
- billing_permissions: []
- environments_permissions:
- - create
- - read
- - update
- - delete
- functionalities_permissions:
- - create
- - read
- - update
- - delete
- groups_permissions:
- - create
- - read
- - update
- - delete
- incident_causes_permissions:
- - create
- - read
- - update
- - delete
- incident_roles_permissions:
- - create
- - read
- - update
- - delete
- incident_types_permissions:
- - create
- - read
- - update
- - delete
- incidents_permissions:
- - create
- - read
- - update
- - delete
- private_incidents_permissions: []
- invitations_permissions:
- - create
- - read
- - update
- - delete
- playbooks_permissions:
- - create
- - read
- - update
- - delete
- retrospective_permissions:
- - create
- - read
- - update
- - delete
- roles_permissions: []
- services_permissions:
- - create
- - read
- - update
- - delete
- severities_permissions:
- - create
- - read
- - update
- - delete
- status_pages_permissions:
- - create
- - read
- - update
- - delete
- workflows_permissions:
- - create
- - read
- - update
- - delete
- team_id: 235
- name: user
- slug: user
- is_editable: true
- is_deletable: false
- incident_feedbacks_permissions:
- - read
- - create
- - update
- form_fields_permissions:
- - create
- - read
- - update
- - delete
- webhooks_permissions: []
- audits_permissions: []
- secrets_permissions:
- - create
- - read
- - update
- - delete
- deleted_at: null
- incident_permission_set_id: ce8e0129-ae20-4109-9ce5-9ce632b86933
- pulses_permissions:
- - create
- - update
- - read
- alerts_permissions:
- - create
- - read
- paging_permissions:
- - create
- - read
- - update
- - delete
- sub_statuses_permissions:
- - read
- catalogs_permissions:
- - create
- - read
- - update
- - delete
- communication_permissions:
- - read
- incident_communication_permissions:
- - read
- integrations_permissions: []
- on_call_role:
- data:
- id: 9817be29-441f-481c-88af-391816fec02b
- team_id: 235
- name: None
- slug: none
- system_role: no_access
- deleted_at: null
- created_at: 2025-05-22T06:46:59.607-07:00
- updated_at: 2025-05-22T06:46:59.607-07:00
- alerts_permissions: []
- api_keys_permissions: []
- audits_permissions: []
- escalation_policies_permissions: []
- groups_permissions: []
- integrations_permissions: []
- invitations_permissions: []
- on_call_roles_permissions: []
- schedules_permissions: []
- services_permissions: []
- shift_overrides_permissions: []
- workflows_permissions: []
- contacts_permissions: []
- live_call_routing_permissions: []
- heartbeats_permissions: []
- alert_urgency_permissions: []
- schedule_override_permissions: []
- webhooks_permissions: []
- alert_sources_permissions: []
- on_call_readiness_report_permissions: []
- alert_routing_rules_permissions: []
- resolved_by: null
- closed_by: null
- cancelled_by: null
- mitigation_message: Restart database fixed it!
- resolution_message: null
- cancellation_message: null
- public_title: null
- duplicate_incident_id: null
- retrospective_progress_status: not_started
- zoom_meeting_id: null
- zoom_meeting_start_url: null
- zoom_meeting_join_url: null
- zoom_meeting_password: null
- zoom_meeting_pstn_password: null
- zoom_meeting_h323_password: null
- zoom_meeting_global_dial_in_numbers: []
- shortcut_story_id: null
- shortcut_story_url: null
- shortcut_task_id: null
- shortcut_task_url: null
- asana_task_id: null
- asana_task_url: null
- github_issue_id: null
- github_issue_url: null
- gitlab_issue_id: null
- gitlab_issue_url: null
- jira_issue_key: null
- jira_issue_id: null
- jira_issue_url: null
- google_meeting_id: null
- google_meeting_url: null
- trello_card_id: null
- trello_card_url: null
- linear_issue_id: null
- linear_issue_url: null
- zendesk_ticket_id: null
- zendesk_ticket_url: null
- motion_task_id: null
- motion_task_url: null
- clickup_task_id: null
- clickup_task_url: null
- slack_channel_name: null
- slack_channel_id: null
- slack_channel_url: null
- slack_channel_short_url: null
- slack_channel_deep_link: null
- slack_channel_archived: false
- slack_last_message_ts: null
- service_now_incident_id: null
- service_now_incident_key: null
- service_now_incident_url: null
- opsgenie_incident_id: null
- opsgenie_incident_url: null
- opsgenie_alert_id: null
- opsgenie_alert_url: null
- victor_ops_incident_id: null
- victor_ops_incident_url: null
- pagerduty_incident_id: null
- pagerduty_incident_number: null
- pagerduty_incident_url: null
- mattermost_channel_id: null
- mattermost_channel_name: null
- mattermost_channel_url: null
- confluence_page_id: null
- confluence_page_url: null
- quip_page_id: null
- quip_page_url: null
- airtable_base_key: null
- airtable_table_name: null
- airtable_record_id: null
- airtable_record_url: null
- google_drive_id: null
- google_drive_parent_id: null
- google_drive_url: null
- sharepoint_page_id: null
- sharepoint_page_url: null
- datadog_notebook_id: null
- datadog_notebook_url: null
- freshservice_ticket_id: null
- freshservice_ticket_url: null
- freshservice_task_id: null
- freshservice_task_url: null
- scheduled_for: null
- scheduled_until: null
- in_triage_at: null
- started_at: 2025-05-22T06:47:00.825-07:00
- detected_at: null
- acknowledged_at: null
- mitigated_at: 2025-05-22T06:47:22.520-07:00
- resolved_at: null
- closed_at: null
- cancelled_at: null
- created_at: 2025-05-22T06:47:00.825-07:00
- updated_at: 2025-05-22T06:47:22.579-07:00
- labels: {}
- relationships:
- incident_post_mortem:
- data:
- id: 8bc5d3ba-3feb-4400-904a-581278b1863a
- type: incident_post_mortems
- causes:
- data: []
- subscribers:
- data: []
- roles:
- data: []
- environments:
- data: []
- incident_types:
- data: []
- services:
- data: []
- functionalities:
- data: []
- groups:
- data: []
- events:
- data:
- - id: 3cab1f5d-892f-4d5b-9d01-ccac8189505d
- type: incident_events
- - id: efbd9ce6-e1ce-45ff-98a6-e8f58ac7c532
- type: incident_events
- - id: d843dae2-84f1-4d33-8b1b-adf5c0451dea
- type: incident_events
- - id: b6699095-08a1-4df9-b271-e3b9c5dfc395
- type: incident_events
- action_items:
- data: []
- custom_field_selections:
- data: []
- feedbacks:
- data: []
- attachments:
- data: []
- slack_messages:
- data: []
- schema:
- $ref: '#/components/schemas/incident_response'
- description: incident mitigated
- "404":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
- $ref: '#/components/schemas/errors_list'
- description: resource not found
+ $ref: '#/components/schemas/incident_role_task_list'
+ description: success
security:
- bearer_auth: []
- summary: Mitigate an incident
+ summary: List incident role tasks
tags:
- - Incidents
- x-content-type: application/vnd.api+json
+ - IncidentRoleTasks
x-accepts:
- application/vnd.api+json
- /v1/incidents/{id}/resolve:
- put:
- description: Resolve a specific incident by id
- operationId: resolveIncident
+ post:
+ description: Creates a new task from provided data
+ operationId: createIncidentRoleTask
parameters:
- explode: false
in: path
- name: id
+ name: incident_role_id
required: true
schema:
type: string
@@ -22917,773 +14383,39 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/resolve_incident'
+ $ref: '#/components/schemas/new_incident_role_task'
required: true
responses:
- "200":
+ "201":
content:
application/vnd.api+json:
- example:
- data:
- id: 3df2515f-3cc3-4285-98c4-2168f7a76c56
- type: incidents
- attributes:
- parent_incident_id: null
- sequential_id: 1
- title: Odit ut ut aliquid.
- slug: odit-ut-ut-aliquid
- kind: normal
- private: false
- summary: Assumenda provident aut. Assumenda occaecati explicabo.
- Non inventore voluptatum.
- status: resolved
- source: web
- url: http://localhost:3001/account/incidents/1-odit-ut-ut-aliquid
- short_url: null
- user:
- data:
- id: "291"
- type: users
- attributes:
- name: Ike Klein
- email: barbara@langosh-torphy.example
- phone: null
- phone_2: null
- first_name: Ike
- last_name: Klein
- full_name: Ike Klein
- full_name_with_team: "[Schmeler-Denesik] Ike Klein"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:47:00.856-07:00
- created_at: 2025-05-22T06:47:00.386-07:00
- relationships:
- email_addresses:
- data:
- - id: 75e899ca-99db-464b-b9d1-a3ed30b34a07
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: 070850d3-910f-42f7-ac8e-881e3d1cf114
- created_at: 2025-05-22T06:46:59.584-07:00
- updated_at: 2025-05-22T06:46:59.584-07:00
- display_order: 2
- api_keys_permissions:
- - create
- - update
- - read
- - delete
- billing_permissions: []
- environments_permissions:
- - create
- - read
- - update
- - delete
- functionalities_permissions:
- - create
- - read
- - update
- - delete
- groups_permissions:
- - create
- - read
- - update
- - delete
- incident_causes_permissions:
- - create
- - read
- - update
- - delete
- incident_roles_permissions:
- - create
- - read
- - update
- - delete
- incident_types_permissions:
- - create
- - read
- - update
- - delete
- incidents_permissions:
- - create
- - read
- - update
- - delete
- private_incidents_permissions: []
- invitations_permissions:
- - create
- - read
- - update
- - delete
- playbooks_permissions:
- - create
- - read
- - update
- - delete
- retrospective_permissions:
- - create
- - read
- - update
- - delete
- roles_permissions: []
- services_permissions:
- - create
- - read
- - update
- - delete
- severities_permissions:
- - create
- - read
- - update
- - delete
- status_pages_permissions:
- - create
- - read
- - update
- - delete
- workflows_permissions:
- - create
- - read
- - update
- - delete
- team_id: 235
- name: user
- slug: user
- is_editable: true
- is_deletable: false
- incident_feedbacks_permissions:
- - read
- - create
- - update
- form_fields_permissions:
- - create
- - read
- - update
- - delete
- webhooks_permissions: []
- audits_permissions: []
- secrets_permissions:
- - create
- - read
- - update
- - delete
- deleted_at: null
- incident_permission_set_id: ce8e0129-ae20-4109-9ce5-9ce632b86933
- pulses_permissions:
- - create
- - update
- - read
- alerts_permissions:
- - create
- - read
- paging_permissions:
- - create
- - read
- - update
- - delete
- sub_statuses_permissions:
- - read
- catalogs_permissions:
- - create
- - read
- - update
- - delete
- communication_permissions:
- - read
- incident_communication_permissions:
- - read
- integrations_permissions: []
- on_call_role:
- data:
- id: 9817be29-441f-481c-88af-391816fec02b
- team_id: 235
- name: None
- slug: none
- system_role: no_access
- deleted_at: null
- created_at: 2025-05-22T06:46:59.607-07:00
- updated_at: 2025-05-22T06:46:59.607-07:00
- alerts_permissions: []
- api_keys_permissions: []
- audits_permissions: []
- escalation_policies_permissions: []
- groups_permissions: []
- integrations_permissions: []
- invitations_permissions: []
- on_call_roles_permissions: []
- schedules_permissions: []
- services_permissions: []
- shift_overrides_permissions: []
- workflows_permissions: []
- contacts_permissions: []
- live_call_routing_permissions: []
- heartbeats_permissions: []
- alert_urgency_permissions: []
- schedule_override_permissions: []
- webhooks_permissions: []
- alert_sources_permissions: []
- on_call_readiness_report_permissions: []
- alert_routing_rules_permissions: []
- severity:
- data:
- id: 37a51805-7c23-4dab-af67-405fe2c43393
- type: severities
- attributes:
- name: j0po1
- slug: j0po1
- description: Aut alias totam consequuntur.
- severity: medium
- color: '#E58A1F'
- position: 1
- notify_emails: []
- slack_channels: []
- slack_aliases: []
- created_at: 2025-05-22T06:47:00.817-07:00
- updated_at: 2025-05-22T06:47:00.817-07:00
- in_triage_by: null
- started_by:
- data:
- id: "291"
- type: users
- attributes:
- name: Ike Klein
- email: barbara@langosh-torphy.example
- phone: null
- phone_2: null
- first_name: Ike
- last_name: Klein
- full_name: Ike Klein
- full_name_with_team: "[Schmeler-Denesik] Ike Klein"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:47:00.856-07:00
- created_at: 2025-05-22T06:47:00.386-07:00
- relationships:
- email_addresses:
- data:
- - id: 75e899ca-99db-464b-b9d1-a3ed30b34a07
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: 070850d3-910f-42f7-ac8e-881e3d1cf114
- created_at: 2025-05-22T06:46:59.584-07:00
- updated_at: 2025-05-22T06:46:59.584-07:00
- display_order: 2
- api_keys_permissions:
- - create
- - update
- - read
- - delete
- billing_permissions: []
- environments_permissions:
- - create
- - read
- - update
- - delete
- functionalities_permissions:
- - create
- - read
- - update
- - delete
- groups_permissions:
- - create
- - read
- - update
- - delete
- incident_causes_permissions:
- - create
- - read
- - update
- - delete
- incident_roles_permissions:
- - create
- - read
- - update
- - delete
- incident_types_permissions:
- - create
- - read
- - update
- - delete
- incidents_permissions:
- - create
- - read
- - update
- - delete
- private_incidents_permissions: []
- invitations_permissions:
- - create
- - read
- - update
- - delete
- playbooks_permissions:
- - create
- - read
- - update
- - delete
- retrospective_permissions:
- - create
- - read
- - update
- - delete
- roles_permissions: []
- services_permissions:
- - create
- - read
- - update
- - delete
- severities_permissions:
- - create
- - read
- - update
- - delete
- status_pages_permissions:
- - create
- - read
- - update
- - delete
- workflows_permissions:
- - create
- - read
- - update
- - delete
- team_id: 235
- name: user
- slug: user
- is_editable: true
- is_deletable: false
- incident_feedbacks_permissions:
- - read
- - create
- - update
- form_fields_permissions:
- - create
- - read
- - update
- - delete
- webhooks_permissions: []
- audits_permissions: []
- secrets_permissions:
- - create
- - read
- - update
- - delete
- deleted_at: null
- incident_permission_set_id: ce8e0129-ae20-4109-9ce5-9ce632b86933
- pulses_permissions:
- - create
- - update
- - read
- alerts_permissions:
- - create
- - read
- paging_permissions:
- - create
- - read
- - update
- - delete
- sub_statuses_permissions:
- - read
- catalogs_permissions:
- - create
- - read
- - update
- - delete
- communication_permissions:
- - read
- incident_communication_permissions:
- - read
- integrations_permissions: []
- on_call_role:
- data:
- id: 9817be29-441f-481c-88af-391816fec02b
- team_id: 235
- name: None
- slug: none
- system_role: no_access
- deleted_at: null
- created_at: 2025-05-22T06:46:59.607-07:00
- updated_at: 2025-05-22T06:46:59.607-07:00
- alerts_permissions: []
- api_keys_permissions: []
- audits_permissions: []
- escalation_policies_permissions: []
- groups_permissions: []
- integrations_permissions: []
- invitations_permissions: []
- on_call_roles_permissions: []
- schedules_permissions: []
- services_permissions: []
- shift_overrides_permissions: []
- workflows_permissions: []
- contacts_permissions: []
- live_call_routing_permissions: []
- heartbeats_permissions: []
- alert_urgency_permissions: []
- schedule_override_permissions: []
- webhooks_permissions: []
- alert_sources_permissions: []
- on_call_readiness_report_permissions: []
- alert_routing_rules_permissions: []
- mitigated_by: null
- resolved_by:
- data:
- id: "289"
- type: users
- attributes:
- name: Annita Wolff
- email: sandy@weimann.example
- phone: null
- phone_2: null
- first_name: Annita
- last_name: Wolff
- full_name: Annita Wolff
- full_name_with_team: "[Schmeler-Denesik] Annita Wolff"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:47:23.477-07:00
- created_at: 2025-05-22T06:46:59.395-07:00
- relationships:
- email_addresses:
- data:
- - id: 85183e4a-ff2f-433e-828a-fbe9d3ffeabb
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: 070850d3-910f-42f7-ac8e-881e3d1cf114
- created_at: 2025-05-22T06:46:59.584-07:00
- updated_at: 2025-05-22T06:46:59.584-07:00
- display_order: 2
- api_keys_permissions:
- - create
- - update
- - read
- - delete
- billing_permissions: []
- environments_permissions:
- - create
- - read
- - update
- - delete
- functionalities_permissions:
- - create
- - read
- - update
- - delete
- groups_permissions:
- - create
- - read
- - update
- - delete
- incident_causes_permissions:
- - create
- - read
- - update
- - delete
- incident_roles_permissions:
- - create
- - read
- - update
- - delete
- incident_types_permissions:
- - create
- - read
- - update
- - delete
- incidents_permissions:
- - create
- - read
- - update
- - delete
- private_incidents_permissions: []
- invitations_permissions:
- - create
- - read
- - update
- - delete
- playbooks_permissions:
- - create
- - read
- - update
- - delete
- retrospective_permissions:
- - create
- - read
- - update
- - delete
- roles_permissions: []
- services_permissions:
- - create
- - read
- - update
- - delete
- severities_permissions:
- - create
- - read
- - update
- - delete
- status_pages_permissions:
- - create
- - read
- - update
- - delete
- workflows_permissions:
- - create
- - read
- - update
- - delete
- team_id: 235
- name: user
- slug: user
- is_editable: true
- is_deletable: false
- incident_feedbacks_permissions:
- - read
- - create
- - update
- form_fields_permissions:
- - create
- - read
- - update
- - delete
- webhooks_permissions: []
- audits_permissions: []
- secrets_permissions:
- - create
- - read
- - update
- - delete
- deleted_at: null
- incident_permission_set_id: ce8e0129-ae20-4109-9ce5-9ce632b86933
- pulses_permissions:
- - create
- - update
- - read
- alerts_permissions:
- - create
- - read
- paging_permissions:
- - create
- - read
- - update
- - delete
- sub_statuses_permissions:
- - read
- catalogs_permissions:
- - create
- - read
- - update
- - delete
- communication_permissions:
- - read
- incident_communication_permissions:
- - read
- integrations_permissions: []
- on_call_role:
- data:
- id: 9817be29-441f-481c-88af-391816fec02b
- team_id: 235
- name: None
- slug: none
- system_role: no_access
- deleted_at: null
- created_at: 2025-05-22T06:46:59.607-07:00
- updated_at: 2025-05-22T06:46:59.607-07:00
- alerts_permissions: []
- api_keys_permissions: []
- audits_permissions: []
- escalation_policies_permissions: []
- groups_permissions: []
- integrations_permissions: []
- invitations_permissions: []
- on_call_roles_permissions: []
- schedules_permissions: []
- services_permissions: []
- shift_overrides_permissions: []
- workflows_permissions: []
- contacts_permissions: []
- live_call_routing_permissions: []
- heartbeats_permissions: []
- alert_urgency_permissions: []
- schedule_override_permissions: []
- webhooks_permissions: []
- alert_sources_permissions: []
- on_call_readiness_report_permissions: []
- alert_routing_rules_permissions: []
- closed_by: null
- cancelled_by: null
- mitigation_message: null
- resolution_message: Restart database fixed it!
- cancellation_message: null
- public_title: null
- duplicate_incident_id: null
- retrospective_progress_status: not_started
- zoom_meeting_id: null
- zoom_meeting_start_url: null
- zoom_meeting_join_url: null
- zoom_meeting_password: null
- zoom_meeting_pstn_password: null
- zoom_meeting_h323_password: null
- zoom_meeting_global_dial_in_numbers: []
- shortcut_story_id: null
- shortcut_story_url: null
- shortcut_task_id: null
- shortcut_task_url: null
- asana_task_id: null
- asana_task_url: null
- github_issue_id: null
- github_issue_url: null
- gitlab_issue_id: null
- gitlab_issue_url: null
- jira_issue_key: null
- jira_issue_id: null
- jira_issue_url: null
- google_meeting_id: null
- google_meeting_url: null
- trello_card_id: null
- trello_card_url: null
- linear_issue_id: null
- linear_issue_url: null
- zendesk_ticket_id: null
- zendesk_ticket_url: null
- motion_task_id: null
- motion_task_url: null
- clickup_task_id: null
- clickup_task_url: null
- slack_channel_name: null
- slack_channel_id: null
- slack_channel_url: null
- slack_channel_short_url: null
- slack_channel_deep_link: null
- slack_channel_archived: false
- slack_last_message_ts: null
- service_now_incident_id: null
- service_now_incident_key: null
- service_now_incident_url: null
- opsgenie_incident_id: null
- opsgenie_incident_url: null
- opsgenie_alert_id: null
- opsgenie_alert_url: null
- victor_ops_incident_id: null
- victor_ops_incident_url: null
- pagerduty_incident_id: null
- pagerduty_incident_number: null
- pagerduty_incident_url: null
- mattermost_channel_id: null
- mattermost_channel_name: null
- mattermost_channel_url: null
- confluence_page_id: null
- confluence_page_url: null
- quip_page_id: null
- quip_page_url: null
- airtable_base_key: null
- airtable_table_name: null
- airtable_record_id: null
- airtable_record_url: null
- google_drive_id: null
- google_drive_parent_id: null
- google_drive_url: null
- sharepoint_page_id: null
- sharepoint_page_url: null
- datadog_notebook_id: null
- datadog_notebook_url: null
- freshservice_ticket_id: null
- freshservice_ticket_url: null
- freshservice_task_id: null
- freshservice_task_url: null
- scheduled_for: null
- scheduled_until: null
- in_triage_at: null
- started_at: 2025-05-22T06:47:00.825-07:00
- detected_at: null
- acknowledged_at: null
- mitigated_at: 2025-05-22T06:47:23.661-07:00
- resolved_at: 2025-05-22T06:47:23.661-07:00
- closed_at: null
- cancelled_at: null
- created_at: 2025-05-22T06:47:00.825-07:00
- updated_at: 2025-05-22T06:47:23.772-07:00
- labels: {}
- relationships:
- incident_post_mortem:
- data:
- id: 8bc5d3ba-3feb-4400-904a-581278b1863a
- type: incident_post_mortems
- causes:
- data: []
- subscribers:
- data: []
- roles:
- data: []
- environments:
- data: []
- incident_types:
- data: []
- services:
- data: []
- functionalities:
- data: []
- groups:
- data: []
- events:
- data:
- - id: 8304c23a-7888-4163-90ae-980445468440
- type: incident_events
- - id: a99079b1-6cc6-45d1-b83d-1edd34ccdcf2
- type: incident_events
- - id: 81466dfe-2865-4662-972b-9766ed3d22e5
- type: incident_events
- - id: d843dae2-84f1-4d33-8b1b-adf5c0451dea
- type: incident_events
- - id: b6699095-08a1-4df9-b271-e3b9c5dfc395
- type: incident_events
- action_items:
- data: []
- custom_field_selections:
- data: []
- feedbacks:
- data: []
- attachments:
- data: []
- slack_messages:
- data: []
schema:
- $ref: '#/components/schemas/incident_response'
- description: incident resolved
- "404":
+ $ref: '#/components/schemas/incident_role_task_response'
+ description: incident_role_task created
+ "422":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
- description: resource not found
+ description: invalid request
+ "401":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: responds with unauthorized for invalid token
security:
- bearer_auth: []
- summary: Resolve an incident
+ summary: Creates an incident role task
tags:
- - Incidents
+ - IncidentRoleTasks
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/incidents/{id}/cancel:
- put:
- description: Cancel a specific incident by id
- operationId: cancelIncident
+ /v1/incident_role_tasks/{id}:
+ delete:
+ description: Delete a specific incident_role task by id
+ operationId: deleteIncidentRoleTask
parameters:
- explode: false
in: path
@@ -23692,773 +14424,29 @@ paths:
schema:
type: string
style: simple
- requestBody:
- content:
- application/vnd.api+json:
- schema:
- $ref: '#/components/schemas/cancel_incident'
- required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 3df2515f-3cc3-4285-98c4-2168f7a76c56
- type: incidents
- attributes:
- parent_incident_id: null
- sequential_id: 1
- title: Odit ut ut aliquid.
- slug: odit-ut-ut-aliquid
- kind: normal
- private: false
- summary: Assumenda provident aut. Assumenda occaecati explicabo.
- Non inventore voluptatum.
- status: cancelled
- source: web
- url: http://localhost:3001/account/incidents/1-odit-ut-ut-aliquid
- short_url: null
- user:
- data:
- id: "291"
- type: users
- attributes:
- name: Ike Klein
- email: barbara@langosh-torphy.example
- phone: null
- phone_2: null
- first_name: Ike
- last_name: Klein
- full_name: Ike Klein
- full_name_with_team: "[Schmeler-Denesik] Ike Klein"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:47:00.856-07:00
- created_at: 2025-05-22T06:47:00.386-07:00
- relationships:
- email_addresses:
- data:
- - id: 75e899ca-99db-464b-b9d1-a3ed30b34a07
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: 070850d3-910f-42f7-ac8e-881e3d1cf114
- created_at: 2025-05-22T06:46:59.584-07:00
- updated_at: 2025-05-22T06:46:59.584-07:00
- display_order: 2
- api_keys_permissions:
- - create
- - update
- - read
- - delete
- billing_permissions: []
- environments_permissions:
- - create
- - read
- - update
- - delete
- functionalities_permissions:
- - create
- - read
- - update
- - delete
- groups_permissions:
- - create
- - read
- - update
- - delete
- incident_causes_permissions:
- - create
- - read
- - update
- - delete
- incident_roles_permissions:
- - create
- - read
- - update
- - delete
- incident_types_permissions:
- - create
- - read
- - update
- - delete
- incidents_permissions:
- - create
- - read
- - update
- - delete
- private_incidents_permissions: []
- invitations_permissions:
- - create
- - read
- - update
- - delete
- playbooks_permissions:
- - create
- - read
- - update
- - delete
- retrospective_permissions:
- - create
- - read
- - update
- - delete
- roles_permissions: []
- services_permissions:
- - create
- - read
- - update
- - delete
- severities_permissions:
- - create
- - read
- - update
- - delete
- status_pages_permissions:
- - create
- - read
- - update
- - delete
- workflows_permissions:
- - create
- - read
- - update
- - delete
- team_id: 235
- name: user
- slug: user
- is_editable: true
- is_deletable: false
- incident_feedbacks_permissions:
- - read
- - create
- - update
- form_fields_permissions:
- - create
- - read
- - update
- - delete
- webhooks_permissions: []
- audits_permissions: []
- secrets_permissions:
- - create
- - read
- - update
- - delete
- deleted_at: null
- incident_permission_set_id: ce8e0129-ae20-4109-9ce5-9ce632b86933
- pulses_permissions:
- - create
- - update
- - read
- alerts_permissions:
- - create
- - read
- paging_permissions:
- - create
- - read
- - update
- - delete
- sub_statuses_permissions:
- - read
- catalogs_permissions:
- - create
- - read
- - update
- - delete
- communication_permissions:
- - read
- incident_communication_permissions:
- - read
- integrations_permissions: []
- on_call_role:
- data:
- id: 9817be29-441f-481c-88af-391816fec02b
- team_id: 235
- name: None
- slug: none
- system_role: no_access
- deleted_at: null
- created_at: 2025-05-22T06:46:59.607-07:00
- updated_at: 2025-05-22T06:46:59.607-07:00
- alerts_permissions: []
- api_keys_permissions: []
- audits_permissions: []
- escalation_policies_permissions: []
- groups_permissions: []
- integrations_permissions: []
- invitations_permissions: []
- on_call_roles_permissions: []
- schedules_permissions: []
- services_permissions: []
- shift_overrides_permissions: []
- workflows_permissions: []
- contacts_permissions: []
- live_call_routing_permissions: []
- heartbeats_permissions: []
- alert_urgency_permissions: []
- schedule_override_permissions: []
- webhooks_permissions: []
- alert_sources_permissions: []
- on_call_readiness_report_permissions: []
- alert_routing_rules_permissions: []
- severity:
- data:
- id: 37a51805-7c23-4dab-af67-405fe2c43393
- type: severities
- attributes:
- name: j0po1
- slug: j0po1
- description: Aut alias totam consequuntur.
- severity: medium
- color: '#E58A1F'
- position: 1
- notify_emails: []
- slack_channels: []
- slack_aliases: []
- created_at: 2025-05-22T06:47:00.817-07:00
- updated_at: 2025-05-22T06:47:00.817-07:00
- in_triage_by: null
- started_by:
- data:
- id: "291"
- type: users
- attributes:
- name: Ike Klein
- email: barbara@langosh-torphy.example
- phone: null
- phone_2: null
- first_name: Ike
- last_name: Klein
- full_name: Ike Klein
- full_name_with_team: "[Schmeler-Denesik] Ike Klein"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:47:00.856-07:00
- created_at: 2025-05-22T06:47:00.386-07:00
- relationships:
- email_addresses:
- data:
- - id: 75e899ca-99db-464b-b9d1-a3ed30b34a07
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: 070850d3-910f-42f7-ac8e-881e3d1cf114
- created_at: 2025-05-22T06:46:59.584-07:00
- updated_at: 2025-05-22T06:46:59.584-07:00
- display_order: 2
- api_keys_permissions:
- - create
- - update
- - read
- - delete
- billing_permissions: []
- environments_permissions:
- - create
- - read
- - update
- - delete
- functionalities_permissions:
- - create
- - read
- - update
- - delete
- groups_permissions:
- - create
- - read
- - update
- - delete
- incident_causes_permissions:
- - create
- - read
- - update
- - delete
- incident_roles_permissions:
- - create
- - read
- - update
- - delete
- incident_types_permissions:
- - create
- - read
- - update
- - delete
- incidents_permissions:
- - create
- - read
- - update
- - delete
- private_incidents_permissions: []
- invitations_permissions:
- - create
- - read
- - update
- - delete
- playbooks_permissions:
- - create
- - read
- - update
- - delete
- retrospective_permissions:
- - create
- - read
- - update
- - delete
- roles_permissions: []
- services_permissions:
- - create
- - read
- - update
- - delete
- severities_permissions:
- - create
- - read
- - update
- - delete
- status_pages_permissions:
- - create
- - read
- - update
- - delete
- workflows_permissions:
- - create
- - read
- - update
- - delete
- team_id: 235
- name: user
- slug: user
- is_editable: true
- is_deletable: false
- incident_feedbacks_permissions:
- - read
- - create
- - update
- form_fields_permissions:
- - create
- - read
- - update
- - delete
- webhooks_permissions: []
- audits_permissions: []
- secrets_permissions:
- - create
- - read
- - update
- - delete
- deleted_at: null
- incident_permission_set_id: ce8e0129-ae20-4109-9ce5-9ce632b86933
- pulses_permissions:
- - create
- - update
- - read
- alerts_permissions:
- - create
- - read
- paging_permissions:
- - create
- - read
- - update
- - delete
- sub_statuses_permissions:
- - read
- catalogs_permissions:
- - create
- - read
- - update
- - delete
- communication_permissions:
- - read
- incident_communication_permissions:
- - read
- integrations_permissions: []
- on_call_role:
- data:
- id: 9817be29-441f-481c-88af-391816fec02b
- team_id: 235
- name: None
- slug: none
- system_role: no_access
- deleted_at: null
- created_at: 2025-05-22T06:46:59.607-07:00
- updated_at: 2025-05-22T06:46:59.607-07:00
- alerts_permissions: []
- api_keys_permissions: []
- audits_permissions: []
- escalation_policies_permissions: []
- groups_permissions: []
- integrations_permissions: []
- invitations_permissions: []
- on_call_roles_permissions: []
- schedules_permissions: []
- services_permissions: []
- shift_overrides_permissions: []
- workflows_permissions: []
- contacts_permissions: []
- live_call_routing_permissions: []
- heartbeats_permissions: []
- alert_urgency_permissions: []
- schedule_override_permissions: []
- webhooks_permissions: []
- alert_sources_permissions: []
- on_call_readiness_report_permissions: []
- alert_routing_rules_permissions: []
- mitigated_by: null
- resolved_by: null
- closed_by: null
- cancelled_by:
- data:
- id: "289"
- type: users
- attributes:
- name: Annita Wolff
- email: sandy@weimann.example
- phone: null
- phone_2: null
- first_name: Annita
- last_name: Wolff
- full_name: Annita Wolff
- full_name_with_team: "[Schmeler-Denesik] Annita Wolff"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:47:24.643-07:00
- created_at: 2025-05-22T06:46:59.395-07:00
- relationships:
- email_addresses:
- data:
- - id: 85183e4a-ff2f-433e-828a-fbe9d3ffeabb
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: 070850d3-910f-42f7-ac8e-881e3d1cf114
- created_at: 2025-05-22T06:46:59.584-07:00
- updated_at: 2025-05-22T06:46:59.584-07:00
- display_order: 2
- api_keys_permissions:
- - create
- - update
- - read
- - delete
- billing_permissions: []
- environments_permissions:
- - create
- - read
- - update
- - delete
- functionalities_permissions:
- - create
- - read
- - update
- - delete
- groups_permissions:
- - create
- - read
- - update
- - delete
- incident_causes_permissions:
- - create
- - read
- - update
- - delete
- incident_roles_permissions:
- - create
- - read
- - update
- - delete
- incident_types_permissions:
- - create
- - read
- - update
- - delete
- incidents_permissions:
- - create
- - read
- - update
- - delete
- private_incidents_permissions: []
- invitations_permissions:
- - create
- - read
- - update
- - delete
- playbooks_permissions:
- - create
- - read
- - update
- - delete
- retrospective_permissions:
- - create
- - read
- - update
- - delete
- roles_permissions: []
- services_permissions:
- - create
- - read
- - update
- - delete
- severities_permissions:
- - create
- - read
- - update
- - delete
- status_pages_permissions:
- - create
- - read
- - update
- - delete
- workflows_permissions:
- - create
- - read
- - update
- - delete
- team_id: 235
- name: user
- slug: user
- is_editable: true
- is_deletable: false
- incident_feedbacks_permissions:
- - read
- - create
- - update
- form_fields_permissions:
- - create
- - read
- - update
- - delete
- webhooks_permissions: []
- audits_permissions: []
- secrets_permissions:
- - create
- - read
- - update
- - delete
- deleted_at: null
- incident_permission_set_id: ce8e0129-ae20-4109-9ce5-9ce632b86933
- pulses_permissions:
- - create
- - update
- - read
- alerts_permissions:
- - create
- - read
- paging_permissions:
- - create
- - read
- - update
- - delete
- sub_statuses_permissions:
- - read
- catalogs_permissions:
- - create
- - read
- - update
- - delete
- communication_permissions:
- - read
- incident_communication_permissions:
- - read
- integrations_permissions: []
- on_call_role:
- data:
- id: 9817be29-441f-481c-88af-391816fec02b
- team_id: 235
- name: None
- slug: none
- system_role: no_access
- deleted_at: null
- created_at: 2025-05-22T06:46:59.607-07:00
- updated_at: 2025-05-22T06:46:59.607-07:00
- alerts_permissions: []
- api_keys_permissions: []
- audits_permissions: []
- escalation_policies_permissions: []
- groups_permissions: []
- integrations_permissions: []
- invitations_permissions: []
- on_call_roles_permissions: []
- schedules_permissions: []
- services_permissions: []
- shift_overrides_permissions: []
- workflows_permissions: []
- contacts_permissions: []
- live_call_routing_permissions: []
- heartbeats_permissions: []
- alert_urgency_permissions: []
- schedule_override_permissions: []
- webhooks_permissions: []
- alert_sources_permissions: []
- on_call_readiness_report_permissions: []
- alert_routing_rules_permissions: []
- mitigation_message: null
- resolution_message: null
- cancellation_message: Nevermind!
- public_title: null
- duplicate_incident_id: null
- retrospective_progress_status: not_started
- zoom_meeting_id: null
- zoom_meeting_start_url: null
- zoom_meeting_join_url: null
- zoom_meeting_password: null
- zoom_meeting_pstn_password: null
- zoom_meeting_h323_password: null
- zoom_meeting_global_dial_in_numbers: []
- shortcut_story_id: null
- shortcut_story_url: null
- shortcut_task_id: null
- shortcut_task_url: null
- asana_task_id: null
- asana_task_url: null
- github_issue_id: null
- github_issue_url: null
- gitlab_issue_id: null
- gitlab_issue_url: null
- jira_issue_key: null
- jira_issue_id: null
- jira_issue_url: null
- google_meeting_id: null
- google_meeting_url: null
- trello_card_id: null
- trello_card_url: null
- linear_issue_id: null
- linear_issue_url: null
- zendesk_ticket_id: null
- zendesk_ticket_url: null
- motion_task_id: null
- motion_task_url: null
- clickup_task_id: null
- clickup_task_url: null
- slack_channel_name: null
- slack_channel_id: null
- slack_channel_url: null
- slack_channel_short_url: null
- slack_channel_deep_link: null
- slack_channel_archived: false
- slack_last_message_ts: null
- service_now_incident_id: null
- service_now_incident_key: null
- service_now_incident_url: null
- opsgenie_incident_id: null
- opsgenie_incident_url: null
- opsgenie_alert_id: null
- opsgenie_alert_url: null
- victor_ops_incident_id: null
- victor_ops_incident_url: null
- pagerduty_incident_id: null
- pagerduty_incident_number: null
- pagerduty_incident_url: null
- mattermost_channel_id: null
- mattermost_channel_name: null
- mattermost_channel_url: null
- confluence_page_id: null
- confluence_page_url: null
- quip_page_id: null
- quip_page_url: null
- airtable_base_key: null
- airtable_table_name: null
- airtable_record_id: null
- airtable_record_url: null
- google_drive_id: null
- google_drive_parent_id: null
- google_drive_url: null
- sharepoint_page_id: null
- sharepoint_page_url: null
- datadog_notebook_id: null
- datadog_notebook_url: null
- freshservice_ticket_id: null
- freshservice_ticket_url: null
- freshservice_task_id: null
- freshservice_task_url: null
- scheduled_for: null
- scheduled_until: null
- in_triage_at: null
- started_at: 2025-05-22T06:47:00.825-07:00
- detected_at: null
- acknowledged_at: null
- mitigated_at: null
- resolved_at: null
- closed_at: null
- cancelled_at: 2025-05-22T06:47:24.837-07:00
- created_at: 2025-05-22T06:47:00.825-07:00
- updated_at: 2025-05-22T06:47:24.913-07:00
- labels: {}
- relationships:
- incident_post_mortem:
- data:
- id: 8bc5d3ba-3feb-4400-904a-581278b1863a
- type: incident_post_mortems
- causes:
- data: []
- subscribers:
- data: []
- roles:
- data: []
- environments:
- data: []
- incident_types:
- data: []
- services:
- data: []
- functionalities:
- data: []
- groups:
- data: []
- events:
- data:
- - id: f0b9cd14-0a90-4495-b63a-b398f28e94b3
- type: incident_events
- - id: d843dae2-84f1-4d33-8b1b-adf5c0451dea
- type: incident_events
- - id: b6699095-08a1-4df9-b271-e3b9c5dfc395
- type: incident_events
- action_items:
- data: []
- custom_field_selections:
- data: []
- feedbacks:
- data: []
- attachments:
- data: []
- slack_messages:
- data: []
schema:
- $ref: '#/components/schemas/incident_response'
- description: incident cancel
+ $ref: '#/components/schemas/incident_role_task_response'
+ description: incident_role_task deleted
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Cancel an incident
+ summary: Delete an incident role task
tags:
- - Incidents
- x-content-type: application/vnd.api+json
+ - IncidentRoleTasks
x-accepts:
- application/vnd.api+json
- /v1/incidents/{id}/in_triage:
- put:
- description: Set a specific incident by ID to triage state
- operationId: triageIncident
+ get:
+ description: Retrieves a specific incident_role_task by id
+ operationId: getIncidentRoleTask
parameters:
- explode: false
in: path
@@ -24467,781 +14455,29 @@ paths:
schema:
type: string
style: simple
- requestBody:
- content:
- application/vnd.api+json:
- schema:
- $ref: '#/components/schemas/in_triage_incident'
- required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: b6632b4f-d81a-45fb-b53a-6ba588ac89ea
- type: incidents
- attributes:
- parent_incident_id: null
- sequential_id: 10
- title: Iusto perspiciatis qui tempore.
- slug: iusto-perspiciatis-qui-tempore
- kind: normal
- private: false
- summary: Voluptatem ut dolorem. Molestiae incidunt dolorem. Ipsa
- odio rerum.
- status: in_triage
- source: web
- url: http://localhost:3001/account/incidents/10-iusto-perspiciatis-qui-tempore
- short_url: null
- user:
- data:
- id: "301"
- type: users
- attributes:
- name: Dee Pouros
- email: xavier@macgyver.test
- phone: null
- phone_2: null
- first_name: Dee
- last_name: Pouros
- full_name: Dee Pouros
- full_name_with_team: "[Schmeler-Denesik] Dee Pouros"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:47:07.155-07:00
- created_at: 2025-05-22T06:47:06.671-07:00
- relationships:
- email_addresses:
- data:
- - id: a32d6d98-e437-4bad-87ca-81f43d6b2a85
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: 070850d3-910f-42f7-ac8e-881e3d1cf114
- created_at: 2025-05-22T06:46:59.584-07:00
- updated_at: 2025-05-22T06:46:59.584-07:00
- display_order: 2
- api_keys_permissions:
- - create
- - update
- - read
- - delete
- billing_permissions: []
- environments_permissions:
- - create
- - read
- - update
- - delete
- functionalities_permissions:
- - create
- - read
- - update
- - delete
- groups_permissions:
- - create
- - read
- - update
- - delete
- incident_causes_permissions:
- - create
- - read
- - update
- - delete
- incident_roles_permissions:
- - create
- - read
- - update
- - delete
- incident_types_permissions:
- - create
- - read
- - update
- - delete
- incidents_permissions:
- - create
- - read
- - update
- - delete
- private_incidents_permissions: []
- invitations_permissions:
- - create
- - read
- - update
- - delete
- playbooks_permissions:
- - create
- - read
- - update
- - delete
- retrospective_permissions:
- - create
- - read
- - update
- - delete
- roles_permissions: []
- services_permissions:
- - create
- - read
- - update
- - delete
- severities_permissions:
- - create
- - read
- - update
- - delete
- status_pages_permissions:
- - create
- - read
- - update
- - delete
- workflows_permissions:
- - create
- - read
- - update
- - delete
- team_id: 235
- name: user
- slug: user
- is_editable: true
- is_deletable: false
- incident_feedbacks_permissions:
- - read
- - create
- - update
- form_fields_permissions:
- - create
- - read
- - update
- - delete
- webhooks_permissions: []
- audits_permissions: []
- secrets_permissions:
- - create
- - read
- - update
- - delete
- deleted_at: null
- incident_permission_set_id: ce8e0129-ae20-4109-9ce5-9ce632b86933
- pulses_permissions:
- - create
- - update
- - read
- alerts_permissions:
- - create
- - read
- paging_permissions:
- - create
- - read
- - update
- - delete
- sub_statuses_permissions:
- - read
- catalogs_permissions:
- - create
- - read
- - update
- - delete
- communication_permissions:
- - read
- incident_communication_permissions:
- - read
- integrations_permissions: []
- on_call_role:
- data:
- id: 9817be29-441f-481c-88af-391816fec02b
- team_id: 235
- name: None
- slug: none
- system_role: no_access
- deleted_at: null
- created_at: 2025-05-22T06:46:59.607-07:00
- updated_at: 2025-05-22T06:46:59.607-07:00
- alerts_permissions: []
- api_keys_permissions: []
- audits_permissions: []
- escalation_policies_permissions: []
- groups_permissions: []
- integrations_permissions: []
- invitations_permissions: []
- on_call_roles_permissions: []
- schedules_permissions: []
- services_permissions: []
- shift_overrides_permissions: []
- workflows_permissions: []
- contacts_permissions: []
- live_call_routing_permissions: []
- heartbeats_permissions: []
- alert_urgency_permissions: []
- schedule_override_permissions: []
- webhooks_permissions: []
- alert_sources_permissions: []
- on_call_readiness_report_permissions: []
- alert_routing_rules_permissions: []
- severity:
- data:
- id: 7638fc0c-4ae0-4f76-991b-856102680ce1
- type: severities
- attributes:
- name: mzd1l
- slug: mzd1l
- description: Qui natus aut sed.
- severity: medium
- color: '#E58A1F'
- position: 1
- notify_emails: []
- slack_channels: []
- slack_aliases: []
- created_at: 2025-05-22T06:47:07.116-07:00
- updated_at: 2025-05-22T06:47:07.116-07:00
- in_triage_by:
- data:
- id: "289"
- type: users
- attributes:
- name: Annita Wolff
- email: sandy@weimann.example
- phone: null
- phone_2: null
- first_name: Annita
- last_name: Wolff
- full_name: Annita Wolff
- full_name_with_team: "[Schmeler-Denesik] Annita Wolff"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:47:26.444-07:00
- created_at: 2025-05-22T06:46:59.395-07:00
- relationships:
- email_addresses:
- data:
- - id: 85183e4a-ff2f-433e-828a-fbe9d3ffeabb
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: 070850d3-910f-42f7-ac8e-881e3d1cf114
- created_at: 2025-05-22T06:46:59.584-07:00
- updated_at: 2025-05-22T06:46:59.584-07:00
- display_order: 2
- api_keys_permissions:
- - create
- - update
- - read
- - delete
- billing_permissions: []
- environments_permissions:
- - create
- - read
- - update
- - delete
- functionalities_permissions:
- - create
- - read
- - update
- - delete
- groups_permissions:
- - create
- - read
- - update
- - delete
- incident_causes_permissions:
- - create
- - read
- - update
- - delete
- incident_roles_permissions:
- - create
- - read
- - update
- - delete
- incident_types_permissions:
- - create
- - read
- - update
- - delete
- incidents_permissions:
- - create
- - read
- - update
- - delete
- private_incidents_permissions: []
- invitations_permissions:
- - create
- - read
- - update
- - delete
- playbooks_permissions:
- - create
- - read
- - update
- - delete
- retrospective_permissions:
- - create
- - read
- - update
- - delete
- roles_permissions: []
- services_permissions:
- - create
- - read
- - update
- - delete
- severities_permissions:
- - create
- - read
- - update
- - delete
- status_pages_permissions:
- - create
- - read
- - update
- - delete
- workflows_permissions:
- - create
- - read
- - update
- - delete
- team_id: 235
- name: user
- slug: user
- is_editable: true
- is_deletable: false
- incident_feedbacks_permissions:
- - read
- - create
- - update
- form_fields_permissions:
- - create
- - read
- - update
- - delete
- webhooks_permissions: []
- audits_permissions: []
- secrets_permissions:
- - create
- - read
- - update
- - delete
- deleted_at: null
- incident_permission_set_id: ce8e0129-ae20-4109-9ce5-9ce632b86933
- pulses_permissions:
- - create
- - update
- - read
- alerts_permissions:
- - create
- - read
- paging_permissions:
- - create
- - read
- - update
- - delete
- sub_statuses_permissions:
- - read
- catalogs_permissions:
- - create
- - read
- - update
- - delete
- communication_permissions:
- - read
- incident_communication_permissions:
- - read
- integrations_permissions: []
- on_call_role:
- data:
- id: 9817be29-441f-481c-88af-391816fec02b
- team_id: 235
- name: None
- slug: none
- system_role: no_access
- deleted_at: null
- created_at: 2025-05-22T06:46:59.607-07:00
- updated_at: 2025-05-22T06:46:59.607-07:00
- alerts_permissions: []
- api_keys_permissions: []
- audits_permissions: []
- escalation_policies_permissions: []
- groups_permissions: []
- integrations_permissions: []
- invitations_permissions: []
- on_call_roles_permissions: []
- schedules_permissions: []
- services_permissions: []
- shift_overrides_permissions: []
- workflows_permissions: []
- contacts_permissions: []
- live_call_routing_permissions: []
- heartbeats_permissions: []
- alert_urgency_permissions: []
- schedule_override_permissions: []
- webhooks_permissions: []
- alert_sources_permissions: []
- on_call_readiness_report_permissions: []
- alert_routing_rules_permissions: []
- started_by:
- data:
- id: "301"
- type: users
- attributes:
- name: Dee Pouros
- email: xavier@macgyver.test
- phone: null
- phone_2: null
- first_name: Dee
- last_name: Pouros
- full_name: Dee Pouros
- full_name_with_team: "[Schmeler-Denesik] Dee Pouros"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:47:07.155-07:00
- created_at: 2025-05-22T06:47:06.671-07:00
- relationships:
- email_addresses:
- data:
- - id: a32d6d98-e437-4bad-87ca-81f43d6b2a85
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: 070850d3-910f-42f7-ac8e-881e3d1cf114
- created_at: 2025-05-22T06:46:59.584-07:00
- updated_at: 2025-05-22T06:46:59.584-07:00
- display_order: 2
- api_keys_permissions:
- - create
- - update
- - read
- - delete
- billing_permissions: []
- environments_permissions:
- - create
- - read
- - update
- - delete
- functionalities_permissions:
- - create
- - read
- - update
- - delete
- groups_permissions:
- - create
- - read
- - update
- - delete
- incident_causes_permissions:
- - create
- - read
- - update
- - delete
- incident_roles_permissions:
- - create
- - read
- - update
- - delete
- incident_types_permissions:
- - create
- - read
- - update
- - delete
- incidents_permissions:
- - create
- - read
- - update
- - delete
- private_incidents_permissions: []
- invitations_permissions:
- - create
- - read
- - update
- - delete
- playbooks_permissions:
- - create
- - read
- - update
- - delete
- retrospective_permissions:
- - create
- - read
- - update
- - delete
- roles_permissions: []
- services_permissions:
- - create
- - read
- - update
- - delete
- severities_permissions:
- - create
- - read
- - update
- - delete
- status_pages_permissions:
- - create
- - read
- - update
- - delete
- workflows_permissions:
- - create
- - read
- - update
- - delete
- team_id: 235
- name: user
- slug: user
- is_editable: true
- is_deletable: false
- incident_feedbacks_permissions:
- - read
- - create
- - update
- form_fields_permissions:
- - create
- - read
- - update
- - delete
- webhooks_permissions: []
- audits_permissions: []
- secrets_permissions:
- - create
- - read
- - update
- - delete
- deleted_at: null
- incident_permission_set_id: ce8e0129-ae20-4109-9ce5-9ce632b86933
- pulses_permissions:
- - create
- - update
- - read
- alerts_permissions:
- - create
- - read
- paging_permissions:
- - create
- - read
- - update
- - delete
- sub_statuses_permissions:
- - read
- catalogs_permissions:
- - create
- - read
- - update
- - delete
- communication_permissions:
- - read
- incident_communication_permissions:
- - read
- integrations_permissions: []
- on_call_role:
- data:
- id: 9817be29-441f-481c-88af-391816fec02b
- team_id: 235
- name: None
- slug: none
- system_role: no_access
- deleted_at: null
- created_at: 2025-05-22T06:46:59.607-07:00
- updated_at: 2025-05-22T06:46:59.607-07:00
- alerts_permissions: []
- api_keys_permissions: []
- audits_permissions: []
- escalation_policies_permissions: []
- groups_permissions: []
- integrations_permissions: []
- invitations_permissions: []
- on_call_roles_permissions: []
- schedules_permissions: []
- services_permissions: []
- shift_overrides_permissions: []
- workflows_permissions: []
- contacts_permissions: []
- live_call_routing_permissions: []
- heartbeats_permissions: []
- alert_urgency_permissions: []
- schedule_override_permissions: []
- webhooks_permissions: []
- alert_sources_permissions: []
- on_call_readiness_report_permissions: []
- alert_routing_rules_permissions: []
- mitigated_by: null
- resolved_by: null
- closed_by: null
- cancelled_by: null
- mitigation_message: null
- resolution_message: null
- cancellation_message: null
- public_title: null
- duplicate_incident_id: null
- retrospective_progress_status: not_started
- zoom_meeting_id: null
- zoom_meeting_start_url: null
- zoom_meeting_join_url: null
- zoom_meeting_password: null
- zoom_meeting_pstn_password: null
- zoom_meeting_h323_password: null
- zoom_meeting_global_dial_in_numbers: []
- shortcut_story_id: null
- shortcut_story_url: null
- shortcut_task_id: null
- shortcut_task_url: null
- asana_task_id: null
- asana_task_url: null
- github_issue_id: null
- github_issue_url: null
- gitlab_issue_id: null
- gitlab_issue_url: null
- jira_issue_key: null
- jira_issue_id: null
- jira_issue_url: null
- google_meeting_id: null
- google_meeting_url: null
- trello_card_id: null
- trello_card_url: null
- linear_issue_id: null
- linear_issue_url: null
- zendesk_ticket_id: null
- zendesk_ticket_url: null
- motion_task_id: null
- motion_task_url: null
- clickup_task_id: null
- clickup_task_url: null
- slack_channel_name: null
- slack_channel_id: null
- slack_channel_url: null
- slack_channel_short_url: null
- slack_channel_deep_link: null
- slack_channel_archived: false
- slack_last_message_ts: null
- service_now_incident_id: null
- service_now_incident_key: null
- service_now_incident_url: null
- opsgenie_incident_id: null
- opsgenie_incident_url: null
- opsgenie_alert_id: null
- opsgenie_alert_url: null
- victor_ops_incident_id: null
- victor_ops_incident_url: null
- pagerduty_incident_id: null
- pagerduty_incident_number: null
- pagerduty_incident_url: null
- mattermost_channel_id: null
- mattermost_channel_name: null
- mattermost_channel_url: null
- confluence_page_id: null
- confluence_page_url: null
- quip_page_id: null
- quip_page_url: null
- airtable_base_key: null
- airtable_table_name: null
- airtable_record_id: null
- airtable_record_url: null
- google_drive_id: null
- google_drive_parent_id: null
- google_drive_url: null
- sharepoint_page_id: null
- sharepoint_page_url: null
- datadog_notebook_id: null
- datadog_notebook_url: null
- freshservice_ticket_id: null
- freshservice_ticket_url: null
- freshservice_task_id: null
- freshservice_task_url: null
- scheduled_for: null
- scheduled_until: null
- in_triage_at: 2025-05-22T06:47:26.635-07:00
- started_at: null
- detected_at: null
- acknowledged_at: null
- mitigated_at: null
- resolved_at: null
- closed_at: null
- cancelled_at: null
- created_at: 2025-05-22T06:47:07.124-07:00
- updated_at: 2025-05-22T06:47:26.698-07:00
- labels: {}
- relationships:
- incident_post_mortem:
- data:
- id: a20720d2-4bb3-42f3-95a8-cc53afbb0059
- type: incident_post_mortems
- causes:
- data: []
- subscribers:
- data: []
- roles:
- data: []
- environments:
- data: []
- incident_types:
- data: []
- services:
- data: []
- functionalities:
- data: []
- groups:
- data: []
- events:
- data:
- - id: d8748447-4e09-46f5-ac1d-c1a2c2ad1413
- type: incident_events
- - id: 0245baa0-bf58-4ca0-bc70-7ca2d0d3c9c3
- type: incident_events
- - id: eeaca573-61d2-4ec0-8d01-b040cb0aa96c
- type: incident_events
- - id: 11831d61-9291-4fb2-8c0e-c0d10a113e76
- type: incident_events
- - id: 916bd571-c142-40cc-9bba-57731264bd88
- type: incident_events
- - id: e75d7f4c-7560-4f94-82b7-4ceb00c4dc11
- type: incident_events
- - id: 8d6a91cb-f5d6-41ae-a92c-d34b4be09d6c
- type: incident_events
- action_items:
- data: []
- custom_field_selections:
- data: []
- feedbacks:
- data: []
- attachments:
- data: []
- slack_messages:
- data: []
schema:
- $ref: '#/components/schemas/incident_response'
- description: incident set to triage
+ $ref: '#/components/schemas/incident_role_task_response'
+ description: incident_role_task found
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Triage an incident
+ summary: Retrieves an incident role task
tags:
- - Incidents
- x-content-type: application/vnd.api+json
+ - IncidentRoleTasks
x-accepts:
- application/vnd.api+json
- /v1/incidents/{id}/restart:
put:
- description: Restart a specific incident by id
- operationId: restartIncident
+ description: Update a specific incident_role task by id
+ operationId: updateIncidentRoleTask
parameters:
- explode: false
in: path
@@ -25254,3753 +14490,275 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/restart_incident'
+ $ref: '#/components/schemas/update_incident_role_task'
required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: b6632b4f-d81a-45fb-b53a-6ba588ac89ea
- type: incidents
- attributes:
- parent_incident_id: null
- sequential_id: 10
- title: Iusto perspiciatis qui tempore.
- slug: iusto-perspiciatis-qui-tempore
- kind: normal
- private: false
- summary: Voluptatem ut dolorem. Molestiae incidunt dolorem. Ipsa
- odio rerum.
- status: started
- source: web
- url: http://localhost:3001/account/incidents/10-iusto-perspiciatis-qui-tempore
- short_url: null
- user:
- data:
- id: "301"
- type: users
- attributes:
- name: Dee Pouros
- email: xavier@macgyver.test
- phone: null
- phone_2: null
- first_name: Dee
- last_name: Pouros
- full_name: Dee Pouros
- full_name_with_team: "[Schmeler-Denesik] Dee Pouros"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:47:07.155-07:00
- created_at: 2025-05-22T06:47:06.671-07:00
- relationships:
- email_addresses:
- data:
- - id: a32d6d98-e437-4bad-87ca-81f43d6b2a85
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: 070850d3-910f-42f7-ac8e-881e3d1cf114
- created_at: 2025-05-22T06:46:59.584-07:00
- updated_at: 2025-05-22T06:46:59.584-07:00
- display_order: 2
- api_keys_permissions:
- - create
- - update
- - read
- - delete
- billing_permissions: []
- environments_permissions:
- - create
- - read
- - update
- - delete
- functionalities_permissions:
- - create
- - read
- - update
- - delete
- groups_permissions:
- - create
- - read
- - update
- - delete
- incident_causes_permissions:
- - create
- - read
- - update
- - delete
- incident_roles_permissions:
- - create
- - read
- - update
- - delete
- incident_types_permissions:
- - create
- - read
- - update
- - delete
- incidents_permissions:
- - create
- - read
- - update
- - delete
- private_incidents_permissions: []
- invitations_permissions:
- - create
- - read
- - update
- - delete
- playbooks_permissions:
- - create
- - read
- - update
- - delete
- retrospective_permissions:
- - create
- - read
- - update
- - delete
- roles_permissions: []
- services_permissions:
- - create
- - read
- - update
- - delete
- severities_permissions:
- - create
- - read
- - update
- - delete
- status_pages_permissions:
- - create
- - read
- - update
- - delete
- workflows_permissions:
- - create
- - read
- - update
- - delete
- team_id: 235
- name: user
- slug: user
- is_editable: true
- is_deletable: false
- incident_feedbacks_permissions:
- - read
- - create
- - update
- form_fields_permissions:
- - create
- - read
- - update
- - delete
- webhooks_permissions: []
- audits_permissions: []
- secrets_permissions:
- - create
- - read
- - update
- - delete
- deleted_at: null
- incident_permission_set_id: ce8e0129-ae20-4109-9ce5-9ce632b86933
- pulses_permissions:
- - create
- - update
- - read
- alerts_permissions:
- - create
- - read
- paging_permissions:
- - create
- - read
- - update
- - delete
- sub_statuses_permissions:
- - read
- catalogs_permissions:
- - create
- - read
- - update
- - delete
- communication_permissions:
- - read
- incident_communication_permissions:
- - read
- integrations_permissions: []
- on_call_role:
- data:
- id: 9817be29-441f-481c-88af-391816fec02b
- team_id: 235
- name: None
- slug: none
- system_role: no_access
- deleted_at: null
- created_at: 2025-05-22T06:46:59.607-07:00
- updated_at: 2025-05-22T06:46:59.607-07:00
- alerts_permissions: []
- api_keys_permissions: []
- audits_permissions: []
- escalation_policies_permissions: []
- groups_permissions: []
- integrations_permissions: []
- invitations_permissions: []
- on_call_roles_permissions: []
- schedules_permissions: []
- services_permissions: []
- shift_overrides_permissions: []
- workflows_permissions: []
- contacts_permissions: []
- live_call_routing_permissions: []
- heartbeats_permissions: []
- alert_urgency_permissions: []
- schedule_override_permissions: []
- webhooks_permissions: []
- alert_sources_permissions: []
- on_call_readiness_report_permissions: []
- alert_routing_rules_permissions: []
- severity:
- data:
- id: 7638fc0c-4ae0-4f76-991b-856102680ce1
- type: severities
- attributes:
- name: mzd1l
- slug: mzd1l
- description: Qui natus aut sed.
- severity: medium
- color: '#E58A1F'
- position: 1
- notify_emails: []
- slack_channels: []
- slack_aliases: []
- created_at: 2025-05-22T06:47:07.116-07:00
- updated_at: 2025-05-22T06:47:07.116-07:00
- in_triage_by: null
- started_by:
- data:
- id: "289"
- type: users
- attributes:
- name: Annita Wolff
- email: sandy@weimann.example
- phone: null
- phone_2: null
- first_name: Annita
- last_name: Wolff
- full_name: Annita Wolff
- full_name_with_team: "[Schmeler-Denesik] Annita Wolff"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:47:27.563-07:00
- created_at: 2025-05-22T06:46:59.395-07:00
- relationships:
- email_addresses:
- data:
- - id: 85183e4a-ff2f-433e-828a-fbe9d3ffeabb
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: 070850d3-910f-42f7-ac8e-881e3d1cf114
- created_at: 2025-05-22T06:46:59.584-07:00
- updated_at: 2025-05-22T06:46:59.584-07:00
- display_order: 2
- api_keys_permissions:
- - create
- - update
- - read
- - delete
- billing_permissions: []
- environments_permissions:
- - create
- - read
- - update
- - delete
- functionalities_permissions:
- - create
- - read
- - update
- - delete
- groups_permissions:
- - create
- - read
- - update
- - delete
- incident_causes_permissions:
- - create
- - read
- - update
- - delete
- incident_roles_permissions:
- - create
- - read
- - update
- - delete
- incident_types_permissions:
- - create
- - read
- - update
- - delete
- incidents_permissions:
- - create
- - read
- - update
- - delete
- private_incidents_permissions: []
- invitations_permissions:
- - create
- - read
- - update
- - delete
- playbooks_permissions:
- - create
- - read
- - update
- - delete
- retrospective_permissions:
- - create
- - read
- - update
- - delete
- roles_permissions: []
- services_permissions:
- - create
- - read
- - update
- - delete
- severities_permissions:
- - create
- - read
- - update
- - delete
- status_pages_permissions:
- - create
- - read
- - update
- - delete
- workflows_permissions:
- - create
- - read
- - update
- - delete
- team_id: 235
- name: user
- slug: user
- is_editable: true
- is_deletable: false
- incident_feedbacks_permissions:
- - read
- - create
- - update
- form_fields_permissions:
- - create
- - read
- - update
- - delete
- webhooks_permissions: []
- audits_permissions: []
- secrets_permissions:
- - create
- - read
- - update
- - delete
- deleted_at: null
- incident_permission_set_id: ce8e0129-ae20-4109-9ce5-9ce632b86933
- pulses_permissions:
- - create
- - update
- - read
- alerts_permissions:
- - create
- - read
- paging_permissions:
- - create
- - read
- - update
- - delete
- sub_statuses_permissions:
- - read
- catalogs_permissions:
- - create
- - read
- - update
- - delete
- communication_permissions:
- - read
- incident_communication_permissions:
- - read
- integrations_permissions: []
- on_call_role:
- data:
- id: 9817be29-441f-481c-88af-391816fec02b
- team_id: 235
- name: None
- slug: none
- system_role: no_access
- deleted_at: null
- created_at: 2025-05-22T06:46:59.607-07:00
- updated_at: 2025-05-22T06:46:59.607-07:00
- alerts_permissions: []
- api_keys_permissions: []
- audits_permissions: []
- escalation_policies_permissions: []
- groups_permissions: []
- integrations_permissions: []
- invitations_permissions: []
- on_call_roles_permissions: []
- schedules_permissions: []
- services_permissions: []
- shift_overrides_permissions: []
- workflows_permissions: []
- contacts_permissions: []
- live_call_routing_permissions: []
- heartbeats_permissions: []
- alert_urgency_permissions: []
- schedule_override_permissions: []
- webhooks_permissions: []
- alert_sources_permissions: []
- on_call_readiness_report_permissions: []
- alert_routing_rules_permissions: []
- mitigated_by: null
- resolved_by: null
- closed_by: null
- cancelled_by: null
- mitigation_message: null
- resolution_message: null
- cancellation_message: null
- public_title: null
- duplicate_incident_id: null
- retrospective_progress_status: not_started
- zoom_meeting_id: null
- zoom_meeting_start_url: null
- zoom_meeting_join_url: null
- zoom_meeting_password: null
- zoom_meeting_pstn_password: null
- zoom_meeting_h323_password: null
- zoom_meeting_global_dial_in_numbers: []
- shortcut_story_id: null
- shortcut_story_url: null
- shortcut_task_id: null
- shortcut_task_url: null
- asana_task_id: null
- asana_task_url: null
- github_issue_id: null
- github_issue_url: null
- gitlab_issue_id: null
- gitlab_issue_url: null
- jira_issue_key: null
- jira_issue_id: null
- jira_issue_url: null
- google_meeting_id: null
- google_meeting_url: null
- trello_card_id: null
- trello_card_url: null
- linear_issue_id: null
- linear_issue_url: null
- zendesk_ticket_id: null
- zendesk_ticket_url: null
- motion_task_id: null
- motion_task_url: null
- clickup_task_id: null
- clickup_task_url: null
- slack_channel_name: null
- slack_channel_id: null
- slack_channel_url: null
- slack_channel_short_url: null
- slack_channel_deep_link: null
- slack_channel_archived: false
- slack_last_message_ts: null
- service_now_incident_id: null
- service_now_incident_key: null
- service_now_incident_url: null
- opsgenie_incident_id: null
- opsgenie_incident_url: null
- opsgenie_alert_id: null
- opsgenie_alert_url: null
- victor_ops_incident_id: null
- victor_ops_incident_url: null
- pagerduty_incident_id: null
- pagerduty_incident_number: null
- pagerduty_incident_url: null
- mattermost_channel_id: null
- mattermost_channel_name: null
- mattermost_channel_url: null
- confluence_page_id: null
- confluence_page_url: null
- quip_page_id: null
- quip_page_url: null
- airtable_base_key: null
- airtable_table_name: null
- airtable_record_id: null
- airtable_record_url: null
- google_drive_id: null
- google_drive_parent_id: null
- google_drive_url: null
- sharepoint_page_id: null
- sharepoint_page_url: null
- datadog_notebook_id: null
- datadog_notebook_url: null
- freshservice_ticket_id: null
- freshservice_ticket_url: null
- freshservice_task_id: null
- freshservice_task_url: null
- scheduled_for: null
- scheduled_until: null
- in_triage_at: null
- started_at: 2025-05-22T06:47:27.740-07:00
- detected_at: null
- acknowledged_at: null
- mitigated_at: null
- resolved_at: null
- closed_at: null
- cancelled_at: null
- created_at: 2025-05-22T06:47:07.124-07:00
- updated_at: 2025-05-22T06:47:27.793-07:00
- labels: {}
- relationships:
- causes:
- data: []
- subscribers:
- data: []
- roles:
- data: []
- environments:
- data: []
- incident_types:
- data: []
- services:
- data: []
- functionalities:
- data: []
- groups:
- data: []
- events:
- data:
- - id: 77eda385-103f-4b40-8334-7f51302b5b50
- type: incident_events
- - id: eeaca573-61d2-4ec0-8d01-b040cb0aa96c
- type: incident_events
- - id: 11831d61-9291-4fb2-8c0e-c0d10a113e76
- type: incident_events
- - id: 916bd571-c142-40cc-9bba-57731264bd88
- type: incident_events
- - id: e75d7f4c-7560-4f94-82b7-4ceb00c4dc11
- type: incident_events
- - id: 8d6a91cb-f5d6-41ae-a92c-d34b4be09d6c
- type: incident_events
- action_items:
- data: []
- custom_field_selections:
- data: []
- feedbacks:
- data: []
- attachments:
- data: []
- slack_messages:
- data: []
schema:
- $ref: '#/components/schemas/incident_response'
- description: incident restarted
+ $ref: '#/components/schemas/incident_role_task_response'
+ description: incident_role_task updated
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Restart an incident
+ summary: Update an incident role task
tags:
- - Incidents
+ - IncidentRoleTasks
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/incidents/{id}/duplicate:
- put:
- description: Mark an incident as a duplicate
- operationId: markAsDuplicateIncident
+ /v1/incident_roles:
+ get:
+ description: List incident roles
+ operationId: listIncidentRoles
parameters:
- - explode: false
- in: path
- name: id
- required: true
+ - explode: true
+ in: query
+ name: "page[number]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ - explode: true
+ in: query
+ name: "page[size]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ - explode: true
+ in: query
+ name: "filter[search]"
+ required: false
schema:
type: string
- style: simple
- requestBody:
- content:
- application/vnd.api+json:
- schema:
- $ref: '#/components/schemas/resolve_incident'
- required: true
+ style: form
+ - explode: true
+ in: query
+ name: "filter[slug]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[name]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[enabled]"
+ required: false
+ schema:
+ type: boolean
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][gt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][gte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][lt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][lte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: sort
+ required: false
+ schema:
+ type: string
+ style: form
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 3df2515f-3cc3-4285-98c4-2168f7a76c56
- type: incidents
- attributes:
- parent_incident_id: null
- sequential_id: 1
- title: Odit ut ut aliquid.
- slug: odit-ut-ut-aliquid
- kind: normal
- private: false
- summary: Assumenda provident aut. Assumenda occaecati explicabo.
- Non inventore voluptatum.
- status: cancelled
- source: web
- url: http://localhost:3001/account/incidents/1-odit-ut-ut-aliquid
- short_url: null
- user:
- data:
- id: "291"
- type: users
- attributes:
- name: Ike Klein
- email: barbara@langosh-torphy.example
- phone: null
- phone_2: null
- first_name: Ike
- last_name: Klein
- full_name: Ike Klein
- full_name_with_team: "[Schmeler-Denesik] Ike Klein"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:47:00.856-07:00
- created_at: 2025-05-22T06:47:00.386-07:00
- relationships:
- email_addresses:
- data:
- - id: 75e899ca-99db-464b-b9d1-a3ed30b34a07
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: 070850d3-910f-42f7-ac8e-881e3d1cf114
- created_at: 2025-05-22T06:46:59.584-07:00
- updated_at: 2025-05-22T06:46:59.584-07:00
- display_order: 2
- api_keys_permissions:
- - create
- - update
- - read
- - delete
- billing_permissions: []
- environments_permissions:
- - create
- - read
- - update
- - delete
- functionalities_permissions:
- - create
- - read
- - update
- - delete
- groups_permissions:
- - create
- - read
- - update
- - delete
- incident_causes_permissions:
- - create
- - read
- - update
- - delete
- incident_roles_permissions:
- - create
- - read
- - update
- - delete
- incident_types_permissions:
- - create
- - read
- - update
- - delete
- incidents_permissions:
- - create
- - read
- - update
- - delete
- private_incidents_permissions: []
- invitations_permissions:
- - create
- - read
- - update
- - delete
- playbooks_permissions:
- - create
- - read
- - update
- - delete
- retrospective_permissions:
- - create
- - read
- - update
- - delete
- roles_permissions: []
- services_permissions:
- - create
- - read
- - update
- - delete
- severities_permissions:
- - create
- - read
- - update
- - delete
- status_pages_permissions:
- - create
- - read
- - update
- - delete
- workflows_permissions:
- - create
- - read
- - update
- - delete
- team_id: 235
- name: user
- slug: user
- is_editable: true
- is_deletable: false
- incident_feedbacks_permissions:
- - read
- - create
- - update
- form_fields_permissions:
- - create
- - read
- - update
- - delete
- webhooks_permissions: []
- audits_permissions: []
- secrets_permissions:
- - create
- - read
- - update
- - delete
- deleted_at: null
- incident_permission_set_id: ce8e0129-ae20-4109-9ce5-9ce632b86933
- pulses_permissions:
- - create
- - update
- - read
- alerts_permissions:
- - create
- - read
- paging_permissions:
- - create
- - read
- - update
- - delete
- sub_statuses_permissions:
- - read
- catalogs_permissions:
- - create
- - read
- - update
- - delete
- communication_permissions:
- - read
- incident_communication_permissions:
- - read
- integrations_permissions: []
- on_call_role:
- data:
- id: 9817be29-441f-481c-88af-391816fec02b
- team_id: 235
- name: None
- slug: none
- system_role: no_access
- deleted_at: null
- created_at: 2025-05-22T06:46:59.607-07:00
- updated_at: 2025-05-22T06:46:59.607-07:00
- alerts_permissions: []
- api_keys_permissions: []
- audits_permissions: []
- escalation_policies_permissions: []
- groups_permissions: []
- integrations_permissions: []
- invitations_permissions: []
- on_call_roles_permissions: []
- schedules_permissions: []
- services_permissions: []
- shift_overrides_permissions: []
- workflows_permissions: []
- contacts_permissions: []
- live_call_routing_permissions: []
- heartbeats_permissions: []
- alert_urgency_permissions: []
- schedule_override_permissions: []
- webhooks_permissions: []
- alert_sources_permissions: []
- on_call_readiness_report_permissions: []
- alert_routing_rules_permissions: []
- severity:
- data:
- id: 37a51805-7c23-4dab-af67-405fe2c43393
- type: severities
- attributes:
- name: j0po1
- slug: j0po1
- description: Aut alias totam consequuntur.
- severity: medium
- color: '#E58A1F'
- position: 1
- notify_emails: []
- slack_channels: []
- slack_aliases: []
- created_at: 2025-05-22T06:47:00.817-07:00
- updated_at: 2025-05-22T06:47:00.817-07:00
- in_triage_by: null
- started_by:
- data:
- id: "291"
- type: users
- attributes:
- name: Ike Klein
- email: barbara@langosh-torphy.example
- phone: null
- phone_2: null
- first_name: Ike
- last_name: Klein
- full_name: Ike Klein
- full_name_with_team: "[Schmeler-Denesik] Ike Klein"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:47:00.856-07:00
- created_at: 2025-05-22T06:47:00.386-07:00
- relationships:
- email_addresses:
- data:
- - id: 75e899ca-99db-464b-b9d1-a3ed30b34a07
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: 070850d3-910f-42f7-ac8e-881e3d1cf114
- created_at: 2025-05-22T06:46:59.584-07:00
- updated_at: 2025-05-22T06:46:59.584-07:00
- display_order: 2
- api_keys_permissions:
- - create
- - update
- - read
- - delete
- billing_permissions: []
- environments_permissions:
- - create
- - read
- - update
- - delete
- functionalities_permissions:
- - create
- - read
- - update
- - delete
- groups_permissions:
- - create
- - read
- - update
- - delete
- incident_causes_permissions:
- - create
- - read
- - update
- - delete
- incident_roles_permissions:
- - create
- - read
- - update
- - delete
- incident_types_permissions:
- - create
- - read
- - update
- - delete
- incidents_permissions:
- - create
- - read
- - update
- - delete
- private_incidents_permissions: []
- invitations_permissions:
- - create
- - read
- - update
- - delete
- playbooks_permissions:
- - create
- - read
- - update
- - delete
- retrospective_permissions:
- - create
- - read
- - update
- - delete
- roles_permissions: []
- services_permissions:
- - create
- - read
- - update
- - delete
- severities_permissions:
- - create
- - read
- - update
- - delete
- status_pages_permissions:
- - create
- - read
- - update
- - delete
- workflows_permissions:
- - create
- - read
- - update
- - delete
- team_id: 235
- name: user
- slug: user
- is_editable: true
- is_deletable: false
- incident_feedbacks_permissions:
- - read
- - create
- - update
- form_fields_permissions:
- - create
- - read
- - update
- - delete
- webhooks_permissions: []
- audits_permissions: []
- secrets_permissions:
- - create
- - read
- - update
- - delete
- deleted_at: null
- incident_permission_set_id: ce8e0129-ae20-4109-9ce5-9ce632b86933
- pulses_permissions:
- - create
- - update
- - read
- alerts_permissions:
- - create
- - read
- paging_permissions:
- - create
- - read
- - update
- - delete
- sub_statuses_permissions:
- - read
- catalogs_permissions:
- - create
- - read
- - update
- - delete
- communication_permissions:
- - read
- incident_communication_permissions:
- - read
- integrations_permissions: []
- on_call_role:
- data:
- id: 9817be29-441f-481c-88af-391816fec02b
- team_id: 235
- name: None
- slug: none
- system_role: no_access
- deleted_at: null
- created_at: 2025-05-22T06:46:59.607-07:00
- updated_at: 2025-05-22T06:46:59.607-07:00
- alerts_permissions: []
- api_keys_permissions: []
- audits_permissions: []
- escalation_policies_permissions: []
- groups_permissions: []
- integrations_permissions: []
- invitations_permissions: []
- on_call_roles_permissions: []
- schedules_permissions: []
- services_permissions: []
- shift_overrides_permissions: []
- workflows_permissions: []
- contacts_permissions: []
- live_call_routing_permissions: []
- heartbeats_permissions: []
- alert_urgency_permissions: []
- schedule_override_permissions: []
- webhooks_permissions: []
- alert_sources_permissions: []
- on_call_readiness_report_permissions: []
- alert_routing_rules_permissions: []
- mitigated_by: null
- resolved_by: null
- closed_by: null
- cancelled_by: null
- mitigation_message: null
- resolution_message: null
- cancellation_message: Duplicate !
- public_title: null
- duplicate_incident_id: cc4f7401-1bb7-4585-9923-7028080aa78c
- retrospective_progress_status: not_started
- zoom_meeting_id: null
- zoom_meeting_start_url: null
- zoom_meeting_join_url: null
- zoom_meeting_password: null
- zoom_meeting_pstn_password: null
- zoom_meeting_h323_password: null
- zoom_meeting_global_dial_in_numbers: []
- shortcut_story_id: null
- shortcut_story_url: null
- shortcut_task_id: null
- shortcut_task_url: null
- asana_task_id: null
- asana_task_url: null
- github_issue_id: null
- github_issue_url: null
- gitlab_issue_id: null
- gitlab_issue_url: null
- jira_issue_key: null
- jira_issue_id: null
- jira_issue_url: null
- google_meeting_id: null
- google_meeting_url: null
- trello_card_id: null
- trello_card_url: null
- linear_issue_id: null
- linear_issue_url: null
- zendesk_ticket_id: null
- zendesk_ticket_url: null
- motion_task_id: null
- motion_task_url: null
- clickup_task_id: null
- clickup_task_url: null
- slack_channel_name: null
- slack_channel_id: null
- slack_channel_url: null
- slack_channel_short_url: null
- slack_channel_deep_link: null
- slack_channel_archived: false
- slack_last_message_ts: null
- service_now_incident_id: null
- service_now_incident_key: null
- service_now_incident_url: null
- opsgenie_incident_id: null
- opsgenie_incident_url: null
- opsgenie_alert_id: null
- opsgenie_alert_url: null
- victor_ops_incident_id: null
- victor_ops_incident_url: null
- pagerduty_incident_id: null
- pagerduty_incident_number: null
- pagerduty_incident_url: null
- mattermost_channel_id: null
- mattermost_channel_name: null
- mattermost_channel_url: null
- confluence_page_id: null
- confluence_page_url: null
- quip_page_id: null
- quip_page_url: null
- airtable_base_key: null
- airtable_table_name: null
- airtable_record_id: null
- airtable_record_url: null
- google_drive_id: null
- google_drive_parent_id: null
- google_drive_url: null
- sharepoint_page_id: null
- sharepoint_page_url: null
- datadog_notebook_id: null
- datadog_notebook_url: null
- freshservice_ticket_id: null
- freshservice_ticket_url: null
- freshservice_task_id: null
- freshservice_task_url: null
- scheduled_for: null
- scheduled_until: null
- in_triage_at: null
- started_at: 2025-05-22T06:47:00.825-07:00
- detected_at: null
- acknowledged_at: null
- mitigated_at: null
- resolved_at: null
- closed_at: null
- cancelled_at: 2025-05-22T06:47:28.944-07:00
- created_at: 2025-05-22T06:47:00.825-07:00
- updated_at: 2025-05-22T06:47:29.013-07:00
- labels: {}
- relationships:
- incident_post_mortem:
- data:
- id: 8bc5d3ba-3feb-4400-904a-581278b1863a
- type: incident_post_mortems
- causes:
- data: []
- subscribers:
- data: []
- roles:
- data: []
- environments:
- data: []
- incident_types:
- data: []
- services:
- data: []
- functionalities:
- data: []
- groups:
- data: []
- events:
- data:
- - id: d215b4c8-5331-4504-a016-7a3ab6522869
- type: incident_events
- - id: 845330bb-66c3-4208-b2e7-28e5936171c0
- type: incident_events
- - id: d843dae2-84f1-4d33-8b1b-adf5c0451dea
- type: incident_events
- - id: b6699095-08a1-4df9-b271-e3b9c5dfc395
- type: incident_events
- action_items:
- data: []
- custom_field_selections:
- data: []
- feedbacks:
- data: []
- attachments:
- data: []
- slack_messages:
- data: []
- schema:
- $ref: '#/components/schemas/incident_response'
- description: incident marked as duplicated
- "404":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
- $ref: '#/components/schemas/errors_list'
- description: resource not found
+ $ref: '#/components/schemas/incident_role_list'
+ description: success
security:
- bearer_auth: []
- summary: Mark an incident as a duplicate
+ summary: List incident roles
tags:
- - Incidents
- x-content-type: application/vnd.api+json
+ - IncidentRoles
x-accepts:
- application/vnd.api+json
- /v1/incidents/{id}/add_subscribers:
post:
- description: Add subscribers to incident
- operationId: addSubscribersToIncident
- parameters:
- - explode: false
- in: path
- name: id
- required: true
- schema:
- type: string
- style: simple
+ description: Creates a new incident role from provided data
+ operationId: createIncidentRole
+ parameters: []
requestBody:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/add_subscribers'
+ $ref: '#/components/schemas/new_incident_role'
required: true
responses:
- "200":
+ "201":
content:
application/vnd.api+json:
- example:
- data:
- id: 3df2515f-3cc3-4285-98c4-2168f7a76c56
- type: incidents
- attributes:
- parent_incident_id: null
- sequential_id: 1
- title: Odit ut ut aliquid.
- slug: odit-ut-ut-aliquid
- kind: normal
- private: false
- summary: Assumenda provident aut. Assumenda occaecati explicabo.
- Non inventore voluptatum.
- status: started
- source: web
- url: http://localhost:3001/account/incidents/1-odit-ut-ut-aliquid
- short_url: null
- user:
- data:
- id: "291"
- type: users
- attributes:
- name: Ike Klein
- email: barbara@langosh-torphy.example
- phone: null
- phone_2: null
- first_name: Ike
- last_name: Klein
- full_name: Ike Klein
- full_name_with_team: "[Schmeler-Denesik] Ike Klein"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:47:00.856-07:00
- created_at: 2025-05-22T06:47:00.386-07:00
- relationships:
- email_addresses:
- data:
- - id: 75e899ca-99db-464b-b9d1-a3ed30b34a07
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: 070850d3-910f-42f7-ac8e-881e3d1cf114
- created_at: 2025-05-22T06:46:59.584-07:00
- updated_at: 2025-05-22T06:46:59.584-07:00
- display_order: 2
- api_keys_permissions:
- - create
- - update
- - read
- - delete
- billing_permissions: []
- environments_permissions:
- - create
- - read
- - update
- - delete
- functionalities_permissions:
- - create
- - read
- - update
- - delete
- groups_permissions:
- - create
- - read
- - update
- - delete
- incident_causes_permissions:
- - create
- - read
- - update
- - delete
- incident_roles_permissions:
- - create
- - read
- - update
- - delete
- incident_types_permissions:
- - create
- - read
- - update
- - delete
- incidents_permissions:
- - create
- - read
- - update
- - delete
- private_incidents_permissions: []
- invitations_permissions:
- - create
- - read
- - update
- - delete
- playbooks_permissions:
- - create
- - read
- - update
- - delete
- retrospective_permissions:
- - create
- - read
- - update
- - delete
- roles_permissions: []
- services_permissions:
- - create
- - read
- - update
- - delete
- severities_permissions:
- - create
- - read
- - update
- - delete
- status_pages_permissions:
- - create
- - read
- - update
- - delete
- workflows_permissions:
- - create
- - read
- - update
- - delete
- team_id: 235
- name: user
- slug: user
- is_editable: true
- is_deletable: false
- incident_feedbacks_permissions:
- - read
- - create
- - update
- form_fields_permissions:
- - create
- - read
- - update
- - delete
- webhooks_permissions: []
- audits_permissions: []
- secrets_permissions:
- - create
- - read
- - update
- - delete
- deleted_at: null
- incident_permission_set_id: ce8e0129-ae20-4109-9ce5-9ce632b86933
- pulses_permissions:
- - create
- - update
- - read
- alerts_permissions:
- - create
- - read
- paging_permissions:
- - create
- - read
- - update
- - delete
- sub_statuses_permissions:
- - read
- catalogs_permissions:
- - create
- - read
- - update
- - delete
- communication_permissions:
- - read
- incident_communication_permissions:
- - read
- integrations_permissions: []
- on_call_role:
- data:
- id: 9817be29-441f-481c-88af-391816fec02b
- team_id: 235
- name: None
- slug: none
- system_role: no_access
- deleted_at: null
- created_at: 2025-05-22T06:46:59.607-07:00
- updated_at: 2025-05-22T06:46:59.607-07:00
- alerts_permissions: []
- api_keys_permissions: []
- audits_permissions: []
- escalation_policies_permissions: []
- groups_permissions: []
- integrations_permissions: []
- invitations_permissions: []
- on_call_roles_permissions: []
- schedules_permissions: []
- services_permissions: []
- shift_overrides_permissions: []
- workflows_permissions: []
- contacts_permissions: []
- live_call_routing_permissions: []
- heartbeats_permissions: []
- alert_urgency_permissions: []
- schedule_override_permissions: []
- webhooks_permissions: []
- alert_sources_permissions: []
- on_call_readiness_report_permissions: []
- alert_routing_rules_permissions: []
- severity:
- data:
- id: 37a51805-7c23-4dab-af67-405fe2c43393
- type: severities
- attributes:
- name: j0po1
- slug: j0po1
- description: Aut alias totam consequuntur.
- severity: medium
- color: '#E58A1F'
- position: 1
- notify_emails: []
- slack_channels: []
- slack_aliases: []
- created_at: 2025-05-22T06:47:00.817-07:00
- updated_at: 2025-05-22T06:47:00.817-07:00
- in_triage_by: null
- started_by:
- data:
- id: "291"
- type: users
- attributes:
- name: Ike Klein
- email: barbara@langosh-torphy.example
- phone: null
- phone_2: null
- first_name: Ike
- last_name: Klein
- full_name: Ike Klein
- full_name_with_team: "[Schmeler-Denesik] Ike Klein"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:47:00.856-07:00
- created_at: 2025-05-22T06:47:00.386-07:00
- relationships:
- email_addresses:
- data:
- - id: 75e899ca-99db-464b-b9d1-a3ed30b34a07
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: 070850d3-910f-42f7-ac8e-881e3d1cf114
- created_at: 2025-05-22T06:46:59.584-07:00
- updated_at: 2025-05-22T06:46:59.584-07:00
- display_order: 2
- api_keys_permissions:
- - create
- - update
- - read
- - delete
- billing_permissions: []
- environments_permissions:
- - create
- - read
- - update
- - delete
- functionalities_permissions:
- - create
- - read
- - update
- - delete
- groups_permissions:
- - create
- - read
- - update
- - delete
- incident_causes_permissions:
- - create
- - read
- - update
- - delete
- incident_roles_permissions:
- - create
- - read
- - update
- - delete
- incident_types_permissions:
- - create
- - read
- - update
- - delete
- incidents_permissions:
- - create
- - read
- - update
- - delete
- private_incidents_permissions: []
- invitations_permissions:
- - create
- - read
- - update
- - delete
- playbooks_permissions:
- - create
- - read
- - update
- - delete
- retrospective_permissions:
- - create
- - read
- - update
- - delete
- roles_permissions: []
- services_permissions:
- - create
- - read
- - update
- - delete
- severities_permissions:
- - create
- - read
- - update
- - delete
- status_pages_permissions:
- - create
- - read
- - update
- - delete
- workflows_permissions:
- - create
- - read
- - update
- - delete
- team_id: 235
- name: user
- slug: user
- is_editable: true
- is_deletable: false
- incident_feedbacks_permissions:
- - read
- - create
- - update
- form_fields_permissions:
- - create
- - read
- - update
- - delete
- webhooks_permissions: []
- audits_permissions: []
- secrets_permissions:
- - create
- - read
- - update
- - delete
- deleted_at: null
- incident_permission_set_id: ce8e0129-ae20-4109-9ce5-9ce632b86933
- pulses_permissions:
- - create
- - update
- - read
- alerts_permissions:
- - create
- - read
- paging_permissions:
- - create
- - read
- - update
- - delete
- sub_statuses_permissions:
- - read
- catalogs_permissions:
- - create
- - read
- - update
- - delete
- communication_permissions:
- - read
- incident_communication_permissions:
- - read
- integrations_permissions: []
- on_call_role:
- data:
- id: 9817be29-441f-481c-88af-391816fec02b
- team_id: 235
- name: None
- slug: none
- system_role: no_access
- deleted_at: null
- created_at: 2025-05-22T06:46:59.607-07:00
- updated_at: 2025-05-22T06:46:59.607-07:00
- alerts_permissions: []
- api_keys_permissions: []
- audits_permissions: []
- escalation_policies_permissions: []
- groups_permissions: []
- integrations_permissions: []
- invitations_permissions: []
- on_call_roles_permissions: []
- schedules_permissions: []
- services_permissions: []
- shift_overrides_permissions: []
- workflows_permissions: []
- contacts_permissions: []
- live_call_routing_permissions: []
- heartbeats_permissions: []
- alert_urgency_permissions: []
- schedule_override_permissions: []
- webhooks_permissions: []
- alert_sources_permissions: []
- on_call_readiness_report_permissions: []
- alert_routing_rules_permissions: []
- mitigated_by: null
- resolved_by: null
- closed_by: null
- cancelled_by: null
- mitigation_message: null
- resolution_message: null
- cancellation_message: null
- public_title: null
- duplicate_incident_id: null
- retrospective_progress_status: not_started
- zoom_meeting_id: null
- zoom_meeting_start_url: null
- zoom_meeting_join_url: null
- zoom_meeting_password: null
- zoom_meeting_pstn_password: null
- zoom_meeting_h323_password: null
- zoom_meeting_global_dial_in_numbers: []
- shortcut_story_id: null
- shortcut_story_url: null
- shortcut_task_id: null
- shortcut_task_url: null
- asana_task_id: null
- asana_task_url: null
- github_issue_id: null
- github_issue_url: null
- gitlab_issue_id: null
- gitlab_issue_url: null
- jira_issue_key: null
- jira_issue_id: null
- jira_issue_url: null
- google_meeting_id: null
- google_meeting_url: null
- trello_card_id: null
- trello_card_url: null
- linear_issue_id: null
- linear_issue_url: null
- zendesk_ticket_id: null
- zendesk_ticket_url: null
- motion_task_id: null
- motion_task_url: null
- clickup_task_id: null
- clickup_task_url: null
- slack_channel_name: null
- slack_channel_id: null
- slack_channel_url: null
- slack_channel_short_url: null
- slack_channel_deep_link: null
- slack_channel_archived: false
- slack_last_message_ts: null
- service_now_incident_id: null
- service_now_incident_key: null
- service_now_incident_url: null
- opsgenie_incident_id: null
- opsgenie_incident_url: null
- opsgenie_alert_id: null
- opsgenie_alert_url: null
- victor_ops_incident_id: null
- victor_ops_incident_url: null
- pagerduty_incident_id: null
- pagerduty_incident_number: null
- pagerduty_incident_url: null
- mattermost_channel_id: null
- mattermost_channel_name: null
- mattermost_channel_url: null
- confluence_page_id: null
- confluence_page_url: null
- quip_page_id: null
- quip_page_url: null
- airtable_base_key: null
- airtable_table_name: null
- airtable_record_id: null
- airtable_record_url: null
- google_drive_id: null
- google_drive_parent_id: null
- google_drive_url: null
- sharepoint_page_id: null
- sharepoint_page_url: null
- datadog_notebook_id: null
- datadog_notebook_url: null
- freshservice_ticket_id: null
- freshservice_ticket_url: null
- freshservice_task_id: null
- freshservice_task_url: null
- scheduled_for: null
- scheduled_until: null
- in_triage_at: null
- started_at: 2025-05-22T06:47:00.825-07:00
- detected_at: null
- acknowledged_at: null
- mitigated_at: null
- resolved_at: null
- closed_at: null
- cancelled_at: null
- created_at: 2025-05-22T06:47:00.825-07:00
- updated_at: 2025-05-22T06:47:00.911-07:00
- labels: {}
- relationships:
- causes:
- data: []
- subscribers:
- data:
- - id: f383029d-613c-4acb-b228-9843bdb2982e
- type: incident_subscribers
- roles:
- data: []
- environments:
- data: []
- incident_types:
- data: []
- services:
- data: []
- functionalities:
- data: []
- groups:
- data: []
- events:
- data:
- - id: d843dae2-84f1-4d33-8b1b-adf5c0451dea
- type: incident_events
- - id: b6699095-08a1-4df9-b271-e3b9c5dfc395
- type: incident_events
- action_items:
- data: []
- custom_field_selections:
- data: []
- feedbacks:
- data: []
- attachments:
- data: []
- slack_messages:
- data: []
schema:
- $ref: '#/components/schemas/incident_response'
- description: add subscribers to incident
- "404":
+ $ref: '#/components/schemas/incident_role_response'
+ description: incident_role created
+ "422":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
- description: resource not found
+ description: invalid request
+ "401":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: responds with unauthorized for invalid token
security:
- bearer_auth: []
- summary: Add subscribers to incident
+ summary: Creates an incident role
tags:
- - Incidents
+ - IncidentRoles
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/incidents/{id}/remove_subscribers:
+ /v1/incident_roles/{id}:
delete:
- description: Remove subscribers to incident
- operationId: removeSubscribersToIncident
+ description: Delete a specific incident_role by id
+ operationId: deleteIncidentRole
parameters:
- explode: false
in: path
name: id
required: true
schema:
- type: string
+ $ref: '#/components/schemas/getAlertField_id_parameter'
style: simple
- requestBody:
- content:
- application/vnd.api+json:
- schema:
- $ref: '#/components/schemas/remove_subscribers'
- required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 3df2515f-3cc3-4285-98c4-2168f7a76c56
- type: incidents
- attributes:
- parent_incident_id: null
- sequential_id: 1
- title: Odit ut ut aliquid.
- slug: odit-ut-ut-aliquid
- kind: normal
- private: false
- summary: Assumenda provident aut. Assumenda occaecati explicabo.
- Non inventore voluptatum.
- status: started
- source: web
- url: http://localhost:3001/account/incidents/1-odit-ut-ut-aliquid
- short_url: null
- user:
- data:
- id: "291"
- type: users
- attributes:
- name: Ike Klein
- email: barbara@langosh-torphy.example
- phone: null
- phone_2: null
- first_name: Ike
- last_name: Klein
- full_name: Ike Klein
- full_name_with_team: "[Schmeler-Denesik] Ike Klein"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:47:00.856-07:00
- created_at: 2025-05-22T06:47:00.386-07:00
- relationships:
- email_addresses:
- data:
- - id: 75e899ca-99db-464b-b9d1-a3ed30b34a07
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: 070850d3-910f-42f7-ac8e-881e3d1cf114
- created_at: 2025-05-22T06:46:59.584-07:00
- updated_at: 2025-05-22T06:46:59.584-07:00
- display_order: 2
- api_keys_permissions:
- - create
- - update
- - read
- - delete
- billing_permissions: []
- environments_permissions:
- - create
- - read
- - update
- - delete
- functionalities_permissions:
- - create
- - read
- - update
- - delete
- groups_permissions:
- - create
- - read
- - update
- - delete
- incident_causes_permissions:
- - create
- - read
- - update
- - delete
- incident_roles_permissions:
- - create
- - read
- - update
- - delete
- incident_types_permissions:
- - create
- - read
- - update
- - delete
- incidents_permissions:
- - create
- - read
- - update
- - delete
- private_incidents_permissions: []
- invitations_permissions:
- - create
- - read
- - update
- - delete
- playbooks_permissions:
- - create
- - read
- - update
- - delete
- retrospective_permissions:
- - create
- - read
- - update
- - delete
- roles_permissions: []
- services_permissions:
- - create
- - read
- - update
- - delete
- severities_permissions:
- - create
- - read
- - update
- - delete
- status_pages_permissions:
- - create
- - read
- - update
- - delete
- workflows_permissions:
- - create
- - read
- - update
- - delete
- team_id: 235
- name: user
- slug: user
- is_editable: true
- is_deletable: false
- incident_feedbacks_permissions:
- - read
- - create
- - update
- form_fields_permissions:
- - create
- - read
- - update
- - delete
- webhooks_permissions: []
- audits_permissions: []
- secrets_permissions:
- - create
- - read
- - update
- - delete
- deleted_at: null
- incident_permission_set_id: ce8e0129-ae20-4109-9ce5-9ce632b86933
- pulses_permissions:
- - create
- - update
- - read
- alerts_permissions:
- - create
- - read
- paging_permissions:
- - create
- - read
- - update
- - delete
- sub_statuses_permissions:
- - read
- catalogs_permissions:
- - create
- - read
- - update
- - delete
- communication_permissions:
- - read
- incident_communication_permissions:
- - read
- integrations_permissions: []
- on_call_role:
- data:
- id: 9817be29-441f-481c-88af-391816fec02b
- team_id: 235
- name: None
- slug: none
- system_role: no_access
- deleted_at: null
- created_at: 2025-05-22T06:46:59.607-07:00
- updated_at: 2025-05-22T06:46:59.607-07:00
- alerts_permissions: []
- api_keys_permissions: []
- audits_permissions: []
- escalation_policies_permissions: []
- groups_permissions: []
- integrations_permissions: []
- invitations_permissions: []
- on_call_roles_permissions: []
- schedules_permissions: []
- services_permissions: []
- shift_overrides_permissions: []
- workflows_permissions: []
- contacts_permissions: []
- live_call_routing_permissions: []
- heartbeats_permissions: []
- alert_urgency_permissions: []
- schedule_override_permissions: []
- webhooks_permissions: []
- alert_sources_permissions: []
- on_call_readiness_report_permissions: []
- alert_routing_rules_permissions: []
- severity:
- data:
- id: 37a51805-7c23-4dab-af67-405fe2c43393
- type: severities
- attributes:
- name: j0po1
- slug: j0po1
- description: Aut alias totam consequuntur.
- severity: medium
- color: '#E58A1F'
- position: 1
- notify_emails: []
- slack_channels: []
- slack_aliases: []
- created_at: 2025-05-22T06:47:00.817-07:00
- updated_at: 2025-05-22T06:47:00.817-07:00
- in_triage_by: null
- started_by:
- data:
- id: "291"
- type: users
- attributes:
- name: Ike Klein
- email: barbara@langosh-torphy.example
- phone: null
- phone_2: null
- first_name: Ike
- last_name: Klein
- full_name: Ike Klein
- full_name_with_team: "[Schmeler-Denesik] Ike Klein"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:47:00.856-07:00
- created_at: 2025-05-22T06:47:00.386-07:00
- relationships:
- email_addresses:
- data:
- - id: 75e899ca-99db-464b-b9d1-a3ed30b34a07
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: 070850d3-910f-42f7-ac8e-881e3d1cf114
- created_at: 2025-05-22T06:46:59.584-07:00
- updated_at: 2025-05-22T06:46:59.584-07:00
- display_order: 2
- api_keys_permissions:
- - create
- - update
- - read
- - delete
- billing_permissions: []
- environments_permissions:
- - create
- - read
- - update
- - delete
- functionalities_permissions:
- - create
- - read
- - update
- - delete
- groups_permissions:
- - create
- - read
- - update
- - delete
- incident_causes_permissions:
- - create
- - read
- - update
- - delete
- incident_roles_permissions:
- - create
- - read
- - update
- - delete
- incident_types_permissions:
- - create
- - read
- - update
- - delete
- incidents_permissions:
- - create
- - read
- - update
- - delete
- private_incidents_permissions: []
- invitations_permissions:
- - create
- - read
- - update
- - delete
- playbooks_permissions:
- - create
- - read
- - update
- - delete
- retrospective_permissions:
- - create
- - read
- - update
- - delete
- roles_permissions: []
- services_permissions:
- - create
- - read
- - update
- - delete
- severities_permissions:
- - create
- - read
- - update
- - delete
- status_pages_permissions:
- - create
- - read
- - update
- - delete
- workflows_permissions:
- - create
- - read
- - update
- - delete
- team_id: 235
- name: user
- slug: user
- is_editable: true
- is_deletable: false
- incident_feedbacks_permissions:
- - read
- - create
- - update
- form_fields_permissions:
- - create
- - read
- - update
- - delete
- webhooks_permissions: []
- audits_permissions: []
- secrets_permissions:
- - create
- - read
- - update
- - delete
- deleted_at: null
- incident_permission_set_id: ce8e0129-ae20-4109-9ce5-9ce632b86933
- pulses_permissions:
- - create
- - update
- - read
- alerts_permissions:
- - create
- - read
- paging_permissions:
- - create
- - read
- - update
- - delete
- sub_statuses_permissions:
- - read
- catalogs_permissions:
- - create
- - read
- - update
- - delete
- communication_permissions:
- - read
- incident_communication_permissions:
- - read
- integrations_permissions: []
- on_call_role:
- data:
- id: 9817be29-441f-481c-88af-391816fec02b
- team_id: 235
- name: None
- slug: none
- system_role: no_access
- deleted_at: null
- created_at: 2025-05-22T06:46:59.607-07:00
- updated_at: 2025-05-22T06:46:59.607-07:00
- alerts_permissions: []
- api_keys_permissions: []
- audits_permissions: []
- escalation_policies_permissions: []
- groups_permissions: []
- integrations_permissions: []
- invitations_permissions: []
- on_call_roles_permissions: []
- schedules_permissions: []
- services_permissions: []
- shift_overrides_permissions: []
- workflows_permissions: []
- contacts_permissions: []
- live_call_routing_permissions: []
- heartbeats_permissions: []
- alert_urgency_permissions: []
- schedule_override_permissions: []
- webhooks_permissions: []
- alert_sources_permissions: []
- on_call_readiness_report_permissions: []
- alert_routing_rules_permissions: []
- mitigated_by: null
- resolved_by: null
- closed_by: null
- cancelled_by: null
- mitigation_message: null
- resolution_message: null
- cancellation_message: null
- public_title: null
- duplicate_incident_id: null
- retrospective_progress_status: not_started
- zoom_meeting_id: null
- zoom_meeting_start_url: null
- zoom_meeting_join_url: null
- zoom_meeting_password: null
- zoom_meeting_pstn_password: null
- zoom_meeting_h323_password: null
- zoom_meeting_global_dial_in_numbers: []
- shortcut_story_id: null
- shortcut_story_url: null
- shortcut_task_id: null
- shortcut_task_url: null
- asana_task_id: null
- asana_task_url: null
- github_issue_id: null
- github_issue_url: null
- gitlab_issue_id: null
- gitlab_issue_url: null
- jira_issue_key: null
- jira_issue_id: null
- jira_issue_url: null
- google_meeting_id: null
- google_meeting_url: null
- trello_card_id: null
- trello_card_url: null
- linear_issue_id: null
- linear_issue_url: null
- zendesk_ticket_id: null
- zendesk_ticket_url: null
- motion_task_id: null
- motion_task_url: null
- clickup_task_id: null
- clickup_task_url: null
- slack_channel_name: null
- slack_channel_id: null
- slack_channel_url: null
- slack_channel_short_url: null
- slack_channel_deep_link: null
- slack_channel_archived: false
- slack_last_message_ts: null
- service_now_incident_id: null
- service_now_incident_key: null
- service_now_incident_url: null
- opsgenie_incident_id: null
- opsgenie_incident_url: null
- opsgenie_alert_id: null
- opsgenie_alert_url: null
- victor_ops_incident_id: null
- victor_ops_incident_url: null
- pagerduty_incident_id: null
- pagerduty_incident_number: null
- pagerduty_incident_url: null
- mattermost_channel_id: null
- mattermost_channel_name: null
- mattermost_channel_url: null
- confluence_page_id: null
- confluence_page_url: null
- quip_page_id: null
- quip_page_url: null
- airtable_base_key: null
- airtable_table_name: null
- airtable_record_id: null
- airtable_record_url: null
- google_drive_id: null
- google_drive_parent_id: null
- google_drive_url: null
- sharepoint_page_id: null
- sharepoint_page_url: null
- datadog_notebook_id: null
- datadog_notebook_url: null
- freshservice_ticket_id: null
- freshservice_ticket_url: null
- freshservice_task_id: null
- freshservice_task_url: null
- scheduled_for: null
- scheduled_until: null
- in_triage_at: null
- started_at: 2025-05-22T06:47:00.825-07:00
- detected_at: null
- acknowledged_at: null
- mitigated_at: null
- resolved_at: null
- closed_at: null
- cancelled_at: null
- created_at: 2025-05-22T06:47:00.825-07:00
- updated_at: 2025-05-22T06:47:00.911-07:00
- labels: {}
- relationships:
- causes:
- data: []
- subscribers:
- data: []
- roles:
- data: []
- environments:
- data: []
- incident_types:
- data: []
- services:
- data: []
- functionalities:
- data: []
- groups:
- data: []
- events:
- data:
- - id: d843dae2-84f1-4d33-8b1b-adf5c0451dea
- type: incident_events
- - id: b6699095-08a1-4df9-b271-e3b9c5dfc395
- type: incident_events
- action_items:
- data: []
- custom_field_selections:
- data: []
- feedbacks:
- data: []
- attachments:
- data: []
- slack_messages:
- data: []
schema:
- $ref: '#/components/schemas/incident_response'
- description: remove subscribers from incident
+ $ref: '#/components/schemas/incident_role_response'
+ description: incident_role deleted
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Remove subscribers from incident
+ summary: Delete an incident role
tags:
- - Incidents
- x-content-type: application/vnd.api+json
+ - IncidentRoles
x-accepts:
- application/vnd.api+json
- /v1/incidents/{id}/assign_role_to_user:
- post:
- description: Assign user to incident
- operationId: assignUserToIncident
+ get:
+ description: Retrieves a specific incident_role by id
+ operationId: getIncidentRole
parameters:
- explode: false
in: path
name: id
required: true
schema:
- type: string
+ $ref: '#/components/schemas/getAlertField_id_parameter'
style: simple
- requestBody:
- content:
- application/vnd.api+json:
- schema:
- $ref: '#/components/schemas/assign_role_to_user'
- required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 3df2515f-3cc3-4285-98c4-2168f7a76c56
- type: incidents
- attributes:
- parent_incident_id: null
- sequential_id: 1
- title: Odit ut ut aliquid.
- slug: odit-ut-ut-aliquid
- kind: normal
- private: false
- summary: Assumenda provident aut. Assumenda occaecati explicabo.
- Non inventore voluptatum.
- status: started
- source: web
- url: http://localhost:3001/account/incidents/1-odit-ut-ut-aliquid
- short_url: null
- user:
- data:
- id: "291"
- type: users
- attributes:
- name: Ike Klein
- email: barbara@langosh-torphy.example
- phone: null
- phone_2: null
- first_name: Ike
- last_name: Klein
- full_name: Ike Klein
- full_name_with_team: "[Schmeler-Denesik] Ike Klein"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:47:00.856-07:00
- created_at: 2025-05-22T06:47:00.386-07:00
- relationships:
- email_addresses:
- data:
- - id: 75e899ca-99db-464b-b9d1-a3ed30b34a07
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: 070850d3-910f-42f7-ac8e-881e3d1cf114
- created_at: 2025-05-22T06:46:59.584-07:00
- updated_at: 2025-05-22T06:46:59.584-07:00
- display_order: 2
- api_keys_permissions:
- - create
- - update
- - read
- - delete
- billing_permissions: []
- environments_permissions:
- - create
- - read
- - update
- - delete
- functionalities_permissions:
- - create
- - read
- - update
- - delete
- groups_permissions:
- - create
- - read
- - update
- - delete
- incident_causes_permissions:
- - create
- - read
- - update
- - delete
- incident_roles_permissions:
- - create
- - read
- - update
- - delete
- incident_types_permissions:
- - create
- - read
- - update
- - delete
- incidents_permissions:
- - create
- - read
- - update
- - delete
- private_incidents_permissions: []
- invitations_permissions:
- - create
- - read
- - update
- - delete
- playbooks_permissions:
- - create
- - read
- - update
- - delete
- retrospective_permissions:
- - create
- - read
- - update
- - delete
- roles_permissions: []
- services_permissions:
- - create
- - read
- - update
- - delete
- severities_permissions:
- - create
- - read
- - update
- - delete
- status_pages_permissions:
- - create
- - read
- - update
- - delete
- workflows_permissions:
- - create
- - read
- - update
- - delete
- team_id: 235
- name: user
- slug: user
- is_editable: true
- is_deletable: false
- incident_feedbacks_permissions:
- - read
- - create
- - update
- form_fields_permissions:
- - create
- - read
- - update
- - delete
- webhooks_permissions: []
- audits_permissions: []
- secrets_permissions:
- - create
- - read
- - update
- - delete
- deleted_at: null
- incident_permission_set_id: ce8e0129-ae20-4109-9ce5-9ce632b86933
- pulses_permissions:
- - create
- - update
- - read
- alerts_permissions:
- - create
- - read
- paging_permissions:
- - create
- - read
- - update
- - delete
- sub_statuses_permissions:
- - read
- catalogs_permissions:
- - create
- - read
- - update
- - delete
- communication_permissions:
- - read
- incident_communication_permissions:
- - read
- integrations_permissions: []
- on_call_role:
- data:
- id: 9817be29-441f-481c-88af-391816fec02b
- team_id: 235
- name: None
- slug: none
- system_role: no_access
- deleted_at: null
- created_at: 2025-05-22T06:46:59.607-07:00
- updated_at: 2025-05-22T06:46:59.607-07:00
- alerts_permissions: []
- api_keys_permissions: []
- audits_permissions: []
- escalation_policies_permissions: []
- groups_permissions: []
- integrations_permissions: []
- invitations_permissions: []
- on_call_roles_permissions: []
- schedules_permissions: []
- services_permissions: []
- shift_overrides_permissions: []
- workflows_permissions: []
- contacts_permissions: []
- live_call_routing_permissions: []
- heartbeats_permissions: []
- alert_urgency_permissions: []
- schedule_override_permissions: []
- webhooks_permissions: []
- alert_sources_permissions: []
- on_call_readiness_report_permissions: []
- alert_routing_rules_permissions: []
- severity:
- data:
- id: 37a51805-7c23-4dab-af67-405fe2c43393
- type: severities
- attributes:
- name: j0po1
- slug: j0po1
- description: Aut alias totam consequuntur.
- severity: medium
- color: '#E58A1F'
- position: 1
- notify_emails: []
- slack_channels: []
- slack_aliases: []
- created_at: 2025-05-22T06:47:00.817-07:00
- updated_at: 2025-05-22T06:47:00.817-07:00
- in_triage_by: null
- started_by:
- data:
- id: "291"
- type: users
- attributes:
- name: Ike Klein
- email: barbara@langosh-torphy.example
- phone: null
- phone_2: null
- first_name: Ike
- last_name: Klein
- full_name: Ike Klein
- full_name_with_team: "[Schmeler-Denesik] Ike Klein"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:47:00.856-07:00
- created_at: 2025-05-22T06:47:00.386-07:00
- relationships:
- email_addresses:
- data:
- - id: 75e899ca-99db-464b-b9d1-a3ed30b34a07
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: 070850d3-910f-42f7-ac8e-881e3d1cf114
- created_at: 2025-05-22T06:46:59.584-07:00
- updated_at: 2025-05-22T06:46:59.584-07:00
- display_order: 2
- api_keys_permissions:
- - create
- - update
- - read
- - delete
- billing_permissions: []
- environments_permissions:
- - create
- - read
- - update
- - delete
- functionalities_permissions:
- - create
- - read
- - update
- - delete
- groups_permissions:
- - create
- - read
- - update
- - delete
- incident_causes_permissions:
- - create
- - read
- - update
- - delete
- incident_roles_permissions:
- - create
- - read
- - update
- - delete
- incident_types_permissions:
- - create
- - read
- - update
- - delete
- incidents_permissions:
- - create
- - read
- - update
- - delete
- private_incidents_permissions: []
- invitations_permissions:
- - create
- - read
- - update
- - delete
- playbooks_permissions:
- - create
- - read
- - update
- - delete
- retrospective_permissions:
- - create
- - read
- - update
- - delete
- roles_permissions: []
- services_permissions:
- - create
- - read
- - update
- - delete
- severities_permissions:
- - create
- - read
- - update
- - delete
- status_pages_permissions:
- - create
- - read
- - update
- - delete
- workflows_permissions:
- - create
- - read
- - update
- - delete
- team_id: 235
- name: user
- slug: user
- is_editable: true
- is_deletable: false
- incident_feedbacks_permissions:
- - read
- - create
- - update
- form_fields_permissions:
- - create
- - read
- - update
- - delete
- webhooks_permissions: []
- audits_permissions: []
- secrets_permissions:
- - create
- - read
- - update
- - delete
- deleted_at: null
- incident_permission_set_id: ce8e0129-ae20-4109-9ce5-9ce632b86933
- pulses_permissions:
- - create
- - update
- - read
- alerts_permissions:
- - create
- - read
- paging_permissions:
- - create
- - read
- - update
- - delete
- sub_statuses_permissions:
- - read
- catalogs_permissions:
- - create
- - read
- - update
- - delete
- communication_permissions:
- - read
- incident_communication_permissions:
- - read
- integrations_permissions: []
- on_call_role:
- data:
- id: 9817be29-441f-481c-88af-391816fec02b
- team_id: 235
- name: None
- slug: none
- system_role: no_access
- deleted_at: null
- created_at: 2025-05-22T06:46:59.607-07:00
- updated_at: 2025-05-22T06:46:59.607-07:00
- alerts_permissions: []
- api_keys_permissions: []
- audits_permissions: []
- escalation_policies_permissions: []
- groups_permissions: []
- integrations_permissions: []
- invitations_permissions: []
- on_call_roles_permissions: []
- schedules_permissions: []
- services_permissions: []
- shift_overrides_permissions: []
- workflows_permissions: []
- contacts_permissions: []
- live_call_routing_permissions: []
- heartbeats_permissions: []
- alert_urgency_permissions: []
- schedule_override_permissions: []
- webhooks_permissions: []
- alert_sources_permissions: []
- on_call_readiness_report_permissions: []
- alert_routing_rules_permissions: []
- mitigated_by: null
- resolved_by: null
- closed_by: null
- cancelled_by: null
- mitigation_message: null
- resolution_message: null
- cancellation_message: null
- public_title: null
- duplicate_incident_id: null
- retrospective_progress_status: not_started
- zoom_meeting_id: null
- zoom_meeting_start_url: null
- zoom_meeting_join_url: null
- zoom_meeting_password: null
- zoom_meeting_pstn_password: null
- zoom_meeting_h323_password: null
- zoom_meeting_global_dial_in_numbers: []
- shortcut_story_id: null
- shortcut_story_url: null
- shortcut_task_id: null
- shortcut_task_url: null
- asana_task_id: null
- asana_task_url: null
- github_issue_id: null
- github_issue_url: null
- gitlab_issue_id: null
- gitlab_issue_url: null
- jira_issue_key: null
- jira_issue_id: null
- jira_issue_url: null
- google_meeting_id: null
- google_meeting_url: null
- trello_card_id: null
- trello_card_url: null
- linear_issue_id: null
- linear_issue_url: null
- zendesk_ticket_id: null
- zendesk_ticket_url: null
- motion_task_id: null
- motion_task_url: null
- clickup_task_id: null
- clickup_task_url: null
- slack_channel_name: null
- slack_channel_id: null
- slack_channel_url: null
- slack_channel_short_url: null
- slack_channel_deep_link: null
- slack_channel_archived: false
- slack_last_message_ts: null
- service_now_incident_id: null
- service_now_incident_key: null
- service_now_incident_url: null
- opsgenie_incident_id: null
- opsgenie_incident_url: null
- opsgenie_alert_id: null
- opsgenie_alert_url: null
- victor_ops_incident_id: null
- victor_ops_incident_url: null
- pagerduty_incident_id: null
- pagerduty_incident_number: null
- pagerduty_incident_url: null
- mattermost_channel_id: null
- mattermost_channel_name: null
- mattermost_channel_url: null
- confluence_page_id: null
- confluence_page_url: null
- quip_page_id: null
- quip_page_url: null
- airtable_base_key: null
- airtable_table_name: null
- airtable_record_id: null
- airtable_record_url: null
- google_drive_id: null
- google_drive_parent_id: null
- google_drive_url: null
- sharepoint_page_id: null
- sharepoint_page_url: null
- datadog_notebook_id: null
- datadog_notebook_url: null
- freshservice_ticket_id: null
- freshservice_ticket_url: null
- freshservice_task_id: null
- freshservice_task_url: null
- scheduled_for: null
- scheduled_until: null
- in_triage_at: null
- started_at: 2025-05-22T06:47:00.825-07:00
- detected_at: null
- acknowledged_at: null
- mitigated_at: null
- resolved_at: null
- closed_at: null
- cancelled_at: null
- created_at: 2025-05-22T06:47:00.825-07:00
- updated_at: 2025-05-22T06:47:32.083-07:00
- labels: {}
- relationships:
- causes:
- data: []
- subscribers:
- data:
- - id: 42d28bfe-87e8-4f41-918f-5f61a0c743b7
- type: incident_subscribers
- roles:
- data:
- - id: 5cf5689d-3d72-4b36-8a21-734d1615af0c
- type: incident_role_assignments
- environments:
- data: []
- incident_types:
- data: []
- services:
- data: []
- functionalities:
- data: []
- groups:
- data: []
- events:
- data:
- - id: 5f0fa6a3-8f8c-402e-b24d-68a422d60925
- type: incident_events
- - id: d843dae2-84f1-4d33-8b1b-adf5c0451dea
- type: incident_events
- - id: b6699095-08a1-4df9-b271-e3b9c5dfc395
- type: incident_events
- action_items:
- data: []
- custom_field_selections:
- data: []
- feedbacks:
- data: []
- attachments:
- data: []
- slack_messages:
- data: []
- included:
- - id: 5cf5689d-3d72-4b36-8a21-734d1615af0c
- type: incident_role_assignments
- attributes:
- incident_role:
- data:
- id: 815fcb33-4135-4c9e-8571-3f2a7117b866
- type: incident_roles
- attributes:
- slug: asperiores-vel-beatae-minima
- name: Asperiores vel beatae minima.
- summary: null
- description: null
- position: 1
- optional: false
- enabled: true
- allow_multi_user_assignment: false
- created_at: 2025-05-22T06:47:07.465-07:00
- updated_at: 2025-05-22T06:47:07.465-07:00
- user:
- data:
- id: "289"
- type: users
- attributes:
- name: Annita Wolff
- email: sandy@weimann.example
- phone: null
- phone_2: null
- first_name: Annita
- last_name: Wolff
- full_name: Annita Wolff
- full_name_with_team: "[Schmeler-Denesik] Annita Wolff"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:47:31.900-07:00
- created_at: 2025-05-22T06:46:59.395-07:00
- relationships:
- email_addresses:
- data:
- - id: 85183e4a-ff2f-433e-828a-fbe9d3ffeabb
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: 070850d3-910f-42f7-ac8e-881e3d1cf114
- created_at: 2025-05-22T06:46:59.584-07:00
- updated_at: 2025-05-22T06:46:59.584-07:00
- display_order: 2
- api_keys_permissions:
- - create
- - update
- - read
- - delete
- billing_permissions: []
- environments_permissions:
- - create
- - read
- - update
- - delete
- functionalities_permissions:
- - create
- - read
- - update
- - delete
- groups_permissions:
- - create
- - read
- - update
- - delete
- incident_causes_permissions:
- - create
- - read
- - update
- - delete
- incident_roles_permissions:
- - create
- - read
- - update
- - delete
- incident_types_permissions:
- - create
- - read
- - update
- - delete
- incidents_permissions:
- - create
- - read
- - update
- - delete
- private_incidents_permissions: []
- invitations_permissions:
- - create
- - read
- - update
- - delete
- playbooks_permissions:
- - create
- - read
- - update
- - delete
- retrospective_permissions:
- - create
- - read
- - update
- - delete
- roles_permissions: []
- services_permissions:
- - create
- - read
- - update
- - delete
- severities_permissions:
- - create
- - read
- - update
- - delete
- status_pages_permissions:
- - create
- - read
- - update
- - delete
- workflows_permissions:
- - create
- - read
- - update
- - delete
- team_id: 235
- name: user
- slug: user
- is_editable: true
- is_deletable: false
- incident_feedbacks_permissions:
- - read
- - create
- - update
- form_fields_permissions:
- - create
- - read
- - update
- - delete
- webhooks_permissions: []
- audits_permissions: []
- secrets_permissions:
- - create
- - read
- - update
- - delete
- deleted_at: null
- incident_permission_set_id: ce8e0129-ae20-4109-9ce5-9ce632b86933
- pulses_permissions:
- - create
- - update
- - read
- alerts_permissions:
- - create
- - read
- paging_permissions:
- - create
- - read
- - update
- - delete
- sub_statuses_permissions:
- - read
- catalogs_permissions:
- - create
- - read
- - update
- - delete
- communication_permissions:
- - read
- incident_communication_permissions:
- - read
- integrations_permissions: []
- on_call_role:
- data:
- id: 9817be29-441f-481c-88af-391816fec02b
- team_id: 235
- name: None
- slug: none
- system_role: no_access
- deleted_at: null
- created_at: 2025-05-22T06:46:59.607-07:00
- updated_at: 2025-05-22T06:46:59.607-07:00
- alerts_permissions: []
- api_keys_permissions: []
- audits_permissions: []
- escalation_policies_permissions: []
- groups_permissions: []
- integrations_permissions: []
- invitations_permissions: []
- on_call_roles_permissions: []
- schedules_permissions: []
- services_permissions: []
- shift_overrides_permissions: []
- workflows_permissions: []
- contacts_permissions: []
- live_call_routing_permissions: []
- heartbeats_permissions: []
- alert_urgency_permissions: []
- schedule_override_permissions: []
- webhooks_permissions: []
- alert_sources_permissions: []
- on_call_readiness_report_permissions: []
- alert_routing_rules_permissions: []
schema:
- $ref: '#/components/schemas/incident_response'
- description: assign user to incident
+ $ref: '#/components/schemas/incident_role_response'
+ description: incident_role found
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Assign user to incident
+ summary: Retrieves an incident role
tags:
- - Incidents
- x-content-type: application/vnd.api+json
+ - IncidentRoles
x-accepts:
- application/vnd.api+json
- /v1/incidents/{id}/unassign_role_from_user:
- delete:
- description: Remove assigned user from incident
- operationId: removeAssignedUserFromIncident
+ put:
+ description: Update a specific incident_role by id
+ operationId: updateIncidentRole
parameters:
- explode: false
in: path
name: id
required: true
schema:
- type: string
+ $ref: '#/components/schemas/getAlertField_id_parameter'
style: simple
requestBody:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/unassign_role_from_user'
+ $ref: '#/components/schemas/update_incident_role'
required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 3df2515f-3cc3-4285-98c4-2168f7a76c56
- type: incidents
- attributes:
- parent_incident_id: null
- sequential_id: 1
- title: Odit ut ut aliquid.
- slug: odit-ut-ut-aliquid
- kind: normal
- private: false
- summary: Assumenda provident aut. Assumenda occaecati explicabo.
- Non inventore voluptatum.
- status: started
- source: web
- url: http://localhost:3001/account/incidents/1-odit-ut-ut-aliquid
- short_url: null
- user:
- data:
- id: "291"
- type: users
- attributes:
- name: Ike Klein
- email: barbara@langosh-torphy.example
- phone: null
- phone_2: null
- first_name: Ike
- last_name: Klein
- full_name: Ike Klein
- full_name_with_team: "[Schmeler-Denesik] Ike Klein"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:47:00.856-07:00
- created_at: 2025-05-22T06:47:00.386-07:00
- relationships:
- email_addresses:
- data:
- - id: 75e899ca-99db-464b-b9d1-a3ed30b34a07
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: 070850d3-910f-42f7-ac8e-881e3d1cf114
- created_at: 2025-05-22T06:46:59.584-07:00
- updated_at: 2025-05-22T06:46:59.584-07:00
- display_order: 2
- api_keys_permissions:
- - create
- - update
- - read
- - delete
- billing_permissions: []
- environments_permissions:
- - create
- - read
- - update
- - delete
- functionalities_permissions:
- - create
- - read
- - update
- - delete
- groups_permissions:
- - create
- - read
- - update
- - delete
- incident_causes_permissions:
- - create
- - read
- - update
- - delete
- incident_roles_permissions:
- - create
- - read
- - update
- - delete
- incident_types_permissions:
- - create
- - read
- - update
- - delete
- incidents_permissions:
- - create
- - read
- - update
- - delete
- private_incidents_permissions: []
- invitations_permissions:
- - create
- - read
- - update
- - delete
- playbooks_permissions:
- - create
- - read
- - update
- - delete
- retrospective_permissions:
- - create
- - read
- - update
- - delete
- roles_permissions: []
- services_permissions:
- - create
- - read
- - update
- - delete
- severities_permissions:
- - create
- - read
- - update
- - delete
- status_pages_permissions:
- - create
- - read
- - update
- - delete
- workflows_permissions:
- - create
- - read
- - update
- - delete
- team_id: 235
- name: user
- slug: user
- is_editable: true
- is_deletable: false
- incident_feedbacks_permissions:
- - read
- - create
- - update
- form_fields_permissions:
- - create
- - read
- - update
- - delete
- webhooks_permissions: []
- audits_permissions: []
- secrets_permissions:
- - create
- - read
- - update
- - delete
- deleted_at: null
- incident_permission_set_id: ce8e0129-ae20-4109-9ce5-9ce632b86933
- pulses_permissions:
- - create
- - update
- - read
- alerts_permissions:
- - create
- - read
- paging_permissions:
- - create
- - read
- - update
- - delete
- sub_statuses_permissions:
- - read
- catalogs_permissions:
- - create
- - read
- - update
- - delete
- communication_permissions:
- - read
- incident_communication_permissions:
- - read
- integrations_permissions: []
- on_call_role:
- data:
- id: 9817be29-441f-481c-88af-391816fec02b
- team_id: 235
- name: None
- slug: none
- system_role: no_access
- deleted_at: null
- created_at: 2025-05-22T06:46:59.607-07:00
- updated_at: 2025-05-22T06:46:59.607-07:00
- alerts_permissions: []
- api_keys_permissions: []
- audits_permissions: []
- escalation_policies_permissions: []
- groups_permissions: []
- integrations_permissions: []
- invitations_permissions: []
- on_call_roles_permissions: []
- schedules_permissions: []
- services_permissions: []
- shift_overrides_permissions: []
- workflows_permissions: []
- contacts_permissions: []
- live_call_routing_permissions: []
- heartbeats_permissions: []
- alert_urgency_permissions: []
- schedule_override_permissions: []
- webhooks_permissions: []
- alert_sources_permissions: []
- on_call_readiness_report_permissions: []
- alert_routing_rules_permissions: []
- severity:
- data:
- id: 37a51805-7c23-4dab-af67-405fe2c43393
- type: severities
- attributes:
- name: j0po1
- slug: j0po1
- description: Aut alias totam consequuntur.
- severity: medium
- color: '#E58A1F'
- position: 1
- notify_emails: []
- slack_channels: []
- slack_aliases: []
- created_at: 2025-05-22T06:47:00.817-07:00
- updated_at: 2025-05-22T06:47:00.817-07:00
- in_triage_by: null
- started_by:
- data:
- id: "291"
- type: users
- attributes:
- name: Ike Klein
- email: barbara@langosh-torphy.example
- phone: null
- phone_2: null
- first_name: Ike
- last_name: Klein
- full_name: Ike Klein
- full_name_with_team: "[Schmeler-Denesik] Ike Klein"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:47:00.856-07:00
- created_at: 2025-05-22T06:47:00.386-07:00
- relationships:
- email_addresses:
- data:
- - id: 75e899ca-99db-464b-b9d1-a3ed30b34a07
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: 070850d3-910f-42f7-ac8e-881e3d1cf114
- created_at: 2025-05-22T06:46:59.584-07:00
- updated_at: 2025-05-22T06:46:59.584-07:00
- display_order: 2
- api_keys_permissions:
- - create
- - update
- - read
- - delete
- billing_permissions: []
- environments_permissions:
- - create
- - read
- - update
- - delete
- functionalities_permissions:
- - create
- - read
- - update
- - delete
- groups_permissions:
- - create
- - read
- - update
- - delete
- incident_causes_permissions:
- - create
- - read
- - update
- - delete
- incident_roles_permissions:
- - create
- - read
- - update
- - delete
- incident_types_permissions:
- - create
- - read
- - update
- - delete
- incidents_permissions:
- - create
- - read
- - update
- - delete
- private_incidents_permissions: []
- invitations_permissions:
- - create
- - read
- - update
- - delete
- playbooks_permissions:
- - create
- - read
- - update
- - delete
- retrospective_permissions:
- - create
- - read
- - update
- - delete
- roles_permissions: []
- services_permissions:
- - create
- - read
- - update
- - delete
- severities_permissions:
- - create
- - read
- - update
- - delete
- status_pages_permissions:
- - create
- - read
- - update
- - delete
- workflows_permissions:
- - create
- - read
- - update
- - delete
- team_id: 235
- name: user
- slug: user
- is_editable: true
- is_deletable: false
- incident_feedbacks_permissions:
- - read
- - create
- - update
- form_fields_permissions:
- - create
- - read
- - update
- - delete
- webhooks_permissions: []
- audits_permissions: []
- secrets_permissions:
- - create
- - read
- - update
- - delete
- deleted_at: null
- incident_permission_set_id: ce8e0129-ae20-4109-9ce5-9ce632b86933
- pulses_permissions:
- - create
- - update
- - read
- alerts_permissions:
- - create
- - read
- paging_permissions:
- - create
- - read
- - update
- - delete
- sub_statuses_permissions:
- - read
- catalogs_permissions:
- - create
- - read
- - update
- - delete
- communication_permissions:
- - read
- incident_communication_permissions:
- - read
- integrations_permissions: []
- on_call_role:
- data:
- id: 9817be29-441f-481c-88af-391816fec02b
- team_id: 235
- name: None
- slug: none
- system_role: no_access
- deleted_at: null
- created_at: 2025-05-22T06:46:59.607-07:00
- updated_at: 2025-05-22T06:46:59.607-07:00
- alerts_permissions: []
- api_keys_permissions: []
- audits_permissions: []
- escalation_policies_permissions: []
- groups_permissions: []
- integrations_permissions: []
- invitations_permissions: []
- on_call_roles_permissions: []
- schedules_permissions: []
- services_permissions: []
- shift_overrides_permissions: []
- workflows_permissions: []
- contacts_permissions: []
- live_call_routing_permissions: []
- heartbeats_permissions: []
- alert_urgency_permissions: []
- schedule_override_permissions: []
- webhooks_permissions: []
- alert_sources_permissions: []
- on_call_readiness_report_permissions: []
- alert_routing_rules_permissions: []
- mitigated_by: null
- resolved_by: null
- closed_by: null
- cancelled_by: null
- mitigation_message: null
- resolution_message: null
- cancellation_message: null
- public_title: null
- duplicate_incident_id: null
- retrospective_progress_status: not_started
- zoom_meeting_id: null
- zoom_meeting_start_url: null
- zoom_meeting_join_url: null
- zoom_meeting_password: null
- zoom_meeting_pstn_password: null
- zoom_meeting_h323_password: null
- zoom_meeting_global_dial_in_numbers: []
- shortcut_story_id: null
- shortcut_story_url: null
- shortcut_task_id: null
- shortcut_task_url: null
- asana_task_id: null
- asana_task_url: null
- github_issue_id: null
- github_issue_url: null
- gitlab_issue_id: null
- gitlab_issue_url: null
- jira_issue_key: null
- jira_issue_id: null
- jira_issue_url: null
- google_meeting_id: null
- google_meeting_url: null
- trello_card_id: null
- trello_card_url: null
- linear_issue_id: null
- linear_issue_url: null
- zendesk_ticket_id: null
- zendesk_ticket_url: null
- motion_task_id: null
- motion_task_url: null
- clickup_task_id: null
- clickup_task_url: null
- slack_channel_name: null
- slack_channel_id: null
- slack_channel_url: null
- slack_channel_short_url: null
- slack_channel_deep_link: null
- slack_channel_archived: false
- slack_last_message_ts: null
- service_now_incident_id: null
- service_now_incident_key: null
- service_now_incident_url: null
- opsgenie_incident_id: null
- opsgenie_incident_url: null
- opsgenie_alert_id: null
- opsgenie_alert_url: null
- victor_ops_incident_id: null
- victor_ops_incident_url: null
- pagerduty_incident_id: null
- pagerduty_incident_number: null
- pagerduty_incident_url: null
- mattermost_channel_id: null
- mattermost_channel_name: null
- mattermost_channel_url: null
- confluence_page_id: null
- confluence_page_url: null
- quip_page_id: null
- quip_page_url: null
- airtable_base_key: null
- airtable_table_name: null
- airtable_record_id: null
- airtable_record_url: null
- google_drive_id: null
- google_drive_parent_id: null
- google_drive_url: null
- sharepoint_page_id: null
- sharepoint_page_url: null
- datadog_notebook_id: null
- datadog_notebook_url: null
- freshservice_ticket_id: null
- freshservice_ticket_url: null
- freshservice_task_id: null
- freshservice_task_url: null
- scheduled_for: null
- scheduled_until: null
- in_triage_at: null
- started_at: 2025-05-22T06:47:00.825-07:00
- detected_at: null
- acknowledged_at: null
- mitigated_at: null
- resolved_at: null
- closed_at: null
- cancelled_at: null
- created_at: 2025-05-22T06:47:00.825-07:00
- updated_at: 2025-05-22T06:47:34.888-07:00
- labels: {}
- relationships:
- causes:
- data: []
- subscribers:
- data:
- - id: f90b162a-04e7-4e64-bac5-74ae306d9d97
- type: incident_subscribers
- roles:
- data: []
- environments:
- data: []
- incident_types:
- data: []
- services:
- data: []
- functionalities:
- data: []
- groups:
- data: []
- events:
- data:
- - id: f89cef6e-4c5e-4893-bb87-b2b4ca4cf540
- type: incident_events
- - id: d843dae2-84f1-4d33-8b1b-adf5c0451dea
- type: incident_events
- - id: b6699095-08a1-4df9-b271-e3b9c5dfc395
- type: incident_events
- action_items:
- data: []
- custom_field_selections:
- data: []
- feedbacks:
- data: []
- attachments:
- data: []
- slack_messages:
- data: []
schema:
- $ref: '#/components/schemas/incident_response'
- description: remove assigned user from incident
+ $ref: '#/components/schemas/incident_role_response'
+ description: incident_role updated
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Remove assigned user from incident
+ summary: Update an incident role
tags:
- - Incidents
+ - IncidentRoles
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/ip_ranges:
- get:
- description: Retrieves the IP ranges for rootly.com services
- operationId: getIpRanges
- responses:
- "200":
- content:
- application/vnd.api+json:
- example:
- data:
- id: ip_ranges
- type: ip_ranges
- attributes:
- integrations_ipv4:
- - 34.232.217.139
- - 18.213.181.255
- integrations_ipv6: []
- webhooks_ipv4:
- - 34.232.217.139
- - 18.213.181.255
- webhooks_ipv6: []
- schema:
- $ref: '#/components/schemas/ip_ranges_response'
- description: ip_ranges found
- security:
- - bearer_auth: []
- summary: Retrieves IP ranges
- tags:
- - IpRanges
- x-accepts:
- - application/vnd.api+json
- /v1/live_call_routers:
+ /v1/incidents/{incident_id}/status-page-events:
get:
- description: List Live Call Routers
- operationId: listLiveCallRouters
+ description: List incident status page events
+ operationId: listIncidentStatusPages
parameters:
+ - explode: false
+ in: path
+ name: incident_id
+ required: true
+ schema:
+ type: string
+ style: simple
- explode: true
in: query
name: include
@@ -29022,196 +14780,68 @@ paths:
schema:
type: integer
style: form
- - explode: true
- in: query
- name: "filter[search]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[name]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[slug]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[created_at][gt]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[created_at][gte]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[created_at][lt]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[created_at][lte]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: sort
- required: false
- schema:
- type: string
- style: form
responses:
"200":
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/live_call_router_list'
+ $ref: '#/components/schemas/incident_status_page_event_list'
description: success
security:
- bearer_auth: []
- summary: List Live Call Routers
+ summary: List incident status page events
tags:
- - LiveCallRouters
+ - IncidentStatusPageEvents
x-accepts:
- application/vnd.api+json
post:
- description: Creates a new Live Call Router from provided data
- operationId: createLiveCallRouter
- parameters: []
+ description: Creates a new event from provided data
+ operationId: createIncidentStatusPage
+ parameters:
+ - explode: false
+ in: path
+ name: incident_id
+ required: true
+ schema:
+ type: string
+ style: simple
requestBody:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/new_live_call_router'
+ $ref: '#/components/schemas/new_incident_status_page_event'
required: true
responses:
"201":
content:
application/vnd.api+json:
- example:
- data:
- id: da4c913f-47e5-4202-a2c5-c739b2f3c36f
- type: live_call_routers
- attributes:
- kind: voicemail
- name: live_call_router-prod
- country_code: US
- phone_type: toll_free
- phone_number: "+14155552344"
- voicemail_greeting: hello
- slug: live_call_router-prod
- enabled: true
- created_at: 2025-05-22T06:47:37.809-07:00
- updated_at: 2025-05-22T06:47:37.809-07:00
- alert_urgency_id: e639afb6-2703-45db-bab2-1d65ac683d1a
- escalation_policy_trigger:
- id: 7ad8f078-05b2-4ea7-a54e-e75f66d30489
- type: service
schema:
- $ref: '#/components/schemas/live_call_router_response'
- description: live_call_router created
+ $ref: '#/components/schemas/incident_status_page_event_response'
+ description: incident_status_page_event created
"422":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Name can't be blank
- status: "422"
schema:
$ref: '#/components/schemas/errors_list'
description: invalid request
"401":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
description: responds with unauthorized for invalid token
security:
- bearer_auth: []
- summary: Creates a Live Call Router
+ summary: Creates an incident status page event
tags:
- - LiveCallRouters
+ - IncidentStatusPageEvents
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/live_call_routers/generate_phone_number:
- get:
- description: Generates a phone number for Live Call Router
- operationId: generatePhoneNumberLiveCallRouter
- parameters:
- - explode: true
- in: query
- name: country_code
- required: true
- schema:
- enum:
- - US
- - GB
- - NZ
- - CA
- - AU
- type: string
- style: form
- - explode: true
- in: query
- name: phone_type
- required: true
- schema:
- enum:
- - local
- - toll_free
- type: string
- style: form
- responses:
- "200":
- content:
- application/vnd.api+json:
- example:
- phone_number: "+18001000052"
- description: live_call_router phone number
- "422":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Invalid params
- status: "422"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: live_call_router without required params
- security:
- - bearer_auth: []
- summary: Generates a phone number for Live Call Router
- tags:
- - LiveCallRouters
- x-accepts:
- - application/vnd.api+json
- /v1/live_call_routers/{id}:
+ /v1/status-page-events/{id}:
delete:
- description: Delete a specific Live Call Router by id
- operationId: deleteLiveCallRouter
+ description: Delete a specific incident status page event by id
+ operationId: deleteIncidentStatusPage
parameters:
- explode: false
in: path
@@ -29224,48 +14854,25 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 9ccb090e-ff8e-48da-9039-ec6a76491a67
- type: live_call_routers
- attributes:
- kind: voicemail
- name: Accusantium doloribus temporibus dolorem.
- country_code: US
- phone_type: local
- phone_number: "14155551234"
- voicemail_greeting: Omnis deserunt quas nesciunt.
- slug: accusantium-doloribus-temporibus-dolorem
- enabled: true
- created_at: 2025-05-22T06:47:49.657-07:00
- updated_at: 2025-05-22T06:47:49.844-07:00
- alert_urgency_id: 37c02ae3-4b9d-4bee-902a-367874bd4101
- escalation_policy_trigger:
- id: 5bbf3d58-7049-4958-af78-a1dfd48e25c7
- type: service
schema:
- $ref: '#/components/schemas/live_call_router_response'
- description: live_call_router deleted
+ $ref: '#/components/schemas/incident_status_page_event_response'
+ description: incident_status_page_event deleted
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Delete a Live Call Router
+ summary: Delete an incident status page event
tags:
- - LiveCallRouters
+ - IncidentStatusPageEvents
x-accepts:
- application/vnd.api+json
get:
- description: Retrieves a specific Live Call Router by id
- operationId: getLiveCallRouter
+ description: Retrieves a specific incident_status_page_event by id
+ operationId: getIncidentStatusPages
parameters:
- explode: false
in: path
@@ -29278,48 +14885,25 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: a2cdf9ac-3280-45ed-a10f-34f551686212
- type: live_call_routers
- attributes:
- kind: voicemail
- name: Eius quis saepe laborum.
- country_code: US
- phone_type: local
- phone_number: "14155551234"
- voicemail_greeting: Quis quia ut et.
- slug: eius-quis-saepe-laborum
- enabled: true
- created_at: 2025-05-22T06:47:42.004-07:00
- updated_at: 2025-05-22T06:47:42.004-07:00
- alert_urgency_id: 601e0845-4076-4be0-9936-af2505a6e58a
- escalation_policy_trigger:
- id: e6e45bd3-4806-4e68-8b8a-16967988a816
- type: service
schema:
- $ref: '#/components/schemas/live_call_router_response'
- description: live_call_router found
+ $ref: '#/components/schemas/incident_status_page_event_response'
+ description: incident_status_page_event found
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Retrieves a Live Call Router
+ summary: Retrieves an incident status page event
tags:
- - LiveCallRouters
+ - IncidentStatusPageEvents
x-accepts:
- application/vnd.api+json
put:
- description: Update a specific Live Call Router by id
- operationId: updateLiveCallRouter
+ description: Update a specific incident status page event by id
+ operationId: updateIncidentStatusPage
parameters:
- explode: false
in: path
@@ -29332,62 +14916,65 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/update_live_call_router'
+ $ref: '#/components/schemas/update_incident_status_page_event'
required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 97024ff0-482e-4e3c-83cf-40c0abfc2132
- type: live_call_routers
- attributes:
- kind: voicemail
- name: live_call_router_staging
- country_code: US
- phone_type: local
- phone_number: "14155551234"
- voicemail_greeting: Ea debitis molestias optio.
- slug: aliquam-mollitia-ducimus-porro
- enabled: true
- created_at: 2025-05-22T06:47:45.436-07:00
- updated_at: 2025-05-22T06:47:45.629-07:00
- alert_urgency_id: 0ccc56bc-67bb-4cc4-9bc4-5718e9d42690
- escalation_policy_trigger:
- id: 9f25e72a-8c99-4f4b-a3ca-ec2f06a1b040
- type: service
schema:
- $ref: '#/components/schemas/live_call_router_response'
- description: live_call_router updated
+ $ref: '#/components/schemas/incident_status_page_event_response'
+ description: incident_status_page_event updated
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Update a Live Call Router
+ summary: Update an incident status page event
tags:
- - LiveCallRouters
+ - IncidentStatusPageEvents
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/on_call_roles:
+ /v1/incidents/{incident_id}/sub_statuses:
get:
- description: List On-Call Roles
- operationId: listOnCallRoles
+ description: List incident_sub_statuses
+ operationId: listIncidentSubStatuses
parameters:
- - explode: true
+ - explode: false
+ in: path
+ name: incident_id
+ required: true
+ schema:
+ type: string
+ style: simple
+ - description: "comma separated if needed. eg: sub_status,assigned_by_user"
+ explode: true
in: query
name: include
required: false
schema:
+ enum:
+ - sub_status
+ - assigned_by_user
+ type: string
+ style: form
+ - description: "comma separated if needed. eg: created_at,updated_at"
+ explode: true
+ in: query
+ name: sort
+ required: false
+ schema:
+ enum:
+ - created_at
+ - -created_at
+ - updated_at
+ - -updated_at
+ - assigned_at
+ - -assigned_at
type: string
style: form
- explode: true
@@ -29406,56 +14993,35 @@ paths:
style: form
- explode: true
in: query
- name: "filter[search]"
+ name: "filter[sub_status_id]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[slug]"
+ name: "filter[assigned_at][gt]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[name]"
+ name: "filter[assigned_at][gte]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[created_at][gt]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[created_at][gte]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[created_at][lt]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[created_at][lte]"
+ name: "filter[assigned_at][lt]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: sort
+ name: "filter[assigned_at][lte]"
required: false
schema:
type: string
@@ -29465,92 +15031,57 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/on_call_role_list'
+ $ref: '#/components/schemas/incident_sub_status_list'
description: success
security:
- bearer_auth: []
- summary: List On-Call Roles
+ summary: List incident_sub_statuses
tags:
- - OnCallRoles
+ - IncidentSubStatuses
x-accepts:
- application/vnd.api+json
post:
- description: Creates a new On-Call Role from provided data
- operationId: createOnCallRole
- parameters: []
+ description: Creates a new sub-status assignment from provided data
+ operationId: createIncidentSubStatus
+ parameters:
+ - explode: false
+ in: path
+ name: incident_id
+ required: true
+ schema:
+ type: string
+ style: simple
requestBody:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/new_on_call_role'
+ $ref: '#/components/schemas/new_incident_sub_status'
required: true
responses:
"201":
content:
application/vnd.api+json:
- example:
- data:
- id: cd854a95-e740-4ebc-bd3d-7964463f2662
- type: on_call_roles
- attributes:
- team_id: 269
- name: Infrastructure
- slug: infrastructure
- system_role: custom
- alert_sources_permissions: []
- alert_urgency_permissions: []
- alerts_permissions: []
- api_keys_permissions: []
- audits_permissions: []
- contacts_permissions: []
- escalation_policies_permissions: []
- groups_permissions: []
- heartbeats_permissions: []
- integrations_permissions: []
- invitations_permissions: []
- live_call_routing_permissions: []
- schedule_override_permissions: []
- schedules_permissions: []
- services_permissions: []
- webhooks_permissions: []
- workflows_permissions: []
- updated_at: 2025-05-22T06:47:54.678-07:00
- created_at: 2025-05-22T06:47:54.678-07:00
- schema:
- $ref: '#/components/schemas/on_call_role_response'
- description: on_call_role created
- "422":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Name can't be blank
- status: "422"
schema:
- $ref: '#/components/schemas/errors_list'
- description: invalid request
+ $ref: '#/components/schemas/incident_sub_status_response'
+ description: incident_sub_status created
"401":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
description: responds with unauthorized for invalid token
security:
- bearer_auth: []
- summary: Creates an On-Call Role
+ summary: Creates a sub-status assignment
tags:
- - OnCallRoles
+ - IncidentSubStatuses
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/on_call_roles/{id}:
+ /v1/incident_sub_statuses/{id}:
delete:
- description: Delete a specific On-Call Role by id
- operationId: deleteOnCallRole
+ description: Delete a specific incident_sub_status by id
+ operationId: deleteIncidentSubStatus
parameters:
- explode: false
in: path
@@ -29563,57 +15094,25 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: f0a3dfc2-0f38-4c22-99f0-3c55ca54c276
- type: on_call_roles
- attributes:
- team_id: 269
- name: On-Call Role 15
- slug: on-call-role-15
- system_role: custom
- alert_sources_permissions: []
- alert_urgency_permissions: []
- alerts_permissions: []
- api_keys_permissions: []
- audits_permissions: []
- contacts_permissions: []
- escalation_policies_permissions: []
- groups_permissions: []
- heartbeats_permissions: []
- integrations_permissions: []
- invitations_permissions: []
- live_call_routing_permissions: []
- schedule_override_permissions: []
- schedules_permissions: []
- services_permissions: []
- webhooks_permissions: []
- workflows_permissions: []
- updated_at: 2025-05-22T06:47:57.668-07:00
- created_at: 2025-05-22T06:47:57.498-07:00
schema:
- $ref: '#/components/schemas/on_call_role_response'
- description: on_call_role deleted
+ $ref: '#/components/schemas/incident_sub_status_response'
+ description: incident_sub_status deleted
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Delete an On-Call Role
+ summary: Delete an incident_sub_status
tags:
- - OnCallRoles
+ - IncidentSubStatuses
x-accepts:
- application/vnd.api+json
get:
- description: Retrieves a specific On-Call Role by id
- operationId: getOnCallRole
+ description: Retrieves a specific incident_sub_status by id
+ operationId: getIncidentSubStatus
parameters:
- explode: false
in: path
@@ -29622,61 +15121,34 @@ paths:
schema:
type: string
style: simple
+ - description: "comma separated if needed. eg: sub_status,assigned_by_user"
+ explode: true
+ in: query
+ name: include
+ required: false
+ schema:
+ enum:
+ - sub_status
+ - assigned_by_user
+ type: string
+ style: form
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 18d37902-754c-4de3-9d9f-05c2bcd9cabd
- type: on_call_roles
- attributes:
- team_id: 269
- name: On-Call Role 11
- slug: on-call-role-11
- system_role: admin
- alert_sources_permissions: []
- alert_urgency_permissions: []
- alerts_permissions: []
- api_keys_permissions: []
- audits_permissions: []
- contacts_permissions: []
- escalation_policies_permissions: []
- groups_permissions: []
- heartbeats_permissions: []
- integrations_permissions: []
- invitations_permissions: []
- live_call_routing_permissions: []
- schedule_override_permissions: []
- schedules_permissions: []
- services_permissions: []
- webhooks_permissions: []
- workflows_permissions: []
- updated_at: 2025-05-22T06:47:55.269-07:00
- created_at: 2025-05-22T06:47:55.269-07:00
schema:
- $ref: '#/components/schemas/on_call_role_response'
- description: on_call_role found
- "404":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: resource not found
+ $ref: '#/components/schemas/incident_sub_status_response'
+ description: sub_status found
security:
- bearer_auth: []
- summary: Retrieves an On-Call Role
+ summary: Retrieves incident_sub_status
tags:
- - OnCallRoles
+ - IncidentSubStatuses
x-accepts:
- application/vnd.api+json
put:
- description: Update a specific On-Call Role by id
- operationId: updateOnCallRole
+ description: Update a specific incident_sub_status by id
+ operationId: updateIncidentSubStatus
parameters:
- explode: false
in: path
@@ -29689,73 +15161,28 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/update_on_call_role'
+ $ref: '#/components/schemas/update_incident_sub_status'
required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 927be85e-3d54-40d5-962f-4c8f04a7d538
- type: on_call_roles
- attributes:
- team_id: 269
- name: Security
- slug: on-call-role-13
- system_role: custom
- alert_sources_permissions: []
- alert_urgency_permissions: []
- alerts_permissions: []
- api_keys_permissions: []
- audits_permissions: []
- contacts_permissions: []
- escalation_policies_permissions: []
- groups_permissions: []
- heartbeats_permissions: []
- integrations_permissions: []
- invitations_permissions: []
- live_call_routing_permissions: []
- schedule_override_permissions: []
- schedules_permissions: []
- services_permissions: []
- webhooks_permissions: []
- workflows_permissions: []
- updated_at: 2025-05-22T06:47:56.515-07:00
- created_at: 2025-05-22T06:47:56.349-07:00
- schema:
- $ref: '#/components/schemas/on_call_role_response'
- description: on_call_role updated
- "404":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
- $ref: '#/components/schemas/errors_list'
- description: resource not found
+ $ref: '#/components/schemas/incident_sub_status_response'
+ description: incident_sub_status updated
security:
- bearer_auth: []
- summary: Update an On-Call Role
+ summary: Update incident_sub_status
tags:
- - OnCallRoles
+ - IncidentSubStatuses
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/schedules/{schedule_id}/on_call_shadows:
+ /v1/incident_types:
get:
- description: List shadow shifts for schedule
- operationId: listOnCallShadows
+ description: List incident types
+ operationId: listIncidentTypes
parameters:
- - explode: false
- in: path
- name: schedule_id
- required: true
- schema:
- type: string
- style: simple
- explode: true
in: query
name: include
@@ -29777,538 +15204,242 @@ paths:
schema:
type: integer
style: form
- responses:
- "200":
- content:
- application/vnd.api+json:
- schema:
- $ref: '#/components/schemas/on_call_shadows_list'
- description: success
- security:
- - bearer_auth: []
- summary: List On Call Shadows for Shift
- tags:
- - OnCallShadows
- x-accepts:
- - application/vnd.api+json
- post:
- description: Creates a new on call shadow configuration from provided data
- operationId: createOnCallShadow
- parameters:
- - explode: false
- in: path
- name: schedule_id
- required: true
+ - explode: true
+ in: query
+ name: "filter[slug]"
+ required: false
schema:
type: string
- style: simple
- requestBody:
- content:
- application/vnd.api+json:
- schema:
- $ref: '#/components/schemas/new_on_call_shadow'
- required: true
- responses:
- "201":
- content:
- application/vnd.api+json:
- example:
- data:
- id: 7b37ad63-6edb-4282-95d9-7a22e4aa094b
- type: on_call_shadows
- attributes:
- schedule_id: 422851c7-df24-4e7d-9358-cef5e45fa6af
- shadowable_type: User
- shadowable_id: "332"
- shadow_user_id: 331
- starts_at: 2025-05-24T06:48:00.126-07:00
- ends_at: 2025-05-25T06:48:00.126-07:00
- created_at: 2025-05-22T06:48:00.297-07:00
- updated_at: 2025-05-22T06:48:00.297-07:00
- schema:
- $ref: '#/components/schemas/on_call_shadow_response'
- description: shadow shift is created
- "422":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Shadow user must exist
- status: "422"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: invalid request
- "401":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: responds with unauthorized for invalid token
- security:
- - bearer_auth: []
- summary: creates an shadow configuration
- tags:
- - OnCallShadows
- x-content-type: application/vnd.api+json
- x-accepts:
- - application/vnd.api+json
- /v1/on_call_shadows/{id}:
- delete:
- description: Delete a specific on call shadow configuration by id
- operationId: deleteOnCallShadow
- parameters:
- - explode: false
- in: path
- name: id
- required: true
+ style: form
+ - explode: true
+ in: query
+ name: "filter[name]"
+ required: false
schema:
type: string
- style: simple
- responses:
- "200":
- content:
- application/vnd.api+json:
- example:
- data:
- id: 1dd17d1c-7863-4fe1-8ac6-a484555e35eb
- type: on_call_shadows
- attributes:
- schedule_id: 422851c7-df24-4e7d-9358-cef5e45fa6af
- shadowable_type: User
- shadowable_id: "332"
- shadow_user_id: 331
- starts_at: 2025-05-22T08:47:59.000-07:00
- ends_at: 2025-05-23T06:47:59.000-07:00
- created_at: 2025-05-22T06:47:59.982-07:00
- updated_at: 2025-05-22T06:47:59.982-07:00
- schema:
- $ref: '#/components/schemas/on_call_shadow_response'
- description: override shift deleted
- "404":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: resource not found
- security:
- - bearer_auth: []
- summary: Delete an on call shadow configuration
- tags:
- - OverrideShifts
- x-accepts:
- - application/vnd.api+json
- get:
- description: Retrieves a specific On Call Shadow configuration by ID
- operationId: getOnCallShadow
- parameters:
- - explode: false
- in: path
- name: id
- required: true
+ style: form
+ - explode: true
+ in: query
+ name: "filter[color]"
+ required: false
schema:
type: string
- style: simple
- responses:
- "200":
- content:
- application/vnd.api+json:
- example:
- data:
- id: 1dd17d1c-7863-4fe1-8ac6-a484555e35eb
- type: on_call_shadows
- attributes:
- schedule_id: 422851c7-df24-4e7d-9358-cef5e45fa6af
- shadowable_type: User
- shadowable_id: "332"
- shadow_user_id: 331
- starts_at: 2025-05-22T08:47:59.000-07:00
- ends_at: 2025-05-23T06:47:59.000-07:00
- created_at: 2025-05-22T06:47:59.982-07:00
- updated_at: 2025-05-22T06:47:59.982-07:00
- schema:
- $ref: '#/components/schemas/on_call_shadow_response'
- description: override shift found
- "404":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: resource not found
- security:
- - bearer_auth: []
- summary: Retrieves an On Call Shadow configuration by ID
- tags:
- - OnCallShadows
- x-accepts:
- - application/vnd.api+json
- put:
- description: Update a specific on call shadow configuration by id
- operationId: updateOnCallShadow
- parameters:
- - explode: false
- in: path
- name: id
- required: true
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][gt]"
+ required: false
schema:
type: string
- style: simple
- requestBody:
- content:
- application/vnd.api+json:
- schema:
- $ref: '#/components/schemas/update_on_call_shadow'
- required: true
- responses:
- "200":
- content:
- application/vnd.api+json:
- example:
- data:
- id: 1dd17d1c-7863-4fe1-8ac6-a484555e35eb
- type: on_call_shadows
- attributes:
- schedule_id: 422851c7-df24-4e7d-9358-cef5e45fa6af
- shadowable_type: Schedule
- shadowable_id: 422851c7-df24-4e7d-9358-cef5e45fa6af
- shadow_user_id: 331
- starts_at: 2025-05-22T08:47:59.000-07:00
- ends_at: 2025-05-23T06:47:59.000-07:00
- created_at: 2025-05-22T06:47:59.982-07:00
- updated_at: 2025-05-22T06:48:01.483-07:00
- schema:
- $ref: '#/components/schemas/on_call_shadow_response'
- description: on call shadows configuration is is updated
- "404":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: resource not found
- security:
- - bearer_auth: []
- summary: Update an On Call Shadow configuration
- tags:
- - OnCallShadows
- x-content-type: application/vnd.api+json
- x-accepts:
- - application/vnd.api+json
- /v1/schedules/{schedule_id}/override_shifts:
- get:
- description: List override shifts
- operationId: listOverrideShifts
- parameters:
- - explode: false
- in: path
- name: schedule_id
- required: true
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][gte]"
+ required: false
schema:
type: string
- style: simple
+ style: form
- explode: true
in: query
- name: include
+ name: "filter[created_at][lt]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "page[number]"
+ name: "filter[created_at][lte]"
required: false
schema:
- type: integer
+ type: string
style: form
- explode: true
in: query
- name: "page[size]"
+ name: sort
required: false
schema:
- type: integer
+ type: string
style: form
responses:
"200":
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/override_shift_list'
+ $ref: '#/components/schemas/incident_type_list'
description: success
security:
- bearer_auth: []
- summary: List override shifts
+ summary: List incident types
tags:
- - OverrideShifts
+ - IncidentTypes
x-accepts:
- application/vnd.api+json
post:
- description: Creates a new override shift from provided data
- operationId: createOverrideShift
- parameters:
- - explode: false
- in: path
- name: schedule_id
- required: true
- schema:
- type: string
- style: simple
+ description: Creates a new incident_type from provided data
+ operationId: createIncidentType
+ parameters: []
requestBody:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/new_override_shift'
+ $ref: '#/components/schemas/new_incident_type'
required: true
responses:
"201":
content:
application/vnd.api+json:
- example:
- data:
- id: 76bb6639-28c9-41eb-a444-fdaee4f6f21e
- type: shifts
- attributes:
- schedule_id: 89ec7aa2-0169-4b8a-8402-c15bc88ef852
- rotation_id: null
- starts_at: 2025-05-22T08:48:04.000-07:00
- ends_at: 2025-05-23T06:48:04.000-07:00
- is_override: true
- relationships:
- shift_override:
- data:
- id: 54050b74-a505-49af-9803-606bade83146
- type: shift_overrides
- user:
- data:
- id: "336"
- type: users
schema:
- $ref: '#/components/schemas/override_shift_response'
- description: override_shift created
+ $ref: '#/components/schemas/incident_type_response'
+ description: incident_type created
"422":
content:
application/vnd.api+json:
- example:
- errors:
- - title: User must exist
- status: "422"
schema:
$ref: '#/components/schemas/errors_list'
description: invalid request
"401":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
- description: responds with unauthorized for invalid token
+ description: resource not found
security:
- bearer_auth: []
- summary: creates an override shift
+ summary: Creates an incident type
tags:
- - OverrideShifts
+ - IncidentTypes
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/override_shifts/{id}:
+ /v1/incident_types/{id}:
delete:
- description: Delete a specific override shift by id
- operationId: deleteOverrideShift
+ description: Delete a specific incident_type by id
+ operationId: deleteIncidentType
parameters:
- explode: false
in: path
name: id
required: true
schema:
- type: string
+ $ref: '#/components/schemas/getAlertField_id_parameter'
style: simple
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 9762e62e-0c5c-4126-9a39-bd6e8d0794fd
- type: shifts
- attributes:
- schedule_id: 89ec7aa2-0169-4b8a-8402-c15bc88ef852
- rotation_id: 113c873e-57bf-4432-ae86-258328d979e7
- starts_at: 2025-05-22T00:48:04.000-07:00
- ends_at: 2025-05-22T08:48:04.000-07:00
- is_override: true
- relationships:
- shift_override:
- data: null
- user:
- data:
- id: "344"
- type: users
schema:
- $ref: '#/components/schemas/override_shift_response'
- description: override shift deleted
+ $ref: '#/components/schemas/incident_type_response'
+ description: incident_type deleted
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Delete an override shift
+ summary: Delete an incident type
tags:
- - OverrideShifts
+ - IncidentTypes
x-accepts:
- application/vnd.api+json
get:
- description: Retrieves a specific override shift by id
- operationId: getOverrideShift
+ description: Retrieves a specific incident_type by id
+ operationId: getIncidentType
parameters:
- explode: false
in: path
name: id
required: true
schema:
- type: string
+ $ref: '#/components/schemas/getAlertField_id_parameter'
style: simple
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 9762e62e-0c5c-4126-9a39-bd6e8d0794fd
- type: shifts
- attributes:
- schedule_id: 89ec7aa2-0169-4b8a-8402-c15bc88ef852
- rotation_id: 113c873e-57bf-4432-ae86-258328d979e7
- starts_at: 2025-05-22T00:48:04.000-07:00
- ends_at: 2025-05-22T08:48:04.000-07:00
- is_override: true
- relationships:
- shift_override:
- data: null
- user:
- data:
- id: "344"
- type: users
schema:
- $ref: '#/components/schemas/override_shift_response'
- description: override shift found
+ $ref: '#/components/schemas/incident_type_response'
+ description: incident_type found by slug
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Retrieves an override shift
+ summary: Retrieves an incident type
tags:
- - OverrideShifts
+ - IncidentTypes
x-accepts:
- application/vnd.api+json
put:
- description: Update a specific override shift by id
- operationId: updateOverrideShift
+ description: Update a specific incident_type by id
+ operationId: updateIncidentType
parameters:
- explode: false
in: path
name: id
required: true
schema:
- type: string
+ $ref: '#/components/schemas/getAlertField_id_parameter'
style: simple
requestBody:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/update_override_shift'
+ $ref: '#/components/schemas/update_incident_type'
required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 9762e62e-0c5c-4126-9a39-bd6e8d0794fd
- type: shifts
- attributes:
- schedule_id: 89ec7aa2-0169-4b8a-8402-c15bc88ef852
- rotation_id: 113c873e-57bf-4432-ae86-258328d979e7
- starts_at: 2025-05-22T00:48:04.000-07:00
- ends_at: 2025-05-22T08:48:04.000-07:00
- is_override: true
- relationships:
- shift_override:
- data:
- id: b57b2c2e-be14-48e9-9670-e5ac87a60020
- type: shift_overrides
- user:
- data:
- id: "345"
- type: users
schema:
- $ref: '#/components/schemas/override_shift_response'
- description: override shift updated
+ $ref: '#/components/schemas/incident_type_response'
+ description: incident_type updated
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Update an override shift
+ summary: Update an incident type
tags:
- - OverrideShifts
+ - IncidentTypes
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/playbooks/{playbook_id}/playbook_tasks:
+ /v1/incident_types/properties:
get:
- description: List playbook tasks
- operationId: listPlaybookTasks
+ description: List IncidentType Catalog Properties
+ operationId: listIncidentTypeCatalogProperties
parameters:
- - explode: false
- in: path
- name: playbook_id
- required: true
+ - description: "comma separated if needed. eg: catalog"
+ explode: true
+ in: query
+ name: include
+ required: false
schema:
+ enum:
+ - catalog
type: string
- style: simple
- - explode: true
+ style: form
+ - description: "comma separated if needed. eg: created_at,updated_at"
+ explode: true
in: query
- name: include
+ name: sort
required: false
schema:
+ enum:
+ - created_at
+ - -created_at
+ - updated_at
+ - -updated_at
+ - position
+ - -position
type: string
style: form
- explode: true
@@ -30325,250 +15456,111 @@ paths:
schema:
type: integer
style: form
+ - explode: true
+ in: query
+ name: "filter[slug]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[name]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[kind]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][gt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][gte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][lt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][lte]"
+ required: false
+ schema:
+ type: string
+ style: form
responses:
"200":
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/playbook_task_list'
+ $ref: '#/components/schemas/catalog_property_list'
description: success
security:
- bearer_auth: []
- summary: List playbook tasks
+ summary: List Catalog Properties
tags:
- - PlaybookTasks
+ - IncidentTypes
x-accepts:
- application/vnd.api+json
post:
- description: Creates a new task from provided data
- operationId: createPlaybookTask
- parameters:
- - explode: false
- in: path
- name: playbook_id
- required: true
- schema:
- type: string
- style: simple
+ description: Creates a new Catalog Property from provided data
+ operationId: createIncidentTypeCatalogProperty
+ parameters: []
requestBody:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/new_playbook_task'
+ $ref: '#/components/schemas/new_catalog_property'
required: true
responses:
"201":
content:
application/vnd.api+json:
- example:
- data:
- id: b72b9d7f-9f8b-40e8-83ac-019f530f92b8
- type: playbook_tasks
- attributes:
- playbook_id: de1a053f-2dea-42a0-a003-1699a6a53777
- task: New task
- description: New task description
- position: 1
- created_at: 2025-05-22T06:48:09.475-07:00
- updated_at: 2025-05-22T06:48:09.475-07:00
schema:
- $ref: '#/components/schemas/playbook_task_response'
- description: playbook_task created
+ $ref: '#/components/schemas/catalog_property_response'
+ description: catalog_property created ignores wrong catalog_type attribute
"422":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Task can't be blank
- status: "422"
schema:
$ref: '#/components/schemas/errors_list'
- description: invalid request
+ description: exceeds max fields per catalog
"401":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
description: responds with unauthorized for invalid token
security:
- bearer_auth: []
- summary: Creates a playbook task
+ summary: Creates a Catalog Property
tags:
- - PlaybookTasks
+ - IncidentTypes
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/playbook_tasks/{id}:
- delete:
- description: Delete a specific playbook task by id
- operationId: deletePlaybookTask
+ /v1/incidents:
+ get:
+ description: List incidents
+ operationId: listIncidents
parameters:
- - explode: false
- in: path
- name: id
- required: true
- schema:
- type: string
- style: simple
- responses:
- "200":
- content:
- application/vnd.api+json:
- example:
- data:
- id: f69a229b-2c29-44f2-925c-32e535fb3535
- type: playbook_tasks
- attributes:
- playbook_id: de1a053f-2dea-42a0-a003-1699a6a53777
- task: Nobis adipisci et facere.
- description: Alias eos aut est.
- position: 3
- created_at: 2025-05-22T06:48:09.200-07:00
- updated_at: 2025-05-22T06:48:12.077-07:00
- schema:
- $ref: '#/components/schemas/playbook_task_response'
- description: playbook_task deleted
- "404":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: resource not found
- security:
- - bearer_auth: []
- summary: Delete a playbook task
- tags:
- - PlaybookTasks
- x-accepts:
- - application/vnd.api+json
- get:
- description: Retrieves a specific playbook_task by id
- operationId: getPlaybookTask
- parameters:
- - explode: false
- in: path
- name: id
- required: true
- schema:
- type: string
- style: simple
- responses:
- "200":
- content:
- application/vnd.api+json:
- example:
- data:
- id: f69a229b-2c29-44f2-925c-32e535fb3535
- type: playbook_tasks
- attributes:
- playbook_id: de1a053f-2dea-42a0-a003-1699a6a53777
- task: Nobis adipisci et facere.
- description: Alias eos aut est.
- position: 3
- created_at: 2025-05-22T06:48:09.200-07:00
- updated_at: 2025-05-22T06:48:09.209-07:00
- schema:
- $ref: '#/components/schemas/playbook_task_response'
- description: playbook_task found
- "404":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: resource not found
- security:
- - bearer_auth: []
- summary: Retrieves a playbook task
- tags:
- - PlaybookTasks
- x-accepts:
- - application/vnd.api+json
- put:
- description: Update a specific playbook task by id
- operationId: updatePlaybookTask
- parameters:
- - explode: false
- in: path
- name: id
- required: true
- schema:
- type: string
- style: simple
- requestBody:
- content:
- application/vnd.api+json:
- schema:
- $ref: '#/components/schemas/update_playbook_task'
- required: true
- responses:
- "200":
- content:
- application/vnd.api+json:
- example:
- data:
- id: f69a229b-2c29-44f2-925c-32e535fb3535
- type: playbook_tasks
- attributes:
- playbook_id: de1a053f-2dea-42a0-a003-1699a6a53777
- task: Task updated
- description: Task description updated
- position: 2
- created_at: 2025-05-22T06:48:09.200-07:00
- updated_at: 2025-05-22T06:48:11.307-07:00
- schema:
- $ref: '#/components/schemas/playbook_task_response'
- description: playbook_task updated
- "404":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: resource not found
- security:
- - bearer_auth: []
- summary: Update a playbook task
- tags:
- - PlaybookTasks
- x-content-type: application/vnd.api+json
- x-accepts:
- - application/vnd.api+json
- /v1/playbooks:
- get:
- description: List playbooks
- operationId: listPlaybooks
- parameters:
- - description: "comma separated if needed. eg: severities,environments,services"
- explode: true
- in: query
- name: include
- required: false
- schema:
- enum:
- - severities
- - environments
- - services
- - functionalities
- - groups
- - causes
- - incident_types
- type: string
- style: form
- explode: true
in: query
name: "page[number]"
@@ -30583,695 +15575,177 @@ paths:
schema:
type: integer
style: form
- responses:
- "200":
- content:
- application/vnd.api+json:
- schema:
- $ref: '#/components/schemas/playbook_list'
- description: success
- security:
- - bearer_auth: []
- summary: List playbooks
- tags:
- - Playbooks
- x-accepts:
- - application/vnd.api+json
- post:
- description: Creates a new playbook from provided data
- operationId: createPlaybook
- parameters: []
- requestBody:
- content:
- application/vnd.api+json:
- schema:
- $ref: '#/components/schemas/new_playbook'
- required: true
- responses:
- "201":
- content:
- application/vnd.api+json:
- example:
- data:
- id: f82c05e1-4b6b-4124-912f-baae47bb77cc
- type: playbooks
- attributes:
- title: How to handle customer-facing incident?
- summary: This is a summary
- external_url: null
- severity_ids: []
- environment_ids:
- - a9afe563-581b-4411-bfc4-7e2f518258ac
- - 89aa790d-5dd7-41d8-8f51-faf333e9104a
- service_ids:
- - 72296f8f-489e-4de6-99fb-0bb7ade01b2c
- - 45f9c084-ecc9-4076-b74f-c1770b0f46b9
- functionality_ids:
- - 6d14c6c2-7130-4722-b5fa-d1370972da3b
- - 60abca98-fcee-48e8-81b9-bcd636e52327
- group_ids: []
- incident_type_ids: []
- cause_ids: []
- created_at: 2025-05-22T06:48:17.062-07:00
- updated_at: 2025-05-22T06:48:17.062-07:00
- relationships:
- severities:
- data: []
- environments:
- data:
- - id: a9afe563-581b-4411-bfc4-7e2f518258ac
- type: environments
- - id: 89aa790d-5dd7-41d8-8f51-faf333e9104a
- type: environments
- services:
- data:
- - id: 72296f8f-489e-4de6-99fb-0bb7ade01b2c
- type: services
- - id: 45f9c084-ecc9-4076-b74f-c1770b0f46b9
- type: services
- functionalities:
- data:
- - id: 6d14c6c2-7130-4722-b5fa-d1370972da3b
- type: functionalities
- - id: 60abca98-fcee-48e8-81b9-bcd636e52327
- type: functionalities
- groups:
- data: []
- causes:
- data: []
- incident_types:
- data: []
- schema:
- $ref: '#/components/schemas/playbook_response'
- description: playbook created
- "422":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Title can't be blank
- status: "422"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: invalid request
- "401":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: responds with unauthorized for invalid token
- security:
- - bearer_auth: []
- summary: Creates a playbook
- tags:
- - Playbooks
- x-content-type: application/vnd.api+json
- x-accepts:
- - application/vnd.api+json
- /v1/playbooks/{id}:
- delete:
- description: Delete a specific playbook by id
- operationId: deletePlaybook
- parameters:
- - explode: false
- in: path
- name: id
- required: true
+ - explode: true
+ in: query
+ name: "filter[search]"
+ required: false
schema:
type: string
- style: simple
- responses:
- "200":
- content:
- application/vnd.api+json:
- example:
- data:
- id: 46849555-2c6d-4bd2-b61b-ade22a8fbd69
- type: playbooks
- attributes:
- title: Rem asperiores accusamus itaque.
- summary: null
- external_url: null
- severity_ids: []
- environment_ids: []
- service_ids: []
- functionality_ids: []
- group_ids: []
- incident_type_ids: []
- cause_ids: []
- created_at: 2025-05-22T06:48:13.610-07:00
- updated_at: 2025-05-22T06:48:19.964-07:00
- relationships:
- severities:
- data: []
- environments:
- data: []
- services:
- data: []
- functionalities:
- data: []
- groups:
- data: []
- causes:
- data: []
- incident_types:
- data: []
- schema:
- $ref: '#/components/schemas/playbook_response'
- description: playbook deleted
- "404":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: resource not found
- security:
- - bearer_auth: []
- summary: Delete a playbook
- tags:
- - Playbooks
- x-accepts:
- - application/vnd.api+json
- get:
- description: Retrieves a specific playbook by id
- operationId: getPlaybook
- parameters:
- - explode: false
- in: path
- name: id
- required: true
+ style: form
+ - explode: true
+ in: query
+ name: "filter[kind]"
+ required: false
schema:
type: string
- style: simple
- - description: "comma separated if needed. eg: severities,environments,services"
- explode: true
+ style: form
+ - explode: true
in: query
- name: include
+ name: "filter[status]"
required: false
schema:
- enum:
- - severities
- - environments
- - services
- - functionalities
- - groups
- - causes
- - incident_types
type: string
style: form
- responses:
- "200":
- content:
- application/vnd.api+json:
- example:
- data:
- id: 46849555-2c6d-4bd2-b61b-ade22a8fbd69
- type: playbooks
- attributes:
- title: Rem asperiores accusamus itaque.
- summary: null
- external_url: null
- severity_ids: []
- environment_ids: []
- service_ids: []
- functionality_ids: []
- group_ids: []
- incident_type_ids: []
- cause_ids: []
- created_at: 2025-05-22T06:48:13.610-07:00
- updated_at: 2025-05-22T06:48:13.610-07:00
- relationships:
- severities:
- data: []
- environments:
- data: []
- services:
- data: []
- functionalities:
- data: []
- groups:
- data: []
- causes:
- data: []
- incident_types:
- data: []
- schema:
- $ref: '#/components/schemas/playbook_response'
- description: playbook found
- "404":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: resource not found
- security:
- - bearer_auth: []
- summary: Retrieves a playbook
- tags:
- - Playbooks
- x-accepts:
- - application/vnd.api+json
- put:
- description: Update a specific playbook by id
- operationId: updatePlaybook
- parameters:
- - explode: false
- in: path
- name: id
- required: true
+ - explode: true
+ in: query
+ name: "filter[private]"
+ required: false
schema:
type: string
- style: simple
- requestBody:
- content:
- application/vnd.api+json:
- schema:
- $ref: '#/components/schemas/update_playbook'
- required: true
- responses:
- "200":
- content:
- application/vnd.api+json:
- example:
- data:
- id: 46849555-2c6d-4bd2-b61b-ade22a8fbd69
- type: playbooks
- attributes:
- title: How to handle security incident?
- summary: This is a summary
- external_url: null
- severity_ids: []
- environment_ids: []
- service_ids: []
- functionality_ids: []
- group_ids: []
- incident_type_ids: []
- cause_ids: []
- created_at: 2025-05-22T06:48:13.610-07:00
- updated_at: 2025-05-22T06:48:19.051-07:00
- relationships:
- severities:
- data: []
- environments:
- data: []
- services:
- data: []
- functionalities:
- data: []
- groups:
- data: []
- causes:
- data: []
- incident_types:
- data: []
- schema:
- $ref: '#/components/schemas/playbook_response'
- description: playbook updated
- "404":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: resource not found
- security:
- - bearer_auth: []
- summary: Update a playbook
- tags:
- - Playbooks
- x-content-type: application/vnd.api+json
- x-accepts:
- - application/vnd.api+json
- /v1/post_mortem_templates:
- get:
- description: List Retrospective Templates
- operationId: listPostmortemTemplates
- parameters:
+ style: form
- explode: true
in: query
- name: include
+ name: "filter[user_id]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ - explode: true
+ in: query
+ name: "filter[severity]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "page[number]"
+ name: "filter[severity_id]"
required: false
schema:
- type: integer
+ type: string
style: form
- explode: true
in: query
- name: "page[size]"
+ name: "filter[labels]"
required: false
schema:
- type: integer
+ type: string
style: form
- responses:
- "200":
- content:
- application/vnd.api+json:
- schema:
- $ref: '#/components/schemas/post_mortem_template_list'
- description: success
- security:
- - bearer_auth: []
- summary: List Retrospective Templates
- tags:
- - RetrospectiveTemplates
- x-accepts:
- - application/vnd.api+json
- post:
- description: Creates a new Retrospective Template from provided data
- operationId: createPostmortemTemplate
- parameters: []
- requestBody:
- content:
- application/vnd.api+json:
- schema:
- $ref: '#/components/schemas/new_post_mortem_template'
- required: true
- responses:
- "201":
- content:
- application/vnd.api+json:
- example:
- data:
- id: f5ec47b4-3ef1-47aa-a273-a8db92703b4d
- type: post_mortem_templates
- attributes:
- name: My Retrospective Template
- slug: my-retrospective-template
- format: markdown
- default: false
- content: |
-
-
Test template
-
- Test new line
-
- created_at: 2025-05-22T06:48:24.529-07:00
- updated_at: 2025-05-22T06:48:24.534-07:00
- schema:
- $ref: '#/components/schemas/post_mortem_template_response'
- description: post_mortem_template created
- "422":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Name can't be blank
- status: "422"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: invalid request
- "401":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: responds with unauthorized for invalid token
- security:
- - bearer_auth: []
- summary: Creates a retrospective template
- tags:
- - RetrospectiveTemplates
- x-content-type: application/vnd.api+json
- x-accepts:
- - application/vnd.api+json
- /v1/post_mortem_templates/{id}:
- delete:
- description: Delete a specific Retrospective Template by id
- operationId: deletePostmortemTemplate
- parameters:
- - explode: false
- in: path
- name: id
- required: true
+ - explode: true
+ in: query
+ name: "filter[types]"
+ required: false
schema:
type: string
- style: simple
- responses:
- "200":
- content:
- application/vnd.api+json:
- example:
- data:
- id: b31dd9ad-e16b-4513-b043-430b6314b140
- type: post_mortem_templates
- attributes:
- name: Non laboriosam earum in.
- slug: non-laboriosam-earum-in
- format: html
- default: false
- content: ""
- created_at: 2025-05-22T06:48:21.625-07:00
- updated_at: 2025-05-22T06:48:26.366-07:00
- schema:
- $ref: '#/components/schemas/post_mortem_template_response'
- description: Retrospective Template deleted
- "404":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: resource not found
- security:
- - bearer_auth: []
- summary: Delete a Retrospective Template
- tags:
- - RetrospectiveTemplates
- x-accepts:
- - application/vnd.api+json
- get:
- description: Retrieves a specific Retrospective Template by id
- operationId: getPostmortemTemplate
- parameters:
- - explode: false
- in: path
- name: id
- required: true
+ style: form
+ - explode: true
+ in: query
+ name: "filter[type_ids]"
+ required: false
schema:
type: string
- style: simple
- responses:
- "200":
- content:
- application/vnd.api+json:
- example:
- data:
- id: b31dd9ad-e16b-4513-b043-430b6314b140
- type: post_mortem_templates
- attributes:
- name: Non laboriosam earum in.
- slug: non-laboriosam-earum-in
- format: html
- default: false
- content: ""
- created_at: 2025-05-22T06:48:21.625-07:00
- updated_at: 2025-05-22T06:48:21.633-07:00
- schema:
- $ref: '#/components/schemas/post_mortem_template_response'
- description: Retrospective Template found
- "404":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: resource not found
- security:
- - bearer_auth: []
- summary: Retrieves a Retrospective Template
- tags:
- - RetrospectiveTemplates
- x-accepts:
- - application/vnd.api+json
- put:
- description: Update a specific Retrospective Template by id
- operationId: updatePostmortemTemplate
- parameters:
- - explode: false
- in: path
- name: id
- required: true
+ style: form
+ - explode: true
+ in: query
+ name: "filter[environments]"
+ required: false
schema:
type: string
- style: simple
- requestBody:
- content:
- application/vnd.api+json:
- schema:
- $ref: '#/components/schemas/update_post_mortem_template'
- required: true
- responses:
- "200":
- content:
- application/vnd.api+json:
- example:
- data:
- id: b31dd9ad-e16b-4513-b043-430b6314b140
- type: post_mortem_templates
- attributes:
- name: My Retrospective Template Updated
- slug: non-laboriosam-earum-in
- format: markdown
- default: false
- content: |
-
-
Test update template
-
- Test new line
-
- created_at: 2025-05-22T06:48:21.625-07:00
- updated_at: 2025-05-22T06:48:25.773-07:00
- schema:
- $ref: '#/components/schemas/post_mortem_template_response'
- description: Retrospective Template updated
- "404":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: resource not found
- security:
- - bearer_auth: []
- summary: Update a Retrospective Template
- tags:
- - RetrospectiveTemplates
- x-content-type: application/vnd.api+json
- x-accepts:
- - application/vnd.api+json
- /v1/pulses:
- get:
- description: List pulses
- operationId: listPulses
- parameters:
+ style: form
- explode: true
in: query
- name: include
+ name: "filter[environment_ids]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[source]"
+ name: "filter[functionalities]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[services]"
+ name: "filter[functionality_ids]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[environments]"
+ name: "filter[functionality_names]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[labels]"
+ name: "filter[services]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[refs]"
+ name: "filter[service_ids]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[started_at][gt]"
+ name: "filter[service_names]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[started_at][gte]"
+ name: "filter[teams]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[started_at][lt]"
+ name: "filter[team_ids]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[started_at][lte]"
+ name: "filter[team_names]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[ended_at][gt]"
+ name: "filter[cause]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[ended_at][gte]"
+ name: "filter[cause_ids]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[ended_at][lt]"
+ name: "filter[custom_field_selected_option_ids]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[ended_at][lte]"
+ name: "filter[slack_channel_id]"
required: false
schema:
type: string
@@ -31306,568 +15780,272 @@ paths:
style: form
- explode: true
in: query
- name: "page[number]"
+ name: "filter[updated_at][gt]"
required: false
schema:
- type: integer
+ type: string
style: form
- explode: true
in: query
- name: "page[size]"
+ name: "filter[updated_at][gte]"
required: false
schema:
- type: integer
+ type: string
style: form
- responses:
- "200":
- content:
- application/vnd.api+json:
- schema:
- $ref: '#/components/schemas/pulse_list'
- description: success
- security:
- - bearer_auth: []
- summary: List pulses
- tags:
- - Pulses
- x-accepts:
- - application/vnd.api+json
- post:
- description: Creates a new pulse from provided data
- operationId: createPulse
- parameters: []
- requestBody:
- content:
- application/vnd.api+json:
- schema:
- $ref: '#/components/schemas/new_pulse'
- required: true
- responses:
- "201":
- content:
- application/vnd.api+json:
- example:
- data:
- id: 3186bd51-c58f-4bb3-81d1-bec2f77de758
- type: pulses
- attributes:
- short_id: null
- source: k8s
- summary: Deploy k8s
- labels:
- - key: status
- value: succeeded
- refs:
- - key: sha
- value: cd62148cbc5eb42168fe99fdb50a364e12b206ac
- - key: image
- value: registry.rootly.com/rootly/my-service:cd6214
- services:
- - id: 23830880-6ef6-4981-a1e8-d99133eb4592
- team_id: 284
- name: Aut dolorem iste odit.
- slug: aut-dolorem-iste-odit
- description: Commodi laudantium doloremque repudiandae.
- deleted_at: null
- created_at: 2025-05-22T06:48:27.855-07:00
- updated_at: 2025-05-22T06:48:27.855-07:00
- opsgenie_id: null
- pagerduty_id: null
- public_description: null
- github_repository_branch: master
- github_repository_name: null
- color: '#FAEBB7'
- heroku_app_name: null
- gitlab_repository_name: null
- gitlab_repository_branch: master
- kubernetes_deployment_name: null
- incidents_count: 0
- position: 1
- slack_channels: []
- slack_aliases: []
- backstage_id: null
- show_uptime: true
- show_uptime_last_days: 60
- status: operational
- external_id: null
- notify_emails: []
- cortex_id: null
- alerts_email_enabled: false
- alerts_email_address: service-b7407c9108553f7c2d25c7adedc62935@email.rootly.com
- opsgenie_team_id: null
- service_now_ci_sys_id: null
- alert_urgency_id: null
- opslevel_id: null
- datadog_id: null
- environments:
- - id: 87322f1d-6c12-462e-9deb-209e56dce237
- team_id: 284
- name: Consequatur natus nemo quo.
- slug: consequatur-natus-nemo-quo
- description: Sed vitae rem dolore.
- color: '#eeeef6'
- deleted_at: null
- created_at: 2025-05-22T06:48:27.869-07:00
- updated_at: 2025-05-22T06:48:27.869-07:00
- incidents_count: 0
- position: 1
- slack_channels: []
- slack_aliases: []
- external_id: null
- notify_emails: []
- data:
- url: https://additionaldata.com
- external_url: https://external-url.com
- started_at: 2025-05-22T06:39:00.000-07:00
- ended_at: 2025-05-22T06:41:00.000-07:00
- created_at: 2025-05-22T06:48:30.322-07:00
- updated_at: 2025-05-22T06:48:30.322-07:00
- schema:
- $ref: '#/components/schemas/pulse_response'
- description: pulse created
- "422":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Summary can't be blank
- status: "422"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: invalid request
- "401":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: responds with unauthorized for invalid token
- security:
- - bearer_auth: []
- summary: Creates a pulse
- tags:
- - Pulses
- x-content-type: application/vnd.api+json
- x-accepts:
- - application/vnd.api+json
- /v1/pulses/{id}:
- get:
- description: Retrieves a specific pulse by id
- operationId: getPulse
- parameters:
- - explode: false
- in: path
- name: id
- required: true
+ - explode: true
+ in: query
+ name: "filter[updated_at][lt]"
+ required: false
schema:
type: string
- style: simple
- responses:
- "200":
- content:
- application/vnd.api+json:
- example:
- data:
- id: c7ee93a5-17ce-45af-91a9-fffbd64b3118
- type: pulses
- attributes:
- short_id: null
- source: unknown
- summary: Laborum quae quis iste.
- labels: []
- refs: []
- services: []
- environments: []
- data: {}
- external_url: null
- started_at: 2025-05-22T06:48:27.799-07:00
- ended_at: null
- created_at: 2025-05-22T06:48:27.799-07:00
- updated_at: 2025-05-22T06:48:27.799-07:00
- schema:
- $ref: '#/components/schemas/pulse_response'
- description: pulse found
- "404":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: resource not found
- security:
- - bearer_auth: []
- summary: Retrieves a pulse
- tags:
- - Pulses
- x-accepts:
- - application/vnd.api+json
- put:
- description: Update a specific pulse by id
- operationId: updatePulse
- parameters:
- - explode: false
- in: path
- name: id
- required: true
+ style: form
+ - explode: true
+ in: query
+ name: "filter[updated_at][lte]"
+ required: false
schema:
type: string
- style: simple
- requestBody:
- content:
- application/vnd.api+json:
- schema:
- $ref: '#/components/schemas/update_pulse'
- required: true
- responses:
- "200":
- content:
- application/vnd.api+json:
- example:
- data:
- id: c7ee93a5-17ce-45af-91a9-fffbd64b3118
- type: pulses
- attributes:
- short_id: null
- source: unknown
- summary: Deploy k8s
- labels: []
- refs: []
- services:
- - id: d8614426-70f1-425c-aaf0-616ea665f030
- team_id: 284
- name: Sit rem eveniet qui.
- slug: sit-rem-eveniet-qui
- description: Natus id repudiandae accusantium.
- deleted_at: null
- created_at: 2025-05-22T06:48:27.879-07:00
- updated_at: 2025-05-22T06:48:27.879-07:00
- opsgenie_id: null
- pagerduty_id: null
- public_description: null
- github_repository_branch: master
- github_repository_name: null
- color: '#D7F5E1'
- heroku_app_name: null
- gitlab_repository_name: null
- gitlab_repository_branch: master
- kubernetes_deployment_name: null
- incidents_count: 0
- position: 2
- slack_channels: []
- slack_aliases: []
- backstage_id: null
- show_uptime: true
- show_uptime_last_days: 60
- status: operational
- external_id: null
- notify_emails: []
- cortex_id: null
- alerts_email_enabled: false
- alerts_email_address: service-001797b81926a886d941857eca9d458a@email.rootly.com
- opsgenie_team_id: null
- service_now_ci_sys_id: null
- alert_urgency_id: null
- opslevel_id: null
- datadog_id: null
- environments:
- - id: 4a670558-b76a-4984-85a9-7809cb43e47c
- team_id: 284
- name: Est repellat tenetur id.
- slug: est-repellat-tenetur-id
- description: Reprehenderit vel eaque aut.
- color: '#e9f7e9'
- deleted_at: null
- created_at: 2025-05-22T06:48:27.893-07:00
- updated_at: 2025-05-22T06:48:27.893-07:00
- incidents_count: 0
- position: 2
- slack_channels: []
- slack_aliases: []
- external_id: null
- notify_emails: []
- data: {}
- external_url: null
- started_at: 2025-05-22T06:48:27.799-07:00
- ended_at: null
- created_at: 2025-05-22T06:48:27.799-07:00
- updated_at: 2025-05-22T06:48:32.231-07:00
- schema:
- $ref: '#/components/schemas/pulse_response'
- description: pulse updated
- "404":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: resource not found
- security:
- - bearer_auth: []
- summary: Update a pulse
- tags:
- - Pulses
- x-content-type: application/vnd.api+json
- x-accepts:
- - application/vnd.api+json
- /v1/retrospective_configurations:
- get:
- description: List retrospective configurations
- operationId: listRetrospectiveConfigurations
- parameters:
- - description: "comma separated if needed. eg: severities,groups"
- explode: true
+ style: form
+ - explode: true
in: query
- name: include
+ name: "filter[started_at][gt]"
required: false
schema:
- enum:
- - severities
- - groups
- - incident_types
type: string
style: form
- explode: true
in: query
- name: "page[number]"
+ name: "filter[started_at][gte]"
required: false
schema:
- type: integer
+ type: string
style: form
- explode: true
in: query
- name: "page[size]"
+ name: "filter[started_at][lt]"
required: false
schema:
- type: integer
+ type: string
style: form
- explode: true
in: query
- name: "filter[kind]"
+ name: "filter[started_at][lte]"
required: false
schema:
type: string
style: form
- responses:
- "200":
- content:
- application/vnd.api+json:
- schema:
- $ref: '#/components/schemas/retrospective_configuration_list'
- description: success
- security:
- - bearer_auth: []
- summary: List retrospective configurations
- tags:
- - RetrospectiveConfigurations
- x-accepts:
- - application/vnd.api+json
- /v1/retrospective_configurations/{id}:
- get:
- description: Retrieves a specific retrospective_configuration by id
- operationId: getRetrospectiveConfiguration
- parameters:
- - explode: false
- in: path
- name: id
- required: true
+ - explode: true
+ in: query
+ name: "filter[detected_at][gt]"
+ required: false
schema:
type: string
- style: simple
- - description: "comma separated if needed. eg: severities,groups"
- explode: true
+ style: form
+ - explode: true
in: query
- name: include
+ name: "filter[detected_at][gte]"
required: false
schema:
- enum:
- - severities
- - groups
- - incident_types
type: string
style: form
- responses:
- "200":
- content:
- application/vnd.api+json:
- example:
- data:
- id: 81cd874c-9aba-4b16-8d9f-3f61bea7e42f
- type: retrospective_configurations
- attributes:
- kind: skip
- severity_ids:
- - 32d3de46-6801-4184-a5d6-8766d4cffa12
- incident_type_ids: []
- group_ids: []
- created_at: 2025-05-22T06:48:34.078-07:00
- updated_at: 2025-05-22T06:48:34.078-07:00
- relationships:
- severities:
- data:
- - id: 32d3de46-6801-4184-a5d6-8766d4cffa12
- type: severities
- groups:
- data: []
- incident_types:
- data: []
- schema:
- $ref: '#/components/schemas/retrospective_configuration_response'
- description: retrospective_configuration found
- "404":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: resource not found
- security:
- - bearer_auth: []
- summary: Retrieves a Retrospective Configuration
- tags:
- - RetrospectiveConfigurations
- x-accepts:
- - application/vnd.api+json
- put:
- description: Update a specific retrospective configuration by id
- operationId: updateRetrospectiveConfiguration
- parameters:
- - explode: false
- in: path
- name: id
- required: true
+ - explode: true
+ in: query
+ name: "filter[detected_at][lt]"
+ required: false
schema:
type: string
- style: simple
- requestBody:
- content:
- application/vnd.api+json:
- schema:
- $ref: '#/components/schemas/update_retrospective_configuration'
- required: true
- responses:
- "200":
- content:
- application/vnd.api+json:
- example:
- data:
- id: 4e88bab2-4e79-49a9-979f-3993d75a5ce0
- type: retrospective_configurations
- attributes:
- kind: skip
- severity_ids: []
- incident_type_ids: []
- group_ids:
- - 29c9bb34-b9c0-4857-9b90-10a15e259fc7
- created_at: 2025-05-22T06:48:36.806-07:00
- updated_at: 2025-05-22T06:48:36.806-07:00
- relationships:
- severities:
- data: []
- groups:
- data:
- - id: 29c9bb34-b9c0-4857-9b90-10a15e259fc7
- type: groups
- incident_types:
- data: []
- schema:
- $ref: '#/components/schemas/retrospective_configuration_response'
- description: retrospective configuration updated
- "404":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: resource not found
- security:
- - bearer_auth: []
- summary: Update a retrospective configuration
- tags:
- - RetrospectiveConfigurations
- x-content-type: application/vnd.api+json
- x-accepts:
- - application/vnd.api+json
- /v1/retrospective_process_groups/{retrospective_process_group_id}/steps:
- get:
- description: List RetrospectiveProcessGroup Steps
- operationId: listRetrospectiveProcessGroupSteps
- parameters:
- - explode: false
- in: path
- name: retrospective_process_group_id
- required: true
+ style: form
+ - explode: true
+ in: query
+ name: "filter[detected_at][lte]"
+ required: false
schema:
type: string
- style: simple
+ style: form
- explode: true
in: query
- name: include
+ name: "filter[acknowledged_at][gt]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "page[number]"
+ name: "filter[acknowledged_at][gte]"
required: false
schema:
- type: integer
+ type: string
style: form
- explode: true
in: query
- name: "page[size]"
+ name: "filter[acknowledged_at][lt]"
required: false
schema:
- type: integer
+ type: string
style: form
- explode: true
in: query
- name: "filter[retrospective_step_id]"
+ name: "filter[acknowledged_at][lte]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[created_at][gt]"
+ name: "filter[mitigated_at][gt]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[created_at][gte]"
+ name: "filter[mitigated_at][gte]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[created_at][lt]"
+ name: "filter[mitigated_at][lt]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[created_at][lte]"
+ name: "filter[mitigated_at][lte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[resolved_at][gt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[resolved_at][gte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[resolved_at][lt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[resolved_at][lte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[closed_at][gt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[closed_at][gte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[closed_at][lt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[closed_at][lte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[in_triage_at][gt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[in_triage_at][gte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[in_triage_at][lt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[in_triage_at][lte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - description: "comma separated if needed. eg: created_at,updated_at"
+ explode: true
+ in: query
+ name: sort
+ required: false
+ schema:
+ enum:
+ - created_at
+ - -created_at
+ - updated_at
+ - -updated_at
+ - started_at
+ - -started_at
+ - in_triage_at
+ - -in_triage_at
+ - mitigated_at
+ - -mitigated_at
+ - resolved_at
+ - -resolved_at
+ type: string
+ style: form
+ - description: "comma separated if needed. eg: sub_statuses,causes,subscribers"
+ explode: true
+ in: query
+ name: include
required: false
schema:
+ enum:
+ - sub_statuses
+ - causes
+ - subscribers
+ - roles
+ - slack_messages
+ - environments
+ - incident_types
+ - services
+ - functionalities
+ - groups
+ - events
+ - action_items
+ - custom_field_selections
+ - feedbacks
+ - incident_post_mortem
+ - alerts
type: string
style: form
responses:
@@ -31875,1080 +16053,660 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/retrospective_process_group_step_list'
+ $ref: '#/components/schemas/incident_list'
description: success
security:
- bearer_auth: []
- summary: List RetrospectiveProcessGroup Steps
+ summary: List incidents
tags:
- - RetrospectiveProcessGroupSteps
+ - Incidents
x-accepts:
- application/vnd.api+json
post:
- description: Creates a new retrospective process group step from provided data
- operationId: createRetrospectiveProcessGroupStep
- parameters:
- - explode: false
- in: path
- name: retrospective_process_group_id
- required: true
- schema:
- type: string
- style: simple
+ description: Creates a new incident from provided data
+ operationId: createIncident
+ parameters: []
requestBody:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/new_retrospective_process_group_step'
+ $ref: '#/components/schemas/new_incident'
required: true
responses:
"201":
content:
application/vnd.api+json:
- example:
- data:
- id: e92e2773-901f-4def-9e7a-519b388a5b70
- type: retrospective_process_group_steps
- attributes:
- retrospective_process_group_id: 64bb966a-0888-430a-868c-e218f0bd0bcc
- retrospective_step_id: 40857c1a-5513-4c13-abaa-bcfc59e36b9f
- position: 1
- updated_at: 2025-05-22T06:48:41.185-07:00
- created_at: 2025-05-22T06:48:41.185-07:00
schema:
- $ref: '#/components/schemas/retrospective_process_group_step_response'
- description: retrospective_process_group_step created
+ $ref: '#/components/schemas/incident_response'
+ description: incident created
+ "422":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: invalid causes association
"401":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
description: responds with unauthorized for invalid token
security:
- bearer_auth: []
- summary: Creates a retrospective process group step
+ summary: Creates an incident
tags:
- - RetrospectiveProcessGroupSteps
+ - Incidents
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/retrospective_process_group_steps/{id}:
+ /v1/incidents/{id}:
delete:
- description: Delete a specific RetrospectiveProcessGroup Step by id
- operationId: deleteRetrospectiveProcessGroupStep
+ description: Delete a specific incident by id
+ operationId: deleteIncident
parameters:
- explode: false
in: path
name: id
required: true
schema:
- type: string
+ $ref: '#/components/schemas/getAlertField_id_parameter'
style: simple
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 8aa827a0-0817-421f-abf9-8342bdf05f5e
- type: retrospective_process_group_steps
- attributes:
- retrospective_process_group_id: 64bb966a-0888-430a-868c-e218f0bd0bcc
- retrospective_step_id: 063cb7d7-a046-413c-9a18-f4462eebae21
- position: 1
- updated_at: 2025-05-22T06:48:43.223-07:00
- created_at: 2025-05-22T06:48:43.052-07:00
schema:
- $ref: '#/components/schemas/retrospective_process_group_step_response'
- description: retrospective_process_group_step deleted
+ $ref: '#/components/schemas/incident_response'
+ description: incident deleted
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Delete a RetrospectiveProcessGroup Step
+ summary: Delete an incident
tags:
- - RetrospectiveProcessGroupSteps
+ - Incidents
x-accepts:
- application/vnd.api+json
get:
- description: Retrieves a specific RetrospectiveProcessGroup Step by id
- operationId: getRetrospectiveProcessGroupStep
+ description: Retrieves a specific incident by id
+ operationId: getIncident
parameters:
- explode: false
in: path
name: id
required: true
schema:
- type: string
+ $ref: '#/components/schemas/getAlertField_id_parameter'
style: simple
+ - description: "comma separated if needed. eg: sub_statuses,causes,subscribers"
+ explode: true
+ in: query
+ name: include
+ required: false
+ schema:
+ enum:
+ - sub_statuses
+ - causes
+ - subscribers
+ - roles
+ - slack_messages
+ - environments
+ - incident_types
+ - services
+ - functionalities
+ - groups
+ - events
+ - action_items
+ - custom_field_selections
+ - feedbacks
+ - incident_post_mortem
+ - alerts
+ type: string
+ style: form
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: fde7ce91-8483-4879-95ab-4e1f5d770e7b
- type: retrospective_process_group_steps
- attributes:
- retrospective_process_group_id: 64bb966a-0888-430a-868c-e218f0bd0bcc
- retrospective_step_id: ca052f30-4e97-482f-8002-faaaae11457d
- position: 1
- updated_at: 2025-05-22T06:48:41.937-07:00
- created_at: 2025-05-22T06:48:41.937-07:00
schema:
- $ref: '#/components/schemas/retrospective_process_group_step_response'
- description: sub_status found
+ $ref: '#/components/schemas/incident_response'
+ description: incident found by slug
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
security:
- bearer_auth: []
- summary: Retrieves a RetrospectiveProcessGroup Step
+ summary: Retrieves an incident
tags:
- - RetrospectiveProcessGroupSteps
+ - Incidents
x-accepts:
- application/vnd.api+json
put:
- description: Update a specific RetrospectiveProcessGroup Step by id
- operationId: updateRetrospectiveProcessGroupStep
+ description: Update a specific incident by id
+ operationId: updateIncident
parameters:
- explode: false
in: path
name: id
required: true
schema:
- type: string
+ $ref: '#/components/schemas/getAlertField_id_parameter'
style: simple
requestBody:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/update_retrospective_process_group_step'
+ $ref: '#/components/schemas/update_incident'
required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 456797dd-dca1-40b6-b69f-c77da03ad159
- type: retrospective_process_group_steps
- attributes:
- retrospective_process_group_id: 64bb966a-0888-430a-868c-e218f0bd0bcc
- retrospective_step_id: 8c7de1fd-62eb-4995-8678-53a8e984f245
- position: 2
- updated_at: 2025-05-22T06:48:42.649-07:00
- created_at: 2025-05-22T06:48:42.493-07:00
schema:
- $ref: '#/components/schemas/retrospective_process_group_step_response'
- description: retrospective_process_group_step updated
- security:
- - bearer_auth: []
- summary: Update RetrospectiveProcessGroup Step
- tags:
- - RetrospectiveProcessGroupSteps
- x-content-type: application/vnd.api+json
- x-accepts:
- - application/vnd.api+json
- /v1/retrospective_processes/{retrospective_process_id}/groups:
- get:
- description: List Retrospective Process Groups
- operationId: listRetrospectiveProcessGroups
- parameters:
- - explode: false
- in: path
- name: retrospective_process_id
- required: true
- schema:
- type: string
- style: simple
- - description: "comma separated if needed. eg: retrospective_process_group_steps"
- explode: true
- in: query
- name: include
- required: false
- schema:
- enum:
- - retrospective_process_group_steps
- type: string
- style: form
- - description: "comma separated if needed. eg: created_at,updated_at"
- explode: true
- in: query
- name: sort
- required: false
- schema:
- enum:
- - created_at
- - -created_at
- - updated_at
- - -updated_at
- - position
- - -position
- type: string
- style: form
- - explode: true
- in: query
- name: "page[number]"
- required: false
- schema:
- type: integer
- style: form
- - explode: true
- in: query
- name: "page[size]"
- required: false
- schema:
- type: integer
- style: form
- - explode: true
- in: query
- name: "filter[sub_status_id]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[created_at][gt]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[created_at][gte]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[created_at][lt]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[created_at][lte]"
- required: false
- schema:
- type: string
- style: form
- responses:
- "200":
+ $ref: '#/components/schemas/incident_response'
+ description: incident updated
+ "404":
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/retrospective_process_group_list'
- description: success
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
security:
- bearer_auth: []
- summary: List Retrospective Process Groups
+ summary: Update an incident
tags:
- - RetrospectiveProcessGroups
+ - Incidents
+ x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- post:
- description: Creates a new retrospective process group from provided data
- operationId: createRetrospectiveProcessGroup
+ /v1/incidents/{id}/mitigate:
+ put:
+ description: Mitigate a specific incident by id
+ operationId: mitigateIncident
parameters:
- explode: false
in: path
- name: retrospective_process_id
+ name: id
required: true
schema:
- type: string
+ $ref: '#/components/schemas/getAlertField_id_parameter'
style: simple
requestBody:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/new_retrospective_process_group'
+ $ref: '#/components/schemas/mitigate_incident'
required: true
responses:
- "201":
+ "200":
content:
application/vnd.api+json:
- example:
- data:
- id: 96efd514-c358-4858-8ad3-1d510d77fce7
- type: retrospective_process_groups
- attributes:
- retrospective_process_id: 84ad6907-2b65-4f69-9afa-649f0c91be62
- sub_status_id: 6fe733a5-3d48-484d-8430-ae732ea5b7aa
- position: 3
- updated_at: 2025-05-22T06:48:46.497-07:00
- created_at: 2025-05-22T06:48:46.497-07:00
- relationships:
- retrospective_process_group_steps:
- data: []
schema:
- $ref: '#/components/schemas/retrospective_process_group_response'
- description: retrospective_process_group created
- "401":
+ $ref: '#/components/schemas/incident_response'
+ description: incident mitigated
+ "404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
- description: responds with unauthorized for invalid token
+ description: resource not found
security:
- bearer_auth: []
- summary: Creates a retrospective process group
+ summary: Mitigate an incident
tags:
- - RetrospectiveProcessGroups
+ - Incidents
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/retrospective_process_groups/{id}:
- delete:
- description: Delete a specific Retrospective Process Group by id
- operationId: deleteRetrospectiveProcessGroup
+ /v1/incidents/{id}/resolve:
+ put:
+ description: Resolve a specific incident by id
+ operationId: resolveIncident
parameters:
- explode: false
in: path
name: id
required: true
schema:
- type: string
+ $ref: '#/components/schemas/getAlertField_id_parameter'
style: simple
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/resolve_incident'
+ required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 50f2a527-e1ad-4e75-80e3-ddc2407645a7
- type: retrospective_process_groups
- attributes:
- retrospective_process_id: 84ad6907-2b65-4f69-9afa-649f0c91be62
- sub_status_id: 34d94037-2870-4ccb-b1e6-9d23d229282d
- position: 1
- updated_at: 2025-05-22T06:48:47.356-07:00
- created_at: 2025-05-22T06:48:45.965-07:00
- relationships:
- retrospective_process_group_steps:
- data: []
schema:
- $ref: '#/components/schemas/retrospective_process_group_response'
- description: retrospective_process_group deleted
+ $ref: '#/components/schemas/incident_response'
+ description: incident resolved
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Delete a Retrospective Process Group
+ summary: Resolve an incident
tags:
- - RetrospectiveProcessGroups
+ - Incidents
+ x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- get:
- description: Retrieves a specific Retrospective Process Group by id
- operationId: getRetrospectiveProcessGroup
+ /v1/incidents/{id}/cancel:
+ put:
+ description: Cancel a specific incident by id
+ operationId: cancelIncident
parameters:
- explode: false
in: path
name: id
required: true
schema:
- type: string
+ $ref: '#/components/schemas/getAlertField_id_parameter'
style: simple
- - description: "comma separated if needed. eg: retrospective_process_group_steps"
- explode: true
- in: query
- name: include
- required: false
- schema:
- enum:
- - retrospective_process_group_steps
- type: string
- style: form
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/cancel_incident'
+ required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 50f2a527-e1ad-4e75-80e3-ddc2407645a7
- type: retrospective_process_groups
- attributes:
- retrospective_process_id: 84ad6907-2b65-4f69-9afa-649f0c91be62
- sub_status_id: 34d94037-2870-4ccb-b1e6-9d23d229282d
- position: 1
- updated_at: 2025-05-22T06:48:45.965-07:00
- created_at: 2025-05-22T06:48:45.965-07:00
- relationships:
- retrospective_process_group_steps:
- data: []
schema:
- $ref: '#/components/schemas/retrospective_process_group_response'
- description: sub_status found
+ $ref: '#/components/schemas/incident_response'
+ description: incident cancel
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
security:
- bearer_auth: []
- summary: Retrieves a Retrospective Process Group
+ summary: Cancel an incident
tags:
- - RetrospectiveProcessGroups
+ - Incidents
+ x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
+ /v1/incidents/{id}/in_triage:
put:
- description: Update a specific Retrospective Process Group by id
- operationId: updateRetrospectiveProcessGroup
+ description: Set a specific incident by ID to triage state
+ operationId: triageIncident
parameters:
- explode: false
in: path
name: id
required: true
schema:
- type: string
+ $ref: '#/components/schemas/getAlertField_id_parameter'
style: simple
requestBody:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/update_retrospective_process_group'
+ $ref: '#/components/schemas/in_triage_incident'
required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 50f2a527-e1ad-4e75-80e3-ddc2407645a7
- type: retrospective_process_groups
- attributes:
- retrospective_process_id: 84ad6907-2b65-4f69-9afa-649f0c91be62
- sub_status_id: 34d94037-2870-4ccb-b1e6-9d23d229282d
- position: 1
- updated_at: 2025-05-22T06:48:45.965-07:00
- created_at: 2025-05-22T06:48:45.965-07:00
- relationships:
- retrospective_process_group_steps:
- data: []
schema:
- $ref: '#/components/schemas/retrospective_process_group_response'
- description: retrospective_process_group updated
- security:
- - bearer_auth: []
- summary: Update a Retrospective Process Group
- tags:
- - RetrospectiveProcessGroups
- x-content-type: application/vnd.api+json
- x-accepts:
- - application/vnd.api+json
- /v1/retrospective_processes:
- get:
- description: List retrospective processes
- operationId: listRetrospectiveProcesses
- parameters:
- - description: "comma separated if needed. eg: retrospective_steps,severities"
- explode: true
- in: query
- name: include
- required: false
- schema:
- enum:
- - retrospective_steps
- - severities
- - incident_types
- - groups
- type: string
- style: form
- - explode: true
- in: query
- name: "page[number]"
- required: false
- schema:
- type: integer
- style: form
- - explode: true
- in: query
- name: "page[size]"
- required: false
- schema:
- type: integer
- style: form
- responses:
- "200":
+ $ref: '#/components/schemas/incident_response'
+ description: incident set to triage
+ "404":
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/retrospective_process_list'
- description: success
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
security:
- bearer_auth: []
- summary: List retrospective processes
+ summary: Triage an incident
tags:
- - RetrospectiveProcesses
+ - Incidents
+ x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- post:
- description: Creates a new retrospective process from provided data
- operationId: createRetrospectiveProcess
- parameters: []
+ /v1/incidents/{id}/restart:
+ put:
+ description: Restart a specific incident by id
+ operationId: restartIncident
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ $ref: '#/components/schemas/getAlertField_id_parameter'
+ style: simple
requestBody:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/new_retrospective_process'
+ $ref: '#/components/schemas/restart_incident'
required: true
responses:
- "201":
- content:
- application/vnd.api+json:
- example:
- data:
- id: b3c4c1af-1e0a-48a2-b207-10f75a28d2ff
- type: retrospective_processes
- attributes:
- name: Retrospective Process 1
- description: Retrospective Process 1 Description
- is_default: false
- created_at: 2025-05-22T06:48:51.082-07:00
- updated_at: 2025-05-22T06:48:51.082-07:00
- retrospective_process_matching_criteria:
- severity_ids:
- - 80da1321-85a6-4568-a454-3144e165a687
- relationships:
- retrospective_steps:
- data:
- - id: 866a24bb-dfe8-46e3-9eb9-d8bce6325870
- type: retrospective_steps
- - id: 5675cf12-884d-44d3-af25-881bf2abddb6
- type: retrospective_steps
- severities:
- data:
- - id: 80da1321-85a6-4568-a454-3144e165a687
- type: severities
- schema:
- $ref: '#/components/schemas/retrospective_process_response'
- description: retrospective_process created
- "422":
+ "200":
content:
application/vnd.api+json:
- example:
- name:
- - can't be blank
schema:
- $ref: '#/components/schemas/errors_list'
- description: invalid request
- "401":
+ $ref: '#/components/schemas/incident_response'
+ description: incident restarted
+ "404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
- description: responds with unauthorized for invalid token
+ description: resource not found
security:
- bearer_auth: []
- summary: Creates a retrospective process
+ summary: Restart an incident
tags:
- - RetrospectiveProcesses
+ - Incidents
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/retrospective_processes/{id}:
- delete:
- description: Delete a specific retrospective process by id
- operationId: deleteRetrospectiveProcess
+ /v1/incidents/{id}/duplicate:
+ put:
+ description: Mark an incident as a duplicate
+ operationId: markAsDuplicateIncident
parameters:
- explode: false
in: path
name: id
required: true
schema:
- type: string
+ $ref: '#/components/schemas/getAlertField_id_parameter'
style: simple
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/resolve_incident'
+ required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 9f500383-20fb-49b7-8adf-48237711710d
- type: retrospective_processes
- attributes:
- name: Id pariatur dolorem nobis.
- description: Aut neque ea. Possimus ea qui. Provident quos est.
- is_default: false
- created_at: 2025-05-22T06:48:48.842-07:00
- updated_at: 2025-05-22T06:48:52.998-07:00
- retrospective_process_matching_criteria:
- incident_type_ids:
- - d4bdcc62-4f39-457e-b68e-ea908db31872
- relationships:
- retrospective_steps:
- data:
- - id: 5837b9a7-866f-49e5-b28c-53b71d6f259f
- type: retrospective_steps
- - id: e89bcc64-ba17-4860-b1c6-c88956761540
- type: retrospective_steps
- incident_types:
- data:
- - id: d4bdcc62-4f39-457e-b68e-ea908db31872
- type: incident_types
schema:
- $ref: '#/components/schemas/retrospective_process_response'
- description: retrospective_process deleted
+ $ref: '#/components/schemas/incident_response'
+ description: incident marked as duplicated
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Delete a retrospective process
+ summary: Mark an incident as a duplicate
tags:
- - RetrospectiveProcesses
+ - Incidents
+ x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- get:
- description: Retrieves a specific retrospective process by id
- operationId: getRetrospectiveProcess
+ /v1/incidents/{id}/detach_from_parent:
+ put:
+ description: Detach a sub-incident from its parent incident
+ operationId: detachFromParentIncident
parameters:
- explode: false
in: path
name: id
required: true
schema:
- type: string
+ $ref: '#/components/schemas/getAlertField_id_parameter'
style: simple
- - description: "comma separated if needed. eg: retrospective_steps,severities"
- explode: true
- in: query
- name: include
- required: false
- schema:
- enum:
- - retrospective_steps
- - severities
- - incident_types
- - groups
- type: string
- style: form
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 9f500383-20fb-49b7-8adf-48237711710d
- type: retrospective_processes
- attributes:
- name: Id pariatur dolorem nobis.
- description: Aut neque ea. Possimus ea qui. Provident quos est.
- is_default: false
- created_at: 2025-05-22T06:48:48.842-07:00
- updated_at: 2025-05-22T06:48:48.842-07:00
- retrospective_process_matching_criteria:
- incident_type_ids:
- - d4bdcc62-4f39-457e-b68e-ea908db31872
- relationships:
- retrospective_steps:
- data:
- - id: 5837b9a7-866f-49e5-b28c-53b71d6f259f
- type: retrospective_steps
- - id: e89bcc64-ba17-4860-b1c6-c88956761540
- type: retrospective_steps
- incident_types:
- data:
- - id: d4bdcc62-4f39-457e-b68e-ea908db31872
- type: incident_types
schema:
- $ref: '#/components/schemas/retrospective_process_response'
- description: retrospective_process found
+ $ref: '#/components/schemas/incident_response'
+ description: incident detached from parent
+ "422":
+ description: incident has no parent
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Retrieves a retrospective process
+ summary: Detach an incident from its parent
tags:
- - RetrospectiveProcesses
+ - Incidents
x-accepts:
- application/vnd.api+json
+ /v1/incidents/{id}/unmark_as_duplicate:
put:
- description: Updates a specific retrospective process by id
- operationId: updateRetrospectiveProcess
+ description: Remove the duplicate marking from an incident
+ operationId: unmarkAsDuplicateIncident
parameters:
- explode: false
in: path
name: id
required: true
schema:
- type: string
+ $ref: '#/components/schemas/getAlertField_id_parameter'
style: simple
- requestBody:
- content:
- application/vnd.api+json:
- schema:
- $ref: '#/components/schemas/update_retrospective_process'
- required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 9f500383-20fb-49b7-8adf-48237711710d
- type: retrospective_processes
- attributes:
- name: Retrospective Process 2
- description: Retrospective Process 2 description
- is_default: false
- created_at: 2025-05-22T06:48:48.842-07:00
- updated_at: 2025-05-22T06:48:52.408-07:00
- retrospective_process_matching_criteria:
- group_ids:
- - b75e5108-4903-4a15-bd4c-439078ac2983
- relationships:
- retrospective_steps:
- data:
- - id: 5837b9a7-866f-49e5-b28c-53b71d6f259f
- type: retrospective_steps
- - id: e89bcc64-ba17-4860-b1c6-c88956761540
- type: retrospective_steps
- groups:
- data:
- - id: b75e5108-4903-4a15-bd4c-439078ac2983
- type: groups
schema:
- $ref: '#/components/schemas/retrospective_process_response'
- description: retrospective_process updated
+ $ref: '#/components/schemas/incident_response'
+ description: duplicate marking removed
+ "422":
+ description: incident is not marked as duplicate
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Update a retrospective process
- tags:
- - RetrospectiveProcesses
- x-content-type: application/vnd.api+json
- x-accepts:
- - application/vnd.api+json
- /v1/retrospective_processes/{retrospective_process_id}/retrospective_steps:
- get:
- description: List retrospective steps
- operationId: listRetrospectiveSteps
- parameters:
- - explode: false
- in: path
- name: retrospective_process_id
- required: true
- schema:
- type: string
- style: simple
- - explode: true
- in: query
- name: include
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "page[number]"
- required: false
- schema:
- type: integer
- style: form
- - explode: true
- in: query
- name: "page[size]"
- required: false
- schema:
- type: integer
- style: form
- - explode: true
- in: query
- name: sort
- required: false
- schema:
- type: string
- style: form
- responses:
- "200":
- content:
- application/vnd.api+json:
- schema:
- $ref: '#/components/schemas/retrospective_step_list'
- description: success
- security:
- - bearer_auth: []
- summary: List retrospective steps
+ summary: Remove duplicate marking from an incident
tags:
- - RetrospectiveSteps
+ - Incidents
x-accepts:
- application/vnd.api+json
+ /v1/incidents/{id}/add_subscribers:
post:
- description: Creates a new retrospective step from provided data
- operationId: createRetrospectiveStep
+ description: Add subscribers to incident
+ operationId: addSubscribersToIncident
parameters:
- explode: false
in: path
- name: retrospective_process_id
+ name: id
required: true
schema:
- type: string
+ $ref: '#/components/schemas/getAlertField_id_parameter'
style: simple
requestBody:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/new_retrospective_step'
+ $ref: '#/components/schemas/add_subscribers'
required: true
responses:
- "201":
- content:
- application/vnd.api+json:
- example:
- data:
- id: 5ff1172a-f016-4517-8bd8-3634e2dd5bef
- type: retrospective_steps
- attributes:
- retrospective_process_id: c916291a-e55c-4226-ba5b-2e56bf83c524
- title: Step 1
- description: Step 1 description
- incident_role_id: 73ea36a1-07b3-4be7-abc6-ab5ea53c79a2
- due_after_days: 5
- position: 1
- skippable: false
- created_at: 2025-05-22T06:48:54.612-07:00
- updated_at: 2025-05-22T06:48:54.612-07:00
- schema:
- $ref: '#/components/schemas/retrospective_step_response'
- description: retrospective_step created
- "422":
+ "200":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Title can't be blank
- status: "422"
schema:
- $ref: '#/components/schemas/errors_list'
- description: invalid request
- "401":
+ $ref: '#/components/schemas/incident_response'
+ description: add subscribers to incident
+ "404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
- description: responds with unauthorized for invalid token
+ description: resource not found
security:
- bearer_auth: []
- summary: Creates a retrospective step
+ summary: Add subscribers to incident
tags:
- - RetrospectiveSteps
+ - Incidents
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/retrospective_steps/{id}:
+ /v1/incidents/{id}/remove_subscribers:
delete:
- description: Delete a specific retrospective step by id
- operationId: deleteRetrospectiveStep
+ description: Remove subscribers to incident
+ operationId: removeSubscribersToIncident
parameters:
- explode: false
in: path
name: id
required: true
schema:
- type: string
+ $ref: '#/components/schemas/getAlertField_id_parameter'
style: simple
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/remove_subscribers'
+ required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 11b3d18a-0b0f-45af-9dea-690d8479bae3
- type: retrospective_steps
- attributes:
- retrospective_process_id: c916291a-e55c-4226-ba5b-2e56bf83c524
- title: Step 11
- description: Bar
- incident_role_id: 73ea36a1-07b3-4be7-abc6-ab5ea53c79a2
- due_after_days: null
- position: 1
- skippable: true
- created_at: 2025-05-22T06:48:54.416-07:00
- updated_at: 2025-05-22T06:48:56.492-07:00
schema:
- $ref: '#/components/schemas/retrospective_step_response'
- description: retrospective_step deleted
+ $ref: '#/components/schemas/incident_response'
+ description: remove subscribers from incident
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Delete a retrospective step
+ summary: Remove subscribers from incident
tags:
- - RetrospectiveSteps
+ - Incidents
+ x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- get:
- description: Retrieves a specific retrospective step by id
- operationId: getRetrospectiveStep
+ /v1/incidents/{id}/assign_role_to_user:
+ post:
+ description: Assign user to incident
+ operationId: assignUserToIncident
parameters:
- explode: false
in: path
name: id
required: true
schema:
- type: string
+ $ref: '#/components/schemas/getAlertField_id_parameter'
style: simple
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/assign_role_to_user'
+ required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 11b3d18a-0b0f-45af-9dea-690d8479bae3
- type: retrospective_steps
- attributes:
- retrospective_process_id: c916291a-e55c-4226-ba5b-2e56bf83c524
- title: Step 11
- description: Bar
- incident_role_id: 73ea36a1-07b3-4be7-abc6-ab5ea53c79a2
- due_after_days: null
- position: 1
- skippable: true
- created_at: 2025-05-22T06:48:54.416-07:00
- updated_at: 2025-05-22T06:48:54.416-07:00
schema:
- $ref: '#/components/schemas/retrospective_step_response'
- description: retrospective_step found
+ $ref: '#/components/schemas/incident_response'
+ description: assign user to incident
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Retrieves a retrospective step
+ summary: Assign user to incident
tags:
- - RetrospectiveSteps
+ - Incidents
+ x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- put:
- description: Update a specific retrospective step by id
- operationId: updateRetrospectiveStep
+ /v1/incidents/{id}/unassign_role_from_user:
+ delete:
+ description: Remove assigned user from incident
+ operationId: removeAssignedUserFromIncident
parameters:
- explode: false
in: path
name: id
required: true
schema:
- type: string
+ $ref: '#/components/schemas/getAlertField_id_parameter'
style: simple
requestBody:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/update_retrospective_step'
+ $ref: '#/components/schemas/unassign_role_from_user'
required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 11b3d18a-0b0f-45af-9dea-690d8479bae3
- type: retrospective_steps
- attributes:
- retrospective_process_id: c916291a-e55c-4226-ba5b-2e56bf83c524
- title: Step 2
- description: Step 2 description
- incident_role_id: 88463ed8-7530-464d-95b3-e08b0035126b
- due_after_days: 7
- position: 2
- skippable: true
- created_at: 2025-05-22T06:48:54.416-07:00
- updated_at: 2025-05-22T06:48:55.871-07:00
schema:
- $ref: '#/components/schemas/retrospective_step_response'
- description: retrospective_step updated
+ $ref: '#/components/schemas/incident_response'
+ description: remove assigned user from incident
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Update a retrospective step
+ summary: Remove assigned user from incident
tags:
- - RetrospectiveSteps
+ - Incidents
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/roles:
+ /v1/ip_ranges:
get:
- description: List roles
- operationId: listRoles
- parameters:
- - explode: true
+ description: Retrieves the IP ranges for rootly.com services
+ operationId: getIpRanges
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/ip_ranges_response'
+ description: ip_ranges found
+ security:
+ - bearer_auth: []
+ summary: Retrieves IP ranges
+ tags:
+ - IpRanges
+ x-accepts:
+ - application/vnd.api+json
+ /v1/live_call_routers:
+ get:
+ description: List Live Call Routers
+ operationId: listLiveCallRouters
+ parameters:
+ - explode: true
in: query
name: include
required: false
@@ -32978,14 +16736,14 @@ paths:
style: form
- explode: true
in: query
- name: "filter[slug]"
+ name: "filter[name]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[name]"
+ name: "filter[slug]"
required: false
schema:
type: string
@@ -33030,131 +16788,105 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/role_list'
+ $ref: '#/components/schemas/live_call_router_list'
description: success
security:
- bearer_auth: []
- summary: List roles
+ summary: List Live Call Routers
tags:
- - Roles
+ - LiveCallRouters
x-accepts:
- application/vnd.api+json
post:
- description: Creates a new role from provided data
- operationId: createRole
+ description: Creates a new Live Call Router from provided data
+ operationId: createLiveCallRouter
parameters: []
requestBody:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/new_role'
+ $ref: '#/components/schemas/new_live_call_router'
required: true
responses:
"201":
content:
application/vnd.api+json:
- example:
- data:
- id: d242838f-854f-4abb-bfb2-c61e3f561030
- type: roles
- attributes:
- team_id: 311
- name: Infrastructure
- slug: infrastructure
- is_deletable: true
- is_editable: true
- alerts_permissions:
- - create
- - read
- api_keys_permissions:
- - read
- audits_permissions: []
- billing_permissions:
- - update
- environments_permissions:
- - read
- form_fields_permissions:
- - read
- functionalities_permissions:
- - read
- groups_permissions:
- - read
- incident_causes_permissions:
- - read
- incident_feedbacks_permissions:
- - read
- - create
- - update
- incident_permission_set_id: 5d65be2f-1543-4d9c-8a50-399ac667308b
- incident_roles_permissions:
- - read
- incident_types_permissions:
- - read
- incidents_permissions:
- - read
- integrations_permissions: []
- invitations_permissions:
- - read
- playbooks_permissions:
- - read
- private_incidents_permissions: []
- pulses_permissions:
- - create
- - update
- - read
- retrospective_permissions:
- - read
- roles_permissions:
- - read
- secrets_permissions:
- - create
- services_permissions:
- - read
- severities_permissions:
- - read
- status_pages_permissions:
- - read
- webhooks_permissions:
- - read
- workflows_permissions:
- - read
- updated_at: 2025-05-22T06:48:59.976-07:00
- created_at: 2025-05-22T06:48:59.976-07:00
schema:
- $ref: '#/components/schemas/role_response'
- description: role created
+ $ref: '#/components/schemas/live_call_router_response'
+ description: live_call_router created with multiple targets without calling_tree_enabled
+ (backward compat)
"422":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Name can't be blank
- status: "422"
schema:
$ref: '#/components/schemas/errors_list'
description: invalid request
"401":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
description: responds with unauthorized for invalid token
security:
- bearer_auth: []
- summary: Creates a role
+ summary: Creates a Live Call Router
tags:
- - Roles
+ - LiveCallRouters
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/roles/{id}:
+ /v1/live_call_routers/generate_phone_number:
+ get:
+ description: Generates a phone number for Live Call Router
+ operationId: generatePhoneNumberLiveCallRouter
+ parameters:
+ - explode: true
+ in: query
+ name: country_code
+ required: true
+ schema:
+ enum:
+ - AU
+ - CA
+ - DE
+ - NL
+ - NZ
+ - SE
+ - GB
+ - US
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: phone_type
+ required: true
+ schema:
+ enum:
+ - local
+ - toll_free
+ - mobile
+ type: string
+ style: form
+ responses:
+ "200":
+ description: live_call_router phone number
+ "422":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: live_call_router without required params
+ security:
+ - bearer_auth: []
+ summary: Generates a phone number for Live Call Router
+ tags:
+ - LiveCallRouters
+ x-accepts:
+ - application/vnd.api+json
+ /v1/live_call_routers/{id}:
delete:
- description: Delete a specific role by id
- operationId: deleteRole
+ description: Delete a specific Live Call Router by id
+ operationId: deleteLiveCallRouter
parameters:
- explode: false
in: path
@@ -33167,96 +16899,25 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 30e8c1f6-65a3-4c6e-b566-46e3b069f119
- type: roles
- attributes:
- team_id: 322
- name: Role 15
- slug: role-15
- is_deletable: true
- is_editable: true
- alerts_permissions:
- - create
- - read
- api_keys_permissions:
- - read
- audits_permissions: []
- billing_permissions:
- - update
- environments_permissions:
- - read
- form_fields_permissions:
- - read
- functionalities_permissions:
- - read
- groups_permissions:
- - read
- incident_causes_permissions:
- - read
- incident_feedbacks_permissions:
- - read
- - create
- - update
- incident_permission_set_id: b16c70fc-214d-49af-842d-d7fe636a3206
- incident_roles_permissions:
- - read
- incident_types_permissions:
- - read
- incidents_permissions:
- - read
- integrations_permissions: []
- invitations_permissions:
- - read
- playbooks_permissions:
- - read
- private_incidents_permissions: []
- pulses_permissions:
- - create
- - update
- - read
- retrospective_permissions:
- - read
- roles_permissions:
- - read
- secrets_permissions:
- - create
- services_permissions:
- - read
- severities_permissions:
- - read
- status_pages_permissions:
- - read
- webhooks_permissions:
- - read
- workflows_permissions:
- - read
- updated_at: 2025-05-22T06:49:08.058-07:00
- created_at: 2025-05-22T06:49:07.874-07:00
schema:
- $ref: '#/components/schemas/role_response'
- description: role deleted
+ $ref: '#/components/schemas/live_call_router_response'
+ description: live_call_router deleted
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Delete a role
+ summary: Delete a Live Call Router
tags:
- - Roles
+ - LiveCallRouters
x-accepts:
- application/vnd.api+json
get:
- description: Retrieves a specific role by id
- operationId: getRole
+ description: Retrieves a specific Live Call Router by id
+ operationId: getLiveCallRouter
parameters:
- explode: false
in: path
@@ -33269,96 +16930,25 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: d261bb6d-0996-4e2b-b3d8-b9aff9c1f811
- type: roles
- attributes:
- team_id: 314
- name: Role 11
- slug: role-11
- is_deletable: true
- is_editable: true
- alerts_permissions:
- - create
- - read
- api_keys_permissions:
- - read
- audits_permissions: []
- billing_permissions:
- - update
- environments_permissions:
- - read
- form_fields_permissions:
- - read
- functionalities_permissions:
- - read
- groups_permissions:
- - read
- incident_causes_permissions:
- - read
- incident_feedbacks_permissions:
- - read
- - create
- - update
- incident_permission_set_id: 5e8ec31b-2461-478c-9602-b305ed3e3cb9
- incident_roles_permissions:
- - read
- incident_types_permissions:
- - read
- incidents_permissions:
- - read
- integrations_permissions: []
- invitations_permissions:
- - read
- playbooks_permissions:
- - read
- private_incidents_permissions: []
- pulses_permissions:
- - create
- - update
- - read
- retrospective_permissions:
- - read
- roles_permissions:
- - read
- secrets_permissions:
- - create
- services_permissions:
- - read
- severities_permissions:
- - read
- status_pages_permissions:
- - read
- webhooks_permissions:
- - read
- workflows_permissions:
- - read
- updated_at: 2025-05-22T06:49:02.727-07:00
- created_at: 2025-05-22T06:49:02.727-07:00
schema:
- $ref: '#/components/schemas/role_response'
- description: role found
+ $ref: '#/components/schemas/live_call_router_response'
+ description: live_call_router found
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Retrieves a role
+ summary: Retrieves a Live Call Router
tags:
- - Roles
+ - LiveCallRouters
x-accepts:
- application/vnd.api+json
put:
- description: Update a specific role by id
- operationId: updateRole
+ description: Update a specific Live Call Router by id
+ operationId: updateLiveCallRouter
parameters:
- explode: false
in: path
@@ -33371,127 +16961,54 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/update_role'
+ $ref: '#/components/schemas/update_live_call_router'
required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: ac9f0456-ef86-4bed-9335-e9016d67c608
- type: roles
- attributes:
- team_id: 318
- name: Security
- slug: role-13
- is_deletable: true
- is_editable: true
- alerts_permissions:
- - create
- - read
- api_keys_permissions:
- - read
- audits_permissions: []
- billing_permissions:
- - update
- environments_permissions:
- - read
- form_fields_permissions:
- - read
- functionalities_permissions:
- - read
- groups_permissions:
- - read
- incident_causes_permissions:
- - read
- incident_feedbacks_permissions:
- - read
- - create
- - update
- incident_permission_set_id: 15938326-11ec-4c4a-880b-0179691c618b
- incident_roles_permissions:
- - read
- incident_types_permissions:
- - read
- incidents_permissions:
- - read
- integrations_permissions: []
- invitations_permissions:
- - read
- playbooks_permissions:
- - read
- private_incidents_permissions: []
- pulses_permissions:
- - create
- - update
- - read
- retrospective_permissions:
- - read
- roles_permissions:
- - read
- secrets_permissions:
- - create
- services_permissions:
- - read
- severities_permissions:
- - read
- status_pages_permissions:
- - read
- webhooks_permissions:
- - read
- workflows_permissions:
- - read
- updated_at: 2025-05-22T06:49:05.449-07:00
- created_at: 2025-05-22T06:49:05.276-07:00
schema:
- $ref: '#/components/schemas/role_response'
- description: role updated
+ $ref: '#/components/schemas/live_call_router_response'
+ description: live_call_router updated
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Update a role
+ summary: Update a Live Call Router
tags:
- - Roles
+ - LiveCallRouters
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/schedule_rotations/{schedule_rotation_id}/schedule_rotation_active_days:
+ /v1/incidents/{incident_id}/meeting_recordings:
get:
- description: List schedule rotation active days
- operationId: listScheduleRotationActiveDays
+ description: "List all meeting recording sessions for an incident. Returns recordings\
+ \ sorted by session number. Each recording represents one bot session with\
+ \ its own transcript, status, and metadata."
+ operationId: listMeetingRecordings
parameters:
- - explode: false
+ - description: Incident UUID
+ explode: false
in: path
- name: schedule_rotation_id
+ name: incident_id
required: true
schema:
type: string
style: simple
- - explode: true
- in: query
- name: include
- required: false
- schema:
- type: string
- style: form
- - explode: true
+ - description: Page number
+ explode: true
in: query
name: "page[number]"
required: false
schema:
type: integer
style: form
- - explode: true
+ - description: Number of recordings per page
+ explode: true
in: query
name: "page[size]"
required: false
@@ -33503,87 +17020,67 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/schedule_rotation_active_day_list'
- description: success
+ $ref: '#/components/schemas/meeting_recording_list'
+ description: meeting recordings listed
+ "404":
+ description: incident not found
security:
- bearer_auth: []
- summary: List schedule rotation active days
+ summary: List meeting recordings
tags:
- - ScheduleRotationActiveDays
+ - Meeting Recordings
x-accepts:
- application/vnd.api+json
post:
- description: Creates a new schedule rotation active day from provided data
- operationId: createScheduleRotationActiveDay
+ description: "Invite a recording bot to the incident's meeting. If no previous\
+ \ recordings exist for the platform, a new bot is invited (session 1). If\
+ \ previous sessions exist, a new session is created (re-invite). The bot joins\
+ \ the meeting, records audio/video, and generates a transcript when the session\
+ \ ends."
+ operationId: createMeetingRecording
parameters:
- - explode: false
+ - description: Incident UUID
+ explode: false
in: path
- name: schedule_rotation_id
+ name: incident_id
required: true
schema:
type: string
style: simple
- requestBody:
- content:
- application/vnd.api+json:
- schema:
- $ref: '#/components/schemas/new_schedule_rotation_active_day'
- required: true
+ - description: Meeting platform
+ explode: true
+ in: query
+ name: platform
+ required: false
+ schema:
+ enum:
+ - zoom
+ - google_meet
+ - microsoft_teams
+ - webex
+ type: string
+ style: form
responses:
"201":
- content:
- application/vnd.api+json:
- example:
- data:
- id: 1a64aa56-6b69-4f65-b6cc-f0bfe687cd2d
- type: schedule_rotation_active_days
- attributes:
- schedule_rotation_id: 44207178-7700-468f-a976-782880106786
- day_name: M
- created_at: 2025-05-22T06:49:11.505-07:00
- updated_at: 2025-05-22T06:49:11.505-07:00
- active_time_attributes:
- - start_time: 07:30
- end_time: 16:30
- - start_time: 17:00
- end_time: 20:00
- schema:
- $ref: '#/components/schemas/schedule_rotation_active_day_response'
- description: schedule_rotation_active_day created
+ description: recording session created
"422":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Day name can't be blank
- status: "422"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: invalid request
- "401":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: responds with unauthorized for invalid token
+ description: validation error (e.g. bot already active)
security:
- bearer_auth: []
- summary: Creates a schedule rotation active day
+ summary: Create meeting recording
tags:
- - ScheduleRotationActiveDays
- x-content-type: application/vnd.api+json
+ - Meeting Recordings
x-accepts:
- - application/vnd.api+json
- /v1/schedule_rotation_active_days/{id}:
+ - application/json
+ /v1/meeting_recordings/{id}:
delete:
- description: Delete a specific schedule rotation active day
- operationId: deleteScheduleRotationActiveDay
+ description: "Delete a meeting recording. Only completed or failed recordings\
+ \ can be deleted. Active recordings (pending, recording, paused) must be stopped\
+ \ first."
+ operationId: deleteMeetingRecording
parameters:
- - explode: false
+ - description: Meeting Recording UUID
+ explode: false
in: path
name: id
required: true
@@ -33592,43 +17089,23 @@ paths:
style: simple
responses:
"200":
- content:
- application/vnd.api+json:
- example:
- data:
- id: 25b36265-8ff1-4159-8142-7e4d6c390dd2
- type: schedule_rotation_active_days
- attributes:
- schedule_rotation_id: 44207178-7700-468f-a976-782880106786
- day_name: S
- created_at: 2025-05-22T06:49:11.334-07:00
- updated_at: 2025-05-22T06:49:13.385-07:00
- active_time_attributes: []
- schema:
- $ref: '#/components/schemas/schedule_rotation_active_day_response'
- description: schedule_rotation_active_day deleted
- "404":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: resource not found
+ description: meeting recording deleted
+ "422":
+ description: cannot delete active recording
security:
- bearer_auth: []
- summary: Delete a schedule rotation active day
+ summary: Delete a meeting recording
tags:
- - ScheduleRotationActiveDays
+ - Meeting Recordings
x-accepts:
- - application/vnd.api+json
+ - application/json
get:
- description: Retrieves a specific schedule rotation active day by id
- operationId: getScheduleRotationActiveDay
+ description: "Retrieve a single meeting recording session including its status,\
+ \ duration, speaker count, word count, and transcript summary."
+ operationId: getMeetingRecording
parameters:
- - explode: false
+ - description: Meeting Recording UUID
+ explode: false
in: path
name: id
required: true
@@ -33637,103 +17114,154 @@ paths:
style: simple
responses:
"200":
- content:
- application/vnd.api+json:
- example:
- data:
- id: 25b36265-8ff1-4159-8142-7e4d6c390dd2
- type: schedule_rotation_active_days
- attributes:
- schedule_rotation_id: 44207178-7700-468f-a976-782880106786
- day_name: S
- created_at: 2025-05-22T06:49:11.334-07:00
- updated_at: 2025-05-22T06:49:11.334-07:00
- active_time_attributes: []
- schema:
- $ref: '#/components/schemas/schedule_rotation_active_day_response'
- description: schedule_rotation_active_day found
+ description: meeting recording found
"404":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: resource not found
+ description: meeting recording not found
security:
- bearer_auth: []
- summary: Retrieves a schedule rotation active day
+ summary: Get a meeting recording
tags:
- - ScheduleRotationActiveDays
+ - Meeting Recordings
x-accepts:
- - application/vnd.api+json
- put:
- description: Update a specific schedule rotation active day by id
- operationId: updateScheduleRotationActiveDay
+ - application/json
+ /v1/meeting_recordings/{id}/delete_video:
+ delete:
+ description: "Delete only the video file from a meeting recording. The transcript,\
+ \ summary, and all metadata are preserved. Only non-active recordings with\
+ \ an attached video can have their video deleted."
+ operationId: deleteMeetingRecordingVideo
parameters:
- - explode: false
+ - description: Meeting Recording UUID
+ explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
- requestBody:
- content:
- application/vnd.api+json:
- schema:
- $ref: '#/components/schemas/update_schedule_rotation_active_day'
+ responses:
+ "200":
+ description: video deleted
+ "422":
+ description: cannot delete video (active recording or no video)
+ security:
+ - bearer_auth: []
+ summary: Delete video from a meeting recording
+ tags:
+ - Meeting Recordings
+ x-accepts:
+ - application/json
+ /v1/meeting_recordings/{id}/pause:
+ post:
+ description: Pause an active recording session. The bot remains in the meeting
+ but stops capturing audio/video. Use the resume endpoint to continue recording.
+ operationId: pauseMeetingRecording
+ parameters:
+ - description: Meeting Recording UUID
+ explode: false
+ in: path
+ name: id
required: true
+ schema:
+ type: string
+ style: simple
responses:
"200":
- content:
- application/vnd.api+json:
- example:
- data:
- id: 25b36265-8ff1-4159-8142-7e4d6c390dd2
- type: schedule_rotation_active_days
- attributes:
- schedule_rotation_id: 44207178-7700-468f-a976-782880106786
- day_name: M
- created_at: 2025-05-22T06:49:11.334-07:00
- updated_at: 2025-05-22T06:49:12.729-07:00
- active_time_attributes:
- - start_time: 10:30
- end_time: 03:30
- schema:
- $ref: '#/components/schemas/schedule_rotation_active_day_response'
- description: schedule_rotation_active_day updated
- "404":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: resource not found
+ description: recording paused
+ "422":
+ description: recording is not active
security:
- bearer_auth: []
- summary: Update a schedule rotation active day
+ summary: Pause a meeting recording
tags:
- - ScheduleRotationActiveDays
- x-content-type: application/vnd.api+json
+ - Meeting Recordings
x-accepts:
- - application/vnd.api+json
- /v1/schedule_rotations/{schedule_rotation_id}/schedule_rotation_users:
- get:
- operationId: listScheduleRotationUsers
+ - application/json
+ /v1/meeting_recordings/{id}/resume:
+ post:
+ description: Resume a paused recording session. The bot continues capturing
+ audio/video from the meeting.
+ operationId: resumeMeetingRecording
parameters:
- - explode: false
+ - description: Meeting Recording UUID
+ explode: false
in: path
- name: schedule_rotation_id
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ responses:
+ "200":
+ description: recording resumed
+ "422":
+ description: recording is not paused
+ security:
+ - bearer_auth: []
+ summary: Resume a meeting recording
+ tags:
+ - Meeting Recordings
+ x-accepts:
+ - application/json
+ /v1/meeting_recordings/{id}/stop:
+ post:
+ description: "Stop an active or paused recording. The bot finishes processing,\
+ \ generates a transcript, and the session status transitions to completed.\
+ \ This is irreversible — to record again, create a new session."
+ operationId: stopMeetingRecording
+ parameters:
+ - description: Meeting Recording UUID
+ explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ responses:
+ "200":
+ description: recording stopped
+ "422":
+ description: recording cannot be stopped
+ security:
+ - bearer_auth: []
+ summary: Stop a meeting recording
+ tags:
+ - Meeting Recordings
+ x-accepts:
+ - application/json
+ /v1/meeting_recordings/{id}/leave:
+ post:
+ description: "Remove the recording bot from the meeting entirely. Unlike stop,\
+ \ this immediately disconnects the bot. The session will transition to analyzing\
+ \ and then completed once transcript processing finishes."
+ operationId: leaveMeetingRecording
+ parameters:
+ - description: Meeting Recording UUID
+ explode: false
+ in: path
+ name: id
required: true
schema:
type: string
style: simple
+ responses:
+ "200":
+ description: bot left the call
+ "422":
+ description: bot is not in a call
+ security:
+ - bearer_auth: []
+ summary: Leave a meeting call
+ tags:
+ - Meeting Recordings
+ x-accepts:
+ - application/json
+ /v1/on_call_pay_reports:
+ get:
+ description: List on-call pay reports
+ operationId: listOnCallPayReports
+ parameters:
- explode: true
in: query
name: include
@@ -33755,86 +17283,97 @@ paths:
schema:
type: integer
style: form
+ - explode: true
+ in: query
+ name: "filter[status]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][gt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][gte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][lt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][lte]"
+ required: false
+ schema:
+ type: string
+ style: form
responses:
"200":
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/schedule_rotation_user_list'
+ $ref: '#/components/schemas/on_call_pay_report_list'
description: success
security:
- bearer_auth: []
- summary: List schedule rotation users
+ summary: List On-Call Pay Reports
tags:
- - ScheduleRotationUsers
+ - OnCallPayReports
x-accepts:
- application/vnd.api+json
post:
- description: Creates a new schedule rotation user from provided data
- operationId: createScheduleRotationUser
- parameters:
- - explode: false
- in: path
- name: schedule_rotation_id
- required: true
- schema:
- type: string
- style: simple
+ description: Generates a new on-call pay report for the given date range. The
+ report is generated asynchronously.
+ operationId: createOnCallPayReport
+ parameters: []
requestBody:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/new_schedule_rotation_user'
+ $ref: '#/components/schemas/new_on_call_pay_report'
required: true
responses:
"201":
content:
application/vnd.api+json:
- example:
- data:
- id: cf52e2a4-231f-4704-aeda-3a32e77edb91
- type: schedule_rotation_users
- attributes:
- schedule_rotation_id: 1e9a0727-8c3b-41ef-901b-1793326a1e32
- user_id: 396
- position: 2
- created_at: 2025-05-22T06:49:15.316-07:00
- updated_at: 2025-05-22T06:49:15.316-07:00
schema:
- $ref: '#/components/schemas/schedule_rotation_user_response'
- description: schedule_rotation_user created
+ $ref: '#/components/schemas/on_call_pay_report_response'
+ description: on_call_pay_report created
"422":
content:
application/vnd.api+json:
- example:
- errors:
- - title: User must exist
- status: "422"
schema:
$ref: '#/components/schemas/errors_list'
description: invalid request
"401":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
description: responds with unauthorized for invalid token
security:
- bearer_auth: []
- summary: Creates a schedule rotation user
+ summary: Creates an On-Call Pay Report
tags:
- - ScheduleRotationUsers
+ - OnCallPayReports
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/schedule_rotation_users/{id}:
- delete:
- description: Delete a specific schedule rotation user by id
- operationId: deleteScheduleRotationUser
+ /v1/on_call_pay_reports/{id}:
+ get:
+ description: Retrieves a specific on-call pay report by id
+ operationId: getOnCallPayReport
parameters:
- explode: false
in: path
@@ -33843,43 +17382,36 @@ paths:
schema:
type: string
style: simple
+ - explode: true
+ in: query
+ name: include
+ required: false
+ schema:
+ type: string
+ style: form
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 5ea40d61-9c2b-44f4-9f22-88016153b42e
- type: schedule_rotation_users
- attributes:
- schedule_rotation_id: 1e9a0727-8c3b-41ef-901b-1793326a1e32
- user_id: 396
- position: 2
- created_at: 2025-05-22T06:49:15.136-07:00
- updated_at: 2025-05-22T06:49:17.137-07:00
schema:
- $ref: '#/components/schemas/schedule_rotation_user_response'
- description: schedule_rotation_user deleted
+ $ref: '#/components/schemas/on_call_pay_report_response'
+ description: on_call_pay_report found
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
- description: resource not found
+ description: resource not found for different team
security:
- bearer_auth: []
- summary: Delete a schedule rotation user
+ summary: Retrieves an On-Call Pay Report
tags:
- - ScheduleRotationUsers
+ - OnCallPayReports
x-accepts:
- application/vnd.api+json
- get:
- description: Retrieves a specific schedule rotation user by id
- operationId: getScheduleRotationUser
+ put:
+ description: Update a specific on-call pay report by id. Triggers report regeneration.
+ operationId: updateOnCallPayReport
parameters:
- explode: false
in: path
@@ -33888,43 +17420,43 @@ paths:
schema:
type: string
style: simple
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/update_on_call_pay_report'
+ required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 5ea40d61-9c2b-44f4-9f22-88016153b42e
- type: schedule_rotation_users
- attributes:
- schedule_rotation_id: 1e9a0727-8c3b-41ef-901b-1793326a1e32
- user_id: 396
- position: 2
- created_at: 2025-05-22T06:49:15.136-07:00
- updated_at: 2025-05-22T06:49:15.141-07:00
schema:
- $ref: '#/components/schemas/schedule_rotation_user_response'
- description: schedule_rotation_user found
+ $ref: '#/components/schemas/on_call_pay_report_response'
+ description: on_call_pay_report updated
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
- description: resource not found
+ description: not allowed when flipper disabled
+ "422":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: invalid request
security:
- bearer_auth: []
- summary: Retrieves a schedule rotation user
+ summary: Update an On-Call Pay Report
tags:
- - ScheduleRotationUsers
+ - OnCallPayReports
+ x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- put:
- description: Update a specific schedule rotation user by id
- operationId: updateScheduleRotationUser
+ /v1/on_call_pay_reports/{id}/regenerate:
+ post:
+ description: Triggers regeneration of an existing on-call pay report.
+ operationId: regenerateOnCallPayReport
parameters:
- explode: false
in: path
@@ -33933,59 +17465,31 @@ paths:
schema:
type: string
style: simple
- requestBody:
- content:
- application/vnd.api+json:
- schema:
- $ref: '#/components/schemas/update_schedule_rotation_user'
- required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 5ea40d61-9c2b-44f4-9f22-88016153b42e
- type: schedule_rotation_users
- attributes:
- schedule_rotation_id: 1e9a0727-8c3b-41ef-901b-1793326a1e32
- user_id: 396
- position: 2
- created_at: 2025-05-22T06:49:15.136-07:00
- updated_at: 2025-05-22T06:49:15.141-07:00
schema:
- $ref: '#/components/schemas/schedule_rotation_user_response'
- description: schedule_rotation_user updated
+ $ref: '#/components/schemas/on_call_pay_report_response'
+ description: on_call_pay_report regeneration triggered
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
- description: resource not found
+ description: on_call_pay_report not found
security:
- bearer_auth: []
- summary: Update schedule rotation user
+ summary: Regenerate an On-Call Pay Report
tags:
- - ScheduleRotationUsers
- x-content-type: application/vnd.api+json
+ - OnCallPayReports
x-accepts:
- application/vnd.api+json
- /v1/schedules/{schedule_id}/schedule_rotations:
+ /v1/on_call_roles:
get:
- description: List schedule rotations
- operationId: listScheduleRotations
+ description: List On-Call Roles
+ operationId: listOnCallRoles
parameters:
- - explode: false
- in: path
- name: schedule_id
- required: true
- schema:
- type: string
- style: simple
- explode: true
in: query
name: include
@@ -34007,6 +17511,55 @@ paths:
schema:
type: integer
style: form
+ - explode: true
+ in: query
+ name: "filter[search]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[slug]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[name]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][gt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][gte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][lt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][lte]"
+ required: false
+ schema:
+ type: string
+ style: form
- explode: true
in: query
name: sort
@@ -34019,94 +17572,56 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/schedule_rotation_list'
+ $ref: '#/components/schemas/on_call_role_list'
description: success
security:
- bearer_auth: []
- summary: List schedule rotations
+ summary: List On-Call Roles
tags:
- - ScheduleRotations
+ - OnCallRoles
x-accepts:
- application/vnd.api+json
post:
- description: Creates a new schedule rotation from provided data
- operationId: createScheduleRotation
- parameters:
- - explode: false
- in: path
- name: schedule_id
- required: true
- schema:
- type: string
- style: simple
+ description: Creates a new On-Call Role from provided data
+ operationId: createOnCallRole
+ parameters: []
requestBody:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/new_schedule_rotation'
+ $ref: '#/components/schemas/new_on_call_role'
required: true
responses:
"201":
content:
application/vnd.api+json:
- example:
- data:
- id: 9bca8e12-6584-4a04-8769-e6b06618b828
- type: schedule_rotations
- attributes:
- schedule_id: 2188f847-62d9-4f1c-a6d9-154609237188
- name: Schedule Rotation Name
- position: 1
- schedule_rotationable_type: ScheduleWeeklyRotation
- active_all_week: false
- active_days:
- - M
- - T
- active_time_type: same_time
- time_zone: American Samoa
- schedule_rotationable_attributes:
- handoff_time: 21:30
- handoff_day: T
- active_time_attributes:
- - start_time: 07:30
- end_time: 16:30
- - start_time: 17:00
- end_time: 21:00
schema:
- $ref: '#/components/schemas/schedule_rotation_response'
- description: schedule_rotation created with custom active times
+ $ref: '#/components/schemas/on_call_role_response'
+ description: on_call_role created
"422":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Name can't be blank
- status: "422"
schema:
$ref: '#/components/schemas/errors_list'
description: invalid request
"401":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
description: responds with unauthorized for invalid token
security:
- bearer_auth: []
- summary: Creates a schedule rotation
+ summary: Creates an On-Call Role
tags:
- - ScheduleRotations
+ - OnCallRoles
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/schedule_rotations/{id}:
+ /v1/on_call_roles/{id}:
delete:
- description: Delete a specific schedule rotation by id
- operationId: deleteScheduleRotation
+ description: Delete a specific On-Call Role by id
+ operationId: deleteOnCallRole
parameters:
- explode: false
in: path
@@ -34119,45 +17634,25 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: f4f11c33-ff57-44d1-b242-6115f3d4877b
- type: schedule_rotations
- attributes:
- schedule_id: 2188f847-62d9-4f1c-a6d9-154609237188
- name: Schedule Rotation 13
- position: 1
- schedule_rotationable_type: ScheduleDailyRotation
- active_all_week: true
- active_days: []
- active_time_type: all_day
- time_zone: UTC
- schedule_rotationable_attributes:
- handoff_time: 17:00
- active_time_attributes: []
schema:
- $ref: '#/components/schemas/schedule_rotation_response'
- description: schedule_rotation deleted
+ $ref: '#/components/schemas/on_call_role_response'
+ description: on_call_role deleted
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Delete a schedule rotation
+ summary: Delete an On-Call Role
tags:
- - ScheduleRotations
+ - OnCallRoles
x-accepts:
- application/vnd.api+json
get:
- description: Retrieves a specific schedule rotation by id
- operationId: getScheduleRotation
+ description: Retrieves a specific On-Call Role by id
+ operationId: getOnCallRole
parameters:
- explode: false
in: path
@@ -34170,45 +17665,25 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: f4f11c33-ff57-44d1-b242-6115f3d4877b
- type: schedule_rotations
- attributes:
- schedule_id: 2188f847-62d9-4f1c-a6d9-154609237188
- name: Schedule Rotation 13
- position: 1
- schedule_rotationable_type: ScheduleDailyRotation
- active_all_week: true
- active_days: []
- active_time_type: all_day
- time_zone: UTC
- schedule_rotationable_attributes:
- handoff_time: 17:00
- active_time_attributes: []
schema:
- $ref: '#/components/schemas/schedule_rotation_response'
- description: schedule_rotation found
+ $ref: '#/components/schemas/on_call_role_response'
+ description: on_call_role found
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Retrieves a schedule rotation
+ summary: Retrieves an On-Call Role
tags:
- - ScheduleRotations
+ - OnCallRoles
x-accepts:
- application/vnd.api+json
put:
- description: Update a specific schedule rotation by id
- operationId: updateScheduleRotation
+ description: Update a specific On-Call Role by id
+ operationId: updateOnCallRole
parameters:
- explode: false
in: path
@@ -34221,104 +17696,44 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/update_schedule_rotation'
+ $ref: '#/components/schemas/update_on_call_role'
required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: f4f11c33-ff57-44d1-b242-6115f3d4877b
- type: schedule_rotations
- attributes:
- schedule_id: 2188f847-62d9-4f1c-a6d9-154609237188
- name: Updated Schedule Rotation Name
- position: 1
- schedule_rotationable_type: ScheduleWeeklyRotation
- active_all_week: false
- active_days:
- - M
- - T
- active_time_type: same_time
- time_zone: American Samoa
- schedule_rotationable_attributes:
- handoff_time: 22:30
- handoff_day: T
- active_time_attributes:
- - start_time: 07:30
- end_time: 20:30
schema:
- $ref: '#/components/schemas/schedule_rotation_response'
- description: schedule_rotation updated
+ $ref: '#/components/schemas/on_call_role_response'
+ description: on_call_role updated
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Update a schedule rotation
+ summary: Update an On-Call Role
tags:
- - ScheduleRotations
+ - OnCallRoles
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/schedules:
+ /v1/schedules/{schedule_id}/on_call_shadows:
get:
- description: List schedules
- operationId: listSchedules
+ description: List shadow shifts for schedule
+ operationId: listOnCallShadows
parameters:
- - explode: true
- in: query
- name: include
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[search]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[name]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[created_at][gt]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[created_at][gte]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[created_at][lt]"
- required: false
+ - explode: false
+ in: path
+ name: schedule_id
+ required: true
schema:
type: string
- style: form
+ style: simple
- explode: true
in: query
- name: "filter[created_at][lte]"
+ name: include
required: false
schema:
type: string
@@ -34342,84 +17757,65 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/schedule_list'
+ $ref: '#/components/schemas/on_call_shadows_list'
description: success
security:
- bearer_auth: []
- summary: List schedules
+ summary: List On Call Shadows for Shift
tags:
- - Schedules
+ - OnCallShadows
x-accepts:
- application/vnd.api+json
post:
- description: Creates a new schedule from provided data
- operationId: createSchedule
- parameters: []
+ description: Creates a new on call shadow configuration from provided data
+ operationId: createOnCallShadow
+ parameters:
+ - explode: false
+ in: path
+ name: schedule_id
+ required: true
+ schema:
+ type: string
+ style: simple
requestBody:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/new_schedule'
+ $ref: '#/components/schemas/new_on_call_shadow'
required: true
responses:
"201":
content:
application/vnd.api+json:
- example:
- data:
- id: 7206f9d2-f171-4236-9b4b-0e8a958531e8
- type: schedules
- attributes:
- name: Schedule Name
- description: Schedule Description
- all_time_coverage: true
- slack_user_group: {}
- owner_user_id: 411
- owner_group_ids:
- - 19625879-8b2f-4240-b374-57e9c5386818
- created_at: 2025-05-22T06:49:32.843-07:00
- updated_at: 2025-05-22T06:49:32.843-07:00
- relationships:
- owner_user:
- data:
- id: "411"
- type: users
- escalation_policies:
- data: []
schema:
- $ref: '#/components/schemas/schedule_response'
- description: schedule created
+ $ref: '#/components/schemas/on_call_shadow_response'
+ description: shadow shift is created
"422":
content:
application/vnd.api+json:
- example:
- name:
- - can't be blank
schema:
$ref: '#/components/schemas/errors_list'
description: invalid request
"401":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
description: responds with unauthorized for invalid token
security:
- bearer_auth: []
- summary: Creates a schedule
+ summary: creates an shadow configuration
tags:
- - Schedules
+ - OnCallShadows
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/schedules/{id}:
+ /v1/on_call_shadows/{id}:
delete:
- description: Delete a specific schedule by id
- operationId: deleteSchedule
+ description: Delete a specific on call shadow configuration by id. Future shadows
+ are hard-deleted. Active shadows (started in the past) have their end time
+ truncated to preserve historical data.
+ operationId: deleteOnCallShadow
parameters:
- explode: false
in: path
@@ -34432,50 +17828,31 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 9d731214-f783-47b1-a5bd-ca7a3257cfc4
- type: schedules
- attributes:
- name: Schedule 10
- description: Schedule description
- all_time_coverage: false
- slack_user_group: {}
- owner_user_id: 411
- owner_group_ids:
- - 19625879-8b2f-4240-b374-57e9c5386818
- created_at: 2025-05-22T06:49:27.017-07:00
- updated_at: 2025-05-22T06:49:35.659-07:00
- relationships:
- owner_user:
- data:
- id: "411"
- type: users
- escalation_policies:
- data: []
schema:
- $ref: '#/components/schemas/schedule_response'
- description: schedule deleted
+ $ref: '#/components/schemas/on_call_shadow_response'
+ description: active shadow is preserved with truncated end time
+ "422":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: shadow period already ended
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Delete a schedule
+ summary: Delete an on call shadow configuration
tags:
- - Schedules
+ - OverrideShifts
x-accepts:
- application/vnd.api+json
get:
- description: Retrieves a specific schedule by id
- operationId: getSchedule
+ description: Retrieves a specific On Call Shadow configuration by ID
+ operationId: getOnCallShadow
parameters:
- explode: false
in: path
@@ -34488,50 +17865,25 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 9d731214-f783-47b1-a5bd-ca7a3257cfc4
- type: schedules
- attributes:
- name: Schedule 10
- description: Schedule description
- all_time_coverage: false
- slack_user_group: {}
- owner_user_id: 411
- owner_group_ids:
- - 19625879-8b2f-4240-b374-57e9c5386818
- created_at: 2025-05-22T06:49:27.017-07:00
- updated_at: 2025-05-22T06:49:27.017-07:00
- relationships:
- owner_user:
- data:
- id: "411"
- type: users
- escalation_policies:
- data: []
schema:
- $ref: '#/components/schemas/schedule_response'
- description: schedule found
+ $ref: '#/components/schemas/on_call_shadow_response'
+ description: override shift found
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Retrieves a schedule
+ summary: Retrieves an On Call Shadow configuration by ID
tags:
- - Schedules
+ - OnCallShadows
x-accepts:
- application/vnd.api+json
put:
- description: Updates a specific schedule by id
- operationId: updateSchedule
+ description: Update a specific on call shadow configuration by id
+ operationId: updateOnCallShadow
parameters:
- explode: false
in: path
@@ -34544,141 +17896,169 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/update_schedule'
+ $ref: '#/components/schemas/update_on_call_shadow'
required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 9d731214-f783-47b1-a5bd-ca7a3257cfc4
- type: schedules
- attributes:
- name: Updated schedule name
- description: Updated schedule description
- all_time_coverage: true
- slack_user_group: {}
- owner_user_id: 411
- owner_group_ids:
- - 19625879-8b2f-4240-b374-57e9c5386818
- created_at: 2025-05-22T06:49:27.017-07:00
- updated_at: 2025-05-22T06:49:35.054-07:00
- relationships:
- owner_user:
- data:
- id: "411"
- type: users
- escalation_policies:
- data: []
schema:
- $ref: '#/components/schemas/schedule_response'
- description: schedule updated
+ $ref: '#/components/schemas/on_call_shadow_response'
+ description: on call shadows configuration is is updated
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Update a schedule
+ summary: Update an On Call Shadow configuration
tags:
- - Schedules
+ - OnCallShadows
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/schedules/{id}/shifts:
+ /v1/oncalls:
get:
- description: Retrieves schedule shifts
- operationId: getScheduleShifts
+ description: "List who is currently on-call, with support for filtering by escalation\
+ \ policy, schedule, and user. Returns on-call entries grouped by escalation\
+ \ policy level."
+ operationId: listOncalls
parameters:
- - explode: false
- in: path
- name: id
- required: true
+ - description: "comma separated if needed. eg: user,schedule"
+ explode: true
+ in: query
+ name: include
+ required: false
+ schema:
+ enum:
+ - user
+ - schedule
+ - escalation_policy
+ type: string
+ style: form
+ - description: "Start of time range in ISO-8601 format (e.g., 2025-01-01T00:00:00Z).\
+ \ Defaults to current time."
+ explode: true
+ in: query
+ name: since
+ required: false
schema:
type: string
- style: simple
- - explode: true
+ style: form
+ - description: "End of time range in ISO-8601 format (e.g., 2025-01-01T00:00:00Z).\
+ \ Defaults to 'since' time."
+ explode: true
in: query
- name: to
+ name: until
required: false
schema:
type: string
style: form
- - explode: true
+ - description: "When true, returns only the first on-call user per escalation\
+ \ policy level"
+ explode: true
in: query
- name: from
+ name: earliest
+ required: false
+ schema:
+ type: boolean
+ style: form
+ - description: "Timezone for response times (e.g., America/New_York). Defaults\
+ \ to UTC."
+ explode: true
+ in: query
+ name: time_zone
+ required: false
+ schema:
+ type: string
+ style: form
+ - description: Comma-separated escalation policy IDs
+ explode: true
+ in: query
+ name: "filter[escalation_policy_ids]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - description: Comma-separated schedule IDs
+ explode: true
+ in: query
+ name: "filter[schedule_ids]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - description: Comma-separated user IDs
+ explode: true
+ in: query
+ name: "filter[user_ids]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - description: Comma-separated service IDs
+ explode: true
+ in: query
+ name: "filter[service_ids]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - description: Comma-separated group IDs (teams)
+ explode: true
+ in: query
+ name: "filter[group_ids]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - description: "Comma-separated notification types to include. One or both of:\
+ \ audible, quiet. When present, oncalls are returned from every non-deferral\
+ \ escalation path whose notification_type is in the filter, sorted audible-first.\
+ \ When absent, only the default path's oncalls are returned (existing behavior)."
+ explode: true
+ in: query
+ name: "filter[notification_types]"
required: false
schema:
type: string
style: form
responses:
"200":
+ description: success
+ "404":
content:
application/vnd.api+json:
- example:
- data:
- - id: 24df91bf-252d-498d-bfc3-42712ea7e5e2
- type: shifts
- attributes:
- schedule_id: 9d731214-f783-47b1-a5bd-ca7a3257cfc4
- rotation_id: e3ea123c-0868-4248-a9bc-cb484cd8909f
- starts_at: 2025-05-22T04:49:28.000-07:00
- ends_at: 2025-05-22T08:49:28.000-07:00
- is_override: true
- relationships:
- shift_override:
- data: null
- user:
- data:
- id: "436"
- type: users
- - id: 4295f5ba-0962-4d5f-870b-11b2b13f3222
- type: shifts
- attributes:
- schedule_id: 9d731214-f783-47b1-a5bd-ca7a3257cfc4
- rotation_id: 862098d1-4463-431b-9692-8443781b829d
- starts_at: 2025-05-22T09:49:29.000-07:00
- ends_at: 2025-05-22T13:49:29.000-07:00
- is_override: false
- relationships:
- shift_override:
- data: null
- user:
- data:
- id: "440"
- type: users
schema:
- $ref: '#/components/schemas/shift_list'
- description: schedule shifts found
- "404":
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found when alerting is disabled
+ "401":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
- description: resource not found
+ description: responds with unauthorized for invalid token
security:
- bearer_auth: []
- summary: Retrieves a schedule shifts
+ summary: List on-calls
tags:
- - Shifts
+ - OnCalls
x-accepts:
- application/vnd.api+json
- /v1/secrets:
+ /v1/schedules/{schedule_id}/override_shifts:
get:
- description: List secrets
- operationId: listSecrets
+ description: List override shifts
+ operationId: listOverrideShifts
parameters:
+ - explode: false
+ in: path
+ name: schedule_id
+ required: true
+ schema:
+ type: string
+ style: simple
- explode: true
in: query
name: include
@@ -34705,77 +18085,65 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/secret_list'
+ $ref: '#/components/schemas/override_shift_list'
description: success
security:
- bearer_auth: []
- summary: List secrets
+ summary: List override shifts
tags:
- - Secrets
+ - OverrideShifts
x-accepts:
- application/vnd.api+json
post:
- description: Creates a new secret from provided data
- operationId: createSecret
- parameters: []
+ description: "Creates a new override shift from provided data. If any existing\
+ \ override shifts overlap with the specified time range, they will be automatically\
+ \ deleted and replaced by the new override."
+ operationId: createOverrideShift
+ parameters:
+ - explode: false
+ in: path
+ name: schedule_id
+ required: true
+ schema:
+ type: string
+ style: simple
requestBody:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/new_secret'
+ $ref: '#/components/schemas/new_override_shift'
required: true
responses:
"201":
content:
application/vnd.api+json:
- example:
- data:
- id: 5cff925c-fa00-4225-8629-3b044b573101
- type: secrets
- attributes:
- kind: built_in
- name: zohlxtfwlq
- secret: "[REDACTED]"
- hashicorp_vault_mount: secret
- hashicorp_vault_path: null
- hashicorp_vault_version: 0
- created_at: 2025-05-22T06:49:39.711-07:00
- updated_at: 2025-05-22T06:49:39.711-07:00
schema:
- $ref: '#/components/schemas/secret_response'
- description: secret created
+ $ref: '#/components/schemas/override_shift_response'
+ description: returns assignee relationship when schedule nesting enabled
"422":
content:
application/vnd.api+json:
- example:
- errors:
- - title: "Name only allows letters, numbers, and underscore"
- status: "422"
schema:
$ref: '#/components/schemas/errors_list'
- description: invalid request
+ description: cannot create schedule-based override shift
"401":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
description: responds with unauthorized for invalid token
security:
- bearer_auth: []
- summary: Creates a secret
+ summary: creates an override shift
tags:
- - Secrets
+ - OverrideShifts
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/secrets/{id}:
+ /v1/override_shifts/{id}:
delete:
- description: Delete a specific secret by id
- operationId: deleteSecret
+ description: Delete a specific override shift by id
+ operationId: deleteOverrideShift
parameters:
- explode: false
in: path
@@ -34788,42 +18156,25 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 4a927218-1c77-4b88-91de-ea46017b20f6
- type: secrets
- attributes:
- kind: built_in
- name: scqzwvxemk
- secret: "[REDACTED]"
- hashicorp_vault_mount: secret
- hashicorp_vault_path: null
- hashicorp_vault_version: 0
- created_at: 2025-05-22T06:49:37.760-07:00
- updated_at: 2025-05-22T06:49:41.519-07:00
schema:
- $ref: '#/components/schemas/secret_response'
- description: secret deleted
+ $ref: '#/components/schemas/override_shift_response'
+ description: override shift deleted
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Delete a secret
+ summary: Delete an override shift
tags:
- - Secrets
+ - OverrideShifts
x-accepts:
- application/vnd.api+json
get:
- description: Retrieve a specific secret by id
- operationId: getSecret
+ description: Retrieves a specific override shift by id
+ operationId: getOverrideShift
parameters:
- explode: false
in: path
@@ -34836,42 +18187,25 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 4a927218-1c77-4b88-91de-ea46017b20f6
- type: secrets
- attributes:
- kind: built_in
- name: scqzwvxemk
- secret: "[REDACTED]"
- hashicorp_vault_mount: secret
- hashicorp_vault_path: null
- hashicorp_vault_version: 0
- created_at: 2025-05-22T06:49:37.760-07:00
- updated_at: 2025-05-22T06:49:37.760-07:00
schema:
- $ref: '#/components/schemas/secret_response'
- description: secret found
+ $ref: '#/components/schemas/override_shift_response'
+ description: override shift found
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Retrieves a secret
+ summary: Retrieves an override shift
tags:
- - Secrets
+ - OverrideShifts
x-accepts:
- application/vnd.api+json
put:
- description: Update a specific secret by id
- operationId: updateSecret
+ description: Update a specific override shift by id
+ operationId: updateOverrideShift
parameters:
- explode: false
in: path
@@ -34884,51 +18218,41 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/update_secret'
+ $ref: '#/components/schemas/update_override_shift'
required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 4a927218-1c77-4b88-91de-ea46017b20f6
- type: secrets
- attributes:
- kind: built_in
- name: foo_bar
- secret: "[REDACTED]"
- hashicorp_vault_mount: secret
- hashicorp_vault_path: null
- hashicorp_vault_version: 0
- created_at: 2025-05-22T06:49:37.760-07:00
- updated_at: 2025-05-22T06:49:40.965-07:00
schema:
- $ref: '#/components/schemas/secret_response'
- description: secret updated
+ $ref: '#/components/schemas/override_shift_response'
+ description: override shift updated
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Update a secret
+ summary: Update an override shift
tags:
- - Secrets
+ - OverrideShifts
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/services:
+ /v1/playbooks/{playbook_id}/playbook_tasks:
get:
- description: List services
- operationId: listServices
+ description: List playbook tasks
+ operationId: listPlaybookTasks
parameters:
+ - explode: false
+ in: path
+ name: playbook_id
+ required: true
+ schema:
+ type: string
+ style: simple
- explode: true
in: query
name: include
@@ -34950,200 +18274,68 @@ paths:
schema:
type: integer
style: form
- - explode: true
- in: query
- name: "filter[search]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[name]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[slug]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[backstage_id]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[cortex_id]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[opslevel_id]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[external_id]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[created_at][gt]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[created_at][gte]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[created_at][lt]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[created_at][lte]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: sort
- required: false
- schema:
- type: string
- style: form
responses:
"200":
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/service_list'
+ $ref: '#/components/schemas/playbook_task_list'
description: success
security:
- bearer_auth: []
- summary: List services
+ summary: List playbook tasks
tags:
- - Services
+ - PlaybookTasks
x-accepts:
- application/vnd.api+json
post:
- description: Creates a new service from provided data
- operationId: createService
- parameters: []
+ description: Creates a new task from provided data
+ operationId: createPlaybookTask
+ parameters:
+ - explode: false
+ in: path
+ name: playbook_id
+ required: true
+ schema:
+ type: string
+ style: simple
requestBody:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/new_service'
+ $ref: '#/components/schemas/new_playbook_task'
required: true
responses:
"201":
content:
application/vnd.api+json:
- example:
- data:
- id: 4ad5d834-c81c-4cc4-bfe0-d13b671c5e38
- type: services
- attributes:
- name: elasticsearch-prod
- slug: elasticsearch-prod
- description: Elastisearch
- public_description: Public description
- notify_emails:
- - john@rootly.com
- - doe@rootly.com
- color: '#FFF'
- status: operational
- position: 1
- show_uptime: true
- show_uptime_last_days: 60
- slack_channels:
- - id: C03MKDSEJE8
- name: elastisearch
- slack_aliases:
- - id: S03F7QUV7F1
- name: engineering
- github_repository_name: rootlyhq/my-github-service
- github_repository_branch: main
- gitlab_repository_name: rootlyhq/my-gitlab-service
- gitlab_repository_branch: main
- opsgenie_id: 8743a1b2-11da-480e-8493-744660987bef
- pagerduty_id: PQ9K7I8
- backstage_id: null
- external_id: d795fe69-acc2-4b30-92c9-3c25cbb92056
- cortex_id: null
- service_now_ci_sys_id: null
- environment_ids:
- - 2d1341fa-f01c-4b43-81d7-aedc5940e6ee
- service_ids:
- - a76b105f-3a3e-4262-a7fe-9a34b6102ca5
- owners_group_ids:
- - eeaeef59-8b40-4581-a60f-1ef228b6bf04
- owners_user_ids:
- - 443
- incidents_count: 0
- alert_urgency_id: null
- alerts_email_enabled: true
- alerts_email_address: service-88f1ad8c69f61937a116dc3baa683e21@test.email.rootly.com
- created_at: 2025-05-22T06:49:50.624-07:00
- updated_at: 2025-05-22T06:49:50.624-07:00
schema:
- $ref: '#/components/schemas/service_response'
- description: service created
+ $ref: '#/components/schemas/playbook_task_response'
+ description: playbook_task created
"422":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Name can't be blank
- status: "422"
schema:
$ref: '#/components/schemas/errors_list'
description: invalid request
"401":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
description: responds with unauthorized for invalid token
security:
- bearer_auth: []
- summary: Creates a service
+ summary: Creates a playbook task
tags:
- - Services
+ - PlaybookTasks
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/services/{id}:
+ /v1/playbook_tasks/{id}:
delete:
- description: Delete a specific service by id
- operationId: deleteService
+ description: Delete a specific playbook task by id
+ operationId: deletePlaybookTask
parameters:
- explode: false
in: path
@@ -35156,66 +18348,25 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: a76b105f-3a3e-4262-a7fe-9a34b6102ca5
- type: services
- attributes:
- name: Rerum reiciendis rem ad.
- slug: rerum-reiciendis-rem-ad
- description: Itaque dolorum quam nesciunt.
- public_description: null
- notify_emails: []
- color: '#D7F5E1'
- status: partial_outage
- position: 1
- show_uptime: true
- show_uptime_last_days: 60
- slack_channels: []
- slack_aliases: []
- github_repository_name: null
- github_repository_branch: master
- gitlab_repository_name: null
- gitlab_repository_branch: master
- opsgenie_id: null
- pagerduty_id: null
- backstage_id: null
- external_id: null
- cortex_id: null
- service_now_ci_sys_id: null
- environment_ids: []
- service_ids: []
- owners_group_ids: []
- owners_user_ids: []
- incidents_count: 1
- alert_urgency_id: null
- alerts_email_enabled: false
- alerts_email_address: service-f22a5a93351479dc1578799bcce662e6@email.rootly.com
- created_at: 2025-05-22T06:49:42.882-07:00
- updated_at: 2025-05-22T06:49:54.516-07:00
schema:
- $ref: '#/components/schemas/service_response'
- description: service deleted
+ $ref: '#/components/schemas/playbook_task_response'
+ description: playbook_task deleted
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Delete a service
+ summary: Delete a playbook task
tags:
- - Services
+ - PlaybookTasks
x-accepts:
- application/vnd.api+json
get:
- description: Retrieves a specific service by id
- operationId: getService
+ description: Retrieves a specific playbook_task by id
+ operationId: getPlaybookTask
parameters:
- explode: false
in: path
@@ -35228,66 +18379,25 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: a76b105f-3a3e-4262-a7fe-9a34b6102ca5
- type: services
- attributes:
- name: Rerum reiciendis rem ad.
- slug: rerum-reiciendis-rem-ad
- description: Itaque dolorum quam nesciunt.
- public_description: null
- notify_emails: []
- color: '#D7F5E1'
- status: partial_outage
- position: 1
- show_uptime: true
- show_uptime_last_days: 60
- slack_channels: []
- slack_aliases: []
- github_repository_name: null
- github_repository_branch: master
- gitlab_repository_name: null
- gitlab_repository_branch: master
- opsgenie_id: null
- pagerduty_id: null
- backstage_id: null
- external_id: null
- cortex_id: null
- service_now_ci_sys_id: null
- environment_ids: []
- service_ids: []
- owners_group_ids: []
- owners_user_ids: []
- incidents_count: 1
- alert_urgency_id: null
- alerts_email_enabled: false
- alerts_email_address: service-f22a5a93351479dc1578799bcce662e6@email.rootly.com
- created_at: 2025-05-22T06:49:42.882-07:00
- updated_at: 2025-05-22T06:49:43.200-07:00
schema:
- $ref: '#/components/schemas/service_response'
- description: service found
+ $ref: '#/components/schemas/playbook_task_response'
+ description: playbook_task found
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Retrieves a service
+ summary: Retrieves a playbook task
tags:
- - Services
+ - PlaybookTasks
x-accepts:
- application/vnd.api+json
put:
- description: Update a specific service by id
- operationId: updateService
+ description: Update a specific playbook task by id
+ operationId: updatePlaybookTask
parameters:
- explode: false
in: path
@@ -35300,203 +18410,48 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/update_service'
+ $ref: '#/components/schemas/update_playbook_task'
required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: a76b105f-3a3e-4262-a7fe-9a34b6102ca5
- type: services
- attributes:
- name: elasticsearch-staging
- slug: rerum-reiciendis-rem-ad
- description: Elastisearch
- public_description: Public description updated
- notify_emails:
- - hello@rootly.com
- - world@rootly.com
- color: '#FFF'
- status: partial_outage
- position: 2
- show_uptime: true
- show_uptime_last_days: 60
- slack_channels:
- - id: C03MKDSEJE8
- name: elastisearch
- slack_aliases:
- - id: S03F7QUV7F1
- name: leadership
- github_repository_name: rootlyhq/my-another-github-service
- github_repository_branch: master
- gitlab_repository_name: rootlyhq/my-another-gitlab-service
- gitlab_repository_branch: master
- opsgenie_id: 8743a1b2-11da-480e-8493-744660987bec
- pagerduty_id: PQ9K7I9
- backstage_id: null
- external_id: 33bfcc62-cc35-46e6-a270-8c52a56fb358
- cortex_id: null
- service_now_ci_sys_id: null
- environment_ids:
- - 2d1341fa-f01c-4b43-81d7-aedc5940e6ee
- service_ids:
- - a76b105f-3a3e-4262-a7fe-9a34b6102ca5
- owners_group_ids: []
- owners_user_ids: []
- incidents_count: 1
- alert_urgency_id: null
- alerts_email_enabled: false
- alerts_email_address: service-f22a5a93351479dc1578799bcce662e6@email.rootly.com
- created_at: 2025-05-22T06:49:42.882-07:00
- updated_at: 2025-05-22T06:49:52.848-07:00
schema:
- $ref: '#/components/schemas/service_response'
- description: service updated
+ $ref: '#/components/schemas/playbook_task_response'
+ description: playbook_task updated
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Update a service
+ summary: Update a playbook task
tags:
- - Services
+ - PlaybookTasks
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/services/{id}/incidents_chart:
+ /v1/playbooks:
get:
- description: Get service incidents chart
- operationId: getServiceIncidentsChart
+ description: List playbooks
+ operationId: listPlaybooks
parameters:
- - explode: false
- in: path
- name: id
- required: true
- schema:
- type: string
- style: simple
- - explode: true
+ - description: "comma separated if needed. eg: severities,environments,services"
+ explode: true
in: query
- name: period
- required: true
- schema:
- type: string
- style: form
- responses:
- "200":
- content:
- application/vnd.api+json:
- example:
- data:
- "2025-03-23 00:00:00 UTC": 0
- "2025-03-30 00:00:00 UTC": 0
- "2025-04-06 00:00:00 UTC": 0
- "2025-04-13 00:00:00 UTC": 0
- "2025-04-20 00:00:00 UTC": 0
- "2025-04-27 00:00:00 UTC": 0
- "2025-05-04 00:00:00 UTC": 0
- "2025-05-11 00:00:00 UTC": 0
- "2025-05-18 00:00:00 UTC": 1
- schema:
- $ref: '#/components/schemas/incidents_chart_response'
- description: success
- "404":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: resource not found
- security:
- - bearer_auth: []
- summary: Get service incidents chart
- tags:
- - Services
- x-accepts:
- - application/vnd.api+json
- /v1/services/{id}/uptime_chart:
- get:
- description: Get service uptime chart
- operationId: getServiceUptimeChart
- parameters:
- - explode: false
- in: path
- name: id
- required: true
- schema:
- type: string
- style: simple
- - explode: true
- in: query
- name: period
- required: false
- schema:
- type: string
- style: form
- responses:
- "200":
- content:
- application/vnd.api+json:
- example:
- data:
- "2025-05-07": 100.0
- "2025-05-08": 100.0
- "2025-05-09": 100.0
- "2025-05-10": 100.0
- "2025-05-11": 100.0
- "2025-05-12": 100.0
- "2025-05-13": 100.0
- "2025-05-14": 100.0
- "2025-05-15": 100.0
- "2025-05-16": 100.0
- "2025-05-17": 100.0
- "2025-05-18": 100.0
- "2025-05-19": 50.0
- "2025-05-20": 0.0
- "2025-05-21": 100.0
- "2025-05-22": 100.0
- schema:
- $ref: '#/components/schemas/uptime_chart_response'
- description: success
- "404":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: resource not found
- security:
- - bearer_auth: []
- summary: Get service uptime chart
- tags:
- - Services
- x-accepts:
- - application/vnd.api+json
- /v1/severities:
- get:
- description: List severities
- operationId: listSeverities
- parameters:
- - explode: true
- in: query
- name: include
- required: false
+ name: include
+ required: false
schema:
+ enum:
+ - severities
+ - environments
+ - services
+ - functionalities
+ - groups
+ - causes
+ - incident_types
type: string
style: form
- explode: true
@@ -35513,161 +18468,61 @@ paths:
schema:
type: integer
style: form
- - explode: true
- in: query
- name: "filter[search]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[slug]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[name]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[severity]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[color]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[created_at][gt]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[created_at][gte]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[created_at][lt]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[created_at][lte]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: sort
- required: false
- schema:
- type: string
- style: form
responses:
"200":
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/severity_list'
+ $ref: '#/components/schemas/playbook_list'
description: success
security:
- bearer_auth: []
- summary: List severities
+ summary: List playbooks
tags:
- - Severities
+ - Playbooks
x-accepts:
- application/vnd.api+json
post:
- description: Creates a new severity from provided data
- operationId: createSeverity
+ description: Creates a new playbook from provided data
+ operationId: createPlaybook
parameters: []
requestBody:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/new_severity'
+ $ref: '#/components/schemas/new_playbook'
required: true
responses:
"201":
content:
application/vnd.api+json:
- example:
- data:
- id: 161f88ac-9a83-4423-ba73-07a56d85158d
- type: severities
- attributes:
- name: P0
- slug: p0
- description: High Priority
- severity: medium
- color: '#E58A1F'
- position: 1
- notify_emails:
- - hello@rootly.com
- - world@rootly.com
- slack_channels:
- - id: C03MKDSEJE8
- name: elastisearch
- slack_aliases:
- - id: S03F7QUV7F1
- name: leadership
- created_at: 2025-05-22T06:50:00.291-07:00
- updated_at: 2025-05-22T06:50:00.291-07:00
schema:
- $ref: '#/components/schemas/severity_response'
- description: severity created
+ $ref: '#/components/schemas/playbook_response'
+ description: playbook created
"422":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Name can't be blank
- status: "422"
schema:
$ref: '#/components/schemas/errors_list'
description: invalid request
"401":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
description: responds with unauthorized for invalid token
security:
- bearer_auth: []
- summary: Creates a severity
+ summary: Creates a playbook
tags:
- - Severities
+ - Playbooks
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/severities/{id}:
+ /v1/playbooks/{id}:
delete:
- description: Delete a specific severity by id
- operationId: deleteSeverity
+ description: Delete a specific playbook by id
+ operationId: deletePlaybook
parameters:
- explode: false
in: path
@@ -35680,45 +18535,25 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: aa938f87-3c36-41fd-97b8-dff1b1447a21
- type: severities
- attributes:
- name: 824n0
- slug: 824n0
- description: Non omnis ut laboriosam.
- severity: medium
- color: '#E58A1F'
- position: 1
- notify_emails: []
- slack_channels: []
- slack_aliases: []
- created_at: 2025-05-22T06:49:58.004-07:00
- updated_at: 2025-05-22T06:50:02.085-07:00
schema:
- $ref: '#/components/schemas/severity_response'
- description: severity deleted
+ $ref: '#/components/schemas/playbook_response'
+ description: playbook deleted
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Delete a severity
+ summary: Delete a playbook
tags:
- - Severities
+ - Playbooks
x-accepts:
- application/vnd.api+json
get:
- description: Retrieves a specific severity by id
- operationId: getSeverity
+ description: Retrieves a specific playbook by id
+ operationId: getPlaybook
parameters:
- explode: false
in: path
@@ -35727,49 +18562,45 @@ paths:
schema:
type: string
style: simple
+ - description: "comma separated if needed. eg: severities,environments,services"
+ explode: true
+ in: query
+ name: include
+ required: false
+ schema:
+ enum:
+ - severities
+ - environments
+ - services
+ - functionalities
+ - groups
+ - causes
+ - incident_types
+ type: string
+ style: form
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: aa938f87-3c36-41fd-97b8-dff1b1447a21
- type: severities
- attributes:
- name: 824n0
- slug: 824n0
- description: Non omnis ut laboriosam.
- severity: medium
- color: '#E58A1F'
- position: 1
- notify_emails: []
- slack_channels: []
- slack_aliases: []
- created_at: 2025-05-22T06:49:58.004-07:00
- updated_at: 2025-05-22T06:49:58.004-07:00
schema:
- $ref: '#/components/schemas/severity_response'
- description: severity found
+ $ref: '#/components/schemas/playbook_response'
+ description: playbook found
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Retrieves a severity
+ summary: Retrieves a playbook
tags:
- - Severities
+ - Playbooks
x-accepts:
- application/vnd.api+json
put:
- description: Update a specific severity by id
- operationId: updateSeverity
+ description: Update a specific playbook by id
+ operationId: updatePlaybook
parameters:
- explode: false
in: path
@@ -35782,167 +18613,34 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/update_severity'
+ $ref: '#/components/schemas/update_playbook'
required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: aa938f87-3c36-41fd-97b8-dff1b1447a21
- type: severities
- attributes:
- name: P1
- slug: p1
- description: Medium Priority
- severity: medium
- color: '#000'
- position: 2
- notify_emails: []
- slack_channels: []
- slack_aliases: []
- created_at: 2025-05-22T06:49:58.004-07:00
- updated_at: 2025-05-22T06:50:01.537-07:00
schema:
- $ref: '#/components/schemas/severity_response'
- description: severity updated
+ $ref: '#/components/schemas/playbook_response'
+ description: playbook updated
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Update a severity
+ summary: Update a playbook
tags:
- - Severities
+ - Playbooks
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/shifts:
- get:
- description: List shifts
- operationId: listShifts
- parameters:
- - description: "comma separated if needed. eg: shift_override,user"
- explode: true
- in: query
- name: include
- required: false
- schema:
- enum:
- - shift_override
- - user
- type: string
- style: form
- - description: Start range for shifts
- explode: true
- in: query
- name: to
- required: false
- schema:
- type: string
- style: form
- - description: End range for shifts
- explode: true
- in: query
- name: from
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "user_ids[]"
- required: false
- schema:
- items:
- type: integer
- type: array
- style: form
- - explode: true
- in: query
- name: "schedule_ids[]"
- required: false
- schema:
- items:
- type: string
- type: array
- style: form
- responses:
- "200":
- content:
- application/vnd.api+json:
- example:
- data:
- - id: 5e7bb8ac-ae6d-4535-80e0-2d33a4837f88
- type: shifts
- attributes:
- schedule_id: 2e7e2260-b5da-44c7-a579-f47c62de8508
- rotation_id: c9de8171-51e8-45ea-b2bb-12f1a090d8b1
- starts_at: 2024-07-02T21:00:00.000-07:00
- ends_at: 2024-07-02T23:00:00.000-07:00
- is_override: true
- relationships:
- shift_override:
- data: null
- user:
- data:
- id: "449"
- type: users
- - id: 90f27b4f-08e7-42b0-b4b7-272900b32a57
- type: shifts
- attributes:
- schedule_id: 2e7e2260-b5da-44c7-a579-f47c62de8508
- rotation_id: 6b860d0b-2f77-458e-ba53-c8bf8ca9701d
- starts_at: 2024-07-02T19:00:00.000-07:00
- ends_at: 2024-07-02T21:00:00.000-07:00
- is_override: false
- relationships:
- shift_override:
- data: null
- user:
- data:
- id: "449"
- type: users
- schema:
- $ref: '#/components/schemas/shift_list'
- description: success
- "404":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: resource not found
- security:
- - bearer_auth: []
- summary: List shifts
- tags:
- - Shifts
- x-accepts:
- - application/vnd.api+json
- /v1/status-pages/{status_page_id}/templates:
+ /v1/post_mortem_templates:
get:
- description: List status page templates
- operationId: listStatusPageTemplates
+ description: List Retrospective Templates
+ operationId: listPostmortemTemplates
parameters:
- - explode: false
- in: path
- name: status_page_id
- required: true
- schema:
- type: string
- style: simple
- explode: true
in: query
name: include
@@ -35969,246 +18667,157 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/status_page_template_list'
+ $ref: '#/components/schemas/post_mortem_template_list'
description: success
security:
- bearer_auth: []
- summary: List status page templates
+ summary: List Retrospective Templates
tags:
- - StatusPageTemplates
+ - RetrospectiveTemplates
x-accepts:
- application/vnd.api+json
post:
- description: Creates a new template from provided data
- operationId: createStatusPageTemplate
- parameters:
- - explode: false
- in: path
- name: status_page_id
- required: true
- schema:
- type: string
- style: simple
+ description: Creates a new Retrospective Template from provided data
+ operationId: createPostmortemTemplate
+ parameters: []
requestBody:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/status_page_template'
+ $ref: '#/components/schemas/new_post_mortem_template'
required: true
responses:
"201":
content:
application/vnd.api+json:
- example:
- data:
- id: 785226b2-d3a3-49cb-9a9a-bcec04668964
- type: status_page_templates
- attributes:
- status_page_id: 19e4076a-6b1e-4d08-be59-fc812c81cfaf
- title: Created from API
- body: This was created from API.
- update_status: null
- should_notify_subscribers: false
- position: 4
- enabled: true
- created_at: 2025-05-22T06:50:07.450-07:00
- updated_at: 2025-05-22T06:50:07.450-07:00
- kind: normal
schema:
- $ref: '#/components/schemas/status_page_template_response'
- description: incident_event created
+ $ref: '#/components/schemas/post_mortem_template_response'
+ description: post_mortem_template created with TipTap blocks
"422":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Title can't be blank
- status: "422"
- - title: Body can't be blank
- status: "422"
schema:
$ref: '#/components/schemas/errors_list'
description: invalid request
"401":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
description: responds with unauthorized for invalid token
security:
- bearer_auth: []
- summary: Creates a status page template
+ summary: Creates a retrospective template
tags:
- - StatusPageTemplates
+ - RetrospectiveTemplates
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/templates/{id}:
+ /v1/post_mortem_templates/{id}:
delete:
- description: Delete a specific template event by id
- operationId: deleteStatusPageTemplate
+ description: Delete a specific Retrospective Template by id
+ operationId: deletePostmortemTemplate
parameters:
- explode: false
in: path
name: id
required: true
schema:
- type: string
+ $ref: '#/components/schemas/getAlertField_id_parameter'
style: simple
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 14d5f69e-f426-4e1a-803f-cde825a05669
- type: status_page_templates
- attributes:
- status_page_id: 19e4076a-6b1e-4d08-be59-fc812c81cfaf
- title: Sint
- body: Necessitatibus quis libero alias.
- update_status: null
- should_notify_subscribers: false
- position: 1
- enabled: true
- created_at: 2025-05-22T06:50:07.172-07:00
- updated_at: 2025-05-22T06:50:10.041-07:00
- kind: normal
schema:
- $ref: '#/components/schemas/status_page_template_response'
- description: incident_event deleted
+ $ref: '#/components/schemas/post_mortem_template_response'
+ description: Retrospective Template deleted
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Delete a incident event
+ summary: Delete a Retrospective Template
tags:
- - StatusPageTemplates
+ - RetrospectiveTemplates
x-accepts:
- application/vnd.api+json
get:
- description: Retrieves a specific status_page_template by id
- operationId: getStatusPageTemplate
+ description: Retrieves a specific Retrospective Template by id
+ operationId: getPostmortemTemplate
parameters:
- explode: false
in: path
name: id
required: true
schema:
- type: string
+ $ref: '#/components/schemas/getAlertField_id_parameter'
style: simple
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 14d5f69e-f426-4e1a-803f-cde825a05669
- type: status_page_templates
- attributes:
- status_page_id: 19e4076a-6b1e-4d08-be59-fc812c81cfaf
- title: Sint
- body: Necessitatibus quis libero alias.
- update_status: null
- should_notify_subscribers: false
- position: 1
- enabled: true
- created_at: 2025-05-22T06:50:07.172-07:00
- updated_at: 2025-05-22T06:50:07.172-07:00
- kind: normal
schema:
- $ref: '#/components/schemas/status_page_template_response'
- description: status page template found
+ $ref: '#/components/schemas/post_mortem_template_response'
+ description: Retrospective Template found
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Retrieves a status page template
+ summary: Retrieves a Retrospective Template
tags:
- - StatusPageTemplates
+ - RetrospectiveTemplates
x-accepts:
- application/vnd.api+json
put:
- description: Update a specific template event by id
- operationId: updateStatusPageTemplate
+ description: Update a specific Retrospective Template by id
+ operationId: updatePostmortemTemplate
parameters:
- explode: false
in: path
name: id
required: true
schema:
- type: string
+ $ref: '#/components/schemas/getAlertField_id_parameter'
style: simple
requestBody:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/status_page_template'
+ $ref: '#/components/schemas/update_post_mortem_template'
required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 14d5f69e-f426-4e1a-803f-cde825a05669
- type: status_page_templates
- attributes:
- status_page_id: 19e4076a-6b1e-4d08-be59-fc812c81cfaf
- title: Update template title
- body: Update template body
- update_status: null
- should_notify_subscribers: false
- position: 1
- enabled: true
- created_at: 2025-05-22T06:50:07.172-07:00
- updated_at: 2025-05-22T06:50:09.266-07:00
- kind: normal
schema:
- $ref: '#/components/schemas/status_page_template_response'
- description: incident_event updated
+ $ref: '#/components/schemas/post_mortem_template_response'
+ description: Retrospective Template updated with sanitized content
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Update status page template
+ summary: Update a Retrospective Template
tags:
- - StatusPageTemplates
+ - RetrospectiveTemplates
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/status-pages:
+ /v1/pulses:
get:
- description: List status pages
- operationId: listStatusPages
+ description: List pulses
+ operationId: listPulses
parameters:
- explode: true
in: query
@@ -36219,35 +18828,91 @@ paths:
style: form
- explode: true
in: query
- name: "page[number]"
+ name: "filter[source]"
required: false
schema:
- type: integer
+ type: string
style: form
- explode: true
in: query
- name: "page[size]"
+ name: "filter[services]"
required: false
schema:
- type: integer
+ type: string
style: form
- explode: true
in: query
- name: "filter[search]"
+ name: "filter[environments]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[name]"
+ name: "filter[labels]"
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[slug]"
+ name: "filter[refs]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[started_at][gt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[started_at][gte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[started_at][lt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[started_at][lte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[ended_at][gt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[ended_at][gte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[ended_at][lt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[ended_at][lte]"
required: false
schema:
type: string
@@ -36282,109 +18947,73 @@ paths:
style: form
- explode: true
in: query
- name: sort
+ name: "page[number]"
required: false
schema:
- type: string
+ type: integer
+ style: form
+ - explode: true
+ in: query
+ name: "page[size]"
+ required: false
+ schema:
+ type: integer
style: form
responses:
"200":
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/status_page_list'
+ $ref: '#/components/schemas/pulse_list'
description: success
security:
- bearer_auth: []
- summary: List status pages
+ summary: List pulses
tags:
- - StatusPages
+ - Pulses
x-accepts:
- application/vnd.api+json
post:
- description: Creates a new status page from provided data
- operationId: createStatusPage
+ description: Creates a new pulse from provided data
+ operationId: createPulse
parameters: []
requestBody:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/new_status_page'
+ $ref: '#/components/schemas/new_pulse'
required: true
responses:
"201":
content:
application/vnd.api+json:
- example:
- data:
- id: 21882183-c77b-495e-8089-c47191f7b465
- type: status_pages
- attributes:
- title: My Status Page
- public_title: null
- description: My Status Page description
- public_description: null
- header_color: '#0061F2'
- footer_color: '#1F2F41'
- allow_search_engine_index: true
- public: false
- website_url: null
- website_privacy_url: null
- website_support_url: null
- ga_tracking_id: null
- time_zone: Etc/UTC
- success_message: All Systems Operational
- failure_message: Something's not quite right
- authentication_enabled: false
- authentication_password: "[REDACTED]"
- enabled: true
- functionality_ids:
- - 44e6b205-4331-4407-b5b7-c5872d6600fe
- service_ids:
- - f8b2e288-275a-460b-b7cd-719fff3d4234
- allow_email_subscribers: true
- allow_sms_subscribers: true
- allow_rss_atom_feeds: true
- show_uptime: true
- show_uptime_last_days: 30
- external_domain_names: []
- created_at: 2025-05-22T06:50:16.038-07:00
- updated_at: 2025-05-22T06:50:16.038-07:00
schema:
- $ref: '#/components/schemas/status_page_response'
- description: status_page created
+ $ref: '#/components/schemas/pulse_response'
+ description: pulse created
"422":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Title can't be blank
- status: "422"
schema:
$ref: '#/components/schemas/errors_list'
description: invalid request
"401":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
description: responds with unauthorized for invalid token
security:
- bearer_auth: []
- summary: Creates a status page
+ summary: Creates a pulse
tags:
- - StatusPages
+ - Pulses
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/status-pages/{id}:
- delete:
- description: Delete a specific status page by id
- operationId: deleteStatusPage
+ /v1/pulses/{id}:
+ get:
+ description: Retrieves a specific pulse by id
+ operationId: getPulse
parameters:
- explode: false
in: path
@@ -36397,62 +19026,25 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 0faeba90-cabf-4b4a-9509-313ee576d69f
- type: status_pages
- attributes:
- title: Ea beatae praesentium voluptas.
- public_title: null
- description: null
- public_description: null
- header_color: '#0061F2'
- footer_color: '#1F2F41'
- allow_search_engine_index: true
- public: false
- website_url: null
- website_privacy_url: null
- website_support_url: null
- ga_tracking_id: null
- time_zone: Etc/UTC
- success_message: All Systems Operational
- failure_message: Something's not quite right
- authentication_enabled: false
- authentication_password: "[REDACTED]"
- enabled: true
- functionality_ids: []
- service_ids: []
- allow_email_subscribers: true
- allow_sms_subscribers: true
- allow_rss_atom_feeds: true
- show_uptime: true
- show_uptime_last_days: 90
- external_domain_names: []
- created_at: 2025-05-22T06:50:11.573-07:00
- updated_at: 2025-05-22T06:50:18.924-07:00
schema:
- $ref: '#/components/schemas/status_page_response'
- description: status_page deleted
+ $ref: '#/components/schemas/pulse_response'
+ description: pulse found
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Delete a status page
+ summary: Retrieves a pulse
tags:
- - StatusPages
+ - Pulses
x-accepts:
- application/vnd.api+json
- get:
- description: Retrieves a specific status page by id
- operationId: getStatusPage
+ put:
+ description: Update a specific pulse by id
+ operationId: updatePulse
parameters:
- explode: false
in: path
@@ -36461,66 +19053,132 @@ paths:
schema:
type: string
style: simple
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/update_pulse'
+ required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 0faeba90-cabf-4b4a-9509-313ee576d69f
- type: status_pages
- attributes:
- title: Ea beatae praesentium voluptas.
- public_title: null
- description: null
- public_description: null
- header_color: '#0061F2'
- footer_color: '#1F2F41'
- allow_search_engine_index: true
- public: false
- website_url: null
- website_privacy_url: null
- website_support_url: null
- ga_tracking_id: null
- time_zone: Etc/UTC
- success_message: All Systems Operational
- failure_message: Something's not quite right
- authentication_enabled: false
- authentication_password: "[REDACTED]"
- enabled: true
- functionality_ids: []
- service_ids: []
- allow_email_subscribers: true
- allow_sms_subscribers: true
- allow_rss_atom_feeds: true
- show_uptime: true
- show_uptime_last_days: 90
- external_domain_names: []
- created_at: 2025-05-22T06:50:11.573-07:00
- updated_at: 2025-05-22T06:50:11.573-07:00
schema:
- $ref: '#/components/schemas/status_page_response'
- description: status_page found
- "404":
+ $ref: '#/components/schemas/pulse_response'
+ description: pulse updated
+ "404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Retrieves a status page
+ summary: Update a pulse
tags:
- - StatusPages
+ - Pulses
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/retrospective_configurations:
+ get:
+ description: List retrospective configurations
+ operationId: listRetrospectiveConfigurations
+ parameters:
+ - description: "comma separated if needed. eg: severities,groups"
+ explode: true
+ in: query
+ name: include
+ required: false
+ schema:
+ enum:
+ - severities
+ - groups
+ - incident_types
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "page[number]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ - explode: true
+ in: query
+ name: "page[size]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ - explode: true
+ in: query
+ name: "filter[kind]"
+ required: false
+ schema:
+ type: string
+ style: form
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/retrospective_configuration_list'
+ description: success
+ security:
+ - bearer_auth: []
+ summary: List retrospective configurations
+ tags:
+ - RetrospectiveConfigurations
+ x-accepts:
+ - application/vnd.api+json
+ /v1/retrospective_configurations/{id}:
+ get:
+ description: Retrieves a specific retrospective_configuration by id
+ operationId: getRetrospectiveConfiguration
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ - description: "comma separated if needed. eg: severities,groups"
+ explode: true
+ in: query
+ name: include
+ required: false
+ schema:
+ enum:
+ - severities
+ - groups
+ - incident_types
+ type: string
+ style: form
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/retrospective_configuration_response'
+ description: retrospective_configuration found
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Retrieves a Retrospective Configuration
+ tags:
+ - RetrospectiveConfigurations
x-accepts:
- application/vnd.api+json
put:
- description: Update a specific status page by id
- operationId: updateStatusPage
+ description: Update a specific retrospective configuration by id
+ operationId: updateRetrospectiveConfiguration
parameters:
- explode: false
in: path
@@ -36533,71 +19191,41 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/update_status_page'
+ $ref: '#/components/schemas/update_retrospective_configuration'
required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 0faeba90-cabf-4b4a-9509-313ee576d69f
- type: status_pages
- attributes:
- title: My Status Page Updated
- public_title: null
- description: My Status Page Description Updated
- public_description: null
- header_color: '#0061F2'
- footer_color: '#1F2F41'
- allow_search_engine_index: true
- public: false
- website_url: null
- website_privacy_url: null
- website_support_url: null
- ga_tracking_id: null
- time_zone: Etc/UTC
- success_message: All Systems Operational
- failure_message: Something's not quite right
- authentication_enabled: false
- authentication_password: "[REDACTED]"
- enabled: true
- functionality_ids: []
- service_ids: []
- allow_email_subscribers: true
- allow_sms_subscribers: true
- allow_rss_atom_feeds: true
- show_uptime: true
- show_uptime_last_days: 60
- external_domain_names: []
- created_at: 2025-05-22T06:50:11.573-07:00
- updated_at: 2025-05-22T06:50:17.976-07:00
schema:
- $ref: '#/components/schemas/status_page_response'
- description: status_page updated
+ $ref: '#/components/schemas/retrospective_configuration_response'
+ description: retrospective configuration updated
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Update a status page
+ summary: Update a retrospective configuration
tags:
- - StatusPages
+ - RetrospectiveConfigurations
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/sub_statuses:
+ /v1/retrospective_process_groups/{retrospective_process_group_id}/steps:
get:
- description: List Sub-Statuses
- operationId: listSubStatuses
+ description: List RetrospectiveProcessGroup Steps
+ operationId: listRetrospectiveProcessGroupSteps
parameters:
+ - explode: false
+ in: path
+ name: retrospective_process_group_id
+ required: true
+ schema:
+ type: string
+ style: simple
- explode: true
in: query
name: include
@@ -36621,21 +19249,7 @@ paths:
style: form
- explode: true
in: query
- name: "filter[slug]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[name]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[parent_status]"
+ name: "filter[retrospective_step_id]"
required: false
schema:
type: string
@@ -36673,79 +19287,57 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/sub_status_list'
+ $ref: '#/components/schemas/retrospective_process_group_step_list'
description: success
security:
- bearer_auth: []
- summary: List Sub-Statuses
+ summary: List RetrospectiveProcessGroup Steps
tags:
- - SubStatuses
+ - RetrospectiveProcessGroupSteps
x-accepts:
- application/vnd.api+json
post:
- description: Creates a new Sub-Status from provided data
- operationId: createSubStatus
- parameters: []
+ description: Creates a new retrospective process group step from provided data
+ operationId: createRetrospectiveProcessGroupStep
+ parameters:
+ - explode: false
+ in: path
+ name: retrospective_process_group_id
+ required: true
+ schema:
+ type: string
+ style: simple
requestBody:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/new_sub_status'
+ $ref: '#/components/schemas/new_retrospective_process_group_step'
required: true
responses:
"201":
content:
application/vnd.api+json:
- example:
- data:
- id: f88f07e5-b70a-4308-b491-b5c6cb538c38
- type: sub_statuses
- attributes:
- name: Test
- description: This is a description
- slug: test
- parent_status: started
- position: 13
- deleted_at: null
- updated_at: 2025-05-22T06:50:22.566-07:00
- created_at: 2025-05-22T06:50:22.566-07:00
- schema:
- $ref: '#/components/schemas/sub_status_response'
- description: sub_status created
- "422":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Name can't be blank
- status: "422"
- - title: Name is too short (minimum is 1 character)
- status: "422"
schema:
- $ref: '#/components/schemas/errors_list'
- description: invalid request
+ $ref: '#/components/schemas/retrospective_process_group_step_response'
+ description: retrospective_process_group_step created
"401":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
description: responds with unauthorized for invalid token
security:
- bearer_auth: []
- summary: Creates a Sub-Status
+ summary: Creates a retrospective process group step
tags:
- - SubStatuses
+ - RetrospectiveProcessGroupSteps
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/sub_statuses/{id}:
+ /v1/retrospective_process_group_steps/{id}:
delete:
- description: Delete a specific Sub-Status by id
- operationId: deleteSubStatus
+ description: Delete a specific RetrospectiveProcessGroup Step by id
+ operationId: deleteRetrospectiveProcessGroupStep
parameters:
- explode: false
in: path
@@ -36758,42 +19350,25 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: eb30cd78-4dec-42f4-a017-18186f051a30
- type: sub_statuses
- attributes:
- name: 1z94c
- description: Nesciunt perspiciatis dolorum ut.
- slug: 1z94c
- parent_status: started
- position: 3
- deleted_at: 2025-05-22T06:50:24.324-07:00
- updated_at: 2025-05-22T06:50:24.324-07:00
- created_at: 2025-05-22T06:50:20.605-07:00
schema:
- $ref: '#/components/schemas/sub_status_response'
- description: sub_status deleted
+ $ref: '#/components/schemas/retrospective_process_group_step_response'
+ description: retrospective_process_group_step deleted
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Delete a Sub-Status
+ summary: Delete a RetrospectiveProcessGroup Step
tags:
- - SubStatuses
+ - RetrospectiveProcessGroupSteps
x-accepts:
- application/vnd.api+json
get:
- description: Retrieves a specific Sub-Status by id
- operationId: getSubStatus
+ description: Retrieves a specific RetrospectiveProcessGroup Step by id
+ operationId: getRetrospectiveProcessGroupStep
parameters:
- explode: false
in: path
@@ -36806,42 +19381,19 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: eb30cd78-4dec-42f4-a017-18186f051a30
- type: sub_statuses
- attributes:
- name: 1z94c
- description: Nesciunt perspiciatis dolorum ut.
- slug: 1z94c
- parent_status: started
- position: 3
- deleted_at: null
- updated_at: 2025-05-22T06:50:20.605-07:00
- created_at: 2025-05-22T06:50:20.605-07:00
schema:
- $ref: '#/components/schemas/sub_status_response'
+ $ref: '#/components/schemas/retrospective_process_group_step_response'
description: sub_status found
- "404":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: resource not found
security:
- bearer_auth: []
- summary: Retrieves a Sub-Status
+ summary: Retrieves a RetrospectiveProcessGroup Step
tags:
- - SubStatuses
+ - RetrospectiveProcessGroupSteps
x-accepts:
- application/vnd.api+json
put:
- description: Update a specific Sub-Status by id
- operationId: updateSubStatus
+ description: Update a specific RetrospectiveProcessGroup Step by id
+ operationId: updateRetrospectiveProcessGroupStep
parameters:
- explode: false
in: path
@@ -36854,124 +19406,77 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/update_sub_status'
+ $ref: '#/components/schemas/update_retrospective_process_group_step'
required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: eb30cd78-4dec-42f4-a017-18186f051a30
- type: sub_statuses
- attributes:
- name: 1z94c
- description: Updated description
- slug: 1z94c
- parent_status: started
- position: 3
- deleted_at: null
- updated_at: 2025-05-22T06:50:23.759-07:00
- created_at: 2025-05-22T06:50:20.605-07:00
- schema:
- $ref: '#/components/schemas/sub_status_response'
- description: sub_status updated
- "404":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
- $ref: '#/components/schemas/errors_list'
- description: resource not found
+ $ref: '#/components/schemas/retrospective_process_group_step_response'
+ description: retrospective_process_group_step updated
security:
- bearer_auth: []
- summary: Update a Sub-Status
+ summary: Update RetrospectiveProcessGroup Step
tags:
- - SubStatuses
+ - RetrospectiveProcessGroupSteps
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/teams:
+ /v1/retrospective_processes/{retrospective_process_id}/groups:
get:
- description: List teams
- operationId: listTeams
+ description: List Retrospective Process Groups
+ operationId: listRetrospectiveProcessGroups
parameters:
- - explode: true
- in: query
- name: include
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "page[number]"
- required: false
- schema:
- type: integer
- style: form
- - explode: true
- in: query
- name: "page[size]"
- required: false
- schema:
- type: integer
- style: form
- - explode: true
- in: query
- name: "filter[search]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[slug]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[name]"
- required: false
+ - explode: false
+ in: path
+ name: retrospective_process_id
+ required: true
schema:
type: string
- style: form
- - explode: true
+ style: simple
+ - description: "comma separated if needed. eg: retrospective_process_group_steps"
+ explode: true
in: query
- name: "filter[backstage_id]"
+ name: include
required: false
schema:
+ enum:
+ - retrospective_process_group_steps
type: string
style: form
- - explode: true
+ - description: "comma separated if needed. eg: created_at,updated_at"
+ explode: true
in: query
- name: "filter[cortex_id]"
+ name: sort
required: false
schema:
+ enum:
+ - created_at
+ - -created_at
+ - updated_at
+ - -updated_at
+ - position
+ - -position
type: string
style: form
- explode: true
in: query
- name: "filter[opslevel_id]"
+ name: "page[number]"
required: false
schema:
- type: string
+ type: integer
style: form
- explode: true
in: query
- name: "filter[external_id]"
+ name: "page[size]"
required: false
schema:
- type: string
+ type: integer
style: form
- explode: true
in: query
- name: "filter[color]"
+ name: "filter[sub_status_id]"
required: false
schema:
type: string
@@ -37004,121 +19509,62 @@ paths:
schema:
type: string
style: form
- - explode: true
- in: query
- name: sort
- required: false
- schema:
- type: string
- style: form
responses:
"200":
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/team_list'
+ $ref: '#/components/schemas/retrospective_process_group_list'
description: success
security:
- bearer_auth: []
- summary: List teams
+ summary: List Retrospective Process Groups
tags:
- - Teams
+ - RetrospectiveProcessGroups
x-accepts:
- application/vnd.api+json
post:
- description: Creates a new team from provided data
- operationId: createTeam
- parameters: []
+ description: Creates a new retrospective process group from provided data
+ operationId: createRetrospectiveProcessGroup
+ parameters:
+ - explode: false
+ in: path
+ name: retrospective_process_id
+ required: true
+ schema:
+ type: string
+ style: simple
requestBody:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/new_team'
+ $ref: '#/components/schemas/new_retrospective_process_group'
required: true
responses:
"201":
content:
application/vnd.api+json:
- example:
- data:
- id: 29208612-053b-4880-91f4-2c7a002d1eaa
- type: groups
- attributes:
- slug: infrastructure
- name: Infrastructure
- description: Everything infrastructure related
- color: '#FFF'
- position: 1
- notify_emails:
- - john@rootly.com
- - doe@rootly.com
- slack_channels:
- - id: C03MKDSEJE8
- name: infrastructure
- slack_aliases:
- - id: S03F7QUV7F1
- name: infrastructure
- pagerduty_id: PQ9K7I8
- pagerduty_service_id: null
- backstage_id: null
- external_id: d795fe69-acc2-4b30-92c9-3c25cbb92056
- opsgenie_id: 8743a1b2-11da-480e-8493-744660987bef
- victor_ops_id: e877c558-12e2-44d2-8723-5c86f7473c54
- pagertree_id: daa8bcd6-bf4a-4716-976c-812832ae115e
- cortex_id: null
- service_now_ci_sys_id: null
- user_ids:
- - 470
- - 471
- admin_ids: []
- incidents_count: 0
- alert_urgency_id: null
- alerts_email_enabled: true
- alerts_email_address: group-2130f9d44fcfe5f15bdf395f35ba013a@test.email.rootly.com
- created_at: 2025-05-22T06:50:32.985-07:00
- updated_at: 2025-05-22T06:50:32.998-07:00
- relationships:
- users:
- data:
- - id: "470"
- type: users
- - id: "471"
- type: users
- schema:
- $ref: '#/components/schemas/team_response'
- description: team created
- "422":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Name can't be blank
- status: "422"
schema:
- $ref: '#/components/schemas/errors_list'
- description: invalid association
+ $ref: '#/components/schemas/retrospective_process_group_response'
+ description: retrospective_process_group created
"401":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
description: responds with unauthorized for invalid token
security:
- bearer_auth: []
- summary: Creates a team
+ summary: Creates a retrospective process group
tags:
- - Teams
+ - RetrospectiveProcessGroups
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/teams/{id}:
+ /v1/retrospective_process_groups/{id}:
delete:
- description: Delete a specific team by id
- operationId: deleteTeam
+ description: Delete a specific Retrospective Process Group by id
+ operationId: deleteRetrospectiveProcessGroup
parameters:
- explode: false
in: path
@@ -37131,62 +19577,25 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: f177c95c-c7bb-43e2-8b43-e5fd2c3f4826
- type: groups
- attributes:
- slug: harum-dolores-dolorum-debitis
- name: Harum dolores dolorum debitis.
- description: null
- color: '#D7E7F5'
- position: 1
- notify_emails: []
- slack_channels: []
- slack_aliases: []
- pagerduty_id: null
- pagerduty_service_id: null
- backstage_id: null
- external_id: null
- opsgenie_id: null
- victor_ops_id: null
- pagertree_id: null
- cortex_id: null
- service_now_ci_sys_id: null
- user_ids: []
- admin_ids: []
- incidents_count: 1
- alert_urgency_id: null
- alerts_email_enabled: false
- alerts_email_address: group-905c197de000e175c1e7027d644d35c2@email.rootly.com
- created_at: 2025-05-22T06:50:25.944-07:00
- updated_at: 2025-05-22T06:50:35.901-07:00
- relationships:
- users:
- data: []
schema:
- $ref: '#/components/schemas/team_response'
- description: team deleted
+ $ref: '#/components/schemas/retrospective_process_group_response'
+ description: retrospective_process_group deleted
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Delete a team
+ summary: Delete a Retrospective Process Group
tags:
- - Teams
+ - RetrospectiveProcessGroups
x-accepts:
- application/vnd.api+json
get:
- description: Retrieves a specific team by id
- operationId: getTeam
+ description: Retrieves a specific Retrospective Process Group by id
+ operationId: getRetrospectiveProcessGroup
parameters:
- explode: false
in: path
@@ -37195,66 +19604,33 @@ paths:
schema:
type: string
style: simple
+ - description: "comma separated if needed. eg: retrospective_process_group_steps"
+ explode: true
+ in: query
+ name: include
+ required: false
+ schema:
+ enum:
+ - retrospective_process_group_steps
+ type: string
+ style: form
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: f177c95c-c7bb-43e2-8b43-e5fd2c3f4826
- type: groups
- attributes:
- slug: harum-dolores-dolorum-debitis
- name: Harum dolores dolorum debitis.
- description: null
- color: '#D7E7F5'
- position: 1
- notify_emails: []
- slack_channels: []
- slack_aliases: []
- pagerduty_id: null
- pagerduty_service_id: null
- backstage_id: null
- external_id: null
- opsgenie_id: null
- victor_ops_id: null
- pagertree_id: null
- cortex_id: null
- service_now_ci_sys_id: null
- user_ids: []
- admin_ids: []
- incidents_count: 1
- alert_urgency_id: null
- alerts_email_enabled: false
- alerts_email_address: group-905c197de000e175c1e7027d644d35c2@email.rootly.com
- created_at: 2025-05-22T06:50:25.944-07:00
- updated_at: 2025-05-22T06:50:25.944-07:00
- relationships:
- users:
- data: []
- schema:
- $ref: '#/components/schemas/team_response'
- description: team found
- "404":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
- $ref: '#/components/schemas/errors_list'
- description: resource not found
+ $ref: '#/components/schemas/retrospective_process_group_response'
+ description: sub_status found
security:
- bearer_auth: []
- summary: Retrieves a team
+ summary: Retrieves a Retrospective Process Group
tags:
- - Teams
+ - RetrospectiveProcessGroups
x-accepts:
- application/vnd.api+json
put:
- description: Update a specific team by id
- operationId: updateTeam
+ description: Update a specific Retrospective Process Group by id
+ operationId: updateRetrospectiveProcessGroup
parameters:
- explode: false
in: path
@@ -37267,169 +19643,39 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/update_team'
+ $ref: '#/components/schemas/update_retrospective_process_group'
required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: f177c95c-c7bb-43e2-8b43-e5fd2c3f4826
- type: groups
- attributes:
- slug: security
- name: Security
- description: Everything security related
- color: '#000'
- position: 2
- notify_emails:
- - hello@rootly.com
- - world@rootly.com
- slack_channels:
- - id: C03MKDSEJE8
- name: infrastructure
- slack_aliases:
- - id: S03F7QUV7F1
- name: infrastructure
- pagerduty_id: PQ9K7I9
- pagerduty_service_id: null
- backstage_id: null
- external_id: 95ee00ee-4b35-40f7-bd0f-a919f9b8008d
- opsgenie_id: a6edf90f-1a61-4592-99a7-bcf101c81bca
- victor_ops_id: 0ae4de13-145a-4214-9cd5-c982ef95a740
- pagertree_id: c4378a92-505c-49e4-a46e-c44c830bbc99
- cortex_id: null
- service_now_ci_sys_id: null
- user_ids:
- - 470
- admin_ids: []
- incidents_count: 1
- alert_urgency_id: null
- alerts_email_enabled: false
- alerts_email_address: group-905c197de000e175c1e7027d644d35c2@email.rootly.com
- created_at: 2025-05-22T06:50:25.944-07:00
- updated_at: 2025-05-22T06:50:35.198-07:00
- relationships:
- users:
- data:
- - id: "470"
- type: users
schema:
- $ref: '#/components/schemas/team_response'
- description: team updated
- "404":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: resource not found
+ $ref: '#/components/schemas/retrospective_process_group_response'
+ description: retrospective_process_group updated
security:
- bearer_auth: []
- summary: Update a team
+ summary: Update a Retrospective Process Group
tags:
- - Teams
+ - RetrospectiveProcessGroups
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/teams/{id}/incidents_chart:
- get:
- description: Get team incidents chart
- operationId: getTeamIncidentsChart
- parameters:
- - explode: false
- in: path
- name: id
- required: true
- schema:
- type: string
- style: simple
- - explode: true
- in: query
- name: period
- required: true
- schema:
- type: string
- style: form
- responses:
- "200":
- content:
- application/vnd.api+json:
- example:
- data:
- "2025-04-21": 0
- "2025-04-22": 0
- "2025-04-23": 0
- "2025-04-24": 0
- "2025-04-25": 0
- "2025-04-26": 0
- "2025-04-27": 0
- "2025-04-28": 0
- "2025-04-29": 0
- "2025-04-30": 0
- "2025-05-01": 0
- "2025-05-02": 0
- "2025-05-03": 0
- "2025-05-04": 0
- "2025-05-05": 0
- "2025-05-06": 0
- "2025-05-07": 0
- "2025-05-08": 0
- "2025-05-09": 0
- "2025-05-10": 0
- "2025-05-11": 0
- "2025-05-12": 0
- "2025-05-13": 0
- "2025-05-14": 0
- "2025-05-15": 0
- "2025-05-16": 0
- "2025-05-17": 0
- "2025-05-18": 0
- "2025-05-19": 1
- "2025-05-20": 0
- "2025-05-21": 0
- "2025-05-22": 0
- schema:
- $ref: '#/components/schemas/incidents_chart_response'
- description: success
- "404":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
- schema:
- $ref: '#/components/schemas/errors_list'
- description: resource not found
- security:
- - bearer_auth: []
- summary: Get team incidents chart
- tags:
- - Teams
- x-accepts:
- - application/vnd.api+json
- /v1/users/{user_id}/notification_rules:
+ /v1/retrospective_processes:
get:
- description: List user notification rules
- operationId: listUserNotificationRules
+ description: List retrospective processes
+ operationId: listRetrospectiveProcesses
parameters:
- - explode: false
- in: path
- name: user_id
- required: true
- schema:
- type: string
- style: simple
- - explode: true
+ - description: "comma separated if needed. eg: retrospective_steps,severities"
+ explode: true
in: query
name: include
required: false
schema:
+ enum:
+ - retrospective_steps
+ - severities
+ - incident_types
+ - groups
type: string
style: form
- explode: true
@@ -37446,100 +19692,61 @@ paths:
schema:
type: integer
style: form
- - explode: true
- in: query
- name: sort
- required: false
- schema:
- type: string
- style: form
responses:
"200":
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/user_notification_rule_list'
+ $ref: '#/components/schemas/retrospective_process_list'
description: success
security:
- bearer_auth: []
- summary: List user notification rules
+ summary: List retrospective processes
tags:
- - UserNotificationRules
+ - RetrospectiveProcesses
x-accepts:
- application/vnd.api+json
post:
- description: Creates a new user notification rule from provided data
- operationId: createUserNotificationRule
- parameters:
- - explode: false
- in: path
- name: user_id
- required: true
- schema:
- type: string
- style: simple
+ description: Creates a new retrospective process from provided data
+ operationId: createRetrospectiveProcess
+ parameters: []
requestBody:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/new_user_notification_rule'
+ $ref: '#/components/schemas/new_retrospective_process'
required: true
responses:
"201":
content:
application/vnd.api+json:
- example:
- data:
- id: 425dcfe4-47fe-42d7-8c9f-b132bade27b4
- type: user_notification_rules
- attributes:
- user_id: 475
- delay: 2
- position: 1
- user_email_address_id: af79bb5c-3b2f-4b9f-a19c-47dbc8ceadfd
- user_call_number_id: 8a027a08-c52c-4751-8bad-18631ac86162
- user_sms_number_id: 8a027a08-c52c-4751-8bad-18631ac86162
- user_device_id: 42cce05b-81bc-4ea5-970d-0d02c8cad355
- enabled_contact_types:
- - email
- created_at: 2025-05-22T06:50:38.198-07:00
- updated_at: 2025-05-22T06:50:38.198-07:00
schema:
- $ref: '#/components/schemas/user_notification_rule_response'
- description: user_notification_rule created
+ $ref: '#/components/schemas/retrospective_process_response'
+ description: retrospective_process created
"422":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Enabled contact types You must select at least 1 contact
- type
- status: "422"
schema:
$ref: '#/components/schemas/errors_list'
description: invalid request
"401":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
description: responds with unauthorized for invalid token
security:
- bearer_auth: []
- summary: Creates an user notification rule
+ summary: Creates a retrospective process
tags:
- - UserNotificationRules
+ - RetrospectiveProcesses
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/notification_rules/{id}:
+ /v1/retrospective_processes/{id}:
delete:
- description: Delete a specific user notification rule by id
- operationId: deleteUserNotificationRule
+ description: Delete a specific retrospective process by id
+ operationId: deleteRetrospectiveProcess
parameters:
- explode: false
in: path
@@ -37552,45 +19759,25 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: c40b9601-3838-4602-897d-93d08e11a314
- type: user_notification_rules
- attributes:
- user_id: 475
- delay: 1
- position: 2
- user_email_address_id: null
- user_call_number_id: null
- user_sms_number_id: null
- user_device_id: null
- enabled_contact_types:
- - email
- created_at: 2025-05-22T06:50:38.014-07:00
- updated_at: 2025-05-22T06:50:38.027-07:00
schema:
- $ref: '#/components/schemas/user_notification_rule_response'
- description: user_notification_rule deleted
+ $ref: '#/components/schemas/retrospective_process_response'
+ description: retrospective_process deleted
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Delete an user notification rule
+ summary: Delete a retrospective process
tags:
- - UserNotificationRules
+ - RetrospectiveProcesses
x-accepts:
- application/vnd.api+json
get:
- description: Retrieves a specific user notification rule by id
- operationId: getUserNotificationRule
+ description: Retrieves a specific retrospective process by id
+ operationId: getRetrospectiveProcess
parameters:
- explode: false
in: path
@@ -37599,49 +19786,42 @@ paths:
schema:
type: string
style: simple
+ - description: "comma separated if needed. eg: retrospective_steps,severities"
+ explode: true
+ in: query
+ name: include
+ required: false
+ schema:
+ enum:
+ - retrospective_steps
+ - severities
+ - incident_types
+ - groups
+ type: string
+ style: form
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: c40b9601-3838-4602-897d-93d08e11a314
- type: user_notification_rules
- attributes:
- user_id: 475
- delay: 1
- position: 2
- user_email_address_id: null
- user_call_number_id: null
- user_sms_number_id: null
- user_device_id: null
- enabled_contact_types:
- - email
- created_at: 2025-05-22T06:50:38.014-07:00
- updated_at: 2025-05-22T06:50:38.027-07:00
schema:
- $ref: '#/components/schemas/user_notification_rule_response'
- description: user_notification_rule found
+ $ref: '#/components/schemas/retrospective_process_response'
+ description: retrospective_process found
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Retrieves an user notification rule
+ summary: Retrieves a retrospective process
tags:
- - UserNotificationRules
+ - RetrospectiveProcesses
x-accepts:
- application/vnd.api+json
put:
- description: Update a specific user notification rule by id
- operationId: updateUserNotificationRule
+ description: Updates a specific retrospective process by id
+ operationId: updateRetrospectiveProcess
parameters:
- explode: false
in: path
@@ -37654,657 +19834,131 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/update_user_notification_rule'
+ $ref: '#/components/schemas/update_retrospective_process'
required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: c40b9601-3838-4602-897d-93d08e11a314
- type: user_notification_rules
- attributes:
- user_id: 475
- delay: 2
- position: 1
- user_email_address_id: af79bb5c-3b2f-4b9f-a19c-47dbc8ceadfd
- user_call_number_id: 8a027a08-c52c-4751-8bad-18631ac86162
- user_sms_number_id: null
- user_device_id: 42cce05b-81bc-4ea5-970d-0d02c8cad355
- enabled_contact_types:
- - device
- created_at: 2025-05-22T06:50:38.014-07:00
- updated_at: 2025-05-22T06:50:39.441-07:00
schema:
- $ref: '#/components/schemas/user_notification_rule_response'
- description: user_notification_rule updated
+ $ref: '#/components/schemas/retrospective_process_response'
+ description: retrospective_process updated
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Update an user notification rule
+ summary: Update a retrospective process
tags:
- - UserNotificationRules
+ - RetrospectiveProcesses
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/users:
+ /v1/retrospective_processes/{retrospective_process_id}/retrospective_steps:
get:
- description: List users
- operationId: listUsers
+ description: List retrospective steps
+ operationId: listRetrospectiveSteps
parameters:
- - explode: true
- in: query
- name: "page[number]"
- required: false
- schema:
- type: integer
- style: form
- - explode: true
- in: query
- name: "page[size]"
- required: false
- schema:
- type: integer
- style: form
- - explode: true
- in: query
- name: "filter[search]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[email]"
- required: false
+ - explode: false
+ in: path
+ name: retrospective_process_id
+ required: true
schema:
type: string
- style: form
+ style: simple
- explode: true
in: query
- name: "filter[created_at][gt]"
+ name: include
required: false
schema:
type: string
style: form
- explode: true
in: query
- name: "filter[created_at][gte]"
+ name: "page[number]"
required: false
schema:
- type: string
+ type: integer
style: form
- explode: true
in: query
- name: "filter[created_at][lt]"
+ name: "page[size]"
required: false
schema:
- type: string
+ type: integer
style: form
- explode: true
- in: query
- name: "filter[created_at][lte]"
- required: false
- schema:
- type: string
- style: form
- - description: "comma separated if needed. eg: created_at,updated_at"
- explode: true
in: query
name: sort
required: false
schema:
- enum:
- - created_at
- - -created_at
- - updated_at
- - -updated_at
- type: string
- style: form
- - description: "comma separated if needed. eg: email_addresses,phone_numbers"
- explode: true
- in: query
- name: include
- required: false
- schema:
- enum:
- - email_addresses
- - phone_numbers
- - devices
- - role
- - on_call_role
type: string
style: form
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- - id: "490"
- type: users
- attributes:
- name: Kerrie Kling
- email: stacee@feil-rath.example
- phone: null
- phone_2: null
- first_name: Kerrie
- last_name: Kling
- full_name: Kerrie Kling
- full_name_with_team: "[Connelly-Reynolds] Kerrie Kling"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:50:43.705-07:00
- created_at: 2025-05-22T06:50:43.705-07:00
- relationships:
- email_addresses:
- data:
- - id: 281fb5ab-466b-4aac-9ed2-3dd13e1e461c
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: 1a958a25-f295-4232-9f73-fcfa974796a0
- type: roles
- on_call_role:
- data:
- id: 3fbd8e20-b7c6-4259-a788-c266424ceeea
- type: on_call_roles
- - id: "489"
- type: users
- attributes:
- name: Charley Hudson
- email: nicki_lynch@flatley.example
- phone: null
- phone_2: null
- first_name: Charley
- last_name: Hudson
- full_name: Charley Hudson
- full_name_with_team: "[Connelly-Reynolds] Charley Hudson"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:50:43.571-07:00
- created_at: 2025-05-22T06:50:43.571-07:00
- relationships:
- email_addresses:
- data:
- - id: 06924b21-c538-47a9-875f-0f876029b1ca
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: d22d568b-1c35-4fdf-acf9-7c0b1e201e9e
- type: roles
- on_call_role:
- data:
- id: 3fbd8e20-b7c6-4259-a788-c266424ceeea
- type: on_call_roles
- - id: "488"
- type: users
- attributes:
- name: Linwood Franecki
- email: wilda_steuber@oconner-macgyver.example
- phone: null
- phone_2: null
- first_name: Linwood
- last_name: Franecki
- full_name: Linwood Franecki
- full_name_with_team: "[Connelly-Reynolds] Linwood Franecki"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:50:43.405-07:00
- created_at: 2025-05-22T06:50:43.405-07:00
- relationships:
- email_addresses:
- data:
- - id: 58d92b9e-a1dd-4d5b-ab69-de3903175337
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: 70e5cede-b198-4cf1-af88-9c65ce5dd280
- type: roles
- on_call_role:
- data:
- id: 3fbd8e20-b7c6-4259-a788-c266424ceeea
- type: on_call_roles
- - id: "486"
- type: users
- attributes:
- name: Debbra Herzog
- email: wilbert@walsh.example
- phone: null
- phone_2: null
- first_name: Debbra
- last_name: Herzog
- full_name: Debbra Herzog
- full_name_with_team: "[Connelly-Reynolds] Debbra Herzog"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:50:42.730-07:00
- created_at: 2025-05-22T06:50:42.730-07:00
- relationships:
- email_addresses:
- data:
- - id: 98a63d43-551a-4403-b57a-c6b663913033
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: d22d568b-1c35-4fdf-acf9-7c0b1e201e9e
- type: roles
- on_call_role:
- data:
- id: 3fbd8e20-b7c6-4259-a788-c266424ceeea
- type: on_call_roles
- - id: "485"
- type: users
- attributes:
- name: Sanora Sporer
- email: eli.cassin@jacobson.example
- phone: null
- phone_2: null
- first_name: Sanora
- last_name: Sporer
- full_name: Sanora Sporer
- full_name_with_team: "[Connelly-Reynolds] Sanora Sporer"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:50:42.604-07:00
- created_at: 2025-05-22T06:50:42.604-07:00
- relationships:
- email_addresses:
- data:
- - id: bd3ca941-d205-43f9-94c3-c57c048e358b
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: d22d568b-1c35-4fdf-acf9-7c0b1e201e9e
- type: roles
- on_call_role:
- data:
- id: 3fbd8e20-b7c6-4259-a788-c266424ceeea
- type: on_call_roles
- - id: "484"
- type: users
- attributes:
- name: Vida Parker
- email: scot@muller.test
- phone: null
- phone_2: null
- first_name: Vida
- last_name: Parker
- full_name: Vida Parker
- full_name_with_team: "[Connelly-Reynolds] Vida Parker"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:50:42.475-07:00
- created_at: 2025-05-22T06:50:42.475-07:00
- relationships:
- email_addresses:
- data:
- - id: e77f381c-c26e-4f3b-a1d5-e98d4abb9878
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: d22d568b-1c35-4fdf-acf9-7c0b1e201e9e
- type: roles
- on_call_role:
- data:
- id: 3fbd8e20-b7c6-4259-a788-c266424ceeea
- type: on_call_roles
- - id: "483"
- type: users
- attributes:
- name: Jade Pfeffer
- email: rocio@borer-mills.test
- phone: null
- phone_2: null
- first_name: Jade
- last_name: Pfeffer
- full_name: Jade Pfeffer
- full_name_with_team: "[Connelly-Reynolds] Jade Pfeffer"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:50:42.349-07:00
- created_at: 2025-05-22T06:50:42.349-07:00
- relationships:
- email_addresses:
- data:
- - id: 271137c1-d4f6-40ec-a4ad-542ae21f2e73
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: d22d568b-1c35-4fdf-acf9-7c0b1e201e9e
- type: roles
- on_call_role:
- data:
- id: 3fbd8e20-b7c6-4259-a788-c266424ceeea
- type: on_call_roles
- - id: "482"
- type: users
- attributes:
- name: Jacque Strosin
- email: tifany@monahan.example
- phone: null
- phone_2: null
- first_name: Jacque
- last_name: Strosin
- full_name: Jacque Strosin
- full_name_with_team: "[Connelly-Reynolds] Jacque Strosin"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:50:42.214-07:00
- created_at: 2025-05-22T06:50:42.214-07:00
- relationships:
- email_addresses:
- data:
- - id: 17b62d21-4dd4-4452-b975-fa1d52c621be
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: d22d568b-1c35-4fdf-acf9-7c0b1e201e9e
- type: roles
- on_call_role:
- data:
- id: 3fbd8e20-b7c6-4259-a788-c266424ceeea
- type: on_call_roles
- - id: "481"
- type: users
- attributes:
- name: Marilou Harris
- email: jesusita.osinski@kutch.test
- phone: null
- phone_2: null
- first_name: Marilou
- last_name: Harris
- full_name: Marilou Harris
- full_name_with_team: "[Connelly-Reynolds] Marilou Harris"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:50:42.031-07:00
- created_at: 2025-05-22T06:50:42.031-07:00
- relationships:
- email_addresses:
- data:
- - id: 03494776-04c1-4a38-bbf0-753a796683b5
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: d22d568b-1c35-4fdf-acf9-7c0b1e201e9e
- type: roles
- on_call_role:
- data:
- id: 3fbd8e20-b7c6-4259-a788-c266424ceeea
- type: on_call_roles
- - id: "480"
- type: users
- attributes:
- name: Kenya Langworth
- email: robin.welch@spinka.example
- phone: null
- phone_2: null
- first_name: Kenya
- last_name: Langworth
- full_name: Kenya Langworth
- full_name_with_team: "[Connelly-Reynolds] Kenya Langworth"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:50:41.830-07:00
- created_at: 2025-05-22T06:50:41.830-07:00
- relationships:
- email_addresses:
- data:
- - id: ba40d117-fcd4-4ca6-878a-28ac3b5cbe47
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: d22d568b-1c35-4fdf-acf9-7c0b1e201e9e
- type: roles
- on_call_role:
- data:
- id: 3fbd8e20-b7c6-4259-a788-c266424ceeea
- type: on_call_roles
- - id: "479"
- type: users
- attributes:
- name: Quinn Pouros
- email: kelvin@altenwerth.test
- phone: null
- phone_2: null
- first_name: Quinn
- last_name: Pouros
- full_name: Quinn Pouros
- full_name_with_team: "[Connelly-Reynolds] Quinn Pouros"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:50:41.643-07:00
- created_at: 2025-05-22T06:50:41.643-07:00
- relationships:
- email_addresses:
- data:
- - id: 9b5a0965-de2d-480d-be54-d141dce7e590
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: d22d568b-1c35-4fdf-acf9-7c0b1e201e9e
- type: roles
- on_call_role:
- data:
- id: 3fbd8e20-b7c6-4259-a788-c266424ceeea
- type: on_call_roles
- - id: "478"
- type: users
- attributes:
- name: Janie Mohr
- email: riley@ruecker.test
- phone: null
- phone_2: null
- first_name: Janie
- last_name: Mohr
- full_name: Janie Mohr
- full_name_with_team: "[Connelly-Reynolds] Janie Mohr"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:50:41.428-07:00
- created_at: 2025-05-22T06:50:41.428-07:00
- relationships:
- email_addresses:
- data:
- - id: 19a29c53-0171-431c-affc-e1cebf9d5623
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: d22d568b-1c35-4fdf-acf9-7c0b1e201e9e
- type: roles
- on_call_role:
- data:
- id: 3fbd8e20-b7c6-4259-a788-c266424ceeea
- type: on_call_roles
- - id: "477"
- type: users
- attributes:
- name: Malissa Maggio
- email: roy_barrows@dickens.test
- phone: null
- phone_2: null
- first_name: Malissa
- last_name: Maggio
- full_name: Malissa Maggio
- full_name_with_team: "[Connelly-Reynolds] Malissa Maggio"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:50:46.656-07:00
- created_at: 2025-05-22T06:50:40.507-07:00
- relationships:
- email_addresses:
- data:
- - id: 5e8f4d3c-e455-4435-9cb8-1d11531c56aa
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: 70e5cede-b198-4cf1-af88-9c65ce5dd280
- type: roles
- on_call_role:
- data:
- id: 3fbd8e20-b7c6-4259-a788-c266424ceeea
- type: on_call_roles
- links:
- self: http://www.example.com/v1/users?page%5Bnumber%5D=1&page%5Bsize%5D=50
- first: http://www.example.com/v1/users?page%5Bnumber%5D=1&page%5Bsize%5D=50
- prev: null
- next: null
- last: http://www.example.com/v1/users?page%5Bnumber%5D=1&page%5Bsize%5D=50
- meta:
- current_page: 1
- next_page: null
- prev_page: null
- total_count: 13
- total_pages: 1
- schema:
- $ref: '#/components/schemas/user_list'
- description: user found
- "401":
- content:
- application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
- $ref: '#/components/schemas/errors_list'
- description: responds with unauthorized for invalid token
+ $ref: '#/components/schemas/retrospective_step_list'
+ description: success
security:
- bearer_auth: []
- summary: List users
+ summary: List retrospective steps
tags:
- - Users
+ - RetrospectiveSteps
x-accepts:
- application/vnd.api+json
- /v1/users/me:
- get:
- description: Get current user
- operationId: getCurrentUser
+ post:
+ description: Creates a new retrospective step from provided data
+ operationId: createRetrospectiveStep
+ parameters:
+ - explode: false
+ in: path
+ name: retrospective_process_id
+ required: true
+ schema:
+ type: string
+ style: simple
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/new_retrospective_step'
+ required: true
responses:
- "200":
+ "201":
content:
application/vnd.api+json:
- example:
- data:
- id: "477"
- type: users
- attributes:
- name: Malissa Maggio
- email: roy_barrows@dickens.test
- phone: null
- phone_2: null
- first_name: Malissa
- last_name: Maggio
- full_name: Malissa Maggio
- full_name_with_team: "[Connelly-Reynolds] Malissa Maggio"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:50:47.229-07:00
- created_at: 2025-05-22T06:50:40.507-07:00
- relationships:
- email_addresses:
- data:
- - id: 5e8f4d3c-e455-4435-9cb8-1d11531c56aa
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: 70e5cede-b198-4cf1-af88-9c65ce5dd280
- type: roles
- on_call_role:
- data:
- id: 3fbd8e20-b7c6-4259-a788-c266424ceeea
- type: on_call_roles
schema:
- $ref: '#/components/schemas/user_response'
- description: user found
+ $ref: '#/components/schemas/retrospective_step_response'
+ description: retrospective_step created
+ "422":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: invalid request
"401":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
description: responds with unauthorized for invalid token
security:
- bearer_auth: []
- summary: Get current user
+ summary: Creates a retrospective step
tags:
- - Users
+ - RetrospectiveSteps
+ x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/users/{id}:
+ /v1/retrospective_steps/{id}:
delete:
- description: Delete a specific user by id
- operationId: deleteUser
+ description: Delete a specific retrospective step by id
+ operationId: deleteRetrospectiveStep
parameters:
- explode: false
in: path
@@ -38317,59 +19971,25 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: "478"
- type: users
- attributes:
- name: Janie Mohr
- email: riley@ruecker.test
- phone: null
- phone_2: null
- first_name: Janie
- last_name: Mohr
- full_name: Janie Mohr
- full_name_with_team: "[Connelly-Reynolds] Janie Mohr"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:50:41.428-07:00
- created_at: 2025-05-22T06:50:41.428-07:00
- relationships:
- email_addresses:
- data:
- - id: 19a29c53-0171-431c-affc-e1cebf9d5623
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data: null
- on_call_role:
- data: null
schema:
- $ref: '#/components/schemas/user_response'
- description: user deleted
+ $ref: '#/components/schemas/retrospective_step_response'
+ description: retrospective_step deleted
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Delete an user
+ summary: Delete a retrospective step
tags:
- - Users
+ - RetrospectiveSteps
x-accepts:
- application/vnd.api+json
get:
- description: Retrieves a specific user by id
- operationId: getUser
+ description: Retrieves a specific retrospective step by id
+ operationId: getRetrospectiveStep
parameters:
- explode: false
in: path
@@ -38378,81 +19998,29 @@ paths:
schema:
type: string
style: simple
- - description: "comma separated if needed. eg: email_addresses,phone_numbers"
- explode: true
- in: query
- name: include
- required: false
- schema:
- enum:
- - email_addresses
- - phone_numbers
- - devices
- - role
- - on_call_role
- type: string
- style: form
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: "477"
- type: users
- attributes:
- name: Malissa Maggio
- email: roy_barrows@dickens.test
- phone: null
- phone_2: null
- first_name: Malissa
- last_name: Maggio
- full_name: Malissa Maggio
- full_name_with_team: "[Connelly-Reynolds] Malissa Maggio"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:50:47.545-07:00
- created_at: 2025-05-22T06:50:40.507-07:00
- relationships:
- email_addresses:
- data:
- - id: 5e8f4d3c-e455-4435-9cb8-1d11531c56aa
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: 70e5cede-b198-4cf1-af88-9c65ce5dd280
- type: roles
- on_call_role:
- data:
- id: 3fbd8e20-b7c6-4259-a788-c266424ceeea
- type: on_call_roles
schema:
- $ref: '#/components/schemas/user_response'
- description: user found
+ $ref: '#/components/schemas/retrospective_step_response'
+ description: retrospective_step found
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Retrieves an user
+ summary: Retrieves a retrospective step
tags:
- - Users
+ - RetrospectiveSteps
x-accepts:
- application/vnd.api+json
put:
- description: Update a specific user by id
- operationId: updateUser
+ description: Update a specific retrospective step by id
+ operationId: updateRetrospectiveStep
parameters:
- explode: false
in: path
@@ -38465,71 +20033,33 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/update_user'
+ $ref: '#/components/schemas/update_retrospective_step'
+ required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: "478"
- type: users
- attributes:
- name: New Name
- email: riley@ruecker.test
- phone: null
- phone_2: null
- first_name: New
- last_name: Name
- full_name: New Name
- full_name_with_team: "[Connelly-Reynolds] New Name"
- slack_id: null
- time_zone: UTC
- updated_at: 2025-05-22T06:50:49.920-07:00
- created_at: 2025-05-22T06:50:41.428-07:00
- relationships:
- email_addresses:
- data:
- - id: 19a29c53-0171-431c-affc-e1cebf9d5623
- type: user_email_addresses
- phone_numbers:
- data: []
- devices:
- data: []
- role:
- data:
- id: e6470a33-8e13-433a-987c-9c7334deed8a
- type: roles
- on_call_role:
- data:
- id: 2610a484-5929-4dc6-9c0f-8ea673616220
- type: on_call_roles
schema:
- $ref: '#/components/schemas/user_response'
- description: update name and role simultaneously
+ $ref: '#/components/schemas/retrospective_step_response'
+ description: retrospective_step updated
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- detail: On-call role not found or does not belong to this team
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
- description: returns 404 for on_call_role_id belonging to another team
+ description: resource not found
security:
- bearer_auth: []
- summary: Update a user
+ summary: Update a retrospective step
tags:
- - Users
+ - RetrospectiveSteps
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/webhooks/endpoints/{endpoint_id}/deliveries:
+ /v1/roles:
get:
- description: List webhook deliveries for given endpoint
- operationId: listWebhooksDeliveries
+ description: List roles
+ operationId: listRoles
parameters:
- explode: true
in: query
@@ -38538,13 +20068,6 @@ paths:
schema:
type: string
style: form
- - explode: false
- in: path
- name: endpoint_id
- required: true
- schema:
- type: string
- style: simple
- explode: true
in: query
name: "page[number]"
@@ -38559,201 +20082,226 @@ paths:
schema:
type: integer
style: form
+ - explode: true
+ in: query
+ name: "filter[search]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[slug]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[name]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][gt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][gte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][lt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][lte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: sort
+ required: false
+ schema:
+ type: string
+ style: form
responses:
"200":
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/webhooks_delivery_list'
+ $ref: '#/components/schemas/role_list'
description: success
security:
- bearer_auth: []
- summary: List webhook deliveries
+ summary: List roles
tags:
- - WebhooksDeliveries
+ - Roles
x-accepts:
- application/vnd.api+json
- /v1/webhooks/deliveries/{id}/deliver:
post:
- description: Retries a webhook delivery
- operationId: deliverWebhooksDelivery
+ description: Creates a new role from provided data
+ operationId: createRole
+ parameters: []
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/new_role'
+ required: true
+ responses:
+ "201":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/role_response'
+ description: role created
+ "422":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: invalid request
+ "401":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: responds with unauthorized for invalid token
+ security:
+ - bearer_auth: []
+ summary: Creates a role
+ tags:
+ - Roles
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/roles/{id}:
+ delete:
+ description: Delete a specific role by id
+ operationId: deleteRole
parameters:
- explode: false
in: path
name: id
required: true
schema:
- type: string
+ $ref: '#/components/schemas/getAlertField_id_parameter'
style: simple
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 794a1f56-4617-481a-bdf0-bb88380bd672
- type: webhooks_deliveries
- attributes:
- endpoint_id: ec1befbf-3785-499d-ac6f-8c2a22d451e7
- payload: "{\"event\":{\"id\":\"02e9aeed-18b0-445f-b31b-d319e952b28c\"\
- ,\"type\":\"incident.created\",\"issued_at\":\"2025-05-22T06:50:54.142-07:00\"\
- },\"data\":{\"id\":null,\"sequential_id\":null,\"title\":\"\
- Inclusive Tree\",\"slug\":\"inclusive-tree\",\"kind\":\"normal\"\
- ,\"private\":false,\"summary\":null,\"status\":\"started\",\"\
- url\":\"http://localhost:3001/account/incidents\",\"short_url\"\
- :null,\"mitigation_message\":null,\"resolution_message\":null,\"\
- cancellation_message\":null,\"public_title\":null,\"zoom_meeting_id\"\
- :null,\"zoom_meeting_start_url\":null,\"zoom_meeting_join_url\"\
- :null,\"zoom_meeting_password\":null,\"zoom_meeting_pstn_password\"\
- :null,\"zoom_meeting_h323_password\":null,\"zoom_meeting_global_dial_in_numbers\"\
- :[],\"shortcut_story_id\":null,\"shortcut_story_url\":null,\"\
- shortcut_task_id\":null,\"shortcut_task_url\":null,\"asana_task_id\"\
- :null,\"asana_task_url\":null,\"github_issue_id\":null,\"github_issue_url\"\
- :null,\"gitlab_issue_id\":null,\"gitlab_issue_url\":null,\"\
- jira_issue_id\":null,\"jira_issue_url\":null,\"google_meeting_id\"\
- :null,\"google_meeting_url\":null,\"trello_card_id\":null,\"\
- trello_card_url\":null,\"linear_issue_id\":null,\"linear_issue_url\"\
- :null,\"zendesk_ticket_id\":null,\"zendesk_ticket_url\":null,\"\
- motion_task_id\":null,\"motion_task_url\":null,\"clickup_task_id\"\
- :null,\"clickup_task_url\":null,\"slack_channel_name\":null,\"\
- slack_channel_id\":null,\"slack_channel_url\":null,\"slack_channel_short_url\"\
- :null,\"slack_channel_deep_link\":null,\"slack_channel_archived\"\
- :false,\"service_now_incident_id\":null,\"service_now_incident_key\"\
- :null,\"service_now_incident_url\":null,\"opsgenie_incident_id\"\
- :null,\"opsgenie_incident_url\":null,\"opsgenie_alert_id\":null,\"\
- opsgenie_alert_url\":null,\"victor_ops_incident_id\":null,\"\
- victor_ops_incident_url\":null,\"pagerduty_incident_id\":null,\"\
- pagerduty_incident_number\":null,\"pagerduty_incident_url\"\
- :null,\"mattermost_channel_id\":null,\"mattermost_channel_name\"\
- :null,\"mattermost_channel_url\":null,\"confluence_page_id\"\
- :null,\"confluence_page_url\":null,\"quip_page_id\":null,\"\
- quip_page_url\":null,\"airtable_base_key\":null,\"airtable_table_name\"\
- :null,\"airtable_record_id\":null,\"airtable_record_url\":null,\"\
- google_drive_id\":null,\"google_drive_parent_id\":null,\"google_drive_url\"\
- :null,\"sharepoint_page_id\":null,\"sharepoint_page_url\":null,\"\
- datadog_notebook_id\":null,\"datadog_notebook_url\":null,\"\
- freshservice_ticket_id\":null,\"freshservice_ticket_url\":null,\"\
- freshservice_task_id\":null,\"freshservice_task_url\":null,\"\
- started_at\":\"2025-05-22T06:50:54.120-07:00\",\"detected_at\"\
- :null,\"acknowledged_at\":null,\"mitigated_at\":null,\"resolved_at\"\
- :null,\"cancelled_at\":null,\"created_at\":null,\"updated_at\"\
- :null,\"labels\":{},\"severity\":null,\"user\":null,\"started_by\"\
- :null,\"mitigated_by\":null,\"resolved_by\":null,\"cancelled_by\"\
- :null,\"causes\":[],\"roles\":[],\"environments\":[],\"incident_types\"\
- :[],\"services\":[],\"functionalities\":[],\"groups\":[],\"\
- events\":[],\"action_items\":[],\"form_field_selections\":[],\"\
- feedbacks\":[]}}"
- delivered_at: 2025-05-22T06:50:54.557-07:00
- created_at: 2025-05-22T06:50:54.164-07:00
- updated_at: 2025-05-22T06:50:54.557-07:00
schema:
- $ref: '#/components/schemas/webhooks_delivery_response'
- description: webhooks_delivery delivered
+ $ref: '#/components/schemas/role_response'
+ description: role deleted
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
security:
- bearer_auth: []
- summary: Retries a webhook delivery
+ summary: Delete a role
tags:
- - WebhooksDeliveries
+ - Roles
x-accepts:
- application/vnd.api+json
- /v1/webhooks/deliveries/{id}:
get:
- description: Retrieves a specific webhook delivery by id
- operationId: getWebhooksDelivery
+ description: Retrieves a specific role by id
+ operationId: getRole
parameters:
- explode: false
in: path
name: id
required: true
schema:
- type: string
+ $ref: '#/components/schemas/getAlertField_id_parameter'
style: simple
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 794a1f56-4617-481a-bdf0-bb88380bd672
- type: webhooks_deliveries
- attributes:
- endpoint_id: ec1befbf-3785-499d-ac6f-8c2a22d451e7
- payload: "{\"event\":{\"id\":\"02e9aeed-18b0-445f-b31b-d319e952b28c\"\
- ,\"type\":\"incident.created\",\"issued_at\":\"2025-05-22T06:50:54.142-07:00\"\
- },\"data\":{\"id\":null,\"sequential_id\":null,\"title\":\"\
- Inclusive Tree\",\"slug\":\"inclusive-tree\",\"kind\":\"normal\"\
- ,\"private\":false,\"summary\":null,\"status\":\"started\",\"\
- url\":\"http://localhost:3001/account/incidents\",\"short_url\"\
- :null,\"mitigation_message\":null,\"resolution_message\":null,\"\
- cancellation_message\":null,\"public_title\":null,\"zoom_meeting_id\"\
- :null,\"zoom_meeting_start_url\":null,\"zoom_meeting_join_url\"\
- :null,\"zoom_meeting_password\":null,\"zoom_meeting_pstn_password\"\
- :null,\"zoom_meeting_h323_password\":null,\"zoom_meeting_global_dial_in_numbers\"\
- :[],\"shortcut_story_id\":null,\"shortcut_story_url\":null,\"\
- shortcut_task_id\":null,\"shortcut_task_url\":null,\"asana_task_id\"\
- :null,\"asana_task_url\":null,\"github_issue_id\":null,\"github_issue_url\"\
- :null,\"gitlab_issue_id\":null,\"gitlab_issue_url\":null,\"\
- jira_issue_id\":null,\"jira_issue_url\":null,\"google_meeting_id\"\
- :null,\"google_meeting_url\":null,\"trello_card_id\":null,\"\
- trello_card_url\":null,\"linear_issue_id\":null,\"linear_issue_url\"\
- :null,\"zendesk_ticket_id\":null,\"zendesk_ticket_url\":null,\"\
- motion_task_id\":null,\"motion_task_url\":null,\"clickup_task_id\"\
- :null,\"clickup_task_url\":null,\"slack_channel_name\":null,\"\
- slack_channel_id\":null,\"slack_channel_url\":null,\"slack_channel_short_url\"\
- :null,\"slack_channel_deep_link\":null,\"slack_channel_archived\"\
- :false,\"service_now_incident_id\":null,\"service_now_incident_key\"\
- :null,\"service_now_incident_url\":null,\"opsgenie_incident_id\"\
- :null,\"opsgenie_incident_url\":null,\"opsgenie_alert_id\":null,\"\
- opsgenie_alert_url\":null,\"victor_ops_incident_id\":null,\"\
- victor_ops_incident_url\":null,\"pagerduty_incident_id\":null,\"\
- pagerduty_incident_number\":null,\"pagerduty_incident_url\"\
- :null,\"mattermost_channel_id\":null,\"mattermost_channel_name\"\
- :null,\"mattermost_channel_url\":null,\"confluence_page_id\"\
- :null,\"confluence_page_url\":null,\"quip_page_id\":null,\"\
- quip_page_url\":null,\"airtable_base_key\":null,\"airtable_table_name\"\
- :null,\"airtable_record_id\":null,\"airtable_record_url\":null,\"\
- google_drive_id\":null,\"google_drive_parent_id\":null,\"google_drive_url\"\
- :null,\"sharepoint_page_id\":null,\"sharepoint_page_url\":null,\"\
- datadog_notebook_id\":null,\"datadog_notebook_url\":null,\"\
- freshservice_ticket_id\":null,\"freshservice_ticket_url\":null,\"\
- freshservice_task_id\":null,\"freshservice_task_url\":null,\"\
- started_at\":\"2025-05-22T06:50:54.120-07:00\",\"detected_at\"\
- :null,\"acknowledged_at\":null,\"mitigated_at\":null,\"resolved_at\"\
- :null,\"cancelled_at\":null,\"created_at\":null,\"updated_at\"\
- :null,\"labels\":{},\"severity\":null,\"user\":null,\"started_by\"\
- :null,\"mitigated_by\":null,\"resolved_by\":null,\"cancelled_by\"\
- :null,\"causes\":[],\"roles\":[],\"environments\":[],\"incident_types\"\
- :[],\"services\":[],\"functionalities\":[],\"groups\":[],\"\
- events\":[],\"action_items\":[],\"form_field_selections\":[],\"\
- feedbacks\":[]}}"
- delivered_at: null
- created_at: 2025-05-22T06:50:54.164-07:00
- updated_at: 2025-05-22T06:50:54.164-07:00
schema:
- $ref: '#/components/schemas/webhooks_delivery_response'
- description: webhooks_delivery found
+ $ref: '#/components/schemas/role_response'
+ description: role found
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Retrieves a webhook delivery
+ summary: Retrieves a role
tags:
- - WebhooksDeliveries
+ - Roles
x-accepts:
- application/vnd.api+json
- /v1/webhooks/endpoints:
+ put:
+ description: Update a specific role by id
+ operationId: updateRole
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ $ref: '#/components/schemas/getAlertField_id_parameter'
+ style: simple
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/update_role'
+ required: true
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/role_response'
+ description: role updated
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Update a role
+ tags:
+ - Roles
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/schedule_rotations/{schedule_rotation_id}/schedule_rotation_active_days:
get:
- description: List webhook endpoints
- operationId: listWebhooksEndpoints
+ description: List schedule rotation active days
+ operationId: listScheduleRotationActiveDays
parameters:
+ - explode: false
+ in: path
+ name: schedule_rotation_id
+ required: true
+ schema:
+ type: string
+ style: simple
- explode: true
in: query
name: include
@@ -38775,102 +20323,68 @@ paths:
schema:
type: integer
style: form
- - explode: true
- in: query
- name: "filter[slug]"
- required: false
- schema:
- type: string
- style: form
- - explode: true
- in: query
- name: "filter[name]"
- required: false
- schema:
- type: string
- style: form
responses:
"200":
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/webhooks_endpoint_list'
+ $ref: '#/components/schemas/schedule_rotation_active_day_list'
description: success
security:
- bearer_auth: []
- summary: List webhook endpoints
+ summary: List schedule rotation active days
tags:
- - WebhooksEndpoints
+ - ScheduleRotationActiveDays
x-accepts:
- application/vnd.api+json
post:
- description: Creates a new webhook endpoint from provided data
- operationId: createWebhooksEndpoint
- parameters: []
+ description: Creates a new schedule rotation active day from provided data
+ operationId: createScheduleRotationActiveDay
+ parameters:
+ - explode: false
+ in: path
+ name: schedule_rotation_id
+ required: true
+ schema:
+ type: string
+ style: simple
requestBody:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/new_webhooks_endpoint'
+ $ref: '#/components/schemas/new_schedule_rotation_active_day'
required: true
responses:
"201":
content:
application/vnd.api+json:
- example:
- data:
- id: 5cca0ed0-4152-456d-9a0d-f21b3981244c
- type: webhooks_endpoints
- attributes:
- team_id: 368
- slug: test-ad709b7d-2a40-4809-985c-d88e1a8e329a
- name: Test
- url: https://test.com/test
- secret: phpzkRKEodThgjv2
- event_types:
- - incident.created
- enabled: true
- created_at: 2025-05-22T06:50:56.299-07:00
- updated_at: 2025-05-22T06:50:56.299-07:00
schema:
- $ref: '#/components/schemas/webhooks_endpoint_response'
- description: webhooks_endpoint created
+ $ref: '#/components/schemas/schedule_rotation_active_day_response'
+ description: schedule_rotation_active_day created
"422":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Name can't be blank
- status: "422"
- - title: URL is not a valid URL
- status: "422"
- - title: URL can't be blank
- status: "422"
schema:
$ref: '#/components/schemas/errors_list'
description: invalid request
"401":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Invalid token
- status: "401"
schema:
$ref: '#/components/schemas/errors_list'
description: responds with unauthorized for invalid token
security:
- bearer_auth: []
- summary: Creates a webhook endpoint
+ summary: Creates a schedule rotation active day
tags:
- - WebhooksEndpoints
+ - ScheduleRotationActiveDays
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
- /v1/webhooks/endpoints/{id}:
+ /v1/schedule_rotation_active_days/{id}:
delete:
- description: Delete a specific webhook endpoint by id
- operationId: deleteWebhooksEndpoint
+ description: Delete a specific schedule rotation active day
+ operationId: deleteScheduleRotationActiveDay
parameters:
- explode: false
in: path
@@ -38883,43 +20397,25 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 931d682a-2fc9-4c9b-9ba3-edb16431c81e
- type: webhooks_endpoints
- attributes:
- team_id: 368
- slug: test
- name: test
- url: https://test.com
- secret: cz32YpvUohNm3eF5
- event_types: []
- enabled: true
- created_at: 2025-05-22T06:50:56.133-07:00
- updated_at: 2025-05-22T06:50:58.086-07:00
schema:
- $ref: '#/components/schemas/webhooks_endpoint_response'
- description: webhooks_endpoint deleted
+ $ref: '#/components/schemas/schedule_rotation_active_day_response'
+ description: schedule_rotation_active_day deleted
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Delete a webhook endpoint
+ summary: Delete a schedule rotation active day
tags:
- - WebhooksEndpoints
+ - ScheduleRotationActiveDays
x-accepts:
- application/vnd.api+json
get:
- description: Retrieves a specific webhook endpoint by id
- operationId: getWebhooksEndpoint
+ description: Retrieves a specific schedule rotation active day by id
+ operationId: getScheduleRotationActiveDay
parameters:
- explode: false
in: path
@@ -38932,43 +20428,25 @@ paths:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 931d682a-2fc9-4c9b-9ba3-edb16431c81e
- type: webhooks_endpoints
- attributes:
- team_id: 368
- slug: test
- name: test
- url: https://test.com
- secret: cz32YpvUohNm3eF5
- event_types: []
- enabled: true
- created_at: 2025-05-22T06:50:56.133-07:00
- updated_at: 2025-05-22T06:50:56.133-07:00
schema:
- $ref: '#/components/schemas/webhooks_endpoint_response'
- description: webhooks_endpoint found
+ $ref: '#/components/schemas/schedule_rotation_active_day_response'
+ description: schedule_rotation_active_day found
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Retrieves a webhook endpoint
+ summary: Retrieves a schedule rotation active day
tags:
- - WebhooksEndpoints
+ - ScheduleRotationActiveDays
x-accepts:
- application/vnd.api+json
put:
- description: Update a specific webhook endpoint by id
- operationId: updateWebhooksEndpoint
+ description: Update a specific schedule rotation active day by id
+ operationId: updateScheduleRotationActiveDay
parameters:
- explode: false
in: path
@@ -38981,202 +20459,6783 @@ paths:
content:
application/vnd.api+json:
schema:
- $ref: '#/components/schemas/update_webhooks_endpoint'
+ $ref: '#/components/schemas/update_schedule_rotation_active_day'
required: true
responses:
"200":
content:
application/vnd.api+json:
- example:
- data:
- id: 931d682a-2fc9-4c9b-9ba3-edb16431c81e
- type: webhooks_endpoints
- attributes:
- team_id: 368
- slug: test
- name: Updated
- url: https://test.com
- secret: cz32YpvUohNm3eF5
- event_types: []
- enabled: true
- created_at: 2025-05-22T06:50:56.133-07:00
- updated_at: 2025-05-22T06:50:57.531-07:00
schema:
- $ref: '#/components/schemas/webhooks_endpoint_response'
- description: webhooks_endpoint updated
+ $ref: '#/components/schemas/schedule_rotation_active_day_response'
+ description: schedule_rotation_active_day updated
"404":
content:
application/vnd.api+json:
- example:
- errors:
- - title: Not found or unauthorized
- status: "404"
schema:
$ref: '#/components/schemas/errors_list'
description: resource not found
security:
- bearer_auth: []
- summary: Update a webhook endpoint
+ summary: Update a schedule rotation active day
tags:
- - WebhooksEndpoints
+ - ScheduleRotationActiveDays
x-content-type: application/vnd.api+json
x-accepts:
- application/vnd.api+json
-components:
- schemas:
- attach_alert:
+ /v1/schedule_rotations/{schedule_rotation_id}/schedule_rotation_users:
+ get:
+ operationId: listScheduleRotationUsers
+ parameters:
+ - explode: false
+ in: path
+ name: schedule_rotation_id
+ required: true
+ schema:
+ type: string
+ style: simple
+ - explode: true
+ in: query
+ name: include
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "page[number]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ - explode: true
+ in: query
+ name: "page[size]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/schedule_rotation_user_list'
+ description: success
+ security:
+ - bearer_auth: []
+ summary: List schedule rotation users
+ tags:
+ - ScheduleRotationUsers
+ x-accepts:
+ - application/vnd.api+json
+ post:
+ description: Creates a new schedule rotation user from provided data
+ operationId: createScheduleRotationUser
+ parameters:
+ - explode: false
+ in: path
+ name: schedule_rotation_id
+ required: true
+ schema:
+ type: string
+ style: simple
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/new_schedule_rotation_user'
+ required: true
+ responses:
+ "201":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/schedule_rotation_user_response'
+ description: schedule_rotation_user created
+ "422":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: invalid request
+ "401":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: responds with unauthorized for invalid token
+ security:
+ - bearer_auth: []
+ summary: Creates a schedule rotation user
+ tags:
+ - ScheduleRotationUsers
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/schedule_rotation_users/{id}:
+ delete:
+ description: Delete a specific schedule rotation user by id
+ operationId: deleteScheduleRotationUser
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/schedule_rotation_user_response'
+ description: schedule_rotation_user deleted
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Delete a schedule rotation user
+ tags:
+ - ScheduleRotationUsers
+ x-accepts:
+ - application/vnd.api+json
+ get:
+ description: Retrieves a specific schedule rotation user by id
+ operationId: getScheduleRotationUser
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/schedule_rotation_user_response'
+ description: schedule_rotation_user found
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Retrieves a schedule rotation user
+ tags:
+ - ScheduleRotationUsers
+ x-accepts:
+ - application/vnd.api+json
+ put:
+ description: Update a specific schedule rotation user by id
+ operationId: updateScheduleRotationUser
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/update_schedule_rotation_user'
+ required: true
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/schedule_rotation_user_response'
+ description: schedule_rotation_user updated
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Update schedule rotation user
+ tags:
+ - ScheduleRotationUsers
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/schedules/{schedule_id}/schedule_rotations:
+ get:
+ description: List schedule rotations
+ operationId: listScheduleRotations
+ parameters:
+ - explode: false
+ in: path
+ name: schedule_id
+ required: true
+ schema:
+ type: string
+ style: simple
+ - explode: true
+ in: query
+ name: include
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "page[number]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ - explode: true
+ in: query
+ name: "page[size]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ - explode: true
+ in: query
+ name: sort
+ required: false
+ schema:
+ type: string
+ style: form
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/schedule_rotation_list'
+ description: success
+ security:
+ - bearer_auth: []
+ summary: List schedule rotations
+ tags:
+ - ScheduleRotations
+ x-accepts:
+ - application/vnd.api+json
+ post:
+ description: Creates a new schedule rotation from provided data
+ operationId: createScheduleRotation
+ parameters:
+ - explode: false
+ in: path
+ name: schedule_id
+ required: true
+ schema:
+ type: string
+ style: simple
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/new_schedule_rotation'
+ required: true
+ responses:
+ "201":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/schedule_rotation_response'
+ description: schedule_rotation created with custom active times
+ "422":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: invalid request
+ "401":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: responds with unauthorized for invalid token
+ security:
+ - bearer_auth: []
+ summary: Creates a schedule rotation
+ tags:
+ - ScheduleRotations
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/schedule_rotations/{id}:
+ delete:
+ description: Delete a specific schedule rotation by id
+ operationId: deleteScheduleRotation
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/schedule_rotation_response'
+ description: schedule_rotation deleted
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Delete a schedule rotation
+ tags:
+ - ScheduleRotations
+ x-accepts:
+ - application/vnd.api+json
+ get:
+ description: Retrieves a specific schedule rotation by id
+ operationId: getScheduleRotation
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/schedule_rotation_response'
+ description: schedule_rotation found
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Retrieves a schedule rotation
+ tags:
+ - ScheduleRotations
+ x-accepts:
+ - application/vnd.api+json
+ put:
+ description: Update a specific schedule rotation by id
+ operationId: updateScheduleRotation
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/update_schedule_rotation'
+ required: true
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/schedule_rotation_response'
+ description: schedule_rotation updated
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Update a schedule rotation
+ tags:
+ - ScheduleRotations
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/schedules:
+ get:
+ description: List schedules
+ operationId: listSchedules
+ parameters:
+ - explode: true
+ in: query
+ name: include
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[search]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[name]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][gt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][gte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][lt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][lte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "page[number]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ - explode: true
+ in: query
+ name: "page[size]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/schedule_list'
+ description: success
+ security:
+ - bearer_auth: []
+ summary: List schedules
+ tags:
+ - Schedules
+ x-accepts:
+ - application/vnd.api+json
+ post:
+ description: Creates a new schedule from provided data
+ operationId: createSchedule
+ parameters: []
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/new_schedule'
+ required: true
+ responses:
+ "201":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/schedule_response'
+ description: schedule created
+ "422":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: invalid request
+ "401":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: responds with unauthorized for invalid token
+ security:
+ - bearer_auth: []
+ summary: Creates a schedule
+ tags:
+ - Schedules
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/schedules/{id}:
+ delete:
+ description: Delete a specific schedule by id
+ operationId: deleteSchedule
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/schedule_response'
+ description: schedule deleted
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Delete a schedule
+ tags:
+ - Schedules
+ x-accepts:
+ - application/vnd.api+json
+ get:
+ description: Retrieves a specific schedule by id
+ operationId: getSchedule
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/schedule_response'
+ description: schedule found
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Retrieves a schedule
+ tags:
+ - Schedules
+ x-accepts:
+ - application/vnd.api+json
+ put:
+ description: Updates a specific schedule by id
+ operationId: updateSchedule
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/update_schedule'
+ required: true
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/schedule_response'
+ description: schedule updated
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Update a schedule
+ tags:
+ - Schedules
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/schedules/{id}/shifts:
+ get:
+ description: Retrieves schedule shifts
+ operationId: getScheduleShifts
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ - explode: true
+ in: query
+ name: to
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: from
+ required: false
+ schema:
+ type: string
+ style: form
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/shift_list'
+ description: schedule shifts found
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Retrieves a schedule shifts
+ tags:
+ - Shifts
+ x-accepts:
+ - application/vnd.api+json
+ /v1/secrets:
+ get:
+ description: List secrets
+ operationId: listSecrets
+ parameters:
+ - explode: true
+ in: query
+ name: include
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "page[number]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ - explode: true
+ in: query
+ name: "page[size]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/secret_list'
+ description: success
+ security:
+ - bearer_auth: []
+ summary: List secrets
+ tags:
+ - Secrets
+ x-accepts:
+ - application/vnd.api+json
+ post:
+ description: Creates a new secret from provided data
+ operationId: createSecret
+ parameters: []
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/new_secret'
+ required: true
+ responses:
+ "201":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/secret_response'
+ description: secret created
+ "422":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: invalid request
+ "401":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: responds with unauthorized for invalid token
+ security:
+ - bearer_auth: []
+ summary: Creates a secret
+ tags:
+ - Secrets
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/secrets/{id}:
+ delete:
+ description: Delete a specific secret by id
+ operationId: deleteSecret
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/secret_response'
+ description: secret deleted
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Delete a secret
+ tags:
+ - Secrets
+ x-accepts:
+ - application/vnd.api+json
+ get:
+ description: Retrieve a specific secret by id
+ operationId: getSecret
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/secret_response'
+ description: secret found
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Retrieves a secret
+ tags:
+ - Secrets
+ x-accepts:
+ - application/vnd.api+json
+ put:
+ description: Update a specific secret by id
+ operationId: updateSecret
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/update_secret'
+ required: true
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/secret_response'
+ description: secret updated
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Update a secret
+ tags:
+ - Secrets
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/services:
+ get:
+ description: List services
+ operationId: listServices
+ parameters:
+ - explode: true
+ in: query
+ name: include
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "page[number]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ - explode: true
+ in: query
+ name: "page[size]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ - explode: true
+ in: query
+ name: "filter[search]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[name]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[slug]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[backstage_id]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[cortex_id]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[opslevel_id]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[external_id]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[alert_broadcast_enabled]"
+ required: false
+ schema:
+ type: boolean
+ style: form
+ - explode: true
+ in: query
+ name: "filter[incident_broadcast_enabled]"
+ required: false
+ schema:
+ type: boolean
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][gt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][gte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][lt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][lte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: sort
+ required: false
+ schema:
+ type: string
+ style: form
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/service_list'
+ description: success
+ security:
+ - bearer_auth: []
+ summary: List services
+ tags:
+ - Services
+ x-accepts:
+ - application/vnd.api+json
+ post:
+ description: Creates a new service from provided data
+ operationId: createService
+ parameters: []
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/new_service'
+ required: true
+ responses:
+ "201":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/service_response'
+ description: service created
+ "422":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: invalid request
+ "401":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: responds with unauthorized for invalid token
+ security:
+ - bearer_auth: []
+ summary: Creates a service
+ tags:
+ - Services
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/services/{id}:
+ delete:
+ description: Delete a specific service by id
+ operationId: deleteService
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ $ref: '#/components/schemas/getAlertField_id_parameter'
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/service_response'
+ description: service deleted
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Delete a service
+ tags:
+ - Services
+ x-accepts:
+ - application/vnd.api+json
+ get:
+ description: Retrieves a specific service by id
+ operationId: getService
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ $ref: '#/components/schemas/getAlertField_id_parameter'
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/service_response'
+ description: service found by slug
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Retrieves a service
+ tags:
+ - Services
+ x-accepts:
+ - application/vnd.api+json
+ put:
+ description: Update a specific service by id
+ operationId: updateService
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ $ref: '#/components/schemas/getAlertField_id_parameter'
+ style: simple
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/update_service'
+ required: true
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/service_response'
+ description: service updated
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Update a service
+ tags:
+ - Services
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/services/{id}/incidents_chart:
+ get:
+ description: Get service incidents chart
+ operationId: getServiceIncidentsChart
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ $ref: '#/components/schemas/getAlertField_id_parameter'
+ style: simple
+ - explode: true
+ in: query
+ name: period
+ required: true
+ schema:
+ type: string
+ style: form
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/incidents_chart_response'
+ description: success
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Get service incidents chart
+ tags:
+ - Services
+ x-accepts:
+ - application/vnd.api+json
+ /v1/services/{id}/uptime_chart:
+ get:
+ description: Get service uptime chart
+ operationId: getServiceUptimeChart
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ $ref: '#/components/schemas/getAlertField_id_parameter'
+ style: simple
+ - explode: true
+ in: query
+ name: period
+ required: false
+ schema:
+ type: string
+ style: form
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/uptime_chart_response'
+ description: success
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Get service uptime chart
+ tags:
+ - Services
+ x-accepts:
+ - application/vnd.api+json
+ /v1/services/properties:
+ get:
+ description: List Service Catalog Properties
+ operationId: listServiceCatalogProperties
+ parameters:
+ - description: "comma separated if needed. eg: catalog"
+ explode: true
+ in: query
+ name: include
+ required: false
+ schema:
+ enum:
+ - catalog
+ type: string
+ style: form
+ - description: "comma separated if needed. eg: created_at,updated_at"
+ explode: true
+ in: query
+ name: sort
+ required: false
+ schema:
+ enum:
+ - created_at
+ - -created_at
+ - updated_at
+ - -updated_at
+ - position
+ - -position
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "page[number]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ - explode: true
+ in: query
+ name: "page[size]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ - explode: true
+ in: query
+ name: "filter[slug]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[name]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[kind]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][gt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][gte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][lt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][lte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/catalog_property_list'
+ description: success
+ security:
+ - bearer_auth: []
+ summary: List Catalog Properties
+ tags:
+ - Services
+ x-accepts:
+ - application/vnd.api+json
+ post:
+ description: Creates a new Catalog Property from provided data
+ operationId: createServiceCatalogProperty
+ parameters: []
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/new_catalog_property'
+ required: true
+ responses:
+ "201":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/catalog_property_response'
+ description: catalog_property created ignores wrong catalog_type attribute
+ "422":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: exceeds max fields per catalog
+ "401":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: responds with unauthorized for invalid token
+ security:
+ - bearer_auth: []
+ summary: Creates a Catalog Property
+ tags:
+ - Services
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/severities:
+ get:
+ description: List severities
+ operationId: listSeverities
+ parameters:
+ - explode: true
+ in: query
+ name: include
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "page[number]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ - explode: true
+ in: query
+ name: "page[size]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ - explode: true
+ in: query
+ name: "filter[search]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[slug]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[name]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[severity]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[color]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][gt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][gte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][lt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][lte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: sort
+ required: false
+ schema:
+ type: string
+ style: form
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/severity_list'
+ description: success
+ security:
+ - bearer_auth: []
+ summary: List severities
+ tags:
+ - Severities
+ x-accepts:
+ - application/vnd.api+json
+ post:
+ description: Creates a new severity from provided data
+ operationId: createSeverity
+ parameters: []
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/new_severity'
+ required: true
+ responses:
+ "201":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/severity_response'
+ description: severity created
+ "422":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: invalid request
+ "401":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: responds with unauthorized for invalid token
+ security:
+ - bearer_auth: []
+ summary: Creates a severity
+ tags:
+ - Severities
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/severities/{id}:
+ delete:
+ description: Delete a specific severity by id
+ operationId: deleteSeverity
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ $ref: '#/components/schemas/getAlertField_id_parameter'
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/severity_response'
+ description: severity deleted
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Delete a severity
+ tags:
+ - Severities
+ x-accepts:
+ - application/vnd.api+json
+ get:
+ description: Retrieves a specific severity by id
+ operationId: getSeverity
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ $ref: '#/components/schemas/getAlertField_id_parameter'
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/severity_response'
+ description: severity found
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Retrieves a severity
+ tags:
+ - Severities
+ x-accepts:
+ - application/vnd.api+json
+ put:
+ description: Update a specific severity by id
+ operationId: updateSeverity
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ $ref: '#/components/schemas/getAlertField_id_parameter'
+ style: simple
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/update_severity'
+ required: true
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/severity_response'
+ description: severity updated
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Update a severity
+ tags:
+ - Severities
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/shifts:
+ get:
+ description: List shifts
+ operationId: listShifts
+ parameters:
+ - description: "comma separated if needed. eg: shift_override,user. Note: `user`\
+ \ is deprecated, use `assignee` instead."
+ explode: true
+ in: query
+ name: include
+ required: false
+ schema:
+ enum:
+ - shift_override
+ - user
+ - assignee
+ - shift_shadow
+ type: string
+ style: form
+ - description: "Start range for shifts in ISO-8601 format (e.g., 2025-01-01T00:00:00Z\
+ \ or 2025-01-01T00:00:00+00:00)"
+ explode: true
+ in: query
+ name: from
+ required: false
+ schema:
+ type: string
+ style: form
+ - description: "End range for shifts in ISO-8601 format (e.g., 2025-01-01T00:00:00Z\
+ \ or 2025-01-01T00:00:00+00:00)"
+ explode: true
+ in: query
+ name: to
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "user_ids[]"
+ required: false
+ schema:
+ items:
+ type: integer
+ type: array
+ style: form
+ - explode: true
+ in: query
+ name: "schedule_ids[]"
+ required: false
+ schema:
+ items:
+ type: string
+ type: array
+ style: form
+ - description: Page number (defaults to 1)
+ explode: true
+ in: query
+ name: "page[number]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ - description: "Number of shifts per page (defaults to 50, max 1000)"
+ explode: true
+ in: query
+ name: "page[size]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/shift_list'
+ description: success
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: List shifts
+ tags:
+ - Shifts
+ x-accepts:
+ - application/vnd.api+json
+ /v1/slas:
+ get:
+ description: List SLAs
+ operationId: listSLAs
+ parameters:
+ - explode: true
+ in: query
+ name: "page[number]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ - explode: true
+ in: query
+ name: "page[size]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ - explode: true
+ in: query
+ name: "filter[search]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[slug]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[name]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][gt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][gte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][lt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][lte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: sort
+ required: false
+ schema:
+ type: string
+ style: form
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/sla_list'
+ description: success
+ security:
+ - bearer_auth: []
+ summary: List SLAs
+ tags:
+ - SLAs
+ x-accepts:
+ - application/vnd.api+json
+ post:
+ description: Creates a new SLA from provided data
+ operationId: createSLA
+ parameters: []
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/new_sla'
+ required: true
+ responses:
+ "201":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/sla_response'
+ description: SLA created
+ "422":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: invalid request
+ "401":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: responds with unauthorized for invalid token
+ security:
+ - bearer_auth: []
+ summary: Creates an SLA
+ tags:
+ - SLAs
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/slas/{id}:
+ delete:
+ description: Delete a specific SLA by id
+ operationId: deleteSLA
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/sla_response'
+ description: SLA deleted
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found for another team
+ security:
+ - bearer_auth: []
+ summary: Delete an SLA
+ tags:
+ - SLAs
+ x-accepts:
+ - application/vnd.api+json
+ get:
+ description: Retrieves a specific SLA by id
+ operationId: getSLA
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/sla_response'
+ description: SLA found
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found for another team
+ security:
+ - bearer_auth: []
+ summary: Retrieves an SLA
+ tags:
+ - SLAs
+ x-accepts:
+ - application/vnd.api+json
+ put:
+ description: Update a specific SLA by id
+ operationId: updateSLA
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/update_sla'
+ required: true
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/sla_response'
+ description: SLA updated
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found for another team
+ security:
+ - bearer_auth: []
+ summary: Update an SLA
+ tags:
+ - SLAs
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/status-pages/{status_page_id}/templates:
+ get:
+ description: List status page templates
+ operationId: listStatusPageTemplates
+ parameters:
+ - explode: false
+ in: path
+ name: status_page_id
+ required: true
+ schema:
+ type: string
+ style: simple
+ - explode: true
+ in: query
+ name: include
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "page[number]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ - explode: true
+ in: query
+ name: "page[size]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/status_page_template_list'
+ description: success
+ security:
+ - bearer_auth: []
+ summary: List status page templates
+ tags:
+ - StatusPageTemplates
+ x-accepts:
+ - application/vnd.api+json
+ post:
+ description: Creates a new template from provided data
+ operationId: createStatusPageTemplate
+ parameters:
+ - explode: false
+ in: path
+ name: status_page_id
+ required: true
+ schema:
+ type: string
+ style: simple
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/status_page_template'
+ required: true
+ responses:
+ "201":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/status_page_template_response'
+ description: incident_event created
+ "422":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: invalid request
+ "401":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: responds with unauthorized for invalid token
+ security:
+ - bearer_auth: []
+ summary: Creates a status page template
+ tags:
+ - StatusPageTemplates
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/templates/{id}:
+ delete:
+ description: Delete a specific template event by id
+ operationId: deleteStatusPageTemplate
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/status_page_template_response'
+ description: incident_event deleted
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Delete a incident event
+ tags:
+ - StatusPageTemplates
+ x-accepts:
+ - application/vnd.api+json
+ get:
+ description: Retrieves a specific status_page_template by id
+ operationId: getStatusPageTemplate
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/status_page_template_response'
+ description: status page template found
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Retrieves a status page template
+ tags:
+ - StatusPageTemplates
+ x-accepts:
+ - application/vnd.api+json
+ put:
+ description: Update a specific template event by id
+ operationId: updateStatusPageTemplate
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/status_page_template'
+ required: true
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/status_page_template_response'
+ description: incident_event updated
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Update status page template
+ tags:
+ - StatusPageTemplates
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/status-pages:
+ get:
+ description: List status pages
+ operationId: listStatusPages
+ parameters:
+ - explode: true
+ in: query
+ name: include
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "page[number]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ - explode: true
+ in: query
+ name: "page[size]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ - explode: true
+ in: query
+ name: "filter[search]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[name]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[slug]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][gt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][gte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][lt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][lte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: sort
+ required: false
+ schema:
+ type: string
+ style: form
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/status_page_list'
+ description: success
+ security:
+ - bearer_auth: []
+ summary: List status pages
+ tags:
+ - StatusPages
+ x-accepts:
+ - application/vnd.api+json
+ post:
+ description: Creates a new status page from provided data
+ operationId: createStatusPage
+ parameters: []
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/new_status_page'
+ required: true
+ responses:
+ "201":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/status_page_response'
+ description: status page with SAML created
+ "422":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: invalid SAML configuration
+ "401":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: responds with unauthorized for invalid token
+ security:
+ - bearer_auth: []
+ summary: Creates a status page
+ tags:
+ - StatusPages
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/status-pages/{id}:
+ delete:
+ description: Delete a specific status page by id
+ operationId: deleteStatusPage
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ $ref: '#/components/schemas/getAlertField_id_parameter'
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/status_page_response'
+ description: status_page deleted
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Delete a status page
+ tags:
+ - StatusPages
+ x-accepts:
+ - application/vnd.api+json
+ get:
+ description: Retrieves a specific status page by id
+ operationId: getStatusPage
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ $ref: '#/components/schemas/getAlertField_id_parameter'
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/status_page_response'
+ description: status_page found
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Retrieves a status page
+ tags:
+ - StatusPages
+ x-accepts:
+ - application/vnd.api+json
+ put:
+ description: Update a specific status page by id
+ operationId: updateStatusPage
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ $ref: '#/components/schemas/getAlertField_id_parameter'
+ style: simple
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/update_status_page'
+ required: true
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/status_page_response'
+ description: external_domain_names persisted
+ "422":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: invalid section_order
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Update a status page
+ tags:
+ - StatusPages
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/statuses:
+ get:
+ description: List Statuses
+ operationId: listStatuses
+ parameters:
+ - explode: true
+ in: query
+ name: include
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "page[number]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ - explode: true
+ in: query
+ name: "page[size]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ - explode: true
+ in: query
+ name: "filter[slug]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[name]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[enabled]"
+ required: false
+ schema:
+ type: boolean
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][gt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][gte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][lt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][lte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/status_list'
+ description: success
+ "401":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: responds with unauthorized for invalid token
+ security:
+ - bearer_auth: []
+ summary: List Statuses
+ tags:
+ - Statuses
+ x-accepts:
+ - application/vnd.api+json
+ /v1/statuses/{id}:
+ get:
+ description: Retrieves a specific Status by id
+ operationId: getStatus
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ $ref: '#/components/schemas/getAlertField_id_parameter'
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/status_response'
+ description: status found by slug
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Retrieves a Status
+ tags:
+ - Statuses
+ x-accepts:
+ - application/vnd.api+json
+ /v1/sub_statuses:
+ get:
+ description: List Sub-Statuses
+ operationId: listSubStatuses
+ parameters:
+ - explode: true
+ in: query
+ name: include
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "page[number]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ - explode: true
+ in: query
+ name: "page[size]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ - explode: true
+ in: query
+ name: "filter[slug]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[name]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[parent_status]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][gt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][gte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][lt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][lte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/sub_status_list'
+ description: success
+ security:
+ - bearer_auth: []
+ summary: List Sub-Statuses
+ tags:
+ - SubStatuses
+ x-accepts:
+ - application/vnd.api+json
+ post:
+ description: Creates a new Sub-Status from provided data
+ operationId: createSubStatus
+ parameters: []
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/new_sub_status'
+ required: true
+ responses:
+ "201":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/sub_status_response'
+ description: sub_status created
+ "422":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: invalid request
+ "401":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: responds with unauthorized for invalid token
+ security:
+ - bearer_auth: []
+ summary: Creates a Sub-Status
+ tags:
+ - SubStatuses
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/sub_statuses/{id}:
+ delete:
+ description: Delete a specific Sub-Status by id
+ operationId: deleteSubStatus
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ $ref: '#/components/schemas/getAlertField_id_parameter'
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/sub_status_response'
+ description: sub_status deleted
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Delete a Sub-Status
+ tags:
+ - SubStatuses
+ x-accepts:
+ - application/vnd.api+json
+ get:
+ description: Retrieves a specific Sub-Status by id
+ operationId: getSubStatus
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ $ref: '#/components/schemas/getAlertField_id_parameter'
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/sub_status_response'
+ description: sub_status found by slug
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Retrieves a Sub-Status
+ tags:
+ - SubStatuses
+ x-accepts:
+ - application/vnd.api+json
+ put:
+ description: Update a specific Sub-Status by id
+ operationId: updateSubStatus
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ $ref: '#/components/schemas/getAlertField_id_parameter'
+ style: simple
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/update_sub_status'
+ required: true
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/sub_status_response'
+ description: sub_status updated
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Update a Sub-Status
+ tags:
+ - SubStatuses
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/teams:
+ get:
+ description: List teams
+ operationId: listTeams
+ parameters:
+ - description: "comma separated if needed. eg: users"
+ explode: true
+ in: query
+ name: include
+ required: false
+ schema:
+ enum:
+ - users
+ - schedules
+ - escalation_policies
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "page[number]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ - explode: true
+ in: query
+ name: "page[size]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ - explode: true
+ in: query
+ name: "filter[search]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[slug]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[name]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[backstage_id]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[cortex_id]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[opslevel_id]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[external_id]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[color]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[alert_broadcast_enabled]"
+ required: false
+ schema:
+ type: boolean
+ style: form
+ - explode: true
+ in: query
+ name: "filter[incident_broadcast_enabled]"
+ required: false
+ schema:
+ type: boolean
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][gt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][gte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][lt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][lte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: sort
+ required: false
+ schema:
+ type: string
+ style: form
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/team_list'
+ description: success
+ security:
+ - bearer_auth: []
+ summary: List teams
+ tags:
+ - Teams
+ x-accepts:
+ - application/vnd.api+json
+ post:
+ description: Creates a new team from provided data
+ operationId: createTeam
+ parameters: []
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/new_team'
+ required: true
+ responses:
+ "201":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/team_response'
+ description: team created
+ "422":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: invalid association
+ "401":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: responds with unauthorized for invalid token
+ security:
+ - bearer_auth: []
+ summary: Creates a team
+ tags:
+ - Teams
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/teams/{id}:
+ delete:
+ description: Delete a specific team by id
+ operationId: deleteTeam
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ $ref: '#/components/schemas/getTeam_id_parameter'
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/team_response'
+ description: team deleted
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Delete a team
+ tags:
+ - Teams
+ x-accepts:
+ - application/vnd.api+json
+ get:
+ description: Retrieves a specific team by id
+ operationId: getTeam
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ $ref: '#/components/schemas/getTeam_id_parameter'
+ style: simple
+ - description: "comma separated if needed. eg: users"
+ explode: true
+ in: query
+ name: include
+ required: false
+ schema:
+ enum:
+ - users
+ - schedules
+ - escalation_policies
+ type: string
+ style: form
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/team_response'
+ description: team found by slug
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Retrieves a team
+ tags:
+ - Teams
+ x-accepts:
+ - application/vnd.api+json
+ put:
+ description: Update a specific team by id
+ operationId: updateTeam
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ $ref: '#/components/schemas/getTeam_id_parameter'
+ style: simple
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/update_team'
+ required: true
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/team_response'
+ description: team updated
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Update a team
+ tags:
+ - Teams
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/teams/{id}/incidents_chart:
+ get:
+ description: Get team incidents chart
+ operationId: getTeamIncidentsChart
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ - explode: true
+ in: query
+ name: period
+ required: true
+ schema:
+ type: string
+ style: form
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/incidents_chart_response'
+ description: success
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Get team incidents chart
+ tags:
+ - Teams
+ x-accepts:
+ - application/vnd.api+json
+ /v1/teams/properties:
+ get:
+ description: List Group Catalog Properties
+ operationId: listGroupCatalogProperties
+ parameters:
+ - description: "comma separated if needed. eg: catalog"
+ explode: true
+ in: query
+ name: include
+ required: false
+ schema:
+ enum:
+ - catalog
+ type: string
+ style: form
+ - description: "comma separated if needed. eg: created_at,updated_at"
+ explode: true
+ in: query
+ name: sort
+ required: false
+ schema:
+ enum:
+ - created_at
+ - -created_at
+ - updated_at
+ - -updated_at
+ - position
+ - -position
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "page[number]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ - explode: true
+ in: query
+ name: "page[size]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ - explode: true
+ in: query
+ name: "filter[slug]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[name]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[kind]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][gt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][gte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][lt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][lte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/catalog_property_list'
+ description: success
+ security:
+ - bearer_auth: []
+ summary: List Catalog Properties
+ tags:
+ - Teams
+ x-accepts:
+ - application/vnd.api+json
+ post:
+ description: Creates a new Catalog Property from provided data
+ operationId: createGroupCatalogProperty
+ parameters: []
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/new_catalog_property'
+ required: true
+ responses:
+ "201":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/catalog_property_response'
+ description: catalog_property created ignores wrong catalog_type attribute
+ "422":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: exceeds max fields per catalog
+ "401":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: responds with unauthorized for invalid token
+ security:
+ - bearer_auth: []
+ summary: Creates a Catalog Property
+ tags:
+ - Teams
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/users/{user_id}/email_addresses:
+ get:
+ description: Retrieves all email addresses for the specified user
+ operationId: getUserEmailAddresses
+ parameters:
+ - explode: false
+ in: path
+ name: user_id
+ required: true
+ schema:
+ type: string
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/user_email_address_list'
+ description: user_email_addresses found
+ "401":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: responds with unauthorized for invalid token
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: responds with not found when accessing other user's resources
+ security:
+ - bearer_auth: []
+ summary: Retrieves user email addresses
+ tags:
+ - UserEmailAddresses
+ x-accepts:
+ - application/vnd.api+json
+ post:
+ description: Creates a new user email address from provided data
+ operationId: createUserEmailAddress
+ parameters:
+ - explode: false
+ in: path
+ name: user_id
+ required: true
+ schema:
+ type: string
+ style: simple
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/new_user_email_address'
+ required: true
+ responses:
+ "201":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/user_email_address_response'
+ description: user_email_address created
+ "401":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: responds with unauthorized for invalid token
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: responds with not found when accessing other user's resources
+ "422":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: invalid request
+ security:
+ - bearer_auth: []
+ summary: Creates a user email address
+ tags:
+ - UserEmailAddresses
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/email_addresses/{id}:
+ delete:
+ description: Deletes a user email address
+ operationId: deleteUserEmailAddress
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/user_email_address_response'
+ description: user_email_address deleted
+ "401":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: responds with unauthorized for invalid token
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: responds with not found when accessing other user's resources
+ security:
+ - bearer_auth: []
+ summary: Delete user email address
+ tags:
+ - UserEmailAddresses
+ x-accepts:
+ - application/vnd.api+json
+ get:
+ description: Retrieves a specific user email address
+ operationId: showUserEmailAddress
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/user_email_address_response'
+ description: user_email_address found
+ "401":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: responds with unauthorized for invalid token
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: responds with not found when accessing other user's resources
+ security:
+ - bearer_auth: []
+ summary: Show user email address
+ tags:
+ - UserEmailAddresses
+ x-accepts:
+ - application/vnd.api+json
+ put:
+ description: Updates a user email address
+ operationId: updateUserEmailAddress
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/update_user_email_address'
+ required: true
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/user_email_address_response'
+ description: user_email_address updated
+ "401":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: responds with unauthorized for invalid token
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: responds with not found when accessing other user's resources
+ "422":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: invalid request
+ security:
+ - bearer_auth: []
+ summary: Update user email address
+ tags:
+ - UserEmailAddresses
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/email_addresses/{id}/verify:
+ post:
+ description: Verifies an email address using a verification token
+ operationId: verifyUserEmailAddress
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ - explode: true
+ in: query
+ name: token
+ required: true
+ schema:
+ type: string
+ style: form
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/user_email_address_response'
+ description: email address verified successfully
+ "422":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: invalid or expired token
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: email address not found
+ security:
+ - bearer_auth: []
+ summary: Verifies an email address with token
+ tags:
+ - UserEmailAddresses
+ x-accepts:
+ - application/vnd.api+json
+ /v1/email_addresses/{id}/resend_verification:
+ post:
+ description: Resends verification email for an email address
+ operationId: resendUserEmailAddressVerification
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/user_email_address_response'
+ description: verification email sent successfully
+ "422":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: email address already verified
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: email address not found
+ security:
+ - bearer_auth: []
+ summary: Resends verification email
+ tags:
+ - UserEmailAddresses
+ x-accepts:
+ - application/vnd.api+json
+ /v1/users/{user_id}/notification_rules:
+ get:
+ description: List user notification rules
+ operationId: listUserNotificationRules
+ parameters:
+ - explode: false
+ in: path
+ name: user_id
+ required: true
+ schema:
+ type: string
+ style: simple
+ - explode: true
+ in: query
+ name: include
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "page[number]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ - explode: true
+ in: query
+ name: "page[size]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ - explode: true
+ in: query
+ name: sort
+ required: false
+ schema:
+ type: string
+ style: form
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/user_notification_rule_list'
+ description: success
+ security:
+ - bearer_auth: []
+ summary: List user notification rules
+ tags:
+ - UserNotificationRules
+ x-accepts:
+ - application/vnd.api+json
+ post:
+ description: Creates a new user notification rule from provided data
+ operationId: createUserNotificationRule
+ parameters:
+ - explode: false
+ in: path
+ name: user_id
+ required: true
+ schema:
+ type: string
+ style: simple
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/new_user_notification_rule'
+ required: true
+ responses:
+ "201":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/user_notification_rule_response'
+ description: user_notification_rule created
+ "422":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: invalid request
+ "401":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: responds with unauthorized for invalid token
+ security:
+ - bearer_auth: []
+ summary: Creates an user notification rule
+ tags:
+ - UserNotificationRules
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/notification_rules/{id}:
+ delete:
+ description: Delete a specific user notification rule by id
+ operationId: deleteUserNotificationRule
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/user_notification_rule_response'
+ description: user_notification_rule deleted
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Delete an user notification rule
+ tags:
+ - UserNotificationRules
+ x-accepts:
+ - application/vnd.api+json
+ get:
+ description: Retrieves a specific user notification rule by id
+ operationId: getUserNotificationRule
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/user_notification_rule_response'
+ description: user_notification_rule found
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Retrieves an user notification rule
+ tags:
+ - UserNotificationRules
+ x-accepts:
+ - application/vnd.api+json
+ put:
+ description: Update a specific user notification rule by id
+ operationId: updateUserNotificationRule
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/update_user_notification_rule'
+ required: true
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/user_notification_rule_response'
+ description: user_notification_rule updated
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Update an user notification rule
+ tags:
+ - UserNotificationRules
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/users/{user_id}/phone_numbers:
+ get:
+ description: Retrieves all phone numbers for the specified user
+ operationId: getUserPhoneNumbers
+ parameters:
+ - explode: false
+ in: path
+ name: user_id
+ required: true
+ schema:
+ type: string
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/user_phone_number_list'
+ description: user_phone_numbers found
+ "401":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: responds with unauthorized for invalid token
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Retrieves user phone numbers
+ tags:
+ - UserPhoneNumbers
+ x-accepts:
+ - application/vnd.api+json
+ post:
+ description: Creates a new user phone number from provided data
+ operationId: createUserPhoneNumber
+ parameters:
+ - explode: false
+ in: path
+ name: user_id
+ required: true
+ schema:
+ type: string
+ style: simple
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/new_user_phone_number'
+ required: true
+ responses:
+ "201":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/user_phone_number_response'
+ description: user_phone_number created
+ "422":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: invalid request
+ "401":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: responds with unauthorized for invalid token
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Creates a user phone number
+ tags:
+ - UserPhoneNumbers
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/phone_numbers/{id}:
+ delete:
+ description: Deletes a user phone number
+ operationId: deleteUserPhoneNumber
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/user_phone_number_response'
+ description: user_phone_number deleted
+ "401":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: responds with unauthorized for invalid token
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ "422":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: cannot delete phone number used by notification rule
+ security:
+ - bearer_auth: []
+ summary: Delete user phone number
+ tags:
+ - UserPhoneNumbers
+ x-accepts:
+ - application/vnd.api+json
+ get:
+ description: Retrieves a specific user phone number
+ operationId: showUserPhoneNumber
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/user_phone_number_response'
+ description: user_phone_number found
+ "401":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: responds with unauthorized for invalid token
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Show user phone number
+ tags:
+ - UserPhoneNumbers
+ x-accepts:
+ - application/vnd.api+json
+ put:
+ description: Updates a user phone number
+ operationId: updateUserPhoneNumber
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/update_user_phone_number'
+ required: true
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/user_phone_number_response'
+ description: user_phone_number updated and verification status reset
+ "422":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: invalid request
+ "401":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: responds with unauthorized for invalid token
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Update user phone number
+ tags:
+ - UserPhoneNumbers
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/users:
+ get:
+ description: List users
+ operationId: listUsers
+ parameters:
+ - explode: true
+ in: query
+ name: "page[number]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ - explode: true
+ in: query
+ name: "page[size]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ - explode: true
+ in: query
+ name: "filter[search]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[email]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][gt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][gte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][lt]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[created_at][lte]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - description: "comma separated if needed. eg: created_at,updated_at"
+ explode: true
+ in: query
+ name: sort
+ required: false
+ schema:
+ enum:
+ - created_at
+ - -created_at
+ - updated_at
+ - -updated_at
+ type: string
+ style: form
+ - description: "comma separated if needed. eg: email_addresses,phone_numbers"
+ explode: true
+ in: query
+ name: include
+ required: false
+ schema:
+ enum:
+ - email_addresses
+ - phone_numbers
+ - devices
+ - role
+ - on_call_role
+ - teams
+ - schedules
+ - notification_rules
+ type: string
+ style: form
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/user_list'
+ description: user found
+ "401":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: responds with unauthorized for invalid token
+ security:
+ - bearer_auth: []
+ summary: List users
+ tags:
+ - Users
+ x-accepts:
+ - application/vnd.api+json
+ /v1/users/me:
+ get:
+ description: Get current user
+ operationId: getCurrentUser
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/user_response'
+ description: user found
+ "401":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: responds with unauthorized for invalid token
+ security:
+ - bearer_auth: []
+ summary: Get current user
+ tags:
+ - Users
+ x-accepts:
+ - application/vnd.api+json
+ /v1/users/{id}:
+ delete:
+ description: Delete a specific user by id
+ operationId: deleteUser
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/user_response'
+ description: user deleted
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Delete an user
+ tags:
+ - Users
+ x-accepts:
+ - application/vnd.api+json
+ get:
+ description: Retrieves a specific user by id
+ operationId: getUser
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ - description: "comma separated if needed. eg: email_addresses,phone_numbers"
+ explode: true
+ in: query
+ name: include
+ required: false
+ schema:
+ enum:
+ - email_addresses
+ - phone_numbers
+ - devices
+ - role
+ - on_call_role
+ - teams
+ - schedules
+ - notification_rules
+ type: string
+ style: form
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/user_response'
+ description: schedules include only returns schedules from the current team
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Retrieves an user
+ tags:
+ - Users
+ x-accepts:
+ - application/vnd.api+json
+ put:
+ description: Update a specific user by id
+ operationId: updateUser
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/update_user'
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/user_response'
+ description: update name and role simultaneously
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: returns 404 for on_call_role_id belonging to another team
+ security:
+ - bearer_auth: []
+ summary: Update a user
+ tags:
+ - Users
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/webhooks/endpoints/{endpoint_id}/deliveries:
+ get:
+ description: List webhook deliveries for given endpoint
+ operationId: listWebhooksDeliveries
+ parameters:
+ - explode: true
+ in: query
+ name: include
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: false
+ in: path
+ name: endpoint_id
+ required: true
+ schema:
+ type: string
+ style: simple
+ - explode: true
+ in: query
+ name: "page[number]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ - explode: true
+ in: query
+ name: "page[size]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/webhooks_delivery_list'
+ description: success
+ security:
+ - bearer_auth: []
+ summary: List webhook deliveries
+ tags:
+ - WebhooksDeliveries
+ x-accepts:
+ - application/vnd.api+json
+ /v1/webhooks/deliveries/{id}/deliver:
+ post:
+ description: Retries a webhook delivery
+ operationId: deliverWebhooksDelivery
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/webhooks_delivery_response'
+ description: webhooks_delivery delivered
+ security:
+ - bearer_auth: []
+ summary: Retries a webhook delivery
+ tags:
+ - WebhooksDeliveries
+ x-accepts:
+ - application/vnd.api+json
+ /v1/webhooks/deliveries/{id}:
+ get:
+ description: Retrieves a specific webhook delivery by id
+ operationId: getWebhooksDelivery
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/webhooks_delivery_response'
+ description: webhooks_delivery found
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: resource not found
+ security:
+ - bearer_auth: []
+ summary: Retrieves a webhook delivery
+ tags:
+ - WebhooksDeliveries
+ x-accepts:
+ - application/vnd.api+json
+ /v1/webhooks/endpoints:
+ get:
+ description: List webhook endpoints
+ operationId: listWebhooksEndpoints
+ parameters:
+ - explode: true
+ in: query
+ name: include
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "page[number]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ - explode: true
+ in: query
+ name: "page[size]"
+ required: false
+ schema:
+ type: integer
+ style: form
+ - explode: true
+ in: query
+ name: "filter[slug]"
+ required: false
+ schema:
+ type: string
+ style: form
+ - explode: true
+ in: query
+ name: "filter[name]"
+ required: false
+ schema:
+ type: string
+ style: form
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/webhooks_endpoint_list'
+ description: excludes hidden endpoints from listing
+ security:
+ - bearer_auth: []
+ summary: List webhook endpoints
+ tags:
+ - WebhooksEndpoints
+ x-accepts:
+ - application/vnd.api+json
+ post:
+ description: Creates a new webhook endpoint from provided data
+ operationId: createWebhooksEndpoint
+ parameters: []
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/new_webhooks_endpoint'
+ required: true
+ responses:
+ "201":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/webhooks_endpoint_response'
+ description: webhooks_endpoint created
+ "422":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: invalid request
+ "401":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: responds with unauthorized for invalid token
+ security:
+ - bearer_auth: []
+ summary: Creates a webhook endpoint
+ tags:
+ - WebhooksEndpoints
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+ /v1/webhooks/endpoints/{id}:
+ delete:
+ description: Delete a specific webhook endpoint by id
+ operationId: deleteWebhooksEndpoint
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/webhooks_endpoint_response'
+ description: webhooks_endpoint deleted
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: hidden endpoint not accessible
+ security:
+ - bearer_auth: []
+ summary: Delete a webhook endpoint
+ tags:
+ - WebhooksEndpoints
+ x-accepts:
+ - application/vnd.api+json
+ get:
+ description: Retrieves a specific webhook endpoint by id
+ operationId: getWebhooksEndpoint
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/webhooks_endpoint_response'
+ description: webhooks_endpoint found
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: hidden endpoint not accessible
+ security:
+ - bearer_auth: []
+ summary: Retrieves a webhook endpoint
+ tags:
+ - WebhooksEndpoints
+ x-accepts:
+ - application/vnd.api+json
+ put:
+ description: Update a specific webhook endpoint by id
+ operationId: updateWebhooksEndpoint
+ parameters:
+ - explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ style: simple
+ requestBody:
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/update_webhooks_endpoint'
+ required: true
+ responses:
+ "200":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/webhooks_endpoint_response'
+ description: webhooks_endpoint updated
+ "404":
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/errors_list'
+ description: hidden endpoint not accessible
+ security:
+ - bearer_auth: []
+ summary: Update a webhook endpoint
+ tags:
+ - WebhooksEndpoints
+ x-content-type: application/vnd.api+json
+ x-accepts:
+ - application/vnd.api+json
+components:
+ schemas:
+ attach_alert:
+ properties:
+ data:
+ $ref: '#/components/schemas/attach_alert_data'
+ required:
+ - data
+ type: object
+ new_alert:
+ properties:
+ data:
+ $ref: '#/components/schemas/new_alert_data'
+ required:
+ - data
+ type: object
+ update_alert:
+ properties:
+ data:
+ $ref: '#/components/schemas/update_alert_data'
+ required:
+ - data
+ type: object
+ alert:
+ properties:
+ short_id:
+ description: Human-readable short identifier for the alert
+ type: string
+ noise:
+ description: Whether the alert is marked as noise
+ enum:
+ - noise
+ - not_noise
+ nullable: true
+ type: string
+ source:
+ description: The source of the alert
+ enum:
+ - rootly
+ - manual
+ - api
+ - heartbeat
+ - web
+ - slack
+ - email
+ - workflow
+ - live_call_routing
+ - mobile
+ - pagerduty
+ - opsgenie
+ - victorops
+ - pagertree
+ - datadog
+ - dynatrace
+ - nobl9
+ - zendesk
+ - asana
+ - clickup
+ - sentry
+ - rollbar
+ - jira
+ - honeycomb
+ - service_now
+ - linear
+ - grafana
+ - alertmanager
+ - google_cloud
+ - generic_webhook
+ - cloud_watch
+ - aws_sns
+ - azure
+ - splunk
+ - chronosphere
+ - app_optics
+ - bug_snag
+ - monte_carlo
+ - nagios
+ - prtg
+ - catchpoint
+ - app_dynamics
+ - checkly
+ - new_relic
+ - gitlab
+ type: string
+ status:
+ description: The status of the alert
+ enum:
+ - open
+ - triggered
+ - acknowledged
+ - resolved
+ - deferred
+ type: string
+ summary:
+ description: The summary of the alert
+ type: string
+ description:
+ description: The description of the alert
+ nullable: true
+ type: string
+ services:
+ description: Services attached to the alert
+ items:
+ allOf:
+ - $ref: '#/components/schemas/service'
+ type: object
+ type: array
+ groups:
+ description: Groups attached to the alert
+ items:
+ allOf:
+ - $ref: '#/components/schemas/team'
+ type: object
+ type: array
+ environments:
+ description: Environments attached to the alert
+ items:
+ allOf:
+ - $ref: '#/components/schemas/environment'
+ type: object
+ type: array
+ service_ids:
+ description: The Service IDs to attach to the alert. If your organization
+ has On-Call enabled and your notification target is a Service. This field
+ will be automatically set for you.
+ items:
+ type: string
+ nullable: true
+ type: array
+ group_ids:
+ description: The Group IDs to attach to the alert. If your organization
+ has On-Call enabled and your notification target is a Group. This field
+ will be automatically set for you.
+ items:
+ type: string
+ nullable: true
+ type: array
+ environment_ids:
+ description: The Environment IDs to attach to the alert
+ items:
+ type: string
+ nullable: true
+ type: array
+ external_id:
+ description: External ID
+ nullable: true
+ type: string
+ external_url:
+ description: External Url
+ nullable: true
+ type: string
+ alert_urgency_id:
+ description: The ID of the alert urgency
+ nullable: true
+ type: string
+ group_leader_alert_id:
+ description: The ID of the group leader alert
+ nullable: true
+ type: string
+ is_group_leader_alert:
+ description: Whether the alert is a group leader alert
+ nullable: true
+ type: boolean
+ labels:
+ items:
+ $ref: '#/components/schemas/new_alert_data_attributes_labels_inner'
+ type: array
+ data:
+ description: Additional data
+ nullable: true
+ type: object
+ deduplication_key:
+ description: Alerts sharing the same deduplication key are treated as a
+ single alert.
+ nullable: true
+ type: string
+ alert_field_values_attributes:
+ description: Custom alert field values to create with the alert
+ items:
+ $ref: '#/components/schemas/new_alert_data_attributes_alert_field_values_attributes_inner'
+ type: array
+ started_at:
+ description: When the alert started
+ format: date-time
+ nullable: true
+ type: string
+ ended_at:
+ description: When the alert ended
+ format: date-time
+ nullable: true
+ type: string
+ created_at:
+ description: Date of creation
+ type: string
+ updated_at:
+ description: Date of last update
+ type: string
+ required:
+ - created_at
+ - short_id
+ - source
+ - summary
+ - updated_at
+ type: object
+ alert_response:
+ properties:
+ data:
+ $ref: '#/components/schemas/alert_response_data'
+ required:
+ - data
+ type: object
+ alert_list:
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/alert_response_data'
+ type: array
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
+ required:
+ - data
+ - links
+ - meta
+ type: object
+ resolve_alert:
+ properties:
+ data:
+ $ref: '#/components/schemas/resolve_alert_data'
+ type: object
+ snooze_alert:
+ properties:
+ data:
+ $ref: '#/components/schemas/snooze_alert_data'
+ required:
+ - data
+ type: object
+ escalate_alert:
+ properties:
+ data:
+ $ref: '#/components/schemas/escalate_alert_data'
+ type: object
+ new_alert_event:
+ properties:
+ data:
+ $ref: '#/components/schemas/new_alert_event_data'
+ required:
+ - data
+ type: object
+ update_alert_event:
+ description: "Update an alert event. Note: Only alert events with kind='note'\
+ \ can be updated. You cannot change the kind field."
+ properties:
+ data:
+ $ref: '#/components/schemas/update_alert_event_data'
+ required:
+ - data
+ type: object
+ alert_event:
+ properties:
+ kind:
+ enum:
+ - informational
+ - notification
+ - action
+ - status_update
+ - recording
+ - alert_grouping
+ - alert_urgency
+ - alert_routing
+ - note
+ - noise
+ - maintenance
+ - deferral
+ type: string
+ action:
+ enum:
+ - created
+ - escalation_policy_paged
+ - ignored_alert_request
+ - emailed
+ - slacked
+ - called
+ - texted
+ - notified
+ - skipped
+ - opened
+ - retriggered
+ - answered
+ - acknowledged
+ - escalated
+ - paged
+ - resolved
+ - attached
+ - snoozed
+ - triggered
+ - open
+ - updated
+ - added
+ - removed
+ - marked
+ - not_marked
+ - muted
+ - deferred
+ type: string
+ source:
+ type: string
+ user_id:
+ description: Author of the note.
+ nullable: true
+ type: integer
+ details:
+ description: Note message.
+ nullable: true
+ type: string
+ created_at:
+ type: string
+ updated_at:
+ type: string
+ required:
+ - action
+ - created_at
+ - kind
+ - source
+ - updated_at
+ type: object
+ alert_event_response:
+ properties:
+ data:
+ $ref: '#/components/schemas/alert_event_response_data'
+ required:
+ - data
+ type: object
+ alert_event_list:
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/alert_event_response_data'
+ type: array
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
+ required:
+ - data
+ - links
+ - meta
+ type: object
+ new_alerts_source:
+ properties:
+ data:
+ $ref: '#/components/schemas/new_alerts_source_data'
+ required:
+ - data
+ type: object
+ update_alerts_source:
+ properties:
+ data:
+ $ref: '#/components/schemas/update_alerts_source_data'
+ required:
+ - data
+ type: object
+ alerts_source:
+ properties:
+ name:
+ description: The name of the alert source
+ type: string
+ source_type:
+ description: The alert source type
+ enum:
+ - email
+ - app_dynamics
+ - catchpoint
+ - datadog
+ - dynatrace
+ - alertmanager
+ - google_cloud
+ - grafana
+ - sentry
+ - generic_webhook
+ - cloud_watch
+ - aws_sns
+ - checkly
+ - azure
+ - new_relic
+ - splunk
+ - chronosphere
+ - app_optics
+ - bug_snag
+ - honeycomb
+ - monte_carlo
+ - nagios
+ - prtg
+ type: string
+ alert_urgency_id:
+ description: ID for the default alert urgency assigned to this alert source
+ type: string
+ deduplicate_alerts_by_key:
+ description: "Toggle alert deduplication using deduplication key. If enabled,\
+ \ deduplication_key_kind and deduplication_key_path are required."
+ type: boolean
+ deduplication_key_kind:
+ description: Kind of deduplication key.
+ enum:
+ - payload
+ type: string
+ deduplication_key_path:
+ description: Path to deduplication key. This is a JSON Path to extract the
+ deduplication key from the request body.
+ nullable: true
+ type: string
+ deduplication_key_regexp:
+ description: Regular expression to extract key from value found at key path.
+ nullable: true
+ type: string
+ owner_group_ids:
+ description: List of team IDs that will own the alert source
+ items:
+ type: string
+ type: array
+ alert_template_attributes:
+ $ref: '#/components/schemas/new_alerts_source_data_attributes_alert_template_attributes'
+ alert_source_urgency_rules_attributes:
+ description: List of rules that define the conditions under which the alert
+ urgency will be set automatically based on the alert payload
+ items:
+ $ref: '#/components/schemas/new_alerts_source_data_attributes_alert_source_urgency_rules_attributes_inner'
+ type: array
+ sourceable_attributes:
+ $ref: '#/components/schemas/new_alerts_source_data_attributes_sourceable_attributes'
+ resolution_rule_attributes:
+ $ref: '#/components/schemas/new_alerts_source_data_attributes_resolution_rule_attributes'
+ alert_source_fields_attributes:
+ description: "List of alert fields to be added to the alert source. Note:\
+ \ This attribute requires the alert field feature to be enabled on your\
+ \ account. Contact Rootly customer support if you need assistance with\
+ \ this feature."
+ items:
+ $ref: '#/components/schemas/new_alerts_source_data_attributes_alert_source_fields_attributes_inner'
+ type: array
+ status:
+ description: The status of the alert source
+ enum:
+ - connected
+ - setup_complete
+ - setup_incomplete
+ type: string
+ secret:
+ description: The secret used to authenticate non-email alert sources
+ type: string
+ email:
+ description: The email generated for email alert sources
+ nullable: true
+ type: string
+ webhook_endpoint:
+ description: The webhook URL generated for non-email alert sources
+ nullable: true
+ type: string
+ created_at:
+ description: Date of creation
+ type: string
+ updated_at:
+ description: Date of last update
+ type: string
+ required:
+ - created_at
+ - name
+ - secret
+ - status
+ - updated_at
+ type: object
+ alerts_source_response:
+ properties:
+ data:
+ $ref: '#/components/schemas/alerts_source_response_data'
+ required:
+ - data
+ type: object
+ alerts_source_list:
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/alerts_source_response_data'
+ type: array
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
+ required:
+ - data
+ - links
+ - meta
+ type: object
+ new_alert_route:
+ properties:
+ data:
+ $ref: '#/components/schemas/new_alert_route_data'
+ type: object
+ update_alert_route:
+ properties:
+ data:
+ $ref: '#/components/schemas/update_alert_route_data'
+ required:
+ - data
+ type: object
+ patch_alert_route:
+ properties:
+ data:
+ $ref: '#/components/schemas/patch_alert_route_data'
+ required:
+ - data
+ type: object
+ alert_route:
+ properties:
+ name:
+ description: The name of the alert route
+ type: string
+ enabled:
+ description: Whether the alert route is enabled
+ type: boolean
+ alerts_source_ids:
+ items:
+ description: The ID of the alerts source
+ format: uuid
+ type: string
+ type: array
+ owning_team_ids:
+ items:
+ description: The ID of the owning team
+ format: uuid
+ type: string
+ type: array
+ rules:
+ items:
+ $ref: '#/components/schemas/new_alert_route_data_attributes_rules_inner'
+ type: array
+ required:
+ - alerts_source_ids
+ - name
+ type: object
+ alert_route_response:
+ properties:
+ data:
+ $ref: '#/components/schemas/alert_route_response_data'
+ required:
+ - data
+ type: object
+ alert_route_list:
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/alert_route_response_data'
+ type: array
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
+ required:
+ - data
+ - links
+ - meta
+ type: object
+ new_alert_routing_rule:
+ properties:
+ data:
+ $ref: '#/components/schemas/new_alert_routing_rule_data'
+ required:
+ - data
+ type: object
+ update_alert_routing_rule:
+ properties:
+ data:
+ $ref: '#/components/schemas/update_alert_routing_rule_data'
+ required:
+ - data
+ type: object
+ alert_routing_rule:
+ properties:
+ name:
+ description: The name of the alert routing rule
+ type: string
+ enabled:
+ description: Whether the alert routing rule is enabled
+ type: boolean
+ alerts_source_id:
+ description: The ID of the alerts source
+ format: uuid
+ type: string
+ position:
+ description: The position of the alert routing rule for ordering evaluation
+ type: integer
+ condition_type:
+ description: The type of condition for the alert routing rule
+ enum:
+ - all
+ - any
+ type: string
+ conditions:
+ description: The conditions for the alert routing rule
+ items:
+ $ref: '#/components/schemas/alert_routing_rule_conditions_inner'
+ type: array
+ destination:
+ $ref: '#/components/schemas/alert_routing_rule_destination'
+ condition_groups:
+ description: The condition groups for the alert routing rule
+ items:
+ $ref: '#/components/schemas/alert_routing_rule_condition_groups_inner'
+ type: array
+ created_at:
+ description: Date of creation
+ type: string
+ updated_at:
+ description: Date of last update
+ type: string
+ required:
+ - alerts_source_id
+ - condition_type
+ - created_at
+ - enabled
+ - name
+ - position
+ - updated_at
+ type: object
+ alert_routing_rule_response:
+ properties:
+ data:
+ $ref: '#/components/schemas/alert_routing_rule_response_data'
+ required:
+ - data
+ type: object
+ alert_routing_rule_list:
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/alert_routing_rule_response_data'
+ type: array
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
+ required:
+ - data
+ - links
+ - meta
+ type: object
+ alert_routing_rule_target:
+ description: The destination target for the alert routing rule
+ nullable: true
+ properties:
+ target_type:
+ description: The type of the target. Please contact support if you encounter
+ issues using `Functionality` as a target type.
+ enum:
+ - Service
+ - Group
+ - Functionality
+ - EscalationPolicy
+ type: string
+ target_id:
+ description: The ID of the target
+ format: uuid
+ type: string
+ required:
+ - target_id
+ - target_type
+ type: object
+ alert_routing_rule_condition:
+ description: A condition for alert routing rule
+ properties:
+ id:
+ description: Unique ID of the condition
+ format: uuid
+ type: string
+ property_field_type:
+ description: The type of the property field
+ enum:
+ - attribute
+ - payload
+ type: string
+ property_field_name:
+ description: The name of the property field
+ type: string
+ property_field_condition_type:
+ description: The condition type of the property field
+ enum:
+ - is_one_of
+ - is_not_one_of
+ - contains
+ - does_not_contain
+ - starts_with
+ - ends_with
+ - matches_regex
+ - is_empty
+ type: string
+ property_field_value:
+ description: The value of the property field
+ nullable: true
+ type: string
+ property_field_values:
+ description: The values of the property field
+ items:
+ type: string
+ nullable: true
+ type: array
+ conditionable_id:
+ description: The ID of the conditionable object
+ format: uuid
+ nullable: true
+ type: string
+ conditionable_type:
+ description: The type of the conditionable object
+ nullable: true
+ type: string
+ created_at:
+ description: Date of creation
+ type: string
+ updated_at:
+ description: Date of last update
+ type: string
+ required:
+ - property_field_condition_type
+ - property_field_name
+ - property_field_type
+ type: object
+ alert_routing_rule_condition_group:
+ description: A group of conditions for alert routing rule
+ properties:
+ id:
+ description: Unique ID of the condition group
+ format: uuid
+ type: string
+ position:
+ description: The position of the condition group for ordering
+ type: integer
+ conditions:
+ description: The conditions within this group
+ items:
+ $ref: '#/components/schemas/alert_routing_rule_condition'
+ type: array
+ created_at:
+ description: Date of creation
+ type: string
+ updated_at:
+ description: Date of last update
+ type: string
+ required:
+ - position
+ type: object
+ new_alert_field:
+ properties:
+ data:
+ $ref: '#/components/schemas/new_alert_field_data'
+ required:
+ - data
+ type: object
+ update_alert_field:
+ properties:
+ data:
+ $ref: '#/components/schemas/update_alert_field_data'
+ required:
+ - data
+ type: object
+ alert_field:
+ properties:
+ slug:
+ description: The slug of the alert field
+ type: string
+ name:
+ description: The name of the alert field
+ type: string
+ kind:
+ description: The kind of alert field
+ type: string
+ created_at:
+ description: Date of creation
+ type: string
+ updated_at:
+ description: Date of last update
+ type: string
+ required:
+ - created_at
+ - kind
+ - name
+ - updated_at
+ type: object
+ alert_field_response:
+ properties:
+ data:
+ $ref: '#/components/schemas/alert_field_response_data'
+ required:
+ - data
+ type: object
+ alert_field_list:
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/alert_field_list_data_inner'
+ type: array
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
+ required:
+ - data
+ - links
+ - meta
+ type: object
+ new_alert_urgency:
+ properties:
+ data:
+ $ref: '#/components/schemas/new_alert_urgency_data'
+ required:
+ - data
+ type: object
+ update_alert_urgency:
+ properties:
+ data:
+ $ref: '#/components/schemas/update_alert_urgency_data'
+ required:
+ - data
+ type: object
+ alert_urgency:
+ properties:
+ name:
+ description: The name of the alert urgency
+ type: string
+ description:
+ description: The description of the alert urgency
+ type: string
+ position:
+ description: Position of the alert urgency
+ type: integer
+ created_at:
+ description: Date of creation
+ type: string
+ updated_at:
+ description: Date of last update
+ type: string
+ required:
+ - created_at
+ - description
+ - name
+ - position
+ - updated_at
+ type: object
+ alert_urgency_response:
+ properties:
+ data:
+ $ref: '#/components/schemas/alert_urgency_response_data'
+ required:
+ - data
+ type: object
+ alert_urgency_list:
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/alert_urgency_response_data'
+ type: array
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
+ required:
+ - data
+ - links
+ - meta
+ type: object
+ new_alert_group:
+ properties:
+ data:
+ $ref: '#/components/schemas/new_alert_group_data'
+ required:
+ - data
+ type: object
+ update_alert_group:
+ properties:
+ data:
+ $ref: '#/components/schemas/update_alert_group_data'
+ required:
+ - data
+ type: object
+ alert_group:
+ properties:
+ name:
+ description: The name of the alert group
+ type: string
+ description:
+ description: The description of the alert group
+ nullable: true
+ type: string
+ slug:
+ description: The slug of the alert group
+ type: string
+ condition_type:
+ description: Grouping condition for the alert group
+ type: string
+ time_window:
+ description: Time window for the alert grouping
+ type: integer
+ group_by_alert_title:
+ deprecated: true
+ description: "[DEPRECATED] Whether the alerts are grouped by title or not.\
+ \ This field is deprecated. Please use the `conditions` field with advanced\
+ \ alert grouping instead."
+ type: boolean
+ group_by_alert_urgency:
+ deprecated: true
+ description: "[DEPRECATED] Whether the alerts are grouped by urgency or\
+ \ not. This field is deprecated. Please use the `conditions` field with\
+ \ advanced alert grouping instead."
+ type: boolean
+ targets:
+ items:
+ $ref: '#/components/schemas/new_alert_group_data_attributes_targets_inner'
+ type: array
+ attributes:
+ deprecated: true
+ description: "This field is deprecated. Please use the `conditions` field\
+ \ instead, `attributes` will be removed in the future."
+ items:
+ $ref: '#/components/schemas/new_alert_group_data_attributes_attributes_inner'
+ type: array
+ conditions:
+ description: The conditions for the alert group
+ items:
+ $ref: '#/components/schemas/alert_group_conditions_inner'
+ type: array
+ created_at:
+ description: Date of creation
+ type: string
+ updated_at:
+ description: Date of last update
+ type: string
+ deleted_at:
+ description: Date or deletion
+ nullable: true
+ type: string
+ required:
+ - condition_type
+ - created_at
+ - deleted_at
+ - description
+ - name
+ - time_window
+ - updated_at
+ type: object
+ alert_group_response:
+ properties:
+ data:
+ $ref: '#/components/schemas/alert_group_response_data'
+ required:
+ - data
+ type: object
+ alert_group_list:
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/alert_group_response_data'
+ type: array
+ required:
+ - data
+ type: object
+ new_api_key:
+ properties:
+ data:
+ $ref: '#/components/schemas/new_api_key_data'
+ required:
+ - data
+ type: object
+ update_api_key:
+ properties:
+ data:
+ $ref: '#/components/schemas/update_api_key_data'
+ required:
+ - data
+ type: object
+ rotate_api_key:
+ properties:
+ data:
+ $ref: '#/components/schemas/rotate_api_key_data'
+ required:
+ - data
+ type: object
+ api_key:
+ properties:
+ name:
+ description: The name of the API key
+ type: string
+ description:
+ description: A description of the API key
+ nullable: true
+ type: string
+ kind:
+ description: The kind of the API key
+ enum:
+ - personal
+ - team
+ - organization
+ type: string
+ role_id:
+ description: The role ID
+ nullable: true
+ type: string
+ on_call_role_id:
+ description: The on-call role ID
+ nullable: true
+ type: string
+ created_at:
+ description: Date of creation
+ type: string
+ updated_at:
+ description: Date of last update
+ type: string
+ expires_at:
+ description: Expiration date
+ nullable: true
+ type: string
+ last_used_at:
+ description: Date of last use
+ nullable: true
+ type: string
+ grace_period_ends_at:
+ description: Grace period end date
+ nullable: true
+ type: string
+ required:
+ - created_at
+ - kind
+ - name
+ - updated_at
+ type: object
+ api_key_response:
+ properties:
+ data:
+ $ref: '#/components/schemas/api_key_response_data'
+ required:
+ - data
+ type: object
+ api_key_with_token_response:
+ properties:
+ data:
+ $ref: '#/components/schemas/api_key_with_token_response_data'
+ required:
+ - data
+ type: object
+ api_key_list:
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/api_key_response_data'
+ type: array
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
+ required:
+ - data
+ - links
+ - meta
+ type: object
+ audit:
+ properties:
+ event:
+ description: Describes the action that was taken.
+ type: string
+ item_type:
+ description: Describes the object in which the action was taken on
+ enum:
+ - AlertRoute
+ - AlertRoutingRule
+ - Alerts::Source
+ - ApiKey
+ - Catalog
+ - CatalogEntity
+ - CatalogEntityProperty
+ - CatalogField
+ - Cause
+ - CustomField
+ - CustomFieldOption
+ - CustomForm
+ - Dashboard
+ - EdgeConnector
+ - EdgeConnector::Action
+ - Environment
+ - EscalationPolicy
+ - EscalationPolicyPath
+ - ExportJob
+ - FormField
+ - Functionality
+ - GeniusWorkflow
+ - GeniusWorkflowGroup
+ - GeniusWorkflowRun
+ - Group
+ - GroupUser
+ - Heartbeat
+ - Incident
+ - LoginActivity
+ - IncidentActionItem
+ - IncidentEvent
+ - IncidentFormFieldSelection
+ - IncidentFormFieldSelectionUser
+ - IncidentPermissionSet
+ - IncidentPostMortem
+ - IncidentRoleAssignment
+ - IncidentRoleTask
+ - IncidentStatusPageEvent
+ - IncidentTask
+ - IncidentType
+ - Integrations::DatadogAccount
+ - Integrations::GithubAccount
+ - Integrations::GoogleMeetAccount
+ - Integrations::JiraAccount
+ - Integrations::MicrosoftTeamsAccount
+ - Integrations::OpsgenieAccount
+ - Integrations::PagerdutyAccount
+ - Integrations::ServiceNowAccount
+ - Integrations::SlackAccount
+ - Integrations::StatusPageIoAccount
+ - Integrations::ZendeskAccount
+ - Integrations::ZoomAccount
+ - LiveCallRouter
+ - Membership
+ - OnCallRole
+ - Playbook
+ - PlaybookTask
+ - Role
+ - Schedule
+ - Secret
+ - Service
+ - Severity
+ - StatusPage
+ nullable: true
+ type: string
+ item_type_display:
+ description: Human-friendly display name for the item type
+ nullable: true
+ type: string
+ object:
+ description: The object in which the action was taken on
+ nullable: true
+ type: object
+ object_changes:
+ description: The changes that occurred on the object
+ nullable: true
+ type: object
+ user_id:
+ description: The ID of who took action on the object. Together with whodunnit_type
+ can be used to find the user
+ nullable: true
+ type: integer
+ created_at:
+ description: Date of creation
+ type: string
+ item_id:
+ description: ID of the affected object
+ nullable: true
+ type: string
+ id:
+ description: ID of audit
+ nullable: true
+ type: integer
+ required:
+ - created_at
+ - event
+ type: object
+ audits_list:
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/audits_list_data_inner'
+ type: array
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
+ required:
+ - data
+ - links
+ - meta
+ type: object
+ new_authorization:
+ properties:
+ data:
+ $ref: '#/components/schemas/new_authorization_data'
+ required:
+ - data
+ type: object
+ update_authorization:
+ properties:
+ data:
+ $ref: '#/components/schemas/update_authorization_data'
+ required:
+ - data
+ type: object
+ authorization:
+ properties:
+ authorizable_id:
+ description: The id of the resource being accessed.
+ type: string
+ authorizable_type:
+ description: The type of resource being accessed.
+ enum:
+ - Dashboard
+ type: string
+ grantee_id:
+ description: The resource id granted access.
+ type: string
+ grantee_type:
+ description: The type of resource granted access.
+ enum:
+ - User
+ - Team
+ type: string
+ permissions:
+ items:
+ enum:
+ - read
+ - update
+ - authorize
+ - destroy
+ type: string
+ type: array
+ created_at:
+ type: string
+ updated_at:
+ type: string
+ required:
+ - authorizable_id
+ - authorizable_type
+ - created_at
+ - grantee_id
+ - grantee_type
+ - permissions
+ - updated_at
+ type: object
+ authorization_response:
+ properties:
+ data:
+ $ref: '#/components/schemas/authorization_response_data'
+ required:
+ - data
+ type: object
+ authorization_list:
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/authorization_response_data'
+ type: array
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
+ required:
+ - data
+ - links
+ - meta
+ type: object
+ new_catalog:
+ properties:
+ data:
+ $ref: '#/components/schemas/new_catalog_data'
+ required:
+ - data
+ type: object
+ update_catalog:
+ properties:
+ data:
+ $ref: '#/components/schemas/update_catalog_data'
+ required:
+ - data
+ type: object
+ catalog:
+ properties:
+ name:
+ type: string
+ description:
+ nullable: true
+ type: string
+ icon:
+ enum:
+ - globe-alt
+ - server-stack
+ - users
+ - user-group
+ - chart-bar
+ - shapes
+ - light-bulb
+ - cursor-arrow-ripple
+ type: string
+ position:
+ description: Default position of the catalog when displayed in a list.
+ nullable: true
+ type: integer
+ created_at:
+ type: string
+ updated_at:
+ type: string
+ required:
+ - created_at
+ - icon
+ - name
+ - position
+ - updated_at
+ type: object
+ catalog_response:
+ properties:
+ data:
+ $ref: '#/components/schemas/catalog_response_data'
+ required:
+ - data
+ type: object
+ catalog_list:
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/catalog_response_data'
+ type: array
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
+ required:
+ - data
+ - links
+ - meta
+ type: object
+ new_catalog_field:
+ description: A catalog can have a maximum of 50 fields.
+ properties:
+ data:
+ $ref: '#/components/schemas/new_catalog_field_data'
+ required:
+ - data
+ type: object
+ update_catalog_field:
+ properties:
+ data:
+ $ref: '#/components/schemas/update_catalog_field_data'
+ required:
+ - data
+ type: object
+ catalog_field:
+ properties:
+ catalog_id:
+ nullable: true
+ type: string
+ name:
+ type: string
+ slug:
+ type: string
+ kind:
+ enum:
+ - text
+ - reference
+ type: string
+ kind_catalog_id:
+ description: Restricts values to items of specified catalog.
+ nullable: true
+ type: string
+ multiple:
+ description: Whether the attribute accepts multiple values.
+ type: boolean
+ position:
+ description: Default position of the item when displayed in a list.
+ nullable: true
+ type: integer
+ required:
+ description: Whether the field is required.
+ type: boolean
+ catalog_type:
+ description: The type of catalog the field belongs to.
+ enum:
+ - catalog
+ - cause
+ - environment
+ - functionality
+ - incident_type
+ - service
+ - team
+ type: string
+ created_at:
+ type: string
+ updated_at:
+ type: string
+ required:
+ - catalog_id
+ - created_at
+ - kind
+ - multiple
+ - name
+ - position
+ - updated_at
+ type: object
+ catalog_field_response:
+ properties:
+ data:
+ $ref: '#/components/schemas/catalog_field_response_data'
+ required:
+ - data
+ type: object
+ catalog_field_list:
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/catalog_field_response_data'
+ type: array
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
+ required:
+ - data
+ - links
+ - meta
+ type: object
+ new_catalog_property:
+ description: A catalog can have a maximum of 50 properties.
+ properties:
+ data:
+ $ref: '#/components/schemas/new_catalog_property_data'
+ required:
+ - data
+ type: object
+ update_catalog_property:
+ properties:
+ data:
+ $ref: '#/components/schemas/update_catalog_property_data'
+ required:
+ - data
+ type: object
+ catalog_property:
+ properties:
+ catalog_id:
+ nullable: true
+ type: string
+ name:
+ type: string
+ slug:
+ type: string
+ kind:
+ enum:
+ - text
+ - reference
+ type: string
+ kind_catalog_id:
+ description: Restricts values to items of specified catalog.
+ nullable: true
+ type: string
+ multiple:
+ description: Whether the attribute accepts multiple values.
+ type: boolean
+ position:
+ description: Default position of the item when displayed in a list.
+ nullable: true
+ type: integer
+ required:
+ description: Whether the property is required.
+ type: boolean
+ catalog_type:
+ description: The type of catalog the property belongs to.
+ enum:
+ - catalog
+ - cause
+ - environment
+ - functionality
+ - incident_type
+ - service
+ - team
+ type: string
+ created_at:
+ type: string
+ updated_at:
+ type: string
+ required:
+ - catalog_id
+ - created_at
+ - kind
+ - multiple
+ - name
+ - position
+ - updated_at
+ type: object
+ catalog_property_response:
properties:
data:
- $ref: '#/components/schemas/attach_alert_data'
+ $ref: '#/components/schemas/catalog_property_response_data'
required:
- data
type: object
- new_alert:
+ catalog_property_list:
properties:
data:
- $ref: '#/components/schemas/new_alert_data'
+ items:
+ $ref: '#/components/schemas/catalog_property_response_data'
+ type: array
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
+ - links
+ - meta
type: object
- update_alert:
+ new_catalog_entity:
properties:
data:
- $ref: '#/components/schemas/update_alert_data'
+ $ref: '#/components/schemas/new_catalog_entity_data'
required:
- data
type: object
- alert:
+ update_catalog_entity:
properties:
- noise:
- description: Whether the alert is marked as noise
- enum:
- - noise
- - not_noise
+ data:
+ $ref: '#/components/schemas/update_catalog_entity_data'
+ required:
+ - data
+ type: object
+ catalog_entity:
+ properties:
+ name:
+ type: string
+ description:
nullable: true
type: string
- source:
- description: The source of the alert
+ position:
+ description: Default position of the item when displayed in a list.
+ nullable: true
+ type: integer
+ backstage_id:
+ description: The Backstage entity ID this catalog entity is linked to.
+ nullable: true
+ type: string
+ created_at:
+ type: string
+ updated_at:
+ type: string
+ properties:
+ description: Array of property values for this catalog entity
+ items:
+ $ref: '#/components/schemas/new_catalog_entity_data_attributes_properties_inner'
+ type: array
+ required:
+ - created_at
+ - name
+ - position
+ - updated_at
+ type: object
+ catalog_entity_response:
+ properties:
+ data:
+ $ref: '#/components/schemas/catalog_entity_response_data'
+ required:
+ - data
+ type: object
+ catalog_entity_list:
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/catalog_entity_response_data'
+ type: array
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
+ required:
+ - data
+ - links
+ - meta
+ type: object
+ new_catalog_entity_property:
+ deprecated: true
+ description: "**Deprecated:** This endpoint is deprecated, please use the `fields`\
+ \ attribute on catalog entities or native catalog endpoints (teams, services,\
+ \ functionalities, incident_types, causes, environments) to set field values\
+ \ instead."
+ properties:
+ data:
+ $ref: '#/components/schemas/new_catalog_entity_property_data'
+ required:
+ - data
+ type: object
+ update_catalog_entity_property:
+ deprecated: true
+ description: "**Deprecated:** This endpoint is deprecated, please use the `fields`\
+ \ attribute on catalog entities or native catalog endpoints (teams, services,\
+ \ functionalities, incident_types, causes, environments) to set field values\
+ \ instead."
+ properties:
+ data:
+ $ref: '#/components/schemas/update_catalog_entity_property_data'
+ required:
+ - data
+ type: object
+ catalog_entity_property:
+ deprecated: true
+ description: "**Deprecated:** This endpoint is deprecated, please use `include=fields`\
+ \ on catalog entities or native catalog endpoints (teams, services, functionalities,\
+ \ incident_types, causes, environments) to retrieve field values instead."
+ properties:
+ catalog_entity_id:
+ type: string
+ catalog_field_id:
+ type: string
+ key:
enum:
- - rootly
- - manual
- - api
- - web
+ - text
+ - catalog_entity
- slack
- - email
- - workflow
- - live_call_routing
- - pagerduty
- - opsgenie
- - victorops
- - pagertree
- - datadog
- - nobl9
- - zendesk
- - asana
- - clickup
- - sentry
- - rollbar
- - jira
- - honeycomb
- - service_now
- - linear
- - grafana
- - alertmanager
- - google_cloud
- - generic_webhook
- - cloud_watch
- - azure
- - splunk
- - chronosphere
- - app_optics
- - bug_snag
- - monte_carlo
- - nagios
- - prtg
- - catchpoint
- - app_dynamics
- - checkly
- - new_relic
- - gitlab
+ type: string
+ value:
+ type: string
+ created_at:
+ type: string
+ updated_at:
+ type: string
+ required:
+ - catalog_entity_id
+ - catalog_field_id
+ - created_at
+ - key
+ - updated_at
+ - value
+ type: object
+ catalog_entity_property_response:
+ deprecated: true
+ description: "**Deprecated:** This endpoint is deprecated, please use `include=fields`\
+ \ on catalog entities or native catalog endpoints (teams, services, functionalities,\
+ \ incident_types, causes, environments) to retrieve field values instead."
+ properties:
+ data:
+ $ref: '#/components/schemas/catalog_entity_property_response_data'
+ required:
+ - data
+ type: object
+ catalog_entity_property_list:
+ deprecated: true
+ description: "**Deprecated:** This endpoint is deprecated, please use `include=fields`\
+ \ on catalog entities or native catalog endpoints (teams, services, functionalities,\
+ \ incident_types, causes, environments) to retrieve field values instead."
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/catalog_entity_property_response_data'
+ type: array
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
+ required:
+ - data
+ - links
+ - meta
+ type: object
+ new_catalog_checklist_template:
+ properties:
+ data:
+ $ref: '#/components/schemas/new_catalog_checklist_template_data'
+ required:
+ - data
+ type: object
+ update_catalog_checklist_template:
+ properties:
+ data:
+ $ref: '#/components/schemas/update_catalog_checklist_template_data'
+ required:
+ - data
+ type: object
+ catalog_checklist_template:
+ properties:
+ name:
+ description: The name of the checklist template
+ type: string
+ slug:
+ description: The slug of the checklist template
+ type: string
+ description:
+ description: The description of the checklist template
+ nullable: true
+ type: string
+ catalog_type:
+ description: The catalog type
+ enum:
+ - Service
+ - Functionality
+ - Environment
+ - Group
+ - Cause
+ - IncidentType
+ - Catalog
+ type: string
+ scope_type:
+ description: The scope type
+ enum:
+ - Team
+ - Catalog
+ type: string
+ scope_id:
+ description: The scope ID
+ type: string
+ created_at:
+ description: Date of creation
+ type: string
+ updated_at:
+ description: Date of last update
+ type: string
+ fields:
+ description: Template fields in position order
+ items:
+ $ref: '#/components/schemas/catalog_checklist_template_fields_inner'
+ nullable: true
+ type: array
+ owners:
+ description: Template owners
+ items:
+ $ref: '#/components/schemas/catalog_checklist_template_owners_inner'
+ nullable: true
+ type: array
+ required:
+ - catalog_type
+ - created_at
+ - name
+ - scope_id
+ - scope_type
+ - updated_at
+ type: object
+ catalog_checklist_template_response:
+ properties:
+ data:
+ $ref: '#/components/schemas/catalog_checklist_template_response_data'
+ required:
+ - data
+ type: object
+ catalog_checklist_template_list:
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/catalog_checklist_template_response_data'
+ type: array
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
+ required:
+ - data
+ type: object
+ catalog_entity_checklist:
+ properties:
+ catalog_checklist_template_id:
+ description: The ID of the checklist template
+ type: string
+ auditable_type:
+ description: The type of the auditable entity
+ enum:
+ - Service
+ - Functionality
+ - Environment
+ - Group
+ - Cause
+ - IncidentType
+ - CatalogEntity
+ type: string
+ auditable_id:
+ description: The ID of the auditable entity
type: string
status:
- description: The status of the alert
+ description: The status of the checklist
enum:
- - open
- triggered
- - acknowledged
- - resolved
+ - in_progress
+ - completed
+ - cancelled
type: string
- summary:
- description: The summary of the alert
+ started_at:
+ description: When the checklist was started
+ nullable: true
+ type: string
+ completed_at:
+ description: When the checklist was completed
+ nullable: true
+ type: string
+ completed_by_user_id:
+ description: The ID of the user who completed the checklist
+ nullable: true
+ type: string
+ created_at:
+ description: Date of creation
+ type: string
+ updated_at:
+ description: Date of last update
+ type: string
+ checklist_fields:
+ description: Checklist fields
+ items:
+ $ref: '#/components/schemas/catalog_entity_checklist_checklist_fields_inner'
+ nullable: true
+ type: array
+ checklist_owners:
+ description: Checklist owners
+ items:
+ $ref: '#/components/schemas/catalog_entity_checklist_checklist_owners_inner'
+ nullable: true
+ type: array
+ required:
+ - auditable_id
+ - auditable_type
+ - catalog_checklist_template_id
+ - created_at
+ - status
+ - updated_at
+ type: object
+ catalog_entity_checklist_response:
+ properties:
+ data:
+ $ref: '#/components/schemas/catalog_entity_checklist_response_data'
+ required:
+ - data
+ type: object
+ catalog_entity_checklist_list:
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/catalog_entity_checklist_response_data'
+ type: array
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
+ required:
+ - data
+ type: object
+ new_cause:
+ properties:
+ data:
+ $ref: '#/components/schemas/new_cause_data'
+ required:
+ - data
+ type: object
+ update_cause:
+ properties:
+ data:
+ $ref: '#/components/schemas/update_cause_data'
+ required:
+ - data
+ type: object
+ cause:
+ properties:
+ name:
+ description: The name of the cause
+ type: string
+ slug:
+ description: The slug of the cause
+ type: string
+ description:
+ description: The description of the cause
+ nullable: true
+ type: string
+ position:
+ description: Position of the cause
+ nullable: true
+ type: integer
+ properties:
+ description: Array of property values for this cause.
+ items:
+ $ref: '#/components/schemas/new_cause_data_attributes_properties_inner'
+ type: array
+ created_at:
+ description: Date of creation
+ type: string
+ updated_at:
+ description: Date of last update
+ type: string
+ required:
+ - created_at
+ - name
+ - updated_at
+ type: object
+ cause_response:
+ properties:
+ data:
+ $ref: '#/components/schemas/cause_response_data'
+ required:
+ - data
+ type: object
+ cause_list:
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/cause_response_data'
+ type: array
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
+ required:
+ - data
+ - links
+ - meta
+ type: object
+ new_communications_stage:
+ properties:
+ data:
+ $ref: '#/components/schemas/new_communications_stage_data'
+ required:
+ - data
+ type: object
+ update_communications_stage:
+ properties:
+ data:
+ $ref: '#/components/schemas/update_communications_stage_data'
+ required:
+ - data
+ type: object
+ communications_stage:
+ properties:
+ name:
+ description: The name of the communications stage
+ type: string
+ slug:
+ description: The slug of the communications stage
+ type: string
+ description:
+ description: The description of the communications stage
+ nullable: true
+ type: string
+ position:
+ description: Position of the communications stage
+ nullable: true
+ type: integer
+ created_at:
+ description: Date of creation
+ type: string
+ updated_at:
+ description: Date of last update
+ type: string
+ required:
+ - created_at
+ - name
+ - position
+ - updated_at
+ type: object
+ communications_stage_response:
+ properties:
+ data:
+ $ref: '#/components/schemas/communications_stage_response_data'
+ required:
+ - data
+ type: object
+ communications_stages_response:
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/communications_stage_response_data'
+ type: array
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
+ required:
+ - data
+ type: object
+ new_communications_type:
+ properties:
+ data:
+ $ref: '#/components/schemas/new_communications_type_data'
+ required:
+ - data
+ type: object
+ update_communications_type:
+ properties:
+ data:
+ $ref: '#/components/schemas/update_communications_type_data'
+ required:
+ - data
+ type: object
+ communications_type:
+ properties:
+ name:
+ description: The name of the communications type
+ type: string
+ slug:
+ description: The slug of the communications type
+ type: string
+ description:
+ description: The description of the communications type
+ nullable: true
+ type: string
+ color:
+ description: The color of the communications type
+ nullable: true
+ type: string
+ position:
+ description: Position of the communications type
+ type: integer
+ created_at:
+ description: Date of creation
+ type: string
+ updated_at:
+ description: Date of last update
+ type: string
+ required:
+ - color
+ - created_at
+ - name
+ - position
+ - updated_at
+ type: object
+ communications_type_response:
+ properties:
+ data:
+ $ref: '#/components/schemas/communications_type_response_data'
+ required:
+ - data
+ type: object
+ communications_types_response:
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/communications_type_response_data'
+ type: array
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
+ required:
+ - data
+ type: object
+ new_communications_template:
+ properties:
+ data:
+ $ref: '#/components/schemas/new_communications_template_data'
+ required:
+ - data
+ type: object
+ update_communications_template:
+ properties:
+ data:
+ $ref: '#/components/schemas/update_communications_template_data'
+ required:
+ - data
+ type: object
+ communications_template:
+ properties:
+ name:
+ description: The name of the communications template
+ type: string
+ slug:
+ description: The slug of the communications template
+ type: string
+ description:
+ description: The description of the communications template
+ nullable: true
+ type: string
+ position:
+ description: Position of the communications template
+ nullable: true
+ type: integer
+ created_at:
+ description: Date of creation
+ type: string
+ updated_at:
+ description: Date of last update
type: string
- description:
- description: The description of the alert
- nullable: true
+ communication_type_id:
+ description: The communication type ID
type: string
- services:
- description: Services attached to the alert
+ communication_template_stages:
+ description: Communication template stages
items:
- allOf:
- - $ref: '#/components/schemas/service'
- type: object
+ $ref: '#/components/schemas/communications_template_communication_template_stages_inner'
+ nullable: true
type: array
- groups:
- description: Groups attached to the alert
+ communication_type:
+ $ref: '#/components/schemas/communications_template_communication_type'
+ required:
+ - created_at
+ - name
+ - position
+ - updated_at
+ type: object
+ communications_template_response:
+ properties:
+ data:
+ $ref: '#/components/schemas/communications_template_response_data'
+ required:
+ - data
+ type: object
+ communications_templates_response:
+ properties:
+ data:
items:
- allOf:
- - $ref: '#/components/schemas/team'
- type: object
+ $ref: '#/components/schemas/communications_template_response_data'
type: array
- environments:
- description: Environments attached to the alert
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
+ required:
+ - data
+ type: object
+ new_communications_group:
+ properties:
+ data:
+ $ref: '#/components/schemas/new_communications_group_data'
+ required:
+ - data
+ type: object
+ update_communications_group:
+ properties:
+ data:
+ $ref: '#/components/schemas/update_communications_group_data'
+ required:
+ - data
+ type: object
+ communications_group:
+ properties:
+ name:
+ description: The name of the communications group
+ type: string
+ slug:
+ description: The slug of the communications group
+ type: string
+ description:
+ description: The description of the communications group
+ nullable: true
+ type: string
+ communication_type_id:
+ description: The communication type ID
+ type: string
+ is_private:
+ description: Whether the group is private
+ type: boolean
+ condition_type:
+ description: Condition type
+ enum:
+ - any
+ - all
+ type: string
+ sms_channel:
+ description: SMS channel enabled
+ type: boolean
+ email_channel:
+ description: Email channel enabled
+ type: boolean
+ created_at:
+ description: Date of creation
+ type: string
+ updated_at:
+ description: Date of last update
+ type: string
+ communication_group_conditions:
+ description: Group conditions attributes
items:
- allOf:
- - $ref: '#/components/schemas/environment'
- type: object
+ $ref: '#/components/schemas/new_communications_group_data_attributes_communication_group_conditions_inner'
+ nullable: true
type: array
- service_ids:
- description: The Service ID's to attach to the alert. If your organization
- has On-Call enabled and your notification target is a Service. This field
- will be automatically set for you.
+ member_ids:
+ description: Array of member user IDs
items:
- type: string
+ type: integer
nullable: true
type: array
- group_ids:
- description: The Group ID's to attach to the alert. If your organization
- has On-Call enabled and your notification target is a Group. This field
- will be automatically set for you.
+ slack_channel_ids:
+ description: Array of Slack channel IDs
items:
type: string
nullable: true
type: array
- environment_ids:
- description: The Environment ID's to attach to the alert
+ communication_external_group_members:
+ description: External group members
items:
- type: string
+ $ref: '#/components/schemas/communications_group_communication_external_group_members_inner'
nullable: true
type: array
- external_id:
- description: External ID
- nullable: true
- type: string
- external_url:
- description: External Url
- nullable: true
- type: string
- alert_urgency_id:
- description: The ID of the alert urgency
- nullable: true
- type: string
- labels:
+ required:
+ - communication_type_id
+ - condition_type
+ - created_at
+ - email_channel
+ - is_private
+ - name
+ - sms_channel
+ - updated_at
+ type: object
+ communications_group_response:
+ properties:
+ data:
+ $ref: '#/components/schemas/communications_group_response_data'
+ required:
+ - data
+ type: object
+ communications_groups_response:
+ properties:
+ data:
items:
- $ref: '#/components/schemas/new_alert_data_attributes_labels_inner'
+ $ref: '#/components/schemas/communications_group_response_data'
type: array
- data:
- description: Additional data
- nullable: true
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
type: object
+ required:
+ - data
+ type: object
+ new_custom_field_option:
+ properties:
+ data:
+ $ref: '#/components/schemas/new_custom_field_option_data'
+ required:
+ - data
+ type: object
+ update_custom_field_option:
+ properties:
+ data:
+ $ref: '#/components/schemas/update_custom_field_option_data'
+ required:
+ - data
+ type: object
+ custom_field_option:
+ properties:
+ custom_field_id:
+ description: The ID of the parent custom field
+ type: integer
+ value:
+ description: The value of the custom_field_option
+ type: string
+ color:
+ description: The hex color of the custom_field_option
+ type: string
+ default:
+ type: boolean
+ position:
+ description: The position of the custom_field_option
+ type: integer
created_at:
description: Date of creation
type: string
@@ -39184,322 +27243,338 @@ components:
description: Date of last update
type: string
required:
+ - color
- created_at
- - source
- - summary
+ - position
- updated_at
+ - value
type: object
- alert_response:
+ custom_field_option_response:
properties:
data:
- $ref: '#/components/schemas/alert_response_data'
+ $ref: '#/components/schemas/custom_field_option_response_data'
required:
- data
type: object
- alert_list:
+ custom_field_option_list:
properties:
data:
items:
- $ref: '#/components/schemas/alert_response_data'
+ $ref: '#/components/schemas/custom_field_option_response_data'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- resolve_alert:
- properties:
- data:
- $ref: '#/components/schemas/resolve_alert_data'
- type: object
- new_alert_event:
+ new_custom_field:
properties:
data:
- $ref: '#/components/schemas/new_alert_event_data'
+ $ref: '#/components/schemas/new_custom_field_data'
required:
- data
type: object
- update_alert_event:
+ update_custom_field:
properties:
data:
- $ref: '#/components/schemas/update_alert_event_data'
+ $ref: '#/components/schemas/update_custom_field_data'
required:
- data
type: object
- alert_event:
+ custom_field:
properties:
+ label:
+ description: The name of the custom_field
+ type: string
kind:
- enum:
- - informational
- - notification
- - action
- - status_update
- - recording
- - alert_grouping
- - alert_urgency
- - alert_routing
- - note
- - noise
- - maintenance
+ description: The kind of the custom_field
type: string
- action:
- enum:
- - created
- - emailed
- - slacked
- - called
- - texted
- - notified
- - opened
- - retriggered
- - answered
- - acknowledged
- - escalated
- - paged
- - resolved
- - attached
- - snoozed
- - triggered
- - updated
- - added
- - removed
- - marked
- - not_marked
- - muted
+ enabled:
+ description: Whether the custom_field is enabled
+ type: boolean
+ slug:
+ description: The slug of the custom_field
type: string
- source:
+ description:
+ description: The description of the custom_field
+ nullable: true
type: string
- user_id:
- description: Author of the note.
+ shown:
+ items:
+ description: Where the custom_field is shown
+ enum:
+ - incident_form
+ - incident_mitigation_form
+ - incident_resolution_form
+ - incident_post_mortem_form
+ - incident_slack_form
+ - incident_mitigation_slack_form
+ - incident_resolution_slack_form
+ - incident_post_mortem
+ type: string
+ type: array
+ required:
+ items:
+ description: Where the custom_field is required
+ enum:
+ - incident_form
+ - incident_mitigation_form
+ - incident_resolution_form
+ - incident_post_mortem_form
+ - incident_slack_form
+ - incident_mitigation_slack_form
+ - incident_resolution_slack_form
+ type: string
nullable: true
- type: integer
- details:
- description: Note message.
+ type: array
+ default:
+ description: The default value for text field kinds
nullable: true
type: string
+ position:
+ description: The position of the custom_field
+ type: integer
created_at:
+ description: Date of creation
type: string
updated_at:
+ description: Date of last update
type: string
required:
- - action
- created_at
- - kind
- - source
+ - label
+ - position
+ - required
+ - shown
- updated_at
type: object
- alert_event_response:
+ custom_field_response:
properties:
data:
- $ref: '#/components/schemas/alert_event_response_data'
+ $ref: '#/components/schemas/custom_field_response_data'
required:
- data
type: object
- alert_event_list:
+ custom_field_list:
properties:
data:
items:
- $ref: '#/components/schemas/alert_event_response_data'
+ $ref: '#/components/schemas/custom_field_response_data'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- new_alerts_source:
+ new_custom_form:
properties:
data:
- $ref: '#/components/schemas/new_alerts_source_data'
+ $ref: '#/components/schemas/new_custom_form_data'
required:
- data
type: object
- update_alerts_source:
+ update_custom_form:
properties:
data:
- $ref: '#/components/schemas/update_alerts_source_data'
+ $ref: '#/components/schemas/update_custom_form_data'
required:
- data
type: object
- alerts_source:
+ custom_form:
properties:
- alert_urgency_id:
- description: ID for the default alert urgency assigned to this alert source
- type: string
name:
- description: The name of the alert source
- type: string
- source_type:
- description: The alert source type
- type: string
- status:
- description: The current status of the alert source
+ description: The name of the custom form.
type: string
- secret:
- description: A secret key used to authenticate incoming requests to this
- alerts source
+ slug:
+ description: The custom form slug. Add this to form_field.shown or form_field.required
+ to associate form fields with custom forms.
type: string
- webhook_endpoint:
- description: The URL endpoint of the alert source
+ description:
nullable: true
type: string
- email:
- description: The email address of the alert source
- nullable: true
+ enabled:
+ type: boolean
+ command:
+ description: The Slack command used to trigger this form.
type: string
- owner_group_ids:
- description: List of team IDs that will own the alert source
- items:
- type: string
- type: array
created_at:
- description: Date of creation
+ description: Date of creation.
type: string
updated_at:
- description: Date of last update
+ description: Date of last update.
type: string
- sourceable_attributes:
- description: "Additional attributes specific to certain alert sources (e.g.,\
- \ generic_webhook), encapsulating source-specific configurations or details"
- nullable: true
- type: object
- resolution_rule_attributes:
- description: Additional attributes for email alerts source
- nullable: true
- type: object
required:
+ - command
- created_at
+ - enabled
- name
- - secret
- - status
- updated_at
type: object
- alerts_source_response:
+ custom_form_response:
properties:
data:
- $ref: '#/components/schemas/alerts_source_response_data'
+ $ref: '#/components/schemas/custom_form_response_data'
required:
- data
type: object
- alerts_source_list:
+ custom_form_list:
properties:
data:
items:
- $ref: '#/components/schemas/alerts_source_response_data'
+ $ref: '#/components/schemas/custom_form_response_data'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- new_alert_routing_rule:
+ new_dashboard_panel:
properties:
data:
- $ref: '#/components/schemas/new_alert_routing_rule_data'
+ $ref: '#/components/schemas/new_dashboard_panel_data'
required:
- data
type: object
- update_alert_routing_rule:
+ update_dashboard_panel:
properties:
data:
- $ref: '#/components/schemas/update_alert_routing_rule_data'
+ $ref: '#/components/schemas/update_dashboard_panel_data'
required:
- data
type: object
- alert_routing_rule:
+ dashboard_panel:
properties:
- name:
- description: The name of the alert routing rule
- type: string
- enabled:
- description: Whether the alert routing rule is enabled
- type: boolean
- alerts_source_id:
- description: The ID of the alerts source
- format: uuid
+ dashboard_id:
+ description: The panel dashboard
type: string
- condition_type:
- description: The type of condition for the alert routing rule
- enum:
- - all
- - any
+ name:
+ description: The name of the dashboard_panel
+ nullable: true
type: string
- conditions:
- description: The conditions for the alert routing rule
+ params:
+ $ref: '#/components/schemas/new_dashboard_panel_data_attributes_params'
+ position:
+ $ref: '#/components/schemas/new_dashboard_panel_data_attributes_position'
+ data:
items:
- $ref: '#/components/schemas/alert_routing_rule_conditions_inner'
+ type: object
type: array
- destination:
- $ref: '#/components/schemas/alert_routing_rule_destination'
- created_at:
- description: Date of creation
- type: string
- updated_at:
- description: Date of last update
- type: string
required:
- - alerts_source_id
- - condition_type
- - created_at
- - destination
- - enabled
- - name
- - updated_at
+ - params
type: object
- alert_routing_rule_response:
+ dashboard_panel_response:
properties:
data:
- $ref: '#/components/schemas/alert_routing_rule_response_data'
+ $ref: '#/components/schemas/dashboard_panel_response_data'
required:
- data
type: object
- alert_routing_rule_list:
+ dashboard_panel_list:
properties:
data:
items:
- $ref: '#/components/schemas/alert_routing_rule_response_data'
+ $ref: '#/components/schemas/dashboard_panel_response_data'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- new_alert_urgency:
+ new_dashboard:
properties:
data:
- $ref: '#/components/schemas/new_alert_urgency_data'
+ $ref: '#/components/schemas/new_dashboard_data'
required:
- data
type: object
- update_alert_urgency:
+ update_dashboard:
properties:
data:
- $ref: '#/components/schemas/update_alert_urgency_data'
+ $ref: '#/components/schemas/update_dashboard_data'
required:
- data
type: object
- alert_urgency:
+ dashboard:
properties:
+ team_id:
+ description: The dashboard team
+ type: integer
+ user_id:
+ description: The dashboard user owner if owner is of type user
+ nullable: true
+ type: integer
name:
- description: The name of the alert urgency
+ description: The name of the dashboard
type: string
description:
- description: The description of the alert urgency
+ description: The description of the dashboard
+ nullable: true
+ type: string
+ owner:
+ description: The owner type of the dashboard
+ enum:
+ - user
+ - team
+ type: string
+ public:
+ description: Whether the dashboard is public
+ type: boolean
+ range:
+ description: The date range for dashboard panel data
+ nullable: true
+ type: string
+ period:
+ description: The grouping period for dashboard panel data
+ nullable: true
+ type: string
+ auto_refresh:
+ description: Whether the dashboard auto-updates the UI with new data.
+ type: boolean
+ color:
+ description: The hex color of the dashboard
+ enum:
+ - '#FCF2CF'
+ - '#D7F5E1'
+ - '#E9E2FF'
+ - '#FAE6E8'
+ - '#FAEEE6'
+ nullable: true
+ type: string
+ icon:
+ description: The emoji icon of the dashboard
type: string
- position:
- description: Position of the alert urgency
- type: integer
created_at:
description: Date of creation
type: string
@@ -39507,78 +27582,135 @@ components:
description: Date of last update
type: string
required:
- - created_at
- - description
- name
- - position
- - updated_at
+ - owner
+ - public
+ type: object
+ dashboard_response:
+ properties:
+ data:
+ $ref: '#/components/schemas/dashboard_response_data'
+ required:
+ - data
+ type: object
+ dashboard_list:
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/dashboard_response_data'
+ type: array
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
+ required:
+ - data
+ - links
+ - meta
+ type: object
+ edge_connector:
+ properties:
+ data:
+ $ref: '#/components/schemas/edge_connector_data'
+ required:
+ - data
+ type: object
+ new_edge_connector:
+ properties:
+ edge_connector:
+ $ref: '#/components/schemas/new_edge_connector_edge_connector'
+ required:
+ - edge_connector
+ type: object
+ update_edge_connector:
+ properties:
+ edge_connector:
+ $ref: '#/components/schemas/updateEdgeConnector_request_data_attributes'
+ required:
+ - edge_connector
type: object
- alert_urgency_response:
+ edge_connector_action:
properties:
data:
- $ref: '#/components/schemas/alert_urgency_response_data'
+ $ref: '#/components/schemas/edge_connector_action_data'
required:
- data
type: object
- alert_urgency_list:
+ new_edge_connector_action:
properties:
- data:
- items:
- $ref: '#/components/schemas/alert_urgency_response_data'
- type: array
- links:
- allOf:
- - $ref: '#/components/schemas/links'
- type: object
+ action:
+ $ref: '#/components/schemas/new_edge_connector_action_action'
required:
- - data
- - links
+ - action
type: object
- new_alert_group:
+ update_edge_connector_action:
+ properties:
+ action:
+ $ref: '#/components/schemas/updateEdgeConnectorAction_request_action'
+ required:
+ - action
+ type: object
+ new_environment:
properties:
data:
- $ref: '#/components/schemas/new_alert_group_data'
+ $ref: '#/components/schemas/new_environment_data'
required:
- data
type: object
- update_alert_group:
+ update_environment:
properties:
data:
- $ref: '#/components/schemas/update_alert_group_data'
+ $ref: '#/components/schemas/update_environment_data'
required:
- data
type: object
- alert_group:
+ environment:
properties:
name:
- description: The name of the alert group
+ description: The name of the environment
+ type: string
+ slug:
+ description: The slug of the environment
type: string
description:
- description: The description of the alert group
+ description: The description of the environment
nullable: true
type: string
- slug:
- description: The slug of the alert group
- type: string
- condition_type:
- description: Grouping condition for the alert group
+ notify_emails:
+ description: Emails attached to the environment
+ items:
+ type: string
+ nullable: true
+ type: array
+ color:
+ description: The hex color of the environment
+ nullable: true
type: string
- time_window:
- description: Time window for the alert grouping
+ position:
+ description: Position of the environment
+ nullable: true
type: integer
- group_by_alert_title:
- description: Whether the alerts are grouped by title or not
- type: boolean
- group_by_alert_urgency:
- description: Whether the alerts are grouped by urgency or not
- type: boolean
- targets:
+ slack_channels:
+ description: Slack Channels associated with this environment
items:
- $ref: '#/components/schemas/new_alert_group_data_attributes_targets_inner'
+ $ref: '#/components/schemas/new_environment_data_attributes_slack_channels_inner'
+ nullable: true
type: array
- attributes:
+ slack_aliases:
+ description: Slack Aliases associated with this environment
items:
- $ref: '#/components/schemas/new_alert_group_data_attributes_attributes_inner'
+ $ref: '#/components/schemas/new_environment_data_attributes_slack_aliases_inner'
+ nullable: true
+ type: array
+ properties:
+ description: Array of property values for this environment.
+ items:
+ $ref: '#/components/schemas/new_cause_data_attributes_properties_inner'
+ nullable: true
type: array
created_at:
description: Date of creation
@@ -39586,653 +27718,1086 @@ components:
updated_at:
description: Date of last update
type: string
- deleted_at:
- description: Date or deletion
- nullable: true
- type: string
required:
- - condition_type
- created_at
- - deleted_at
- - description
- - group_by_alert_title
- - group_by_alert_urgency
- name
- - slug
- - time_window
- updated_at
type: object
- alert_group_response:
- properties:
- data:
- $ref: '#/components/schemas/alert_group_response_data'
- required:
- - data
- type: object
- alert_group_list:
+ environment_response:
properties:
data:
- items:
- $ref: '#/components/schemas/alert_group_response_data'
- type: array
+ $ref: '#/components/schemas/environment_response_data'
required:
- data
type: object
- audit:
- properties:
- event:
- description: Describes the action that was taken.
- type: string
- item_type:
- description: Describes the object in which the action was taken on
- enum:
- - ApiKey
- - Cause
- - CustomField
- - CustomFieldOption
- - CustomForm
- - Dashboard
- - Environment
- - EscalationPolicy
- - EscalationPolicyPath
- - ExportJob
- - FormField
- - Functionality
- - GeniusWorkflow
- - GeniusWorkflowGroup
- - GeniusWorkflowRun
- - Group
- - Heartbeat
- - Incident
- - IncidentActionItem
- - IncidentEvent
- - IncidentFormFieldSelection
- - IncidentFormFieldSelectionUser
- - IncidentPostMortem
- - IncidentRoleAssignment
- - IncidentRoleTask
- - IncidentStatusPageEvent
- - IncidentTask
- - IncidentType
- - LiveCallRouter
- - OnCallRole
- - Playbook
- - PlaybookTask
- - Role
- - Schedule
- - Service
- - Severity
- - StatusPage
- nullable: true
- type: string
- object:
- description: The object in which the action was taken on
- nullable: true
- type: object
- object_changes:
- description: The changes that occurred on the object
- nullable: true
- type: object
- user_id:
- description: The ID of who took action on the object. Together with whodunnit_type
- can be used to find the user
- nullable: true
- type: integer
- created_at:
- description: Date of creation
- type: string
- item_id:
- description: ID of the affected object
- nullable: true
- type: string
- id:
- description: ID of audit
- nullable: true
- type: integer
- required:
- - created_at
- - event
- type: object
- audits_list:
+ environment_list:
properties:
data:
items:
- $ref: '#/components/schemas/audits_list_data_inner'
+ $ref: '#/components/schemas/environment_response_data'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- new_authorization:
+ errors_list:
+ properties:
+ errors:
+ items:
+ $ref: '#/components/schemas/errors_list_errors_inner'
+ type: array
+ type: object
+ new_escalation_policy:
properties:
data:
- $ref: '#/components/schemas/new_authorization_data'
+ $ref: '#/components/schemas/new_escalation_policy_data'
required:
- data
type: object
- update_authorization:
+ update_escalation_policy:
properties:
data:
- $ref: '#/components/schemas/update_authorization_data'
+ $ref: '#/components/schemas/update_escalation_policy_data'
required:
- data
type: object
- authorization:
+ escalation_policy:
properties:
- authorizable_id:
- description: The id of the resource being accessed.
- type: string
- authorizable_type:
- description: The type of resource being accessed.
- enum:
- - Dashboard
- type: string
- grantee_id:
- description: The resource id granted access.
+ name:
+ description: The name of the escalation policy
type: string
- grantee_type:
- description: The type of resource granted access.
- enum:
- - User
- - Team
+ description:
+ description: The description of the escalation policy
+ nullable: true
type: string
- permissions:
+ repeat_count:
+ description: The number of times this policy will be executed until someone
+ acknowledges the alert
+ type: integer
+ created_by_user_id:
+ description: User who created the escalation policy
+ type: integer
+ last_updated_by_user_id:
+ description: User who updated the escalation policy
+ type: integer
+ group_ids:
+ description: Associated groups (alerting the group will trigger escalation
+ policy)
+ items:
+ type: string
+ type: array
+ service_ids:
+ description: Associated services (alerting the service will trigger escalation
+ policy)
items:
- enum:
- - read
- - update
- - authorize
- - destroy
type: string
type: array
+ business_hours:
+ $ref: '#/components/schemas/new_escalation_policy_data_attributes_business_hours'
created_at:
+ description: Date of creation
type: string
updated_at:
+ description: Date of last update
type: string
required:
- - authorizable_id
- - authorizable_type
- - created_at
- - grantee_id
- - grantee_type
- - permissions
- - updated_at
+ - created_by_user_id
+ - name
+ - repeat_count
type: object
- authorization_response:
+ escalation_policy_response:
properties:
data:
- $ref: '#/components/schemas/authorization_response_data'
+ $ref: '#/components/schemas/escalation_policy_response_data'
required:
- data
type: object
- authorization_list:
+ escalation_policy_list:
properties:
data:
items:
- $ref: '#/components/schemas/authorization_response_data'
+ $ref: '#/components/schemas/escalation_policy_response_data'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- new_catalog:
+ new_escalation_policy_path:
properties:
data:
- $ref: '#/components/schemas/new_catalog_data'
+ $ref: '#/components/schemas/new_escalation_policy_path_data'
required:
- data
type: object
- update_catalog:
+ update_escalation_policy_path:
properties:
data:
- $ref: '#/components/schemas/update_catalog_data'
+ $ref: '#/components/schemas/update_escalation_policy_path_data'
required:
- data
type: object
- catalog:
+ escalation_policy_path:
properties:
name:
+ description: The name of the escalation path
type: string
- description:
+ default:
+ description: Whether this escalation path is the default path
+ type: boolean
+ notification_type:
+ description: Notification rule type
+ type: string
+ path_type:
+ description: The type of escalation path
+ enum:
+ - escalation
+ - deferral
+ type: string
+ escalation_policy_id:
+ description: The ID of the escalation policy
+ type: string
+ after_deferral_behavior:
+ description: What happens after a deferral path finishes
+ enum:
+ - re_evaluate
+ - execute_path
nullable: true
type: string
- icon:
+ after_deferral_path_id:
+ description: The escalation path to execute after this deferral path when
+ after_deferral_behavior is execute_path
+ nullable: true
+ type: string
+ match_mode:
+ description: How path rules are matched.
enum:
- - globe-alt
- - server-stack
- - users
- - user-group
- - chart-bar
- - shapes
- - light-bulb
- - cursor-arrow-ripple
+ - match-all-rules
+ - match-any-rule
type: string
position:
- description: Default position of the catalog when displayed in a list.
+ description: The position of this path in the paths for this EP.
+ type: integer
+ repeat:
+ description: Whether this path should be repeated until someone acknowledges
+ the alert
+ nullable: true
+ type: boolean
+ repeat_count:
+ description: The number of times this path will be executed until someone
+ acknowledges the alert
nullable: true
type: integer
+ initial_delay:
+ description: Initial delay for escalation path in minutes. Maximum 1 week
+ (10080).
+ type: integer
created_at:
+ description: Date of creation
type: string
updated_at:
+ description: Date of last update
type: string
+ rules:
+ description: Escalation path rules
+ items:
+ $ref: '#/components/schemas/update_escalation_policy_path_data_attributes_rules_inner'
+ type: array
+ time_restriction_time_zone:
+ description: Time zone used for time restrictions.
+ enum:
+ - International Date Line West
+ - Etc/GMT+12
+ - American Samoa
+ - Pacific/Pago_Pago
+ - Midway Island
+ - Pacific/Midway
+ - Hawaii
+ - Pacific/Honolulu
+ - Alaska
+ - America/Juneau
+ - Pacific Time (US & Canada)
+ - America/Los_Angeles
+ - Tijuana
+ - America/Tijuana
+ - Arizona
+ - America/Phoenix
+ - Mazatlan
+ - America/Mazatlan
+ - Mountain Time (US & Canada)
+ - America/Denver
+ - Central America
+ - America/Guatemala
+ - Central Time (US & Canada)
+ - America/Chicago
+ - Chihuahua
+ - America/Chihuahua
+ - Guadalajara
+ - America/Mexico_City
+ - Mexico City
+ - America/Mexico_City
+ - Monterrey
+ - America/Monterrey
+ - Saskatchewan
+ - America/Regina
+ - Bogota
+ - America/Bogota
+ - Eastern Time (US & Canada)
+ - America/New_York
+ - Indiana (East)
+ - America/Indiana/Indianapolis
+ - Lima
+ - America/Lima
+ - Quito
+ - America/Lima
+ - Atlantic Time (Canada)
+ - America/Halifax
+ - Caracas
+ - America/Caracas
+ - Georgetown
+ - America/Guyana
+ - La Paz
+ - America/La_Paz
+ - Puerto Rico
+ - America/Puerto_Rico
+ - Santiago
+ - America/Santiago
+ - Newfoundland
+ - America/St_Johns
+ - Asuncion
+ - America/Asuncion
+ - Brasilia
+ - America/Sao_Paulo
+ - Buenos Aires
+ - America/Argentina/Buenos_Aires
+ - Montevideo
+ - America/Montevideo
+ - Greenland
+ - America/Nuuk
+ - Mid-Atlantic
+ - Atlantic/South_Georgia
+ - Azores
+ - Atlantic/Azores
+ - Cape Verde Is.
+ - Atlantic/Cape_Verde
+ - Edinburgh
+ - Europe/London
+ - Lisbon
+ - Europe/Lisbon
+ - London
+ - Europe/London
+ - Monrovia
+ - Africa/Monrovia
+ - UTC
+ - Etc/UTC
+ - Amsterdam
+ - Europe/Amsterdam
+ - Belgrade
+ - Europe/Belgrade
+ - Berlin
+ - Europe/Berlin
+ - Bern
+ - Europe/Zurich
+ - Bratislava
+ - Europe/Bratislava
+ - Brussels
+ - Europe/Brussels
+ - Budapest
+ - Europe/Budapest
+ - Casablanca
+ - Africa/Casablanca
+ - Copenhagen
+ - Europe/Copenhagen
+ - Dublin
+ - Europe/Dublin
+ - Ljubljana
+ - Europe/Ljubljana
+ - Madrid
+ - Europe/Madrid
+ - Paris
+ - Europe/Paris
+ - Prague
+ - Europe/Prague
+ - Rome
+ - Europe/Rome
+ - Sarajevo
+ - Europe/Sarajevo
+ - Skopje
+ - Europe/Skopje
+ - Stockholm
+ - Europe/Stockholm
+ - Vienna
+ - Europe/Vienna
+ - Warsaw
+ - Europe/Warsaw
+ - West Central Africa
+ - Africa/Algiers
+ - Zagreb
+ - Europe/Zagreb
+ - Zurich
+ - Europe/Zurich
+ - Athens
+ - Europe/Athens
+ - Bucharest
+ - Europe/Bucharest
+ - Cairo
+ - Africa/Cairo
+ - Harare
+ - Africa/Harare
+ - Helsinki
+ - Europe/Helsinki
+ - Jerusalem
+ - Asia/Jerusalem
+ - Kaliningrad
+ - Europe/Kaliningrad
+ - Kyiv
+ - Europe/Kiev
+ - Pretoria
+ - Africa/Johannesburg
+ - Riga
+ - Europe/Riga
+ - Sofia
+ - Europe/Sofia
+ - Tallinn
+ - Europe/Tallinn
+ - Vilnius
+ - Europe/Vilnius
+ - Baghdad
+ - Asia/Baghdad
+ - Istanbul
+ - Europe/Istanbul
+ - Kuwait
+ - Asia/Kuwait
+ - Minsk
+ - Europe/Minsk
+ - Moscow
+ - Europe/Moscow
+ - Nairobi
+ - Africa/Nairobi
+ - Riyadh
+ - Asia/Riyadh
+ - St. Petersburg
+ - Europe/Moscow
+ - Volgograd
+ - Europe/Volgograd
+ - Tehran
+ - Asia/Tehran
+ - Abu Dhabi
+ - Asia/Muscat
+ - Baku
+ - Asia/Baku
+ - Muscat
+ - Asia/Muscat
+ - Samara
+ - Europe/Samara
+ - Tbilisi
+ - Asia/Tbilisi
+ - Yerevan
+ - Asia/Yerevan
+ - Kabul
+ - Asia/Kabul
+ - Almaty
+ - Asia/Almaty
+ - Astana
+ - Asia/Almaty
+ - Ekaterinburg
+ - Asia/Yekaterinburg
+ - Islamabad
+ - Asia/Karachi
+ - Karachi
+ - Asia/Karachi
+ - Tashkent
+ - Asia/Tashkent
+ - Chennai
+ - Asia/Kolkata
+ - Kolkata
+ - Asia/Kolkata
+ - Mumbai
+ - Asia/Kolkata
+ - New Delhi
+ - Asia/Kolkata
+ - Sri Jayawardenepura
+ - Asia/Colombo
+ - Kathmandu
+ - Asia/Kathmandu
+ - Dhaka
+ - Asia/Dhaka
+ - Urumqi
+ - Asia/Urumqi
+ - Rangoon
+ - Asia/Rangoon
+ - Bangkok
+ - Asia/Bangkok
+ - Hanoi
+ - Asia/Bangkok
+ - Jakarta
+ - Asia/Jakarta
+ - Krasnoyarsk
+ - Asia/Krasnoyarsk
+ - Novosibirsk
+ - Asia/Novosibirsk
+ - Beijing
+ - Asia/Shanghai
+ - Chongqing
+ - Asia/Chongqing
+ - Hong Kong
+ - Asia/Hong_Kong
+ - Irkutsk
+ - Asia/Irkutsk
+ - Kuala Lumpur
+ - Asia/Kuala_Lumpur
+ - Perth
+ - Australia/Perth
+ - Singapore
+ - Asia/Singapore
+ - Taipei
+ - Asia/Taipei
+ - Ulaanbaatar
+ - Asia/Ulaanbaatar
+ - Osaka
+ - Asia/Tokyo
+ - Sapporo
+ - Asia/Tokyo
+ - Seoul
+ - Asia/Seoul
+ - Tokyo
+ - Asia/Tokyo
+ - Yakutsk
+ - Asia/Yakutsk
+ - Adelaide
+ - Australia/Adelaide
+ - Darwin
+ - Australia/Darwin
+ - Brisbane
+ - Australia/Brisbane
+ - Canberra
+ - Australia/Canberra
+ - Guam
+ - Pacific/Guam
+ - Hobart
+ - Australia/Hobart
+ - Melbourne
+ - Australia/Melbourne
+ - Port Moresby
+ - Pacific/Port_Moresby
+ - Sydney
+ - Australia/Sydney
+ - Vladivostok
+ - Asia/Vladivostok
+ - Magadan
+ - Asia/Magadan
+ - New Caledonia
+ - Pacific/Noumea
+ - Solomon Is.
+ - Pacific/Guadalcanal
+ - Srednekolymsk
+ - Asia/Srednekolymsk
+ - Auckland
+ - Pacific/Auckland
+ - Fiji
+ - Pacific/Fiji
+ - Kamchatka
+ - Asia/Kamchatka
+ - Marshall Is.
+ - Pacific/Majuro
+ - Wellington
+ - Pacific/Auckland
+ - Chatham Is.
+ - Pacific/Chatham
+ - Nuku'alofa
+ - Pacific/Tongatapu
+ - Samoa
+ - Pacific/Apia
+ - Tokelau Is.
+ - Pacific/Fakaofo
+ nullable: true
+ type: string
+ time_restrictions:
+ description: "If time restrictions are set, alerts will follow this path\
+ \ when they arrive within the specified time ranges and meet the rules."
+ items:
+ $ref: '#/components/schemas/update_escalation_policy_path_data_attributes_time_restrictions_inner'
+ type: array
required:
- - created_at
- - icon
+ - default
+ - escalation_policy_id
- name
- - position
- - updated_at
+ - notification_type
+ - repeat
+ - repeat_count
type: object
- catalog_response:
+ escalation_policy_path_response:
properties:
data:
- $ref: '#/components/schemas/catalog_response_data'
+ $ref: '#/components/schemas/escalation_policy_path_response_data'
required:
- data
type: object
- catalog_list:
+ escalation_policy_path_list:
properties:
data:
items:
- $ref: '#/components/schemas/catalog_response_data'
+ $ref: '#/components/schemas/escalation_policy_path_list_data_inner'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- new_catalog_field:
+ new_escalation_policy_level:
properties:
data:
- $ref: '#/components/schemas/new_catalog_field_data'
+ $ref: '#/components/schemas/new_escalation_policy_level_data'
required:
- data
type: object
- update_catalog_field:
+ update_escalation_policy_level:
properties:
data:
- $ref: '#/components/schemas/update_catalog_field_data'
+ $ref: '#/components/schemas/update_escalation_policy_level_data'
required:
- data
type: object
- catalog_field:
+ escalation_policy_level:
properties:
- catalog_id:
- type: string
- name:
+ escalation_policy_id:
+ description: The ID of the escalation policy
type: string
- slug:
+ escalation_policy_path_id:
+ description: The ID of the dynamic escalation policy path the level will
+ belong to. If nothing is specified it will add the level to your default
+ path.
+ nullable: true
type: string
- kind:
+ paging_strategy_configuration_strategy:
+ default: default
enum:
- - text
- - reference
+ - default
+ - random
+ - cycle
+ - alert
+ nullable: true
type: string
- kind_catalog_id:
- description: Restricts values to items of specified catalog.
+ paging_strategy_configuration_schedule_strategy:
+ default: on_call_only
+ enum:
+ - on_call_only
+ - everyone
nullable: true
type: string
- multiple:
- description: Whether the attribute accepts multiple values.
- type: boolean
+ delay:
+ description: Delay before notifying targets in the next Escalation Level.
+ type: integer
position:
- description: Default position of the item when displayed in a list.
- nullable: true
+ description: Position of the escalation policy level
type: integer
created_at:
+ description: Date of creation
type: string
updated_at:
+ description: Date of last update
type: string
+ notification_target_params:
+ description: Escalation level's notification targets
+ items:
+ $ref: '#/components/schemas/update_escalation_policy_level_data_attributes_notification_target_params_inner'
+ type: array
required:
- - catalog_id
- - created_at
- - kind
- - multiple
- - name
+ - delay
+ - escalation_policy_id
+ - notification_target_params
- position
- - slug
- - updated_at
type: object
- catalog_field_response:
+ escalation_policy_level_response:
properties:
data:
- $ref: '#/components/schemas/catalog_field_response_data'
+ $ref: '#/components/schemas/escalation_policy_level_response_data'
required:
- data
type: object
- catalog_field_list:
+ escalation_policy_level_list:
properties:
data:
items:
- $ref: '#/components/schemas/catalog_field_response_data'
+ $ref: '#/components/schemas/escalation_policy_level_list_data_inner'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- new_catalog_entity:
+ new_form_field_option:
properties:
data:
- $ref: '#/components/schemas/new_catalog_entity_data'
+ $ref: '#/components/schemas/new_form_field_option_data'
required:
- data
type: object
- update_catalog_entity:
+ update_form_field_option:
properties:
data:
- $ref: '#/components/schemas/update_catalog_entity_data'
+ $ref: '#/components/schemas/update_form_field_option_data'
required:
- data
type: object
- catalog_entity:
+ form_field_option:
properties:
- name:
+ id:
+ description: Unique ID of the form field option
type: string
- description:
- nullable: true
+ form_field_id:
+ description: The ID of the parent custom field
+ type: string
+ value:
+ description: The value of the form field option
type: string
+ color:
+ description: The hex color of the form field option
+ type: string
+ default:
+ type: boolean
position:
- description: Default position of the item when displayed in a list.
- nullable: true
+ description: The position of the form field option
type: integer
created_at:
+ description: Date of creation
type: string
updated_at:
+ description: Date of last update
type: string
required:
+ - color
- created_at
- - name
- position
- updated_at
+ - value
type: object
- catalog_entity_response:
+ form_field_option_response:
properties:
data:
- $ref: '#/components/schemas/catalog_entity_response_data'
+ $ref: '#/components/schemas/form_field_option_response_data'
required:
- data
type: object
- catalog_entity_list:
+ form_field_option_list:
properties:
data:
items:
- $ref: '#/components/schemas/catalog_entity_response_data'
+ $ref: '#/components/schemas/form_field_option_response_data'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- new_catalog_entity_property:
+ new_form_field_placement_condition:
properties:
data:
- $ref: '#/components/schemas/new_catalog_entity_property_data'
+ $ref: '#/components/schemas/new_form_field_placement_condition_data'
required:
- data
type: object
- update_catalog_entity_property:
+ update_form_field_placement_condition:
properties:
data:
- $ref: '#/components/schemas/update_catalog_entity_property_data'
+ $ref: '#/components/schemas/update_form_field_placement_condition_data'
required:
- data
type: object
- catalog_entity_property:
+ form_field_placement_condition:
properties:
- catalog_entity_id:
- type: string
- catalog_field_id:
+ form_field_placement_id:
+ description: The form field placement this condition applies.
type: string
- key:
+ conditioned:
+ description: The resource or attribute the condition applies.
enum:
- - text
- - catalog_entity
- type: string
- value:
+ - placement
+ - required
type: string
- created_at:
+ position:
+ description: The condition position.
+ type: integer
+ form_field_id:
+ description: The condition field.
type: string
- updated_at:
+ comparison:
+ description: The condition comparison.
+ enum:
+ - equal
+ - not_equal
+ - is_set
+ - is_not_set
type: string
+ values:
+ description: The values for comparison.
+ items:
+ description: The value for comparison.
+ type: string
+ type: array
required:
- - catalog_entity_id
- - catalog_field_id
- - created_at
- - key
- - updated_at
- - value
+ - comparison
+ - conditioned
+ - form_field_id
+ - form_field_placement_id
+ - position
+ - values
type: object
- catalog_entity_property_response:
+ form_field_placement_condition_response:
properties:
data:
- $ref: '#/components/schemas/catalog_entity_property_response_data'
+ $ref: '#/components/schemas/form_field_placement_condition_response_data'
required:
- data
type: object
- catalog_entity_property_list:
+ form_field_placement_condition_list:
properties:
data:
items:
- $ref: '#/components/schemas/catalog_entity_property_response_data'
+ $ref: '#/components/schemas/form_field_placement_condition_response_data'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- new_cause:
+ new_form_field_placement:
properties:
data:
- $ref: '#/components/schemas/new_cause_data'
+ $ref: '#/components/schemas/new_form_field_placement_data'
required:
- data
type: object
- update_cause:
+ update_form_field_placement:
properties:
data:
- $ref: '#/components/schemas/update_cause_data'
+ $ref: '#/components/schemas/update_form_field_placement_data'
required:
- data
type: object
- cause:
+ form_field_placement:
properties:
- name:
- description: The name of the cause
+ form_field_id:
+ description: The form field that is placed.
type: string
- slug:
- description: The slug of the cause
+ form_set_id:
+ description: The form set this field is placed in.
type: string
- description:
- description: The description of the cause
- nullable: true
+ form:
+ description: The form this field is placed on.
type: string
position:
- description: Position of the cause
- nullable: true
+ description: The position of the field placement.
type: integer
- created_at:
- description: Date of creation
+ required:
+ description: Whether the field is unconditionally required on this form.
+ type: boolean
+ required_operator:
+ description: Logical operator when evaluating multiple form_field_placement_conditions
+ with conditioned=required
+ enum:
+ - and
+ - or
type: string
- updated_at:
- description: Date of last update
+ placement_operator:
+ description: Logical operator when evaluating multiple form_field_placement_conditions
+ with conditioned=placement
+ enum:
+ - and
+ - or
type: string
+ non_editable:
+ description: Whether the field is read-only and cannot be edited by users.
+ type: boolean
required:
- - created_at
- - name
- - updated_at
+ - form
+ - form_field_id
+ - form_set_id
+ - position
+ - required
type: object
- cause_response:
+ form_field_placement_response:
properties:
data:
- $ref: '#/components/schemas/cause_response_data'
+ $ref: '#/components/schemas/form_field_placement_response_data'
required:
- data
type: object
- cause_list:
+ form_field_placement_list:
properties:
data:
items:
- $ref: '#/components/schemas/cause_response_data'
+ $ref: '#/components/schemas/form_field_placement_response_data'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- new_custom_field_option:
+ new_form_field_position:
properties:
data:
- $ref: '#/components/schemas/new_custom_field_option_data'
+ $ref: '#/components/schemas/new_form_field_position_data'
required:
- data
type: object
- update_custom_field_option:
+ update_form_field_position:
properties:
data:
- $ref: '#/components/schemas/update_custom_field_option_data'
+ $ref: '#/components/schemas/update_form_field_position_data'
required:
- data
type: object
- custom_field_option:
+ form_field_position:
properties:
- custom_field_id:
- description: The ID of the parent custom field
- type: integer
- value:
- description: The value of the custom_field_option
+ form_field_id:
+ description: The ID of the form field.
type: string
- color:
- description: The hex color of the custom_field_option
+ form:
+ description: The form for the position
+ enum:
+ - web_new_incident_form
+ - web_update_incident_form
+ - web_incident_post_mortem_form
+ - web_incident_mitigation_form
+ - web_incident_resolution_form
+ - web_incident_cancellation_form
+ - web_scheduled_incident_form
+ - web_update_scheduled_incident_form
+ - incident_post_mortem
+ - slack_new_incident_form
+ - slack_update_incident_form
+ - slack_update_incident_status_form
+ - slack_incident_mitigation_form
+ - slack_incident_resolution_form
+ - slack_incident_cancellation_form
+ - slack_scheduled_incident_form
+ - slack_update_scheduled_incident_form
type: string
- default:
- type: boolean
position:
- description: The position of the custom_field_option
+ description: The position of the form_field_position
type: integer
- created_at:
- description: Date of creation
- type: string
- updated_at:
- description: Date of last update
- type: string
required:
- - color
- - created_at
+ - form
+ - form_field_id
- position
- - updated_at
- - value
type: object
- custom_field_option_response:
+ form_field_position_response:
properties:
data:
- $ref: '#/components/schemas/custom_field_option_response_data'
+ $ref: '#/components/schemas/form_field_position_response_data'
required:
- data
type: object
- custom_field_option_list:
+ form_field_position_list:
properties:
data:
items:
- $ref: '#/components/schemas/custom_field_option_response_data'
+ $ref: '#/components/schemas/form_field_position_response_data'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- new_custom_field:
+ new_form_field:
properties:
data:
- $ref: '#/components/schemas/new_custom_field_data'
+ $ref: '#/components/schemas/new_form_field_data'
required:
- data
type: object
- update_custom_field:
+ update_form_field:
properties:
data:
- $ref: '#/components/schemas/update_custom_field_data'
+ $ref: '#/components/schemas/update_form_field_data'
required:
- data
type: object
- custom_field:
+ form_field:
properties:
- label:
- description: The name of the custom_field
- type: string
kind:
- description: The kind of the custom_field
+ description: The kind of the form field
+ enum:
+ - custom
+ - title
+ - summary
+ - mitigation_message
+ - resolution_message
+ - severity
+ - environments
+ - types
+ - services
+ - causes
+ - functionalities
+ - teams
+ - visibility
+ - mark_as_test
+ - mark_as_backfilled
+ - labels
+ - notify_emails
+ - trigger_manual_workflows
+ - show_ongoing_incidents
+ - attach_alerts
+ - mark_as_in_triage
+ - in_triage_at
+ - started_at
+ - detected_at
+ - acknowledged_at
+ - mitigated_at
+ - resolved_at
+ - closed_at
+ - custom_sub_status
+ - manual_starting_datetime_field
+ type: string
+ input_kind:
+ description: The input kind of the form field
+ enum:
+ - text
+ - textarea
+ - select
+ - multi_select
+ - date
+ - datetime
+ - number
+ - checkbox
+ - tags
+ - rich_text
+ type: string
+ value_kind:
+ description: The value kind of the form field
+ enum:
+ - inherit
+ - group
+ - service
+ - functionality
+ - user
+ - catalog_entity
+ - environment
+ - cause
+ - incident_type
+ type: string
+ value_kind_catalog_id:
+ description: The ID of the catalog used when value_kind is `catalog_entity`
+ nullable: true
+ type: string
+ name:
+ description: The name of the form field
type: string
- enabled:
- description: Whether the custom_field is enabled
- type: boolean
slug:
- description: The slug of the custom_field
+ description: The slug of the form field
type: string
description:
- description: The description of the custom_field
+ description: The description of the form field
nullable: true
type: string
shown:
items:
- description: Where the custom_field is shown
- enum:
- - incident_form
- - incident_mitigation_form
- - incident_resolution_form
- - incident_post_mortem_form
- - incident_slack_form
- - incident_mitigation_slack_form
- - incident_resolution_slack_form
- - incident_post_mortem
+ description: "Where the form field is shown. Add custom forms using the\
+ \ custom form's `slug` field. Or choose a built-in form: `web_new_incident_form`,\
+ \ `web_update_incident_form`, `web_incident_post_mortem_form`, `web_incident_mitigation_form`,\
+ \ `web_incident_resolution_form`, `web_incident_cancellation_form`,\
+ \ `web_scheduled_incident_form`, `web_update_scheduled_incident_form`,\
+ \ `incident_post_mortem`, `slack_new_incident_form`, `slack_update_incident_form`,\
+ \ `slack_update_incident_status_form`, `slack_incident_mitigation_form`,\
+ \ `slack_incident_resolution_form`, `slack_incident_cancellation_form`,\
+ \ `slack_scheduled_incident_form`, `slack_update_scheduled_incident_form`"
type: string
type: array
required:
items:
- description: Where the custom_field is required
- enum:
- - incident_form
- - incident_mitigation_form
- - incident_resolution_form
- - incident_post_mortem_form
- - incident_slack_form
- - incident_mitigation_slack_form
- - incident_resolution_slack_form
+ description: "Where the form field is required. Add custom forms using\
+ \ the custom form's `slug` field. Or choose a built-in form: `web_new_incident_form`,\
+ \ `web_update_incident_form`, `web_incident_post_mortem_form`, `web_incident_mitigation_form`,\
+ \ `web_incident_resolution_form`, `web_incident_cancellation_form`,\
+ \ `web_scheduled_incident_form`, `web_update_scheduled_incident_form`,\
+ \ `slack_new_incident_form`, `slack_update_incident_form`, `slack_update_incident_status_form`,\
+ \ `slack_incident_mitigation_form`, `slack_incident_resolution_form`,\
+ \ `slack_incident_cancellation_form`, `slack_scheduled_incident_form`,\
+ \ `slack_update_scheduled_incident_form`"
type: string
- nullable: true
type: array
- default:
- description: The default value for text field kinds
+ show_on_incident_details:
+ description: Whether the form field is shown on the incident details panel
+ type: boolean
+ enabled:
+ description: Whether the form field is enabled
+ type: boolean
+ default_values:
+ items:
+ description: The default values.
+ type: string
+ type: array
+ auto_set_by_catalog_property_id:
+ description: Catalog property ID to auto-set this form field. Only reference-kind
+ catalog properties are supported.
nullable: true
type: string
- position:
- description: The position of the custom_field
- type: integer
created_at:
description: Date of creation
type: string
@@ -40241,218 +28806,152 @@ components:
type: string
required:
- created_at
- - label
- - position
+ - default_values
+ - input_kind
+ - kind
+ - name
- required
- shown
- - slug
- updated_at
+ - value_kind
type: object
- custom_field_response:
+ form_field_response:
properties:
data:
- $ref: '#/components/schemas/custom_field_response_data'
+ $ref: '#/components/schemas/form_field_response_data'
required:
- data
type: object
- custom_field_list:
+ form_field_list:
properties:
data:
items:
- $ref: '#/components/schemas/custom_field_response_data'
+ $ref: '#/components/schemas/form_field_response_data'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
- required:
- - data
- - links
- type: object
- new_custom_form:
- properties:
- data:
- $ref: '#/components/schemas/new_custom_form_data'
- required:
- - data
- type: object
- update_custom_form:
- properties:
- data:
- $ref: '#/components/schemas/update_custom_form_data'
- required:
- - data
- type: object
- custom_form:
- properties:
- name:
- description: The name of the custom form.
- type: string
- slug:
- description: The custom form slug. Add this to form_field.shown or form_field.required
- to associate form fields with custom forms.
- type: string
- description:
- nullable: true
- type: string
- enabled:
- type: boolean
- command:
- description: The Slack command used to trigger this form.
- type: string
- created_at:
- description: Date of creation.
- type: string
- updated_at:
- description: Date of last update.
- type: string
- required:
- - command
- - created_at
- - enabled
- - name
- - slug
- - updated_at
- type: object
- custom_form_response:
- properties:
- data:
- $ref: '#/components/schemas/custom_form_response_data'
- required:
- - data
- type: object
- custom_form_list:
- properties:
- data:
- items:
- $ref: '#/components/schemas/custom_form_response_data'
- type: array
- links:
+ meta:
allOf:
- - $ref: '#/components/schemas/links'
+ - $ref: '#/components/schemas/meta'
type: object
required:
- data
- links
+ - meta
type: object
- new_dashboard_panel:
+ new_form_set_condition:
properties:
data:
- $ref: '#/components/schemas/new_dashboard_panel_data'
+ $ref: '#/components/schemas/new_form_set_condition_data'
required:
- data
type: object
- update_dashboard_panel:
+ update_form_set_condition:
properties:
data:
- $ref: '#/components/schemas/update_dashboard_panel_data'
+ $ref: '#/components/schemas/update_form_set_condition_data'
required:
- data
type: object
- dashboard_panel:
+ form_set_condition:
properties:
- dashboard_id:
- description: The panel dashboard
+ form_set_id:
+ description: The form set this condition applies.
type: string
- name:
- description: The name of the dashboard_panel
- nullable: true
+ form_field_id:
+ description: The form field this condition applies.
type: string
- params:
- $ref: '#/components/schemas/new_dashboard_panel_data_attributes_params'
- position:
- $ref: '#/components/schemas/new_dashboard_panel_data_attributes_position'
- data:
+ comparison:
+ description: The condition comparison.
+ enum:
+ - equal
+ type: string
+ values:
+ description: The values for comparison.
items:
- type: object
+ description: The value for comparison.
+ type: string
type: array
required:
- - params
+ - comparison
+ - form_field_id
+ - form_set_id
+ - values
type: object
- dashboard_panel_response:
+ form_set_condition_response:
properties:
data:
- $ref: '#/components/schemas/dashboard_panel_response_data'
+ $ref: '#/components/schemas/form_set_condition_response_data'
required:
- data
type: object
- dashboard_panel_list:
+ form_set_condition_list:
properties:
data:
items:
- $ref: '#/components/schemas/dashboard_panel_response_data'
+ $ref: '#/components/schemas/form_set_condition_response_data'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- new_dashboard:
+ new_form_set:
properties:
data:
- $ref: '#/components/schemas/new_dashboard_data'
+ $ref: '#/components/schemas/new_form_set_data'
required:
- data
type: object
- update_dashboard:
+ update_form_set:
properties:
data:
- $ref: '#/components/schemas/update_dashboard_data'
+ $ref: '#/components/schemas/update_form_set_data'
required:
- data
type: object
- dashboard:
+ form_set:
properties:
- team_id:
- description: The dashboard team
- type: integer
- user_id:
- description: The dashboard user owner if owner is of type user
- nullable: true
- type: integer
name:
- description: The name of the dashboard
- type: string
- description:
- description: The description of the dashboard
- nullable: true
- type: string
- owner:
- description: The owner type of the dashboard
- enum:
- - user
- - team
- type: string
- public:
- description: Whether the dashboard is public
- type: boolean
- range:
- description: The date range for dashboard panel data
- nullable: true
+ description: The name of the form set
type: string
- period:
- description: The grouping period for dashboard panel data
- nullable: true
+ slug:
+ description: The slug of the form set
type: string
- auto_refresh:
- description: Whether the dashboard auto-updates the UI with new data.
+ is_default:
+ description: Whether the form set is default
type: boolean
- color:
- description: The hex color of the dashboard
- enum:
- - '#FCF2CF'
- - '#D7F5E1'
- - '#E9E2FF'
- - '#FAE6E8'
- - '#FAEEE6'
- nullable: true
- type: string
- icon:
- description: The emoji icon of the dashboard
- type: string
+ forms:
+ description: "The forms included in the form set. Add custom forms using\
+ \ the custom form's `slug` field. Or choose a built-in form: `web_new_incident_form`,\
+ \ `web_update_incident_form`, `web_incident_post_mortem_form`, `web_incident_mitigation_form`,\
+ \ `web_incident_resolution_form`, `web_incident_cancellation_form`, `web_scheduled_incident_form`,\
+ \ `web_update_scheduled_incident_form`, `slack_new_incident_form`, `slack_update_incident_form`,\
+ \ `slack_update_incident_status_form`, `slack_incident_mitigation_form`,\
+ \ `slack_incident_resolution_form`, `slack_incident_cancellation_form`,\
+ \ `slack_scheduled_incident_form`, `slack_update_scheduled_incident_form`"
+ items:
+ description: "The form included in the form set. Add custom forms using\
+ \ the custom form's `slug` field. Or choose a built-in form: `web_new_incident_form`,\
+ \ `web_update_incident_form`, `web_incident_post_mortem_form`, `web_incident_mitigation_form`,\
+ \ `web_incident_resolution_form`, `web_incident_cancellation_form`,\
+ \ `web_scheduled_incident_form`, `web_update_scheduled_incident_form`,\
+ \ `slack_new_incident_form`, `slack_update_incident_form`, `slack_update_incident_status_form`,\
+ \ `slack_incident_mitigation_form`, `slack_incident_resolution_form`,\
+ \ `slack_incident_cancellation_form`, `slack_scheduled_incident_form`,\
+ \ `slack_update_scheduled_incident_form`"
+ type: string
+ type: array
created_at:
description: Date of creation
type: string
@@ -40460,83 +28959,157 @@ components:
description: Date of last update
type: string
required:
+ - created_at
+ - forms
+ - is_default
- name
- - owner
- - public
+ - updated_at
type: object
- dashboard_response:
+ form_set_response:
properties:
data:
- $ref: '#/components/schemas/dashboard_response_data'
+ $ref: '#/components/schemas/form_set_response_data'
required:
- data
type: object
- dashboard_list:
+ form_set_list:
properties:
data:
items:
- $ref: '#/components/schemas/dashboard_response_data'
+ $ref: '#/components/schemas/form_set_response_data'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- new_environment:
+ new_functionality:
properties:
data:
- $ref: '#/components/schemas/new_environment_data'
+ $ref: '#/components/schemas/new_functionality_data'
required:
- data
type: object
- update_environment:
+ update_functionality:
properties:
data:
- $ref: '#/components/schemas/update_environment_data'
+ $ref: '#/components/schemas/update_functionality_data'
required:
- data
type: object
- environment:
+ functionality:
properties:
name:
- description: The name of the environment
+ description: The name of the functionality
type: string
slug:
- description: The slug of the environment
+ description: The slug of the functionality
type: string
description:
- description: The description of the environment
+ description: The description of the functionality
+ nullable: true
+ type: string
+ public_description:
+ description: The public description of the functionality
nullable: true
type: string
notify_emails:
- description: Emails attached to the environment
+ description: Emails attached to the functionality
items:
type: string
nullable: true
type: array
color:
- description: The hex color of the environment
+ description: The hex color of the functionality
+ nullable: true
+ type: string
+ backstage_id:
+ description: "The Backstage entity id associated to this functionality.\
+ \ eg: :namespace/:kind/:entity_name"
+ nullable: true
+ type: string
+ external_id:
+ description: The external id associated to this functionality
+ nullable: true
+ type: string
+ pagerduty_id:
+ description: The PagerDuty service id associated to this functionality
+ nullable: true
+ type: string
+ opsgenie_id:
+ description: The Opsgenie service id associated to this functionality
+ nullable: true
+ type: string
+ opsgenie_team_id:
+ description: The Opsgenie team id associated to this functionality
+ nullable: true
+ type: string
+ cortex_id:
+ description: The Cortex group id associated to this functionality
+ nullable: true
+ type: string
+ service_now_ci_sys_id:
+ description: The Service Now CI sys id associated to this functionality
nullable: true
type: string
position:
- description: Position of the environment
+ description: Position of the functionality
nullable: true
type: integer
+ environment_ids:
+ description: Environments associated with this functionality
+ items:
+ type: string
+ nullable: true
+ type: array
+ service_ids:
+ description: Services associated with this functionality
+ items:
+ type: string
+ nullable: true
+ type: array
+ owner_group_ids:
+ description: Owner Teams associated with this functionality
+ items:
+ type: string
+ nullable: true
+ type: array
+ owner_user_ids:
+ description: Owner Users associated with this functionality
+ items:
+ type: integer
+ nullable: true
+ type: array
+ escalation_policy_id:
+ description: The escalation policy id of the functionality
+ nullable: true
+ type: string
slack_channels:
- description: Slack Channels associated with this environment
+ description: Slack Channels associated with this functionality
items:
$ref: '#/components/schemas/new_environment_data_attributes_slack_channels_inner'
nullable: true
type: array
slack_aliases:
- description: Slack Aliases associated with this environment
+ description: Slack Aliases associated with this functionality
items:
$ref: '#/components/schemas/new_environment_data_attributes_slack_aliases_inner'
nullable: true
type: array
+ properties:
+ description: Array of property values for this functionality.
+ items:
+ $ref: '#/components/schemas/new_cause_data_attributes_properties_inner'
+ nullable: true
+ type: array
created_at:
description: Date of creation
type: string
@@ -40548,1260 +29121,1581 @@ components:
- name
- updated_at
type: object
- environment_response:
+ incidents_chart_response:
+ required:
+ - data
+ type: object
+ uptime_chart_response:
+ required:
+ - data
+ type: object
+ functionality_response:
properties:
data:
- $ref: '#/components/schemas/environment_response_data'
+ $ref: '#/components/schemas/functionality_response_data'
required:
- data
type: object
- environment_list:
+ functionality_list:
properties:
data:
items:
- $ref: '#/components/schemas/environment_response_data'
+ $ref: '#/components/schemas/functionality_response_data'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- errors_list:
+ add_action_item_task_params:
properties:
- errors:
+ task_type:
+ enum:
+ - add_action_item
+ type: string
+ attribute_to_query_by:
+ description: Attribute of the Incident to match against
+ enum:
+ - jira_issue_id
+ nullable: true
+ type: string
+ query_value:
+ description: Value that attribute_to_query_by to uses to match against
+ nullable: true
+ type: string
+ incident_role_id:
+ description: The role id this action item is associated with
+ type: string
+ assigned_to_user_id:
+ description: "[DEPRECATED] Use assigned_to_user attribute instead. The user\
+ \ id this action item is assigned to"
+ type: string
+ assigned_to_user:
+ $ref: '#/components/schemas/add_action_item_task_params_assigned_to_user'
+ priority:
+ description: The action item priority
+ enum:
+ - high
+ - medium
+ - low
+ type: string
+ kind:
+ description: The action item kind
+ type: string
+ summary:
+ description: The action item summary
+ type: string
+ description:
+ description: The action item description
+ type: string
+ status:
+ description: The action item status
+ enum:
+ - open
+ - in_progress
+ - cancelled
+ - done
+ type: string
+ post_to_incident_timeline:
+ type: boolean
+ custom_fields_mapping:
+ description: Custom field mappings. Can contain liquid markup and need to
+ be valid JSON
+ nullable: true
+ type: string
+ post_to_slack_channels:
items:
- $ref: '#/components/schemas/errors_list_errors_inner'
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
type: array
- type: object
- new_escalation_policy:
- properties:
- data:
- $ref: '#/components/schemas/new_escalation_policy_data'
- required:
- - data
- type: object
- update_escalation_policy:
- properties:
- data:
- $ref: '#/components/schemas/update_escalation_policy_data'
required:
- - data
+ - priority
+ - status
+ - summary
type: object
- escalation_policy:
+ update_action_item_task_params:
properties:
- name:
- description: The name of the escalation policy
+ task_type:
+ enum:
+ - update_action_item
type: string
- description:
- description: The description of the escalation policy
- nullable: true
+ query_value:
+ description: Value that attribute_to_query_by to uses to match against
type: string
- repeat_count:
- description: The number of times this policy will be executed until someone
- acknowledges the alert
- type: integer
- created_by_user_id:
- description: User who created the escalation policy
- type: integer
- last_updated_by_user_id:
- description: User who updated the escalation policy
- type: integer
+ attribute_to_query_by:
+ default: id
+ description: Attribute of the action item to match against
+ enum:
+ - id
+ - jira_issue_id
+ - asana_task_id
+ - shortcut_task_id
+ - linear_issue_id
+ - zendesk_ticket_id
+ - motion_task_id
+ - trello_card_id
+ - airtable_record_id
+ - shortcut_story_id
+ - github_issue_id
+ - gitlab_issue_id
+ - freshservice_ticket_id
+ - freshservice_task_id
+ - clickup_task_id
+ type: string
+ summary:
+ description: Brief description of the action item
+ type: string
+ assigned_to_user_id:
+ description: "[DEPRECATED] Use assigned_to_user attribute instead. The user\
+ \ id this action item is assigned to"
+ type: string
+ assigned_to_user:
+ $ref: '#/components/schemas/add_action_item_task_params_assigned_to_user'
group_ids:
- description: Associated groups (alerting the group will trigger escalation
- policy)
- items:
- type: string
- type: array
- service_ids:
- description: Associated services (alerting the service will trigger escalation
- policy)
items:
type: string
+ nullable: true
type: array
- business_hours:
- $ref: '#/components/schemas/new_escalation_policy_data_attributes_business_hours'
- created_at:
- description: Date of creation
+ description:
+ description: The action item description
type: string
- updated_at:
- description: Date of last update
+ priority:
+ description: The action item priority
+ enum:
+ - high
+ - medium
+ - low
+ type: string
+ status:
+ description: The action item status
+ enum:
+ - open
+ - in_progress
+ - cancelled
+ - done
+ type: string
+ custom_fields_mapping:
+ description: Custom field mappings. Can contain liquid markup and need to
+ be valid JSON
+ nullable: true
type: string
+ post_to_incident_timeline:
+ type: boolean
required:
- - created_by_user_id
- - name
- - repeat_count
+ - attribute_to_query_by
+ - query_value
type: object
- escalation_policy_response:
+ add_role_task_params:
properties:
- data:
- $ref: '#/components/schemas/escalation_policy_response_data'
+ task_type:
+ enum:
+ - add_role
+ type: string
+ incident_role_id:
+ description: The role id to add to the incident
+ type: string
+ assigned_to_user_id:
+ description: "[DEPRECATED] Use assigned_to_user attribute instead. The user\
+ \ id this role is assigned to"
+ type: string
+ assigned_to_user:
+ $ref: '#/components/schemas/add_role_task_params_assigned_to_user'
required:
- - data
+ - incident_role_id
type: object
- escalation_policy_list:
+ add_slack_bookmark_task_params:
+ anyOf: []
+ nullable: true
properties:
- data:
- items:
- $ref: '#/components/schemas/escalation_policy_response_data'
- type: array
- links:
- allOf:
- - $ref: '#/components/schemas/links'
+ task_type:
+ enum:
+ - add_slack_bookmark
+ type: string
+ playbook_id:
+ description: The playbook id if bookmark is of an incident playbook
+ type: string
+ channel:
+ properties:
+ id:
+ type: string
+ name:
+ type: string
type: object
+ title:
+ description: The bookmark title. Required if not a playbook bookmark
+ nullable: true
+ type: string
+ link:
+ description: The bookmark link. Required if not a playbook bookmark
+ nullable: true
+ type: string
+ emoji:
+ description: The bookmark emoji
+ type: string
required:
- - data
- - links
- type: object
- new_escalation_policy_path:
- properties:
- data:
- $ref: '#/components/schemas/new_escalation_policy_path_data'
- required:
- - data
+ - channel
type: object
- update_escalation_policy_path:
+ add_team_task_params:
properties:
- data:
- $ref: '#/components/schemas/update_escalation_policy_path_data'
+ task_type:
+ enum:
+ - add_team
+ type: string
+ group_id:
+ description: The team id
+ type: string
required:
- - data
+ - group_id
type: object
- escalation_policy_path:
+ add_to_timeline_task_params:
properties:
- name:
- description: The name of the escalation path
- type: string
- default:
- description: Whether this escalation path is the default path
- type: boolean
- notification_type:
- description: Notification rule type
- type: string
- escalation_policy_id:
- description: The ID of the escalation policy
- type: string
- match_mode:
- description: How path rules are matched.
+ task_type:
enum:
- - match-all-rules
- - match-any-rule
+ - add_to_timeline
type: string
- position:
- description: The position of this path in the paths for this EP.
- type: integer
- repeat:
- description: Whether this path should be repeated until someone acknowledges
- the alert
- nullable: true
- type: boolean
- repeat_count:
- description: The number of times this path will be executed until someone
- acknowledges the alert
- nullable: true
- type: integer
- initial_delay:
- description: Initial delay for escalation path in minutes. Maximum 1 week
- (10080).
- type: integer
- created_at:
- description: Date of creation
+ event:
+ description: The timeline event description
type: string
- updated_at:
- description: Date of last update
+ url:
+ description: A URL for the timeline event
type: string
- rules:
- description: Escalation path rules
+ post_to_slack_channels:
items:
- $ref: '#/components/schemas/escalation_policy_path_rules_inner'
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
type: array
required:
- - default
- - escalation_policy_id
- - name
- - notification_type
- - repeat
- - repeat_count
+ - event
type: object
- escalation_policy_path_response:
+ archive_slack_channels_task_params:
properties:
- data:
- $ref: '#/components/schemas/escalation_policy_path_response_data'
+ task_type:
+ enum:
+ - archive_slack_channels
+ type: string
+ channels:
+ items:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ type: array
required:
- - data
+ - channels
type: object
- escalation_policy_path_list:
+ attach_datadog_dashboards_task_params:
properties:
- data:
+ task_type:
+ enum:
+ - attach_datadog_dashboards
+ type: string
+ dashboards:
items:
- $ref: '#/components/schemas/escalation_policy_path_list_data_inner'
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ type: array
+ post_to_incident_timeline:
+ type: boolean
+ post_to_slack_channels:
+ items:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
type: array
- links:
- allOf:
- - $ref: '#/components/schemas/links'
- type: object
required:
- - data
- - links
+ - dashboards
type: object
- new_escalation_policy_level:
+ auto_assign_role_opsgenie_task_params:
properties:
- data:
- $ref: '#/components/schemas/new_escalation_policy_level_data'
+ task_type:
+ enum:
+ - auto_assign_role_opsgenie
+ type: string
+ incident_role_id:
+ description: The role id
+ type: string
+ schedule:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
required:
- - data
+ - incident_role_id
+ - schedule
type: object
- update_escalation_policy_level:
+ auto_assign_role_rootly_task_params:
properties:
- data:
- $ref: '#/components/schemas/update_escalation_policy_level_data'
+ task_type:
+ enum:
+ - auto_assign_role_rootly
+ type: string
+ incident_role_id:
+ description: The role id
+ type: string
+ escalation_policy_target:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ service_target:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ user_target:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ group_target:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ schedule_target:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
required:
- - data
+ - incident_role_id
type: object
- escalation_policy_level:
+ auto_assign_role_pagerduty_task_params:
+ anyOf: []
+ nullable: true
properties:
- escalation_policy_id:
- description: The ID of the escalation policy
+ task_type:
+ enum:
+ - auto_assign_role_pagerduty
+ type: string
+ incident_role_id:
+ description: The role id
+ type: string
+ service:
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ type: object
+ schedule:
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ type: object
+ escalation_policy:
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ type: object
+ required:
+ - incident_role_id
+ type: object
+ update_pagerduty_incident_task_params:
+ properties:
+ task_type:
+ enum:
+ - update_pagerduty_incident
+ type: string
+ pagerduty_incident_id:
+ description: Pagerduty incident id
type: string
- escalation_policy_path_id:
- description: The ID of the dynamic escalation policy path the level will
- belong to. If nothing is specified it will add the level to your default
- path.
- nullable: true
+ title:
+ description: Title to update to
type: string
- paging_strategy_configuration_strategy:
+ status:
enum:
- - default
- - random
- - cycle
- - alert
- nullable: true
+ - resolved
+ - acknowledged
+ - auto
type: string
- paging_strategy_configuration_schedule_strategy:
- enum:
- - on_call_only
- - everyone
- nullable: true
+ resolution:
+ description: A message outlining the incident's resolution in PagerDuty
type: string
- delay:
- description: Delay before notification targets will be alerted.
- type: integer
- position:
- description: Position of the escalation policy level
+ escalation_level:
+ description: Escalation level of policy attached to incident
+ example: 1
+ maximum: 20
+ minimum: 1
type: integer
- created_at:
- description: Date of creation
+ urgency:
+ description: "PagerDuty incident urgency, selecting auto will let Rootly\
+ \ auto map our incident severity"
+ enum:
+ - high
+ - low
+ - auto
type: string
- updated_at:
- description: Date of last update
+ priority:
+ description: "PagerDuty incident priority, selecting auto will let Rootly\
+ \ auto map our incident severity"
type: string
- notification_target_params:
- description: Escalation level's notification targets
- items:
- $ref: '#/components/schemas/update_escalation_policy_level_data_attributes_notification_target_params_inner'
- type: array
required:
- - delay
- - escalation_policy_id
- - notification_target_params
- - position
+ - pagerduty_incident_id
type: object
- escalation_policy_level_response:
+ create_pagerduty_status_update_task_params:
properties:
- data:
- $ref: '#/components/schemas/escalation_policy_level_response_data'
+ task_type:
+ enum:
+ - create_pagerduty_status_update
+ type: string
+ pagerduty_incident_id:
+ description: PagerDuty incident id
+ type: string
+ message:
+ description: A message outlining the incident's resolution in PagerDuty
+ type: string
required:
- - data
+ - message
+ - pagerduty_incident_id
type: object
- escalation_policy_level_list:
+ create_pagertree_alert_task_params:
properties:
- data:
+ task_type:
+ enum:
+ - create_pagertree_alert
+ type: string
+ title:
+ description: Title of alert as text
+ type: string
+ description:
+ description: Description of alert as text
+ type: string
+ urgency:
+ enum:
+ - auto
+ - critical
+ - high
+ - medium
+ - low
+ type: string
+ severity:
+ enum:
+ - auto
+ - SEV-1
+ - SEV-2
+ - SEV-3
+ - SEV-4
+ type: string
+ teams:
items:
- $ref: '#/components/schemas/escalation_policy_level_list_data_inner'
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
type: array
- links:
- allOf:
- - $ref: '#/components/schemas/links'
- type: object
- required:
- - data
- - links
- type: object
- new_form_field_option:
- properties:
- data:
- $ref: '#/components/schemas/new_form_field_option_data'
- required:
- - data
- type: object
- update_form_field_option:
- properties:
- data:
- $ref: '#/components/schemas/update_form_field_option_data'
- required:
- - data
+ users:
+ items:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ type: array
+ incident:
+ description: Setting to true makes an alert a Pagertree incident
+ type: boolean
type: object
- form_field_option:
+ update_pagertree_alert_task_params:
properties:
- form_field_id:
- description: The ID of the parent custom field
+ task_type:
+ enum:
+ - update_pagertree_alert
type: string
- value:
- description: The value of the form_field_option
+ pagertree_alert_id:
+ description: The prefix ID of the Pagertree alert
type: string
- color:
- description: The hex color of the form_field_option
+ title:
+ description: Title of alert as text
type: string
- default:
- type: boolean
- position:
- description: The position of the form_field_option
- type: integer
- created_at:
- description: Date of creation
+ description:
+ description: Description of alert as text
type: string
- updated_at:
- description: Date of last update
+ urgency:
+ enum:
+ - auto
+ - critical
+ - high
+ - medium
+ - low
type: string
- required:
- - color
- - created_at
- - position
- - updated_at
- - value
+ severity:
+ enum:
+ - auto
+ - SEV-1
+ - SEV-2
+ - SEV-3
+ - SEV-4
+ type: string
+ teams:
+ items:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ type: array
+ users:
+ items:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ type: array
+ incident:
+ description: Setting to true makes an alert a Pagertree incident
+ type: boolean
type: object
- form_field_option_response:
+ auto_assign_role_victor_ops_task_params:
properties:
- data:
- $ref: '#/components/schemas/form_field_option_response_data'
+ task_type:
+ enum:
+ - auto_assign_role_victor_ops
+ type: string
+ incident_role_id:
+ description: The role id
+ type: string
+ team:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
required:
- - data
+ - incident_role_id
+ - team
type: object
- form_field_option_list:
+ call_people_task_params:
properties:
- data:
+ task_type:
+ enum:
+ - call_people
+ type: string
+ phone_numbers:
items:
- $ref: '#/components/schemas/form_field_option_response_data'
+ description: A recipient phone number
+ example: "[\"14150001111\"]"
+ type: string
type: array
- links:
- allOf:
- - $ref: '#/components/schemas/links'
- type: object
- required:
- - data
- - links
- type: object
- new_form_field_placement_condition:
- properties:
- data:
- $ref: '#/components/schemas/new_form_field_placement_condition_data'
+ name:
+ description: The name
+ type: string
+ content:
+ description: The message to be read by text-to-voice
+ type: string
required:
- - data
+ - content
+ - name
+ - phone_numbers
type: object
- update_form_field_placement_condition:
+ create_airtable_table_record_task_params:
properties:
- data:
- $ref: '#/components/schemas/update_form_field_placement_condition_data'
+ task_type:
+ enum:
+ - create_airtable_table_record
+ type: string
+ base:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ table:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ custom_fields_mapping:
+ description: Custom field mappings. Can contain liquid markup and need to
+ be valid JSON
+ nullable: true
+ type: string
required:
- - data
+ - base
+ - table
type: object
- form_field_placement_condition:
+ create_asana_subtask_task_params:
properties:
- form_field_placement_id:
- description: The form field placement this condition applies.
- type: string
- conditioned:
- description: The resource or attribute the condition applies.
+ task_type:
enum:
- - placement
- - required
+ - create_asana_subtask
type: string
- position:
- description: The condition position.
- type: integer
- form_field_id:
- description: The condition field.
+ parent_task_id:
+ description: The parent task id
type: string
- comparison:
- description: The condition comparison.
+ title:
+ description: The subtask title
+ type: string
+ notes:
+ type: string
+ assign_user_email:
+ description: The assigned user's email
+ type: string
+ completion:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ due_date:
+ description: The due date
+ type: string
+ custom_fields_mapping:
+ description: Custom field mappings. Can contain liquid markup and need to
+ be valid JSON
+ nullable: true
+ type: string
+ dependency_direction:
+ default: blocking
enum:
- - equal
- - is_set
- - is_not_set
+ - blocking
+ - blocked_by
type: string
- values:
- description: The values for comparison.
+ dependent_task_ids:
+ description: Dependent task ids. Supports liquid syntax
items:
- description: The value for comparison.
type: string
+ nullable: true
type: array
required:
- - comparison
- - conditioned
- - form_field_id
- - form_field_placement_id
- - position
- - values
- type: object
- form_field_placement_condition_response:
- properties:
- data:
- $ref: '#/components/schemas/form_field_placement_condition_response_data'
- required:
- - data
+ - completion
+ - parent_task_id
+ - title
type: object
- form_field_placement_condition_list:
+ create_asana_task_task_params:
properties:
- data:
+ task_type:
+ enum:
+ - create_asana_task
+ type: string
+ workspace:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ projects:
items:
- $ref: '#/components/schemas/form_field_placement_condition_response_data'
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
type: array
- links:
- allOf:
- - $ref: '#/components/schemas/links'
- type: object
- required:
- - data
- - links
- type: object
- new_form_field_placement:
- properties:
- data:
- $ref: '#/components/schemas/new_form_field_placement_data'
- required:
- - data
- type: object
- update_form_field_placement:
- properties:
- data:
- $ref: '#/components/schemas/update_form_field_placement_data'
- required:
- - data
- type: object
- form_field_placement:
- properties:
- form_field_id:
- description: The form field that is placed.
+ title:
+ description: The task title
type: string
- form_set_id:
- description: The form set this field is placed in.
+ notes:
type: string
- form:
- description: The form this field is placed on.
+ assign_user_email:
+ description: The assigned user's email
type: string
- position:
- description: The position of the field placement.
- type: integer
- required:
- description: Whether the field is unconditionally required on this form.
- type: boolean
- required_operator:
- description: Logical operator when evaluating multiple form_field_placement_conditions
- with conditioned=required
- enum:
- - and
- - or
+ completion:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ due_date:
+ description: The due date
type: string
- placement_operator:
- description: Logical operator when evaluating multiple form_field_placement_conditions
- with conditioned=placement
+ custom_fields_mapping:
+ description: Custom field mappings. Can contain liquid markup and need to
+ be valid JSON
+ nullable: true
+ type: string
+ dependency_direction:
+ default: blocking
enum:
- - and
- - or
+ - blocking
+ - blocked_by
type: string
- required:
- - form
- - form_field_id
- - form_set_id
- - position
- - required
- type: object
- form_field_placement_response:
- properties:
- data:
- $ref: '#/components/schemas/form_field_placement_response_data'
- required:
- - data
- type: object
- form_field_placement_list:
- properties:
- data:
+ dependent_task_ids:
+ description: Dependent task ids. Supports liquid syntax
items:
- $ref: '#/components/schemas/form_field_placement_response_data'
+ type: string
+ nullable: true
type: array
- links:
- allOf:
- - $ref: '#/components/schemas/links'
- type: object
- required:
- - data
- - links
- type: object
- new_form_field_position:
- properties:
- data:
- $ref: '#/components/schemas/new_form_field_position_data'
required:
- - data
+ - completion
+ - projects
+ - title
+ - workspace
type: object
- update_form_field_position:
+ create_confluence_page_task_params:
properties:
- data:
- $ref: '#/components/schemas/update_form_field_position_data'
+ task_type:
+ enum:
+ - create_confluence_page
+ type: string
+ integration:
+ $ref: '#/components/schemas/create_confluence_page_task_params_integration'
+ space:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ ancestor:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ template:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ title:
+ description: The page title
+ type: string
+ content:
+ description: The page content
+ type: string
+ post_mortem_template_id:
+ description: The Retrospective template to use
+ type: string
+ mark_post_mortem_as_published:
+ default: true
+ type: boolean
required:
- - data
+ - space
+ - title
type: object
- form_field_position:
+ create_datadog_notebook_task_params:
properties:
- form_field_id:
- description: The ID of the form field.
+ task_type:
+ enum:
+ - create_datadog_notebook
type: string
- form:
- description: The form for the position
+ post_mortem_template_id:
+ description: "Retrospective template to use when creating notebook, if desired"
+ type: string
+ mark_post_mortem_as_published:
+ default: true
+ type: boolean
+ template:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ title:
+ description: The notebook title
+ type: string
+ kind:
+ description: The notebook kind
enum:
- - web_new_incident_form
- - web_update_incident_form
- - web_incident_post_mortem_form
- - web_incident_mitigation_form
- - web_incident_resolution_form
- - web_incident_cancellation_form
- - web_scheduled_incident_form
- - web_update_scheduled_incident_form
- - incident_post_mortem
- - slack_new_incident_form
- - slack_update_incident_form
- - slack_update_incident_status_form
- - slack_incident_mitigation_form
- - slack_incident_resolution_form
- - slack_incident_cancellation_form
- - slack_scheduled_incident_form
- - slack_update_scheduled_incident_form
+ - postmortem
+ - runbook
+ - investigation
+ - documentation
+ - report
+ type: string
+ content:
+ description: The notebook content
type: string
- position:
- description: The position of the form_field_position
- type: integer
- required:
- - form
- - form_field_id
- - position
- type: object
- form_field_position_response:
- properties:
- data:
- $ref: '#/components/schemas/form_field_position_response_data'
required:
- - data
+ - kind
+ - title
type: object
- form_field_position_list:
+ create_coda_page_task_params:
properties:
- data:
- items:
- $ref: '#/components/schemas/form_field_position_response_data'
- type: array
- links:
- allOf:
- - $ref: '#/components/schemas/links'
- type: object
+ task_type:
+ enum:
+ - create_coda_page
+ type: string
+ post_mortem_template_id:
+ description: "Retrospective template to use when creating page, if desired"
+ type: string
+ mark_post_mortem_as_published:
+ default: true
+ type: boolean
+ title:
+ description: The Coda page title
+ type: string
+ subtitle:
+ description: The Coda page subtitle
+ type: string
+ content:
+ description: The Coda page content
+ type: string
+ template:
+ $ref: '#/components/schemas/create_coda_page_task_params_template'
+ folder_id:
+ description: The Coda folder id
+ type: string
+ doc:
+ $ref: '#/components/schemas/create_coda_page_task_params_doc'
required:
- - data
- - links
+ - title
type: object
- new_form_field:
+ create_dropbox_paper_page_task_params:
properties:
- data:
- $ref: '#/components/schemas/new_form_field_data'
+ task_type:
+ enum:
+ - create_dropbox_paper_page
+ type: string
+ post_mortem_template_id:
+ description: "Retrospective template to use when creating page task, if\
+ \ desired"
+ type: string
+ mark_post_mortem_as_published:
+ default: true
+ type: boolean
+ title:
+ description: The page task title
+ type: string
+ content:
+ description: The page content
+ type: string
+ namespace:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ parent_folder:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
required:
- - data
+ - title
type: object
- update_form_field:
+ create_github_issue_task_params:
properties:
- data:
- $ref: '#/components/schemas/update_form_field_data'
+ task_type:
+ enum:
+ - create_github_issue
+ type: string
+ title:
+ description: The issue title
+ type: string
+ body:
+ description: The issue body
+ type: string
+ repository:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ labels:
+ description: The issue labels
+ items:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ type: array
+ issue_type:
+ $ref: '#/components/schemas/create_github_issue_task_params_issue_type'
+ parent_issue_number:
+ description: The parent issue number for sub-issue linking
+ nullable: true
+ type: string
required:
- - data
+ - repository
+ - title
type: object
- form_field:
+ create_gitlab_issue_task_params:
properties:
- kind:
- description: The kind of the form field
+ task_type:
enum:
- - custom
- - title
- - summary
- - mitigation_message
- - resolution_message
- - severity
- - environments
- - types
- - services
- - causes
- - functionalities
- - teams
- - visibility
- - mark_as_test
- - mark_as_backfilled
- - labels
- - notify_emails
- - trigger_manual_workflows
- - show_ongoing_incidents
- - attach_alerts
- - mark_as_in_triage
- - in_triage_at
- - started_at
- - detected_at
- - acknowledged_at
- - mitigated_at
- - resolved_at
- - closed_at
- - manual_starting_datetime_field
+ - create_gitlab_issue
type: string
- input_kind:
- description: The input kind of the form field
+ issue_type:
+ description: The issue type
enum:
- - text
- - textarea
- - select
- - multi_select
- - date
- - datetime
- - number
- - checkbox
- - tags
- - rich_text
+ - issue
+ - incident
+ - test_case
+ - task
type: string
- value_kind:
- description: The value kind of the form field
+ title:
+ description: The issue title
+ type: string
+ description:
+ description: The issue description
+ type: string
+ repository:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ labels:
+ description: The issue labels
+ type: string
+ due_date:
+ description: The due date
+ type: string
+ required:
+ - repository
+ - title
+ type: object
+ create_outlook_event_task_params:
+ properties:
+ task_type:
enum:
- - inherit
- - group
- - service
- - functionality
- - user
- - catalog_entity
+ - create_outlook_event
type: string
- value_kind_catalog_id:
- description: The ID of the catalog used when value_kind is `catalog_entity`
+ calendar:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ attendees:
+ description: Emails of attendees
+ items:
+ type: string
+ type: array
+ time_zone:
+ description: A valid IANA time zone name.
nullable: true
type: string
- name:
- description: The name of the form field
+ days_until_meeting:
+ description: The days until meeting
+ maximum: 31
+ minimum: 0
+ type: integer
+ time_of_meeting:
+ description: Time of meeting in format HH:MM
+ example: 14:30
type: string
- slug:
- description: The slug of the form field
+ meeting_duration:
+ description: "Meeting duration in format like '1 hour', '30 minutes'"
+ example: 1 hour
+ type: string
+ summary:
+ description: The event summary
type: string
description:
- description: The description of the form field
- nullable: true
+ description: The event description
type: string
- shown:
+ exclude_weekends:
+ type: boolean
+ enable_online_meeting:
+ description: Enable Microsoft Teams online meeting
+ type: boolean
+ post_to_incident_timeline:
+ type: boolean
+ post_to_slack_channels:
items:
- description: "Where the form field is shown. Add custom forms using the\
- \ custom form's `slug` field. Or choose a built-in form: `web_new_incident_form`,\
- \ `web_update_incident_form`, `web_incident_post_mortem_form`, `web_incident_mitigation_form`,\
- \ `web_incident_resolution_form`, `web_incident_cancellation_form`,\
- \ `web_scheduled_incident_form`, `web_update_scheduled_incident_form`,\
- \ `incident_post_mortem`, `slack_new_incident_form`, `slack_update_incident_form`,\
- \ `slack_update_incident_status_form`, `slack_incident_mitigation_form`,\
- \ `slack_incident_resolution_form`, `slack_incident_cancellation_form`,\
- \ `slack_scheduled_incident_form`, `slack_update_scheduled_incident_form`"
- type: string
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
type: array
- required:
+ required:
+ - calendar
+ - days_until_meeting
+ - description
+ - meeting_duration
+ - summary
+ - time_of_meeting
+ type: object
+ create_google_calendar_event_task_params:
+ properties:
+ task_type:
+ enum:
+ - create_google_calendar_event
+ type: string
+ attendees:
+ description: Emails of attendees
items:
- description: "Where the form field is required. Add custom forms using\
- \ the custom form's `slug` field. Or choose a built-in form: `web_new_incident_form`,\
- \ `web_update_incident_form`, `web_incident_post_mortem_form`, `web_incident_mitigation_form`,\
- \ `web_incident_resolution_form`, `web_incident_cancellation_form`,\
- \ `web_scheduled_incident_form`, `web_update_scheduled_incident_form`,\
- \ `slack_new_incident_form`, `slack_update_incident_form`, `slack_update_incident_status_form`,\
- \ `slack_incident_mitigation_form`, `slack_incident_resolution_form`,\
- \ `slack_incident_cancellation_form`, `slack_scheduled_incident_form`,\
- \ `slack_update_scheduled_incident_form`"
type: string
type: array
- show_on_incident_details:
- description: Whether the form field is shown on the incident details panel
+ time_zone:
+ description: A valid IANA time zone name.
+ nullable: true
+ type: string
+ calendar_id:
+ default: primary
+ nullable: true
+ type: string
+ days_until_meeting:
+ description: The days until meeting
+ maximum: 31
+ minimum: 0
+ type: integer
+ time_of_meeting:
+ description: Time of meeting in format HH:MM
+ example: 14:30
+ type: string
+ meeting_duration:
+ description: "Meeting duration in format like '1 hour', '30 minutes'"
+ example: 1 hour
+ type: string
+ send_updates:
+ description: Send an email to the attendees notifying them of the event
type: boolean
- enabled:
- description: Whether the form field is enabled
+ can_guests_modify_event:
type: boolean
- default_values:
- items:
- description: The default values.
- type: string
- type: array
- created_at:
- description: Date of creation
+ can_guests_see_other_guests:
+ type: boolean
+ can_guests_invite_others:
+ type: boolean
+ summary:
+ description: The event summary
type: string
- updated_at:
- description: Date of last update
+ description:
+ description: The event description
type: string
- required:
- - created_at
- - default_values
- - input_kind
- - kind
- - name
- - required
- - shown
- - slug
- - updated_at
- - value_kind
- type: object
- form_field_response:
- properties:
- data:
- $ref: '#/components/schemas/form_field_response_data'
- required:
- - data
- type: object
- form_field_list:
- properties:
- data:
+ exclude_weekends:
+ type: boolean
+ conference_solution_key:
+ description: Sets the video conference type attached to the meeting
+ enum:
+ - eventHangout
+ - eventNamedHangout
+ - hangoutsMeet
+ - addOn
+ nullable: true
+ type: string
+ post_to_incident_timeline:
+ type: boolean
+ post_to_slack_channels:
items:
- $ref: '#/components/schemas/form_field_response_data'
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
type: array
- links:
- allOf:
- - $ref: '#/components/schemas/links'
- type: object
required:
- - data
- - links
+ - days_until_meeting
+ - description
+ - meeting_duration
+ - summary
+ - time_of_meeting
type: object
- new_form_set_condition:
+ update_google_docs_page_task_params:
properties:
- data:
- $ref: '#/components/schemas/new_form_set_condition_data'
+ task_type:
+ enum:
+ - update_google_docs_page
+ type: string
+ file_id:
+ description: The Google Doc file ID
+ type: string
+ title:
+ description: The Google Doc title
+ type: string
+ content:
+ description: The Google Doc content
+ type: string
+ post_mortem_template_id:
+ description: "Retrospective template to use when updating page, if desired"
+ type: string
+ template_id:
+ description: The Google Doc file ID to use as a template.
+ type: string
required:
- - data
+ - file_id
type: object
- update_form_set_condition:
+ update_coda_page_task_params:
properties:
- data:
- $ref: '#/components/schemas/update_form_set_condition_data'
+ task_type:
+ enum:
+ - update_coda_page
+ type: string
+ doc_id:
+ description: The Coda doc id
+ type: string
+ page_id:
+ description: The Coda page id
+ type: string
+ title:
+ description: The Coda page title
+ type: string
+ subtitle:
+ description: The Coda page subtitle
+ type: string
+ content:
+ description: The Coda page content
+ type: string
+ template:
+ $ref: '#/components/schemas/create_coda_page_task_params_template'
required:
- - data
+ - page_id
type: object
- form_set_condition:
+ update_google_calendar_event_task_params:
properties:
- form_set_id:
- description: The form set this condition applies.
+ task_type:
+ enum:
+ - create_google_calendar_event
type: string
- form_field_id:
- description: The form field this condition applies.
+ calendar_id:
+ default: primary
+ nullable: true
type: string
- comparison:
- description: The condition comparison.
- enum:
- - equal
+ event_id:
+ description: The event ID
type: string
- values:
- description: The values for comparison.
+ summary:
+ description: The event summary
+ type: string
+ description:
+ description: The event description
+ type: string
+ adjustment_days:
+ description: Days to adjust meeting by
+ maximum: 31
+ minimum: 0
+ type: integer
+ time_of_meeting:
+ description: Time of meeting in format HH:MM
+ type: string
+ meeting_duration:
+ description: "Meeting duration in format like '1 hour', '30 minutes'"
+ example: 1 hour
+ type: string
+ send_updates:
+ description: Send an email to the attendees notifying them of the event
+ type: boolean
+ can_guests_modify_event:
+ type: boolean
+ can_guests_see_other_guests:
+ type: boolean
+ can_guests_invite_others:
+ type: boolean
+ attendees:
+ description: Emails of attendees
items:
- description: The value for comparison.
type: string
type: array
+ replace_attendees:
+ type: boolean
+ conference_solution_key:
+ description: Sets the video conference type attached to the meeting
+ enum:
+ - eventHangout
+ - eventNamedHangout
+ - hangoutsMeet
+ - addOn
+ nullable: true
+ type: string
+ post_to_incident_timeline:
+ type: boolean
+ post_to_slack_channels:
+ items:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ type: array
required:
- - comparison
- - form_field_id
- - form_set_id
- - values
- type: object
- form_set_condition_response:
- properties:
- data:
- $ref: '#/components/schemas/form_set_condition_response_data'
- required:
- - data
- type: object
- form_set_condition_list:
- properties:
- data:
- items:
- $ref: '#/components/schemas/form_set_condition_response_data'
- type: array
- links:
- allOf:
- - $ref: '#/components/schemas/links'
- type: object
- required:
- - data
- - links
- type: object
- new_form_set:
- properties:
- data:
- $ref: '#/components/schemas/new_form_set_data'
- required:
- - data
- type: object
- update_form_set:
- properties:
- data:
- $ref: '#/components/schemas/update_form_set_data'
- required:
- - data
+ - event_id
type: object
- form_set:
+ create_sharepoint_page_task_params:
properties:
- name:
- description: The name of the form set
+ task_type:
+ enum:
+ - create_sharepoint_page
type: string
- slug:
- description: The slug of the form set
+ post_mortem_template_id:
+ description: "Retrospective template to use when creating page, if desired"
type: string
- is_default:
- description: Whether the form set is default
+ mark_post_mortem_as_published:
+ default: true
type: boolean
- forms:
- description: "The forms included in the form set. Add custom forms using\
- \ the custom form's `slug` field. Or choose a built-in form: `web_new_incident_form`,\
- \ `web_update_incident_form`, `web_incident_post_mortem_form`, `web_incident_mitigation_form`,\
- \ `web_incident_resolution_form`, `web_incident_cancellation_form`, `web_scheduled_incident_form`,\
- \ `web_update_scheduled_incident_form`, `slack_new_incident_form`, `slack_update_incident_form`,\
- \ `slack_update_incident_status_form`, `slack_incident_mitigation_form`,\
- \ `slack_incident_resolution_form`, `slack_incident_cancellation_form`,\
- \ `slack_scheduled_incident_form`, `slack_update_scheduled_incident_form`"
- items:
- description: "The form included in the form set. Add custom forms using\
- \ the custom form's `slug` field. Or choose a built-in form: `web_new_incident_form`,\
- \ `web_update_incident_form`, `web_incident_post_mortem_form`, `web_incident_mitigation_form`,\
- \ `web_incident_resolution_form`, `web_incident_cancellation_form`,\
- \ `web_scheduled_incident_form`, `web_update_scheduled_incident_form`,\
- \ `slack_new_incident_form`, `slack_update_incident_form`, `slack_update_incident_status_form`,\
- \ `slack_incident_mitigation_form`, `slack_incident_resolution_form`,\
- \ `slack_incident_cancellation_form`, `slack_scheduled_incident_form`,\
- \ `slack_update_scheduled_incident_form`"
- type: string
- type: array
- created_at:
- description: Date of creation
+ title:
+ description: The page title
type: string
- updated_at:
- description: Date of last update
+ site:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ drive:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ parent_folder:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ content:
+ description: The page content
+ type: string
+ template_id:
+ description: The SharePoint file ID to use as a template
type: string
required:
- - created_at
- - forms
- - is_default
- - name
- - slug
- - updated_at
+ - drive
+ - site
+ - title
type: object
- form_set_response:
+ create_google_docs_page_task_params:
properties:
- data:
- $ref: '#/components/schemas/form_set_response_data'
+ task_type:
+ enum:
+ - create_google_docs_page
+ type: string
+ post_mortem_template_id:
+ description: "Retrospective template to use when creating page, if desired"
+ type: string
+ mark_post_mortem_as_published:
+ default: true
+ type: boolean
+ title:
+ description: The page title
+ type: string
+ drive:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ parent_folder:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ content:
+ description: The page content
+ type: string
+ template_id:
+ description: The Google Doc file ID to use as a template
+ type: string
+ permissions:
+ description: Page permissions JSON
+ type: string
required:
- - data
+ - title
type: object
- form_set_list:
+ create_google_docs_permissions_task_params:
properties:
- data:
- items:
- $ref: '#/components/schemas/form_set_response_data'
- type: array
- links:
- allOf:
- - $ref: '#/components/schemas/links'
- type: object
+ task_type:
+ enum:
+ - create_google_docs_permissions
+ type: string
+ file_id:
+ description: The Google Doc file ID
+ type: string
+ permissions:
+ description: Page permissions JSON
+ type: string
+ send_notification_email:
+ type: boolean
+ email_message:
+ description: Email message notification
+ nullable: true
+ type: string
required:
- - data
- - links
+ - file_id
+ - permissions
type: object
- new_functionality:
+ remove_google_docs_permissions_task_params:
properties:
- data:
- $ref: '#/components/schemas/new_functionality_data'
+ task_type:
+ enum:
+ - remove_google_docs_permissions
+ type: string
+ file_id:
+ description: The Google Doc file ID
+ type: string
+ attribute_to_query_by:
+ default: email_address
+ enum:
+ - type
+ - role
+ - email_address
+ type: string
+ value:
+ type: string
required:
- - data
+ - attribute_to_query_by
+ - file_id
+ - value
type: object
- update_functionality:
+ create_quip_page_task_params:
properties:
- data:
- $ref: '#/components/schemas/update_functionality_data'
+ task_type:
+ enum:
+ - create_google_docs_page
+ type: string
+ post_mortem_template_id:
+ description: "Retrospective template to use when creating page, if desired"
+ type: string
+ title:
+ description: The page title
+ type: string
+ parent_folder_id:
+ description: The parent folder id
+ type: string
+ content:
+ description: The page content
+ type: string
+ template_id:
+ description: The Quip file ID to use as a template
+ type: string
+ mark_post_mortem_as_published:
+ default: true
+ type: boolean
required:
- - data
+ - title
type: object
- functionality:
+ create_google_meeting_task_params:
properties:
- name:
- description: The name of the functionality
+ task_type:
+ enum:
+ - create_google_meeting
type: string
- slug:
- description: The slug of the functionality
+ summary:
+ description: "[DEPRECATED] The meeting summary"
+ nullable: true
type: string
description:
- description: The description of the functionality
+ description: "[DEPRECATED] The meeting description"
nullable: true
type: string
- public_description:
- description: The public description of the functionality
+ conference_solution_key:
+ description: "[DEPRECATED] Sets the video conference type attached to the\
+ \ meeting"
+ enum:
+ - eventHangout
+ - eventNamedHangout
+ - hangoutsMeet
+ - addOn
nullable: true
type: string
- notify_emails:
- description: Emails attached to the functionality
- items:
- type: string
- nullable: true
- type: array
- color:
- description: The hex color of the functionality
+ record_meeting:
+ description: Rootly AI will record the meeting and automatically generate
+ a transcript and summary from your meeting
+ type: boolean
+ recording_mode:
+ description: "The video layout for the bot's recording (e.g. speaker_view,\
+ \ gallery_view, gallery_view_v2, audio_only)"
+ enum:
+ - speaker_view
+ - gallery_view
+ - gallery_view_v2
+ - audio_only
nullable: true
type: string
- backstage_id:
- description: "The Backstage entity id associated to this functionality.\
- \ eg: :namespace/:kind/:entity_name"
- nullable: true
+ post_to_incident_timeline:
+ type: boolean
+ post_to_slack_channels:
+ items:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ type: array
+ required:
+ - description
+ - summary
+ type: object
+ create_go_to_meeting_task_params:
+ properties:
+ task_type:
+ enum:
+ - create_go_to_meeting_task
type: string
- external_id:
- description: The external id associated to this functionality
- nullable: true
+ subject:
+ description: The meeting subject
type: string
- pagerduty_id:
- description: The PagerDuty service id associated to this functionality
+ conference_call_info:
+ default: voip
+ enum:
+ - ptsn
+ - free
+ - hyrid
+ - voip
+ example: voip
nullable: true
type: string
- opsgenie_id:
- description: The Opsgenie service id associated to this functionality
+ password_required:
nullable: true
+ type: boolean
+ post_to_incident_timeline:
+ type: boolean
+ post_to_slack_channels:
+ items:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ type: array
+ required:
+ - subject
+ type: object
+ create_incident_task_params:
+ properties:
+ task_type:
+ enum:
+ - create_incident
type: string
- opsgenie_team_id:
- description: The Opsgenie team id associated to this functionality
- nullable: true
+ title:
+ description: The incident title
type: string
- cortex_id:
- description: The Cortex group id associated to this functionality
- nullable: true
+ summary:
+ description: The incident summary
type: string
- service_now_ci_sys_id:
- description: The Service Now CI sys id associated to this functionality
- nullable: true
+ severity_id:
type: string
- position:
- description: Position of the functionality
- nullable: true
- type: integer
- environment_ids:
- description: Environments associated with this functionality
+ incident_type_ids:
items:
type: string
- nullable: true
type: array
service_ids:
- description: Services associated with this functionality
+ description: Array of service UUIDs
items:
type: string
- nullable: true
type: array
- owners_group_ids:
- description: Owner Teams associated with this functionality
+ functionality_ids:
+ description: Array of functionality UUIDs
items:
type: string
- nullable: true
type: array
- owners_user_ids:
- description: Owner Users associated with this functionality
+ environment_ids:
items:
- type: integer
- nullable: true
+ type: string
type: array
- slack_channels:
- description: Slack Channels associated with this functionality
+ group_ids:
+ description: Array of group/team UUIDs
items:
- $ref: '#/components/schemas/new_environment_data_attributes_slack_channels_inner'
- nullable: true
+ type: string
type: array
- slack_aliases:
- description: Slack Aliases associated with this functionality
- items:
- $ref: '#/components/schemas/new_environment_data_attributes_slack_aliases_inner'
+ private:
+ type: boolean
+ custom_fields_mapping:
+ description: "Custom field mappings. Can contain liquid markup and need\
+ \ to be valid JSON. Use 'services', 'functionalities', or 'groups' keys\
+ \ with arrays of names/slugs for name/slug lookup"
nullable: true
- type: array
- created_at:
- description: Date of creation
- type: string
- updated_at:
- description: Date of last update
type: string
required:
- - created_at
- - name
- - updated_at
- type: object
- incidents_chart_response:
- required:
- - data
- type: object
- uptime_chart_response:
- required:
- - data
+ - title
type: object
- functionality_response:
+ create_sub_incident_task_params:
properties:
- data:
- $ref: '#/components/schemas/functionality_response_data'
+ task_type:
+ enum:
+ - create_sub_incident
+ type: string
+ title:
+ description: The sub incident title
+ type: string
+ summary:
+ description: The sub incident summary
+ type: string
required:
- - data
+ - title
type: object
- functionality_list:
+ create_incident_postmortem_task_params:
properties:
- data:
- items:
- $ref: '#/components/schemas/functionality_response_data'
- type: array
- links:
- allOf:
- - $ref: '#/components/schemas/links'
- type: object
+ task_type:
+ enum:
+ - create_incident_postmortem
+ type: string
+ incident_id:
+ description: UUID of the incident that needs a retrospective
+ type: string
+ title:
+ description: The retrospective title
+ type: string
+ status:
+ nullable: true
+ type: string
+ template:
+ $ref: '#/components/schemas/create_incident_postmortem_task_params_template'
required:
- - data
- - links
+ - incident_id
+ - title
type: object
- add_action_item_task_params:
+ create_jira_issue_task_params:
properties:
task_type:
enum:
- - add_action_item
- type: string
- attribute_to_query_by:
- description: Attribute of the Incident to match against
- enum:
- - jira_issue_id
- nullable: true
+ - create_jira_issue
type: string
- query_value:
- description: Value that attribute_to_query_by to uses to match against
- nullable: true
+ integration:
+ $ref: '#/components/schemas/create_jira_issue_task_params_integration'
+ title:
+ description: The issue title
type: string
- incident_role_id:
- description: The role id this action item is associated with
+ description:
+ description: The issue description
type: string
- assigned_to_user_id:
- description: "[DEPRECATED] Use assigned_to_user attribute instead. The user\
- \ id this action item is assigned to"
+ labels:
+ description: The issue labels
type: string
- assigned_to_user:
- $ref: '#/components/schemas/add_action_item_task_params_assigned_to_user'
- priority:
- description: The action item priority
- enum:
- - high
- - medium
- - low
+ assign_user_email:
+ description: The assigned user's email
type: string
- kind:
- description: The action item kind
+ reporter_user_email:
+ description: The reporter user's email
type: string
- summary:
- description: The action item summary
+ project_key:
+ description: The project key
type: string
- description:
- description: The action item description
+ due_date:
+ description: The due date
type: string
+ issue_type:
+ $ref: '#/components/schemas/create_jira_issue_task_params_issue_type'
+ priority:
+ $ref: '#/components/schemas/create_jira_issue_task_params_priority'
status:
- description: The action item status
- enum:
- - open
- - in_progress
- - cancelled
- - done
- type: string
- post_to_incident_timeline:
- type: boolean
+ $ref: '#/components/schemas/create_jira_issue_task_params_status'
custom_fields_mapping:
description: Custom field mappings. Can contain liquid markup and need to
be valid JSON
nullable: true
type: string
- post_to_slack_channels:
- items:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- type: array
+ update_payload:
+ description: Update payload. Can contain liquid markup and need to be valid
+ JSON
+ nullable: true
+ type: string
required:
- - priority
- - status
- - summary
+ - issue_type
+ - project_key
+ - title
type: object
- update_action_item_task_params:
+ create_jira_subtask_task_params:
properties:
task_type:
enum:
- - update_action_item
- type: string
- query_value:
- description: Value that attribute_to_query_by to uses to match against
+ - create_jira_subtask
type: string
- attribute_to_query_by:
- default: id
- description: Attribute of the action item to match against
- enum:
- - id
- - jira_issue_id
- - asana_task_id
- - shortcut_task_id
- - linear_issue_id
- - zendesk_ticket_id
- - motion_task_id
- - trello_card_id
- - airtable_record_id
- - shortcut_story_id
- - github_issue_id
- - gitlab_issue_id
- - freshservice_ticket_id
- - freshservice_task_id
- - clickup_task_id
+ integration:
+ $ref: '#/components/schemas/create_jira_issue_task_params_integration'
+ project_key:
+ description: The project key
type: string
- summary:
- description: Brief description of the action item
+ parent_issue_id:
+ description: The parent issue
type: string
- assigned_to_user_id:
- description: "[DEPRECATED] Use assigned_to_user attribute instead. The user\
- \ id this action item is assigned to"
+ title:
+ description: The issue title
type: string
- assigned_to_user:
- $ref: '#/components/schemas/add_action_item_task_params_assigned_to_user'
- group_ids:
- items:
- type: string
- nullable: true
- type: array
description:
- description: The action item description
+ description: The issue description
+ type: string
+ subtask_issue_type:
+ $ref: '#/components/schemas/create_jira_issue_task_params_issue_type'
+ labels:
+ description: The issue labels
+ type: string
+ due_date:
+ description: The due date
type: string
- priority:
- description: The action item priority
- enum:
- - high
- - medium
- - low
+ assign_user_email:
+ description: The assigned user's email
type: string
- status:
- description: The action item status
- enum:
- - open
- - in_progress
- - cancelled
- - done
+ reporter_user_email:
+ description: The reporter user's email
type: string
+ priority:
+ $ref: '#/components/schemas/create_jira_issue_task_params_priority'
+ status:
+ $ref: '#/components/schemas/create_jira_issue_task_params_status'
custom_fields_mapping:
description: Custom field mappings. Can contain liquid markup and need to
be valid JSON
nullable: true
type: string
- post_to_incident_timeline:
- type: boolean
+ update_payload:
+ description: Update payload. Can contain liquid markup and need to be valid
+ JSON
+ nullable: true
+ type: string
required:
- - attribute_to_query_by
- - query_value
+ - parent_issue_id
+ - project_key
+ - subtask_issue_type
+ - title
type: object
- add_role_task_params:
+ create_linear_issue_task_params:
properties:
task_type:
enum:
- - add_role
+ - create_linear_issue
type: string
- incident_role_id:
- description: The role id to add to the incident
+ title:
+ description: The issue title
type: string
- assigned_to_user_id:
- description: "[DEPRECATED] Use assigned_to_user attribute instead. The user\
- \ id this role is assigned to"
+ description:
+ description: The issue description
+ type: string
+ team:
+ $ref: '#/components/schemas/create_linear_issue_task_params_team'
+ state:
+ $ref: '#/components/schemas/create_linear_issue_task_params_state'
+ project:
+ $ref: '#/components/schemas/create_linear_issue_task_params_project'
+ labels:
+ items:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ type: array
+ priority:
+ $ref: '#/components/schemas/create_jira_issue_task_params_priority'
+ assign_user_email:
+ description: The assigned user's email
type: string
- assigned_to_user:
- $ref: '#/components/schemas/add_role_task_params_assigned_to_user'
required:
- - incident_role_id
+ - state
+ - team
+ - title
type: object
- add_slack_bookmark_task_params:
- anyOf: []
- nullable: true
+ create_linear_subtask_issue_task_params:
properties:
task_type:
enum:
- - add_slack_bookmark
+ - create_linear_subtask_issue
type: string
- playbook_id:
- description: The playbook id if bookmark is of an incident playbook
+ parent_issue_id:
+ description: The parent issue
type: string
- channel:
- properties:
- id:
- type: string
- name:
- type: string
- type: object
title:
- description: The bookmark title. Required if not a playbook bookmark
- nullable: true
+ description: The issue title
type: string
- link:
- description: The bookmark link. Required if not a playbook bookmark
- nullable: true
+ description:
+ description: The issue description
type: string
- emoji:
- description: The bookmark emoji
+ state:
+ $ref: '#/components/schemas/create_linear_issue_task_params_state'
+ priority:
+ $ref: '#/components/schemas/create_jira_issue_task_params_priority'
+ labels:
+ items:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ type: array
+ assign_user_email:
+ description: The assigned user's email
type: string
required:
- - channel
+ - parent_issue_id
+ - state
+ - title
type: object
- add_team_task_params:
+ create_linear_issue_comment_task_params:
properties:
task_type:
enum:
- - add_team
+ - create_linear_issue_comment
type: string
- group_id:
- description: The team id
+ issue_id:
+ description: The issue id
+ type: string
+ body:
+ description: The issue description
type: string
required:
- - group_id
+ - body
+ - issue_id
type: object
- add_to_timeline_task_params:
+ create_microsoft_teams_meeting_task_params:
properties:
task_type:
enum:
- - add_to_timeline
- type: string
- event:
- description: The timeline event description
+ - create_microsoft_teams_meeting
type: string
- url:
- description: A URL for the timeline event
+ name:
+ description: The meeting name
type: string
- post_to_slack_channels:
- items:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- type: array
- required:
- - event
- type: object
- archive_slack_channels_task_params:
- properties:
- task_type:
- enum:
- - archive_slack_channels
+ subject:
+ description: The meeting subject
type: string
- channels:
- items:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- type: array
- required:
- - channels
- type: object
- attach_datadog_dashboards_task_params:
- properties:
- task_type:
+ record_meeting:
+ description: Rootly AI will record the meeting and automatically generate
+ a transcript and summary from your meeting
+ type: boolean
+ recording_mode:
+ description: "The video layout for the bot's recording (e.g. speaker_view,\
+ \ gallery_view, gallery_view_v2, audio_only)"
enum:
- - attach_datadog_dashboards
+ - speaker_view
+ - gallery_view
+ - gallery_view_v2
+ - audio_only
+ nullable: true
type: string
- dashboards:
- items:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- type: array
post_to_incident_timeline:
type: boolean
post_to_slack_channels:
@@ -41809,646 +30703,560 @@ components:
$ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
type: array
required:
- - dashboards
+ - name
+ - subject
type: object
- auto_assign_role_opsgenie_task_params:
+ create_microsoft_teams_channel_task_params:
properties:
task_type:
enum:
- - auto_assign_role_opsgenie
- type: string
- incident_role_id:
- description: The role id
+ - create_microsoft_teams_channel
type: string
- schedule:
+ team:
$ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ title:
+ description: Microsoft Team channel title
+ type: string
+ description:
+ description: Microsoft Team channel description
+ type: string
+ private:
+ default: auto
+ enum:
+ - auto
+ - "true"
+ - "false"
+ type: string
required:
- - incident_role_id
- - schedule
+ - title
+ - workspace
type: object
- auto_assign_role_rootly_task_params:
+ create_microsoft_teams_chat_task_params:
properties:
task_type:
enum:
- - auto_assign_role_rootly
+ - create_microsoft_teams_chat
type: string
- incident_role_id:
- description: The role id
+ topic:
+ description: Chat topic (only for group chats)
+ nullable: true
type: string
- escalation_policy_target:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- service_target:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- user_target:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- group_target:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- schedule_target:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ chat_type:
+ default: group
+ description: Type of chat to create
+ enum:
+ - group
+ - oneOnOne
+ type: string
+ members:
+ description: Array of members to include in the chat
+ items:
+ $ref: '#/components/schemas/create_microsoft_teams_chat_task_params_members_inner'
+ type: array
required:
- - incident_role_id
+ - members
type: object
- auto_assign_role_pagerduty_task_params:
+ add_microsoft_teams_tab_task_params:
anyOf: []
nullable: true
properties:
task_type:
enum:
- - auto_assign_role_pagerduty
+ - add_microsoft_teams_tab
type: string
- incident_role_id:
- description: The role id
+ playbook_id:
+ description: The playbook id if tab is of an incident playbook
type: string
- service:
- properties:
- id:
- type: string
- name:
- type: string
- type: object
- schedule:
+ team:
properties:
id:
type: string
name:
type: string
type: object
- escalation_policy:
+ channel:
properties:
id:
type: string
name:
type: string
type: object
- required:
- - incident_role_id
- type: object
- update_pagerduty_incident_task_params:
- properties:
- task_type:
- enum:
- - update_pagerduty_incident
- type: string
- pagerduty_incident_id:
- description: Pagerduty incident id
- type: string
title:
- description: Title to update to
- type: string
- status:
- enum:
- - resolved
- - acknowledged
- - auto
- type: string
- resolution:
- description: A message outlining the incident's resolution in PagerDuty
- type: string
- escalation_level:
- description: Escalation level of policy attached to incident
- example: 1
- maximum: 20
- minimum: 1
- type: integer
- urgency:
- description: "PagerDuty incident urgency, selecting auto will let Rootly\
- \ auto map our incident severity"
- enum:
- - high
- - low
- - auto
+ description: The tab title. Required if not a playbook tab
+ nullable: true
type: string
- priority:
- description: "PagerDuty incident priority, selecting auto will let Rootly\
- \ auto map our incident severity"
+ link:
+ description: The tab link. Required if not a playbook tab
+ nullable: true
type: string
required:
- - pagerduty_incident_id
+ - channel
+ - team
type: object
- create_pagerduty_status_update_task_params:
+ add_microsoft_teams_chat_tab_task_params:
properties:
task_type:
enum:
- - create_pagerduty_status_update
+ - add_microsoft_teams_chat_tab
type: string
- pagerduty_incident_id:
- description: PagerDuty incident id
+ chat:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ title:
+ description: The tab title
type: string
- message:
- description: A message outlining the incident's resolution in PagerDuty
+ link:
+ description: The tab link
type: string
required:
- - message
- - pagerduty_incident_id
+ - chat
+ - link
+ - title
type: object
- create_pagertree_alert_task_params:
+ archive_microsoft_teams_channels_task_params:
properties:
task_type:
enum:
- - create_pagertree_alert
- type: string
- title:
- description: Title of alert as text
- type: string
- description:
- description: Description of alert as text
- type: string
- urgency:
- enum:
- - auto
- - critical
- - high
- - medium
- - low
- type: string
- severity:
- enum:
- - auto
- - SEV-1
- - SEV-2
- - SEV-3
- - SEV-4
+ - archive_microsoft_teams_channels
type: string
- teams:
- items:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- type: array
- users:
+ team:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ channels:
items:
$ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
type: array
- incident:
- description: Setting to true makes an alert a Pagertree incident
- type: boolean
+ required:
+ - channels
+ - team
type: object
- update_pagertree_alert_task_params:
+ rename_microsoft_teams_channel_task_params:
properties:
task_type:
enum:
- - update_pagertree_alert
- type: string
- pagertree_alert_id:
- description: The prefix ID of the Pagertree alert
+ - rename_microsoft_teams_channel
type: string
+ team:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ channel:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
title:
- description: Title of alert as text
- type: string
- description:
- description: Description of alert as text
- type: string
- urgency:
- enum:
- - auto
- - critical
- - high
- - medium
- - low
- type: string
- severity:
- enum:
- - auto
- - SEV-1
- - SEV-2
- - SEV-3
- - SEV-4
type: string
- teams:
- items:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- type: array
- users:
- items:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- type: array
- incident:
- description: Setting to true makes an alert a Pagertree incident
- type: boolean
+ required:
+ - channel
+ - team
+ - title
type: object
- auto_assign_role_victor_ops_task_params:
+ invite_to_microsoft_teams_channel_task_params:
properties:
task_type:
enum:
- - auto_assign_role_victor_ops
- type: string
- incident_role_id:
- description: The role id
+ - invite_to_microsoft_teams_channel
type: string
team:
$ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ channel:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ emails:
+ description: Comma separated list of emails to invite
+ type: string
required:
- - incident_role_id
- - team
+ - channel
+ - emails
type: object
- call_people_task_params:
+ create_notion_page_task_params:
properties:
task_type:
enum:
- - call_people
+ - create_notion_page
type: string
- phone_numbers:
- items:
- description: A recipient phone number
- example: "[\"14150001111\"]"
- type: string
- type: array
- name:
- description: The name
+ title:
+ description: The Notion page title
+ type: string
+ parent_page:
+ $ref: '#/components/schemas/create_notion_page_task_params_parent_page'
+ post_mortem_template_id:
+ description: "Retrospective template to use when creating page task, if\
+ \ desired"
type: string
content:
- description: The message to be read by text-to-voice
+ description: "Custom page content with liquid templating support. When provided,\
+ \ only this content will be rendered (no default sections)"
type: string
+ mark_post_mortem_as_published:
+ default: true
+ type: boolean
+ show_timeline_as_table:
+ type: boolean
+ show_action_items_as_table:
+ type: boolean
required:
- - content
- - name
- - phone_numbers
+ - parent_page
+ - title
type: object
- create_airtable_table_record_task_params:
+ send_microsoft_teams_message_task_params:
+ anyOf: []
+ nullable: true
properties:
task_type:
enum:
- - create_airtable_table_record
+ - send_microsoft_teams_message
type: string
- base:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- table:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- custom_fields_mapping:
- description: Custom field mappings. Can contain liquid markup and need to
- be valid JSON
- nullable: true
+ channels:
+ items:
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ type: object
+ type: array
+ text:
+ description: The message text
type: string
required:
- - base
- - table
+ - text
type: object
- create_asana_subtask_task_params:
+ send_microsoft_teams_chat_message_task_params:
properties:
task_type:
enum:
- - create_asana_subtask
- type: string
- parent_task_id:
- description: The parent task id
- type: string
- title:
- description: The subtask title
- type: string
- notes:
- type: string
- assign_user_email:
- description: The assigned user's email
- type: string
- completion:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- due_date:
- description: The due date
+ - send_microsoft_teams_chat_message
type: string
- custom_fields_mapping:
- description: Custom field mappings. Can contain liquid markup and need to
- be valid JSON
- nullable: true
+ chats:
+ items:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ type: array
+ text:
+ description: The message text
type: string
- dependency_direction:
- default: blocking
+ required:
+ - chats
+ - text
+ type: object
+ send_microsoft_teams_blocks_task_params:
+ anyOf: []
+ nullable: true
+ properties:
+ task_type:
enum:
- - blocking
- - blocked_by
+ - send_microsoft_teams_blocks
+ type: string
+ attachments:
+ description: Support liquid markup. Needs to be a valid JSON string after
+ liquid is parsed
type: string
- dependent_task_ids:
- description: Dependent task ids. Supports liquid syntax
- items:
- type: string
- nullable: true
- type: array
required:
- - completion
- - parent_task_id
- - title
+ - attachments
type: object
- create_asana_task_task_params:
+ update_notion_page_task_params:
properties:
task_type:
enum:
- - create_asana_task
+ - update_notion_page
+ type: string
+ file_id:
+ description: The Notion page ID
type: string
- workspace:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- projects:
- items:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- type: array
title:
- description: The task title
+ description: The Notion page title
type: string
- notes:
+ post_mortem_template_id:
+ description: "Retrospective template to use when creating page task, if\
+ \ desired"
type: string
- assign_user_email:
- description: The assigned user's email
+ content:
+ description: "Custom page content with liquid templating support. When provided,\
+ \ only this content will be rendered (no default sections)"
type: string
- completion:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- due_date:
- description: The due date
+ show_timeline_as_table:
+ type: boolean
+ show_action_items_as_table:
+ type: boolean
+ required:
+ - file_id
+ type: object
+ update_quip_page_task_params:
+ properties:
+ task_type:
+ enum:
+ - update_quip_page
type: string
- custom_fields_mapping:
- description: Custom field mappings. Can contain liquid markup and need to
- be valid JSON
- nullable: true
+ file_id:
+ description: The Quip page ID
type: string
- dependency_direction:
- default: blocking
- enum:
- - blocking
- - blocked_by
+ title:
+ description: The Quip page title
+ type: string
+ content:
+ description: The Quip page content
+ type: string
+ post_mortem_template_id:
+ description: "Retrospective template to use when updating page, if desired"
+ type: string
+ template_id:
+ description: The Quip file ID to use as a template
type: string
- dependent_task_ids:
- description: Dependent task ids. Supports liquid syntax
- items:
- type: string
- nullable: true
- type: array
required:
- - completion
- - projects
- - title
- - workspace
+ - file_id
type: object
- create_confluence_page_task_params:
+ update_confluence_page_task_params:
properties:
task_type:
enum:
- - create_confluence_page
+ - update_confluence_page
type: string
integration:
$ref: '#/components/schemas/create_confluence_page_task_params_integration'
- space:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- ancestor:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- template:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ file_id:
+ description: The Confluence page ID
+ type: string
title:
- description: The page title
+ description: The Confluence page title
type: string
content:
- description: The page content
+ description: The Confluence page content
type: string
post_mortem_template_id:
- description: The Retrospective template to use
+ description: "Retrospective template to use when updating page, if desired"
type: string
- mark_post_mortem_as_published:
- default: true
- type: boolean
+ template:
+ $ref: '#/components/schemas/update_confluence_page_task_params_template'
required:
- - space
- - title
+ - file_id
type: object
- create_datadog_notebook_task_params:
+ update_sharepoint_page_task_params:
properties:
task_type:
enum:
- - create_datadog_notebook
+ - update_sharepoint_page
type: string
- post_mortem_template_id:
- description: "Retrospective template to use when creating notebook, if desired"
+ file_id:
+ description: The SharePoint file ID
type: string
- mark_post_mortem_as_published:
- default: true
- type: boolean
- template:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
title:
- description: The notebook title
- type: string
- kind:
- description: The notebook kind
- enum:
- - postmortem
- - runbook
- - investigation
- - documentation
- - report
+ description: The SharePoint document title
type: string
content:
- description: The notebook content
+ description: The SharePoint document content
+ type: string
+ post_mortem_template_id:
+ description: "Retrospective template to use when updating document, if desired"
type: string
required:
- - kind
- - title
+ - file_id
type: object
- create_coda_page_task_params:
+ update_dropbox_paper_page_task_params:
properties:
task_type:
enum:
- - create_coda_page
+ - update_dropbox_paper_page
type: string
- post_mortem_template_id:
- description: "Retrospective template to use when creating page, if desired"
+ file_id:
+ description: The Dropbox Paper document ID
type: string
- mark_post_mortem_as_published:
- default: true
- type: boolean
title:
- description: The Coda page title
- type: string
- subtitle:
- description: The Coda page subtitle
+ description: The Dropbox Paper document title
type: string
content:
- description: The Coda page content
+ description: The Dropbox Paper document content
type: string
- template:
- $ref: '#/components/schemas/create_coda_page_task_params_template'
- folder_id:
- description: The Coda folder id
+ post_mortem_template_id:
+ description: "Retrospective template to use when updating document, if desired"
type: string
required:
- - title
+ - file_id
type: object
- create_dropbox_paper_page_task_params:
+ update_datadog_notebook_task_params:
properties:
task_type:
enum:
- - create_dropbox_paper_page
+ - update_datadog_notebook
type: string
- post_mortem_template_id:
- description: "Retrospective template to use when creating page task, if\
- \ desired"
+ file_id:
+ description: The Datadog notebook ID
type: string
- mark_post_mortem_as_published:
- default: true
- type: boolean
title:
- description: The page task title
+ description: The Datadog notebook title
type: string
content:
- description: The page content
+ description: The Datadog notebook content
type: string
- namespace:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- parent_folder:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ kind:
+ description: The notebook type
+ enum:
+ - postmortem
+ - runbook
+ - investigation
+ - documentation
+ - report
+ type: string
+ post_mortem_template_id:
+ description: "Retrospective template to use when updating notebook, if desired"
+ type: string
+ template:
+ $ref: '#/components/schemas/update_datadog_notebook_task_params_template'
required:
- - title
+ - file_id
type: object
- create_github_issue_task_params:
+ create_service_now_incident_task_params:
properties:
task_type:
enum:
- - create_github_issue
+ - create_service_now_incident
type: string
title:
- description: The issue title
+ description: The incident title
type: string
- body:
- description: The issue body
+ description:
+ description: The incident description
+ type: string
+ priority:
+ $ref: '#/components/schemas/create_jira_issue_task_params_priority'
+ completion:
+ $ref: '#/components/schemas/create_service_now_incident_task_params_completion'
+ custom_fields_mapping:
+ description: Custom field mappings. Can contain liquid markup and need to
+ be valid JSON
+ nullable: true
type: string
- repository:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
required:
- - repository
- title
type: object
- create_gitlab_issue_task_params:
+ create_shortcut_story_task_params:
+ anyOf: []
+ nullable: true
properties:
task_type:
enum:
- - create_gitlab_issue
- type: string
- issue_type:
- description: The issue type
- enum:
- - issue
- - incident
- - test_case
- - task
+ - create_shortcut_story
type: string
title:
- description: The issue title
+ description: The incident title
+ type: string
+ kind:
+ enum:
+ - bug
+ - chore
+ - feature
type: string
description:
- description: The issue description
+ description: The incident description
type: string
- repository:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
labels:
- description: The issue labels
+ description: The story labels
type: string
due_date:
description: The due date
type: string
+ archivation:
+ description: The archivation id and display name
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ type: object
+ group:
+ description: The group id and display name
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ type: object
+ project:
+ description: The project id and display name
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ type: object
+ workflow_state:
+ description: The workflow state id workflow state name
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ type: object
required:
- - repository
+ - archivation
+ - kind
- title
type: object
- create_outlook_event_task_params:
+ create_shortcut_task_task_params:
properties:
task_type:
enum:
- - create_outlook_event
+ - create_shortcut_task
type: string
- calendar:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- attendees:
- description: Emails of attendees
- items:
- type: string
- type: array
- time_zone:
- description: A valid IANA time zone name.
- nullable: true
+ parent_story_id:
+ description: The parent story
type: string
- days_until_meeting:
- description: The days until meeting
- maximum: 31
- minimum: 0
- type: integer
- time_of_meeting:
- description: Time of meeting in format HH:MM
- example: 14:30
+ description:
+ description: The task description
type: string
- meeting_duration:
- description: "Meeting duration in format like '1 hour', '30 minutes'"
- example: 1 hour
+ completion:
+ $ref: '#/components/schemas/create_service_now_incident_task_params_completion'
+ required:
+ - completion
+ - description
+ - parent_story_id
+ type: object
+ create_trello_card_task_params:
+ properties:
+ task_type:
+ enum:
+ - create_trello_card
type: string
- summary:
- description: The event summary
+ title:
+ description: The card title
type: string
description:
- description: The event description
+ description: The card description
type: string
- exclude_weekends:
- type: boolean
- post_to_incident_timeline:
- type: boolean
- post_to_slack_channels:
+ due_date:
+ description: The due date
+ type: string
+ board:
+ $ref: '#/components/schemas/create_trello_card_task_params_board'
+ list:
+ $ref: '#/components/schemas/create_trello_card_task_params_list'
+ labels:
items:
$ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
type: array
+ archivation:
+ $ref: '#/components/schemas/create_trello_card_task_params_archivation'
required:
- - calendar
- - days_until_meeting
- - description
- - meeting_duration
- - summary
- - time_of_meeting
+ - board
+ - list
+ - title
type: object
- create_google_calendar_event_task_params:
+ create_webex_meeting_task_params:
properties:
task_type:
enum:
- - create_google_calendar_event
- type: string
- attendees:
- description: Emails of attendees
- items:
- type: string
- type: array
- time_zone:
- description: A valid IANA time zone name.
- nullable: true
- type: string
- calendar_id:
- default: primary
- nullable: true
- type: string
- days_until_meeting:
- description: The days until meeting
- maximum: 31
- minimum: 0
- type: integer
- time_of_meeting:
- description: Time of meeting in format HH:MM
- example: 14:30
- type: string
- meeting_duration:
- description: "Meeting duration in format like '1 hour', '30 minutes'"
- example: 1 hour
+ - create_webex_meeting
type: string
- send_updates:
- description: Send an email to the attendees notifying them of the event
- type: boolean
- can_guests_modify_event:
- type: boolean
- can_guests_see_other_guests:
- type: boolean
- can_guests_invite_others:
- type: boolean
- summary:
- description: The event summary
+ topic:
+ description: The meeting topic
type: string
- description:
- description: The event description
+ password:
+ description: The meeting password
type: string
- exclude_weekends:
+ record_meeting:
+ description: Rootly AI will record the meeting and automatically generate
+ a transcript and summary from your meeting
type: boolean
- conference_solution_key:
- description: Sets the video conference type attached to the meeting
+ recording_mode:
+ description: "The video layout for the bot's recording (e.g. speaker_view,\
+ \ gallery_view, gallery_view_v2, audio_only)"
enum:
- - eventHangout
- - eventNamedHangout
- - hangoutsMeet
- - addOn
+ - speaker_view
+ - gallery_view
+ - gallery_view_v2
+ - audio_only
nullable: true
type: string
post_to_incident_timeline:
@@ -42458,289 +31266,308 @@ components:
$ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
type: array
required:
- - days_until_meeting
- - description
- - meeting_duration
- - summary
- - time_of_meeting
+ - topic
type: object
- update_google_docs_page_task_params:
+ create_zendesk_ticket_task_params:
properties:
task_type:
enum:
- - update_google_docs_page
- type: string
- file_id:
- description: The Google Doc file ID
- type: string
- title:
- description: The Google Doc title
- type: string
- content:
- description: The Google Doc content
- type: string
- post_mortem_template_id:
- description: "Retrospective template to use when updating page, if desired"
- type: string
- template_id:
- description: The Google Doc file ID to use as a template.
+ - create_zendesk_ticket
type: string
- required:
- - file_id
- type: object
- update_coda_page_task_params:
- properties:
- task_type:
+ kind:
enum:
- - update_coda_page
+ - problem
+ - incident
+ - question
+ - task
type: string
- doc_id:
- description: The Coda doc id
+ subject:
+ description: The ticket subject
type: string
- page_id:
- description: The Coda page id
+ comment:
+ description: The ticket comment
type: string
- title:
- description: The Coda page title
+ tags:
+ description: The ticket tags
type: string
- subtitle:
- description: The Coda page subtitle
+ priority:
+ $ref: '#/components/schemas/create_jira_issue_task_params_priority'
+ completion:
+ $ref: '#/components/schemas/create_service_now_incident_task_params_completion'
+ custom_fields_mapping:
+ description: Custom field mappings. Can contain liquid markup and need to
+ be valid JSON
+ nullable: true
type: string
- content:
- description: The Coda page content
+ ticket_payload:
+ description: Additional Zendesk ticket attributes. Will be merged into whatever
+ was specified in this tasks current parameters. Can contain liquid markup
+ and need to be valid JSON
+ nullable: true
type: string
- template:
- $ref: '#/components/schemas/create_coda_page_task_params_template'
required:
- - page_id
+ - kind
+ - subject
type: object
- update_google_calendar_event_task_params:
+ create_zendesk_jira_link_task_params:
properties:
task_type:
enum:
- - create_google_calendar_event
- type: string
- calendar_id:
- default: primary
- nullable: true
- type: string
- event_id:
- description: The event ID
- type: string
- summary:
- description: The event summary
- type: string
- description:
- description: The event description
- type: string
- adjustment_days:
- description: Days to adjust meeting by
- maximum: 31
- minimum: 0
- type: integer
- time_of_meeting:
- description: Time of meeting in format HH:MM
+ - create_zendesk_jira_link
type: string
- meeting_duration:
- description: "Meeting duration in format like '1 hour', '30 minutes'"
- example: 1 hour
+ jira_issue_id:
+ description: Jira Issue Id.
type: string
- send_updates:
- description: Send an email to the attendees notifying them of the event
- type: boolean
- can_guests_modify_event:
- type: boolean
- can_guests_see_other_guests:
- type: boolean
- can_guests_invite_others:
- type: boolean
- attendees:
- description: Emails of attendees
- items:
- type: string
- type: array
- replace_attendees:
- type: boolean
- conference_solution_key:
- description: Sets the video conference type attached to the meeting
- enum:
- - eventHangout
- - eventNamedHangout
- - hangoutsMeet
- - addOn
- nullable: true
+ jira_issue_key:
+ description: Jira Issue Key.
+ type: string
+ zendesk_ticket_id:
+ description: Zendesk Ticket Id.
type: string
- post_to_incident_timeline:
- type: boolean
- post_to_slack_channels:
- items:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- type: array
required:
- - event_id
+ - jira_issue_id
+ - jira_issue_key
+ - zendesk_ticket_id
type: object
- create_sharepoint_page_task_params:
+ create_clickup_task_task_params:
properties:
task_type:
enum:
- - create_sharepoint_page
- type: string
- post_mortem_template_id:
- description: "Retrospective template to use when creating page, if desired"
+ - create_clickup_task
type: string
- mark_post_mortem_as_published:
- default: true
- type: boolean
title:
- description: The page title
+ description: The task title
type: string
- site:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- drive:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- parent_folder:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- content:
- description: The page content
+ description:
+ description: The task description
type: string
- template_id:
- description: The SharePoint file ID to use as a template
+ tags:
+ description: The task tags
+ type: string
+ priority:
+ $ref: '#/components/schemas/create_jira_issue_task_params_priority'
+ due_date:
+ description: The due date
+ type: string
+ custom_fields_mapping:
+ description: Custom field mappings. Can contain liquid markup and need to
+ be valid JSON
+ nullable: true
+ type: string
+ task_payload:
+ description: Additional ClickUp task attributes. Will be merged into whatever
+ was specified in this tasks current parameters. Can contain liquid markup
+ and need to be valid JSON
+ nullable: true
type: string
required:
- - drive
- - site
- title
type: object
- create_google_docs_page_task_params:
+ create_motion_task_task_params:
properties:
task_type:
enum:
- - create_google_docs_page
- type: string
- post_mortem_template_id:
- description: "Retrospective template to use when creating page, if desired"
- type: string
- mark_post_mortem_as_published:
- default: true
- type: boolean
- title:
- description: The page title
+ - create_motion_task
type: string
- drive:
+ workspace:
$ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- parent_folder:
+ project:
$ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- content:
- description: The page content
+ status:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ title:
+ description: The task title
type: string
- template_id:
- description: The Google Doc file ID to use as a template
+ description:
+ description: The task description
type: string
- permissions:
- description: Page permissions JSON
+ labels:
+ items:
+ type: string
+ type: array
+ priority:
+ $ref: '#/components/schemas/create_jira_issue_task_params_priority'
+ duration:
+ description: "The duration. Eg. \"NONE\", \"REMINDER\", or a integer greater\
+ \ than 0."
+ type: string
+ due_date:
+ description: The due date
type: string
required:
- title
+ - workspace
type: object
- create_google_docs_permissions_task_params:
+ create_zoom_meeting_task_params:
properties:
task_type:
enum:
- - create_google_docs_permissions
+ - create_zoom_meeting
type: string
- file_id:
- description: The Google Doc file ID
+ topic:
+ description: The meeting topic
type: string
- permissions:
- description: Page permissions JSON
+ password:
+ description: The meeting password
type: string
- send_notification_email:
+ create_as_email:
+ description: The email to use if creating as email
+ type: string
+ alternative_hosts:
+ items:
+ description: Alternative host email
+ type: string
+ type: array
+ auto_recording:
+ default: none
+ enum:
+ - none
+ - local
+ - cloud
+ type: string
+ record_meeting:
+ description: Rootly AI will record the meeting and automatically generate
+ a transcript and summary from your meeting
type: boolean
- email_message:
- description: Email message notification
+ recording_mode:
+ description: "The video layout for the bot's recording (e.g. speaker_view,\
+ \ gallery_view, gallery_view_v2, audio_only)"
+ enum:
+ - speaker_view
+ - gallery_view
+ - gallery_view_v2
+ - audio_only
nullable: true
type: string
+ post_to_incident_timeline:
+ type: boolean
+ post_to_slack_channels:
+ items:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ type: array
required:
- - file_id
- - permissions
+ - topic
type: object
- remove_google_docs_permissions_task_params:
+ get_github_commits_task_params:
+ anyOf: []
+ nullable: true
properties:
task_type:
enum:
- - remove_google_docs_permissions
- type: string
- file_id:
- description: The Google Doc file ID
+ - get_github_commits
type: string
- attribute_to_query_by:
- default: email_address
- enum:
- - type
- - role
- - email_address
+ service_ids:
+ items:
+ description: ID of service impacted by incident
+ type: string
+ type: array
+ github_repository_names:
+ items:
+ type: string
+ type: array
+ branch:
+ description: The branch
type: string
- value:
+ past_duration:
+ description: "How far back to fetch commits (in format '1 minute', '30 days',\
+ \ '3 months', etc.)"
+ example: 1 hour
type: string
+ services_impacted_by_incident:
+ type: boolean
+ post_to_incident_timeline:
+ type: boolean
+ post_to_slack_channels:
+ items:
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ type: object
+ type: array
required:
- - attribute_to_query_by
- - file_id
- - value
+ - branch
+ - past_duration
type: object
- create_quip_page_task_params:
+ get_gitlab_commits_task_params:
+ anyOf: []
+ nullable: true
properties:
task_type:
enum:
- - create_google_docs_page
- type: string
- post_mortem_template_id:
- description: "Retrospective template to use when creating page, if desired"
- type: string
- title:
- description: The page title
- type: string
- parent_folder_id:
- description: The parent folder id
+ - get_gitlab_commits
type: string
- content:
- description: The page content
+ service_ids:
+ items:
+ description: ID of service impacted by incident
+ type: string
+ type: array
+ gitlab_repository_names:
+ items:
+ type: string
+ type: array
+ branch:
+ description: The branch
type: string
- template_id:
- description: The Quip file ID to use as a template
+ past_duration:
+ description: "How far back to fetch commits (in format '1 minute', '30 days',\
+ \ '3 months', etc.)"
+ example: 1 hour
type: string
- mark_post_mortem_as_published:
- default: true
+ services_impacted_by_incident:
+ type: boolean
+ post_to_incident_timeline:
type: boolean
+ post_to_slack_channels:
+ items:
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ type: object
+ type: array
required:
- - title
+ - branch
+ - past_duration
type: object
- create_google_meeting_task_params:
+ get_pulses_task_params:
properties:
task_type:
enum:
- - create_google_meeting
- type: string
- summary:
- description: "[DEPRECATED] The meeting summary"
- nullable: true
- type: string
- description:
- description: "[DEPRECATED] The meeting description"
- nullable: true
+ - get_pulses
type: string
- conference_solution_key:
- description: "[DEPRECATED] Sets the video conference type attached to the\
- \ meeting"
- enum:
- - eventHangout
- - eventNamedHangout
- - hangoutsMeet
- - addOn
- nullable: true
+ service_ids:
+ items:
+ description: ID of service impacted by incident
+ type: string
+ type: array
+ environment_ids:
+ items:
+ description: ID of environment impacted by incident
+ type: string
+ type: array
+ labels:
+ items:
+ type: string
+ type: array
+ refs:
+ items:
+ type: string
+ type: array
+ sources:
+ items:
+ type: string
+ type: array
+ past_duration:
+ description: "How far back to fetch commits (in format '1 minute', '30 days',\
+ \ '3 months', etc.)"
+ example: 1 hour
type: string
- record_meeting:
- description: Rootly AI will record the meeting and automatically generate
- a transcript and summary from your meeting
+ services_impacted_by_incident:
+ type: boolean
+ environments_impacted_by_incident:
type: boolean
post_to_incident_timeline:
type: boolean
@@ -42748,31 +31575,43 @@ components:
items:
$ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
type: array
+ parent_message_thread_task:
+ $ref: '#/components/schemas/get_pulses_task_params_parent_message_thread_task'
required:
- - description
- - summary
+ - past_duration
type: object
- create_go_to_meeting_task_params:
+ get_alerts_task_params:
properties:
task_type:
enum:
- - create_go_to_meeting_task
- type: string
- subject:
- description: The meeting subject
+ - get_alerts
type: string
- conference_call_info:
- default: voip
- enum:
- - ptsn
- - free
- - hyrid
- - voip
- example: voip
- nullable: true
+ service_ids:
+ items:
+ description: ID of service impacted by incident
+ type: string
+ type: array
+ environment_ids:
+ items:
+ description: ID of environment impacted by incident
+ type: string
+ type: array
+ labels:
+ items:
+ type: string
+ type: array
+ sources:
+ items:
+ type: string
+ type: array
+ past_duration:
+ description: "How far back to fetch commits (in format '1 minute', '30 days',\
+ \ '3 months', etc.)"
+ example: 1 hour
type: string
- password_required:
- nullable: true
+ services_impacted_by_incident:
+ type: boolean
+ environments_impacted_by_incident:
type: boolean
post_to_incident_timeline:
type: boolean
@@ -42780,430 +31619,518 @@ components:
items:
$ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
type: array
+ parent_message_thread_task:
+ $ref: '#/components/schemas/get_pulses_task_params_parent_message_thread_task'
required:
- - subject
+ - past_duration
type: object
- create_incident_task_params:
+ http_client_task_params:
properties:
task_type:
enum:
- - create_incident
+ - http_client
type: string
- title:
- description: The incident title
+ headers:
+ description: JSON map of HTTP headers
type: string
- summary:
- description: The incident summary
+ params:
+ description: JSON map of HTTP query parameters
type: string
- severity_id:
+ body:
+ description: HTTP body
type: string
- incident_type_ids:
+ url:
+ description: URL endpoint
+ example: https://example.com/foo.json
+ type: string
+ event_url:
+ type: string
+ event_message:
+ type: string
+ method:
+ default: GET
+ description: HTTP method
+ enum:
+ - GET
+ - POST
+ - PATCH
+ - PUT
+ - DELETE
+ - OPTIONS
+ type: string
+ succeed_on_status:
+ description: "HTTP status code expected. Can be a regular expression. Eg:\
+ \ 200, 200|203, 20[0-3]"
+ example: "200"
+ type: string
+ post_to_incident_timeline:
+ type: boolean
+ post_to_slack_channels:
items:
- type: string
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
type: array
- service_ids:
+ required:
+ - succeed_on_status
+ - url
+ type: object
+ invite_to_slack_channel_opsgenie_task_params:
+ properties:
+ task_type:
+ enum:
+ - invite_to_slack_channel_opsgenie
+ type: string
+ channels:
items:
- type: string
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
type: array
- functionality_ids:
+ schedule:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ required:
+ - channels
+ - schedule
+ type: object
+ invite_to_slack_channel_rootly_task_params:
+ properties:
+ task_type:
+ enum:
+ - invite_to_slack_channel_rootly
+ type: string
+ channels:
items:
- type: string
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
type: array
- environment_ids:
+ escalation_policy_target:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ service_target:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ user_target:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ group_target:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ schedule_target:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ required:
+ - channels
+ type: object
+ invite_to_slack_channel_pagerduty_task_params:
+ anyOf: []
+ nullable: true
+ properties:
+ task_type:
+ enum:
+ - invite_to_slack_channel_pagerduty
+ type: string
+ channels:
items:
- type: string
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ type: object
type: array
- group_ids:
+ escalation_policy:
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ type: object
+ schedule:
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ type: object
+ service:
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ type: object
+ required:
+ - channels
+ type: object
+ invite_to_slack_channel_task_params:
+ anyOf: []
+ nullable: true
+ properties:
+ task_type:
+ enum:
+ - invite_to_slack_channel
+ type: string
+ channel:
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ type: object
+ slack_users:
items:
- type: string
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ type: object
type: array
- private:
- type: boolean
- custom_fields_mapping:
- description: Custom field mappings. Can contain liquid markup and need to
- be valid JSON
- nullable: true
+ slack_user_groups:
+ items:
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ type: object
+ type: array
+ slack_emails:
+ description: Comma separated list of emails to invite to the channel
type: string
required:
- - title
+ - channel
type: object
- create_incident_postmortem_task_params:
+ invite_to_slack_channel_victor_ops_task_params:
properties:
task_type:
enum:
- - create_incident_postmortem
- type: string
- incident_id:
- description: UUID of the incident that needs a retrospective
- type: string
- title:
- description: The retrospective title
- type: string
- status:
- nullable: true
+ - invite_to_slack_channel_victor_ops
type: string
- template:
- $ref: '#/components/schemas/create_incident_postmortem_task_params_template'
+ channels:
+ items:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ type: array
+ team:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
required:
- - incident_id
- - title
+ - channels
+ - team
type: object
- create_jira_issue_task_params:
+ page_opsgenie_on_call_responders_task_params:
properties:
task_type:
enum:
- - create_jira_issue
+ - page_opsgenie_on_call_responders
type: string
- integration:
- $ref: '#/components/schemas/create_jira_issue_task_params_integration'
title:
- description: The issue title
- type: string
- description:
- description: The issue description
- type: string
- labels:
- description: The issue labels
- type: string
- assign_user_email:
- description: The assigned user's email
- type: string
- reporter_user_email:
- description: The reporter user's email
+ description: Incident title.
+ nullable: true
type: string
- project_key:
- description: The project key
+ message:
+ description: Message of the incident
type: string
- due_date:
- description: The due date
+ description:
+ description: Description field of the incident that is generally used to
+ provide a detailed information about the incident
type: string
- issue_type:
- $ref: '#/components/schemas/create_jira_issue_task_params_issue_type'
+ teams:
+ items:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ type: array
+ users:
+ items:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ type: array
priority:
- $ref: '#/components/schemas/create_jira_issue_task_params_priority'
- status:
- $ref: '#/components/schemas/create_jira_issue_task_params_status'
- custom_fields_mapping:
- description: Custom field mappings. Can contain liquid markup and need to
- be valid JSON
- nullable: true
- type: string
- update_payload:
- description: Update payload. Can contain liquid markup and need to be valid
- JSON
- nullable: true
+ default: P1
+ enum:
+ - P1
+ - P2
+ - P3
+ - P4
+ - P5
+ - auto
type: string
- required:
- - issue_type
- - project_key
- - title
type: object
- create_jira_subtask_task_params:
+ create_opsgenie_alert_task_params:
properties:
task_type:
enum:
- - create_jira_subtask
- type: string
- integration:
- $ref: '#/components/schemas/create_jira_issue_task_params_integration'
- project_key:
- description: The project key
- type: string
- parent_issue_id:
- description: The parent issue
+ - create_opsgenie_alert
type: string
- title:
- description: The issue title
+ message:
+ description: Message of the alert
type: string
description:
- description: The issue description
- type: string
- subtask_issue_type:
- $ref: '#/components/schemas/create_jira_issue_task_params_issue_type'
- labels:
- description: The issue labels
- type: string
- due_date:
- description: The due date
- type: string
- assign_user_email:
- description: The assigned user's email
- type: string
- reporter_user_email:
- description: The reporter user's email
+ description: Description field of the alert that is generally used to provide
+ a detailed information about the alert
type: string
+ teams:
+ items:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ type: array
+ users:
+ items:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ type: array
+ schedules:
+ items:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ type: array
+ escalations:
+ items:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ type: array
priority:
- $ref: '#/components/schemas/create_jira_issue_task_params_priority'
- status:
- $ref: '#/components/schemas/create_jira_issue_task_params_status'
- custom_fields_mapping:
- description: Custom field mappings. Can contain liquid markup and need to
- be valid JSON
- nullable: true
+ default: P1
+ enum:
+ - P1
+ - P2
+ - P3
+ - P4
+ - P5
+ - auto
type: string
- update_payload:
- description: Update payload. Can contain liquid markup and need to be valid
+ details:
+ description: Details payload. Can contain liquid markup and need to be valid
JSON
nullable: true
type: string
required:
- - parent_issue_id
- - project_key
- - subtask_issue_type
- - title
+ - message
type: object
- create_linear_issue_task_params:
+ create_jsmops_alert_task_params:
properties:
task_type:
enum:
- - create_linear_issue
+ - create_jsmops_alert
type: string
- title:
- description: The issue title
+ message:
+ description: Message of the alert
type: string
description:
- description: The issue description
+ description: Description field of the alert that is generally used to provide
+ a detailed information about the alert
+ nullable: true
type: string
- team:
- $ref: '#/components/schemas/create_linear_issue_task_params_team'
- state:
- $ref: '#/components/schemas/create_linear_issue_task_params_state'
- project:
- $ref: '#/components/schemas/create_linear_issue_task_params_project'
- labels:
+ teams:
+ items:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ type: array
+ users:
+ items:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ type: array
+ schedules:
+ items:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ type: array
+ escalations:
items:
$ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
type: array
priority:
- $ref: '#/components/schemas/create_jira_issue_task_params_priority'
- assign_user_email:
- description: The assigned user's email
+ default: P3
+ enum:
+ - P3
+ - P1
+ - P2
+ - P3
+ - P4
+ - P5
+ - auto
+ type: string
+ details:
+ description: Details payload. Can contain liquid markup and need to be valid
+ JSON
+ nullable: true
type: string
required:
- - state
- - team
- - title
+ - message
type: object
- create_linear_subtask_issue_task_params:
+ page_jsmops_on_call_responders_task_params:
properties:
task_type:
enum:
- - create_linear_subtask_issue
- type: string
- parent_issue_id:
- description: The parent issue
+ - page_jsmops_on_call_responders
type: string
title:
- description: The issue title
+ description: Incident title.
+ nullable: true
+ type: string
+ message:
+ description: Message of the incident
type: string
description:
- description: The issue description
+ description: Description field of the incident that is generally used to
+ provide a detailed information about the incident
type: string
- state:
- $ref: '#/components/schemas/create_linear_issue_task_params_state'
- priority:
- $ref: '#/components/schemas/create_jira_issue_task_params_priority'
- labels:
+ teams:
items:
$ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
type: array
- assign_user_email:
- description: The assigned user's email
+ users:
+ items:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ type: array
+ priority:
+ default: P3
+ enum:
+ - P3
+ - P1
+ - P2
+ - P3
+ - P4
+ - P5
+ - auto
type: string
- required:
- - parent_issue_id
- - state
- - title
type: object
- create_linear_issue_comment_task_params:
+ update_opsgenie_alert_task_params:
properties:
+ alert_id:
+ description: Opsgenie Alert ID
+ type: string
task_type:
enum:
- - create_linear_issue_comment
+ - update_opsgenie_alert
type: string
- issue_id:
- description: The issue id
+ message:
+ description: Message of the alert
type: string
- body:
- description: The issue description
+ description:
+ description: Description field of the alert that is generally used to provide
+ a detailed information about the alert
type: string
- required:
- - body
- - issue_id
- type: object
- create_microsoft_teams_meeting_task_params:
- properties:
- task_type:
+ priority:
enum:
- - create_microsoft_teams_meeting
- type: string
- name:
- description: The meeting name
- type: string
- subject:
- description: The meeting subject
+ - P1
+ - P2
+ - P3
+ - P4
+ - P5
+ - auto
type: string
- record_meeting:
- description: Rootly AI will record the meeting and automatically generate
- a transcript and summary from your meeting
- type: boolean
- post_to_incident_timeline:
- type: boolean
- post_to_slack_channels:
- items:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- type: array
+ completion:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
required:
- - name
- - subject
+ - alert_id
+ - completion
+ - priority
type: object
- create_microsoft_teams_channel_task_params:
+ update_opsgenie_incident_task_params:
properties:
task_type:
enum:
- - create_microsoft_teams_channel
+ - update_opsgenie_incident
type: string
- team:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- title:
- description: Microsoft Team channel title
+ opsgenie_incident_id:
+ description: "The Opsgenie incident ID, this can also be a Rootly incident\
+ \ variable ex. {{ incident.opsgenie_incident_id }}"
+ type: string
+ message:
+ description: Message of the alert
type: string
description:
- description: Microsoft Team channel description
+ description: Description field of the alert that is generally used to provide
+ a detailed information about the alert
type: string
- private:
- default: auto
+ status:
enum:
+ - resolve
+ - open
+ - close
- auto
- - "true"
- - "false"
+ type: string
+ priority:
+ enum:
+ - P1
+ - P2
+ - P3
+ - P4
+ - P5
+ - auto
+ - ""
+ nullable: true
type: string
required:
- - title
- - workspace
+ - opsgenie_incident_id
type: object
- add_microsoft_teams_tab_task_params:
- anyOf: []
- nullable: true
+ page_rootly_on_call_responders_task_params:
properties:
task_type:
enum:
- - add_microsoft_teams_tab
+ - page_rootly_on_call_responders
type: string
- playbook_id:
- description: The playbook id if tab is of an incident playbook
+ escalation_policy_target:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ service_target:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ user_target:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ group_target:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ functionality_target:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ alert_urgency_id:
+ description: Alert urgency ID
type: string
- team:
- properties:
- id:
- type: string
- name:
- type: string
- type: object
- channel:
- properties:
- id:
- type: string
- name:
- type: string
- type: object
- title:
- description: The tab title. Required if not a playbook tab
- nullable: true
+ summary:
+ description: Alert title
type: string
- link:
- description: The tab link. Required if not a playbook tab
- nullable: true
+ description:
+ description: Alert description
+ type: string
+ escalation_note:
type: string
required:
- - channel
- - team
+ - alert_urgency_id
+ - summary
type: object
- archive_microsoft_teams_channels_task_params:
+ page_pagerduty_on_call_responders_task_params:
properties:
task_type:
enum:
- - archive_microsoft_teams_channels
+ - page_pagerduty_on_call_responders
type: string
- team:
+ service:
$ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- channels:
+ escalation_policies:
+ items:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ type: array
+ users:
items:
$ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
type: array
- required:
- - channels
- - team
- type: object
- rename_microsoft_teams_channel_task_params:
- properties:
- task_type:
- enum:
- - rename_microsoft_teams_channel
- type: string
- team:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- channel:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
title:
+ description: Incident title.
+ nullable: true
type: string
- required:
- - channel
- - team
- - title
- type: object
- invite_to_microsoft_teams_channel_task_params:
- properties:
- task_type:
- enum:
- - invite_to_microsoft_teams_channel
- type: string
- team:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- channel:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- emails:
- description: Comma separated list of emails to invite
+ message:
type: string
- required:
- - channel
- - emails
- type: object
- create_notion_page_task_params:
- properties:
- task_type:
+ urgency:
+ default: high
enum:
- - create_notion_page
- type: string
- title:
- description: The Notion page title
+ - high
+ - low
+ - auto
type: string
- parent_page:
- $ref: '#/components/schemas/create_notion_page_task_params_parent_page'
- post_mortem_template_id:
- description: "Retrospective template to use when creating page task, if\
- \ desired"
+ priority:
+ description: "PagerDuty incident priority, selecting auto will let Rootly\
+ \ auto map our incident severity"
type: string
- mark_post_mortem_as_published:
- default: true
- type: boolean
- show_timeline_as_table:
- type: boolean
- show_action_items_as_table:
+ create_new_incident_on_conflict:
+ default: false
+ description: "Rootly only supports linking to a single PagerDuty incident.\
+ \ If this feature is disabled Rootly will add responders from any additional\
+ \ pages to the existing PagerDuty incident that is linked to the Rootly\
+ \ incident. If enabled, Rootly will create a new PagerDuty incident that\
+ \ is not linked to any Rootly incidents"
type: boolean
required:
- - parent_page
- - title
+ - service
type: object
- send_microsoft_teams_message_task_params:
+ page_victor_ops_on_call_responders_task_params:
anyOf: []
nullable: true
properties:
task_type:
enum:
- - send_microsoft_teams_message
+ - page_victor_ops_on_call_responders
type: string
- channels:
+ escalation_policies:
items:
properties:
id:
@@ -43212,202 +32139,174 @@ components:
type: string
type: object
type: array
- text:
- description: The message text
+ users:
+ items:
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ type: object
+ type: array
+ title:
+ description: Alert title.
+ nullable: true
+ type: string
+ type: object
+ update_victor_ops_incident_task_params:
+ properties:
+ task_type:
+ enum:
+ - update_victor_ops_incident
+ type: string
+ victor_ops_incident_id:
+ description: "The victor_ops incident ID, this can also be a Rootly incident\
+ \ variable ex. {{ incident.victor_ops_incident_id }}"
+ type: string
+ status:
+ enum:
+ - resolve
+ - ack
+ - auto
+ type: string
+ resolution_message:
+ description: Resolution message
type: string
required:
- - text
+ - status
+ - victor_ops_incident_id
type: object
- send_microsoft_teams_blocks_task_params:
- anyOf: []
- nullable: true
+ print_task_params:
properties:
task_type:
enum:
- - send_microsoft_teams_blocks
+ - print
type: string
- attachments:
- description: Support liquid markup. Needs to be a valid JSON string after
- liquid is parsed
+ message:
+ description: The message to print
type: string
required:
- - attachments
+ - message
type: object
- update_notion_page_task_params:
+ publish_incident_task_params:
properties:
task_type:
enum:
- - update_notion_page
+ - publish_incident
type: string
- file_id:
- description: The Notion page ID
+ incident:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ public_title:
type: string
- title:
- description: The Notion page title
+ event:
+ description: Incident event description
type: string
- post_mortem_template_id:
- description: "Retrospective template to use when creating page task, if\
- \ desired"
+ status:
+ default: resolved
+ enum:
+ - investigating
+ - identified
+ - monitoring
+ - resolved
+ - scheduled
+ - in_progress
+ - completed
type: string
- show_timeline_as_table:
+ notify_subscribers:
+ default: false
+ description: When true notifies subscribers of the status page by email/text
type: boolean
- show_action_items_as_table:
+ should_tweet:
+ default: false
+ description: For Statuspage.io integrated pages auto publishes a tweet for
+ your update
type: boolean
- required:
- - file_id
- type: object
- create_service_now_incident_task_params:
- properties:
- task_type:
- enum:
- - create_service_now_incident
- type: string
- title:
- description: The incident title
- type: string
- description:
- description: The incident description
+ status_page_template:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ status_page_id:
type: string
- priority:
- $ref: '#/components/schemas/create_jira_issue_task_params_priority'
- completion:
- $ref: '#/components/schemas/create_service_now_incident_task_params_completion'
- custom_fields_mapping:
- description: Custom field mappings. Can contain liquid markup and need to
- be valid JSON
+ integration_payload:
+ description: Additional API Payload you can pass to statuspage.io for example.
+ Can contain liquid markup and need to be valid JSON
nullable: true
type: string
required:
- - title
+ - incident
+ - public_title
+ - status
+ - status_page_id
type: object
- create_shortcut_story_task_params:
- anyOf: []
- nullable: true
+ redis_client_task_params:
properties:
task_type:
enum:
- - create_shortcut_story
- type: string
- title:
- description: The incident title
+ - redis_client
type: string
- kind:
- enum:
- - bug
- - chore
- - feature
+ url:
+ example: redis://redis-12345.c1.us-east-1-2.ec2.cloud.redislabs.com:12345
type: string
- description:
- description: The incident description
+ commands:
type: string
- labels:
- description: The story labels
+ event_url:
type: string
- due_date:
- description: The due date
+ event_message:
type: string
- archivation:
- description: The archivation id and display name
- properties:
- id:
- type: string
- name:
- type: string
- type: object
- group:
- description: The group id and display name
- properties:
- id:
- type: string
- name:
- type: string
- type: object
- project:
- description: The project id and display name
- properties:
- id:
- type: string
- name:
- type: string
- type: object
- workflow_state:
- description: The workflow state id workflow state name
- properties:
- id:
- type: string
- name:
- type: string
- type: object
+ post_to_incident_timeline:
+ type: boolean
+ post_to_slack_channels:
+ items:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ type: array
required:
- - archivation
- - kind
- - title
+ - commands
+ - url
type: object
- create_shortcut_task_task_params:
+ rename_slack_channel_task_params:
properties:
task_type:
enum:
- - create_shortcut_task
- type: string
- parent_story_id:
- description: The parent story
+ - rename_slack_channel
type: string
- description:
- description: The task description
+ channel:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ title:
type: string
- completion:
- $ref: '#/components/schemas/create_service_now_incident_task_params_completion'
required:
- - completion
- - description
- - parent_story_id
+ - channel
+ - title
type: object
- create_trello_card_task_params:
+ change_slack_channel_privacy_task_params:
properties:
task_type:
enum:
- - create_trello_card
- type: string
- title:
- description: The card title
- type: string
- description:
- description: The card description
+ - rename_slack_channel
type: string
- due_date:
- description: The due date
+ channel:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ privacy:
+ enum:
+ - private
+ - public
type: string
- board:
- $ref: '#/components/schemas/create_trello_card_task_params_board'
- list:
- $ref: '#/components/schemas/create_trello_card_task_params_list'
- labels:
- items:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- type: array
- archivation:
- $ref: '#/components/schemas/create_trello_card_task_params_archivation'
required:
- - board
- - list
+ - privacy
- title
type: object
- create_webex_meeting_task_params:
+ run_command_heroku_task_params:
properties:
task_type:
enum:
- - create_webex_meeting
+ - run_command_heroku
type: string
- topic:
- description: The meeting topic
+ command:
type: string
- password:
- description: The meeting password
+ app_name:
+ type: string
+ size:
+ enum:
+ - standard-1X
+ - standard-2X
type: string
- record_meeting:
- description: Rootly AI will record the meeting and automatically generate
- a transcript and summary from your meeting
- type: boolean
post_to_incident_timeline:
type: boolean
post_to_slack_channels:
@@ -43415,392 +32314,348 @@ components:
$ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
type: array
required:
- - topic
+ - app_name
+ - command
+ - size
type: object
- create_zendesk_ticket_task_params:
+ send_email_task_params:
properties:
task_type:
enum:
- - create_zendesk_ticket
+ - send_email
type: string
- kind:
- enum:
- - problem
- - incident
- - question
- - task
+ from:
+ default: Rootly
+ description: The from email address. Need to use SMTP integration if different
+ than rootly.com
type: string
+ to:
+ items:
+ description: To address email
+ type: string
+ type: array
+ cc:
+ items:
+ description: Cc address email
+ type: string
+ type: array
+ bcc:
+ items:
+ description: Bcc address email
+ type: string
+ type: array
subject:
- description: The ticket subject
- type: string
- comment:
- description: The ticket comment
+ description: The subject
type: string
- tags:
- description: The ticket tags
+ preheader:
+ description: The preheader
+ nullable: true
type: string
- priority:
- $ref: '#/components/schemas/create_jira_issue_task_params_priority'
- completion:
- $ref: '#/components/schemas/create_service_now_incident_task_params_completion'
- custom_fields_mapping:
- description: Custom field mappings. Can contain liquid markup and need to
- be valid JSON
+ body:
+ description: The email body
nullable: true
type: string
- ticket_payload:
- description: Additional Zendesk ticket attributes. Will be merged into whatever
- was specified in this tasks current parameters. Can contain liquid markup
- and need to be valid JSON
+ include_header:
+ type: boolean
+ include_footer:
+ type: boolean
+ custom_logo_url:
+ description: URL to your custom email logo
nullable: true
type: string
required:
- - kind
+ - body
- subject
+ - to
type: object
- create_zendesk_jira_link_task_params:
+ send_dashboard_report_task_params:
properties:
task_type:
enum:
- - create_zendesk_jira_link
+ - send_dashboard_report
type: string
- jira_issue_id:
- description: Jira Issue Id.
+ dashboard_ids:
+ items:
+ type: string
+ type: array
+ from:
+ default: Rootly
+ description: The from email address. Need to use SMTP integration if different
+ than rootly.com
type: string
- jira_issue_key:
- description: Jira Issue Key.
+ to:
+ items:
+ description: The recipient
+ type: string
+ type: array
+ subject:
+ description: The subject
type: string
- zendesk_ticket_id:
- description: Zendesk Ticket Id.
+ preheader:
+ description: The preheader
+ nullable: true
+ type: string
+ body:
+ description: The email body
+ nullable: true
type: string
required:
- - jira_issue_id
- - jira_issue_key
- - zendesk_ticket_id
+ - body
+ - dashboard_ids
+ - subject
+ - to
type: object
- create_clickup_task_task_params:
+ create_slack_channel_task_params:
properties:
task_type:
enum:
- - create_clickup_task
+ - create_slack_channel
type: string
+ workspace:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
title:
- description: The task title
- type: string
- description:
- description: The task description
- type: string
- tags:
- description: The task tags
- type: string
- priority:
- $ref: '#/components/schemas/create_jira_issue_task_params_priority'
- due_date:
- description: The due date
- type: string
- custom_fields_mapping:
- description: Custom field mappings. Can contain liquid markup and need to
- be valid JSON
- nullable: true
+ description: Slack channel title
type: string
- task_payload:
- description: Additional ClickUp task attributes. Will be merged into whatever
- was specified in this tasks current parameters. Can contain liquid markup
- and need to be valid JSON
- nullable: true
+ private:
+ default: auto
+ enum:
+ - auto
+ - "true"
+ - "false"
type: string
required:
- title
+ - workspace
type: object
- create_motion_task_task_params:
+ send_slack_message_task_params:
+ anyOf: []
+ nullable: true
properties:
task_type:
enum:
- - create_motion_task
- type: string
- workspace:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- project:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- status:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- title:
- description: The task title
- type: string
- description:
- description: The task description
+ - send_slack_message
type: string
- labels:
+ channels:
+ items:
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ type: object
+ type: array
+ slack_users:
+ items:
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ type: object
+ type: array
+ slack_user_groups:
+ items:
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ type: object
+ type: array
+ actionables:
items:
+ enum:
+ - update_summary
+ - update_status
+ - archive_channel
+ - manage_incident_roles
+ - update_incident
+ - all_commands
+ - leave_feedback
+ - manage_form_fields
+ - manage_action_items
+ - view_tasks
+ - add_pagerduty_responders
+ - add_opsgenie_responders
+ - add_victor_ops_responders
+ - update_status_page
+ - pause_reminder
+ - snooze_reminder
+ - restart_reminder
+ - cancel_incident
+ - delete_message
type: string
type: array
- priority:
- $ref: '#/components/schemas/create_jira_issue_task_params_priority'
- duration:
- description: "The duration. Eg. \"NONE\", \"REMINDER\", or a integer greater\
- \ than 0."
+ broadcast_thread_reply_to_channel:
+ type: boolean
+ send_as_ephemeral:
+ type: boolean
+ color:
+ description: "A hex color ex. #FFFFFF"
type: string
- due_date:
- description: The due date
+ pin_to_channel:
+ type: boolean
+ update_parent_message:
+ type: boolean
+ thread_ts:
+ description: The thread to send the message into
+ type: string
+ parent_message_thread_task:
+ description: "A hash where [id] is the task id of the parent task that sent\
+ \ a message, and [name] is the name of the parent task"
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ type: object
+ text:
+ description: The message text
type: string
+ send_only_as_threaded_message:
+ description: "When set to true, if the parent for this threaded message\
+ \ cannot be found the message will be skipped."
+ type: boolean
required:
- - title
- - workspace
+ - text
type: object
- create_zoom_meeting_task_params:
+ send_sms_task_params:
properties:
task_type:
enum:
- - create_zoom_meeting
- type: string
- topic:
- description: The meeting topic
- type: string
- password:
- description: The meeting password
- type: string
- create_as_email:
- description: The email to use if creating as email
+ - send_sms
type: string
- alternative_hosts:
+ phone_numbers:
items:
- description: Alternative host email
+ description: A recipient phone number
+ example: "[\"14150001111\"]"
type: string
type: array
- auto_recording:
- default: none
- enum:
- - none
- - local
- - cloud
+ name:
+ description: The name
+ type: string
+ content:
+ description: The SMS message
type: string
- record_meeting:
- description: Rootly AI will record the meeting and automatically generate
- a transcript and summary from your meeting
- type: boolean
- post_to_incident_timeline:
- type: boolean
- post_to_slack_channels:
- items:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- type: array
required:
- - topic
+ - content
+ - name
+ - phone_numbers
type: object
- get_github_commits_task_params:
- anyOf: []
- nullable: true
+ send_whatsapp_message_task_params:
properties:
task_type:
enum:
- - get_github_commits
+ - send_whatsapp_message
type: string
- service_ids:
- items:
- description: ID of service impacted by incident
- type: string
- type: array
- github_repository_names:
+ phone_numbers:
items:
+ description: A recipient phone number
+ example: "[\"14150001111\"]"
type: string
type: array
- branch:
- description: The branch
+ name:
+ description: The name
type: string
- past_duration:
- description: "How far back to fetch commits (in format '1 minute', '30 days',\
- \ '3 months', etc.)"
- example: 1 hour
+ content:
+ description: The WhatsApp message
type: string
- services_impacted_by_incident:
- type: boolean
- post_to_incident_timeline:
- type: boolean
- post_to_slack_channels:
- items:
- properties:
- id:
- type: string
- name:
- type: string
- type: object
- type: array
required:
- - branch
- - past_duration
+ - content
+ - name
+ - phone_numbers
type: object
- get_gitlab_commits_task_params:
- anyOf: []
- nullable: true
+ snapshot_datadog_graph_task_params:
properties:
task_type:
enum:
- - get_gitlab_commits
+ - snapshot_datadog_graph
type: string
- service_ids:
- items:
- description: ID of service impacted by incident
- type: string
- type: array
- gitlab_repository_names:
+ dashboards:
items:
- type: string
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
type: array
- branch:
- description: The branch
- type: string
past_duration:
- description: "How far back to fetch commits (in format '1 minute', '30 days',\
- \ '3 months', etc.)"
+ description: "in format '1 minute', '30 days', '3 months', etc"
example: 1 hour
type: string
- services_impacted_by_incident:
- type: boolean
+ metric_queries:
+ items:
+ type: string
+ type: array
post_to_incident_timeline:
type: boolean
post_to_slack_channels:
items:
- properties:
- id:
- type: string
- name:
- type: string
- type: object
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
type: array
required:
- - branch
- past_duration
type: object
- get_pulses_task_params:
+ snapshot_grafana_dashboard_task_params:
properties:
task_type:
enum:
- - get_pulses
+ - snapshot_grafana_dashboard
type: string
- service_ids:
- items:
- description: ID of service impacted by incident
- type: string
- type: array
- environment_ids:
- items:
- description: ID of environment impacted by incident
- type: string
- type: array
- labels:
- items:
- type: string
- type: array
- refs:
- items:
- type: string
- type: array
- sources:
+ dashboards:
items:
- type: string
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
type: array
- past_duration:
- description: "How far back to fetch commits (in format '1 minute', '30 days',\
- \ '3 months', etc.)"
- example: 1 hour
- type: string
- services_impacted_by_incident:
- type: boolean
- environments_impacted_by_incident:
- type: boolean
post_to_incident_timeline:
type: boolean
post_to_slack_channels:
items:
$ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
type: array
- parent_message_thread_task:
- $ref: '#/components/schemas/get_pulses_task_params_parent_message_thread_task'
required:
- - past_duration
+ - dashboards
type: object
- get_alerts_task_params:
+ snapshot_looker_look_task_params:
properties:
task_type:
enum:
- - get_alerts
+ - snapshot_looker_look
type: string
- service_ids:
- items:
- description: ID of service impacted by incident
- type: string
- type: array
- environment_ids:
- items:
- description: ID of environment impacted by incident
- type: string
- type: array
- labels:
- items:
- type: string
- type: array
- sources:
+ dashboards:
items:
- type: string
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
type: array
- past_duration:
- description: "How far back to fetch commits (in format '1 minute', '30 days',\
- \ '3 months', etc.)"
- example: 1 hour
- type: string
- services_impacted_by_incident:
- type: boolean
- environments_impacted_by_incident:
- type: boolean
post_to_incident_timeline:
type: boolean
post_to_slack_channels:
items:
$ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
type: array
- parent_message_thread_task:
- $ref: '#/components/schemas/get_pulses_task_params_parent_message_thread_task'
required:
- - past_duration
+ - dashboards
type: object
- http_client_task_params:
+ snapshot_new_relic_graph_task_params:
properties:
task_type:
enum:
- - http_client
- type: string
- headers:
- description: JSON map of HTTP headers
- type: string
- params:
- description: JSON map of HTTP query parameters
- type: string
- body:
- description: HTTP body
- type: string
- url:
- description: URL endpoint
- example: https://example.com/foo.json
- type: string
- event_url:
+ - snapshot_looker_graph
type: string
- event_message:
+ metric_query:
type: string
- method:
- default: GET
- description: HTTP method
+ metric_type:
enum:
- - GET
- - POST
- - PATCH
- - PUT
- - DELETE
- - OPTIONS
- type: string
- succeed_on_status:
- description: "HTTP status code expected. Can be a regular expression. Eg:\
- \ 200, 200|203, 20[0-3]"
- example: "200"
+ - APDEX
+ - AREA
+ - BAR
+ - BASELINE
+ - BILLBOARD
+ - BULLET
+ - EVENT_FEED
+ - FUNNEL
+ - HEATMAP
+ - HISTOGRAM
+ - LINE
+ - PIE
+ - SCATTER
+ - STACKED_HORIZONTAL_BAR
+ - TABLE
+ - VERTICAL_BAR
type: string
post_to_incident_timeline:
type: boolean
@@ -43809,680 +32664,716 @@ components:
$ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
type: array
required:
- - succeed_on_status
- - url
+ - metric_query
+ - metric_type
type: object
- invite_to_slack_channel_opsgenie_task_params:
+ tweet_twitter_message_task_params:
properties:
task_type:
enum:
- - invite_to_slack_channel_opsgenie
+ - tweet_twitter_message
+ type: string
+ message:
type: string
- channels:
- items:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- type: array
- schedule:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
required:
- - channels
- - schedule
+ - message
type: object
- invite_to_slack_channel_rootly_task_params:
+ update_airtable_table_record_task_params:
properties:
task_type:
enum:
- - invite_to_slack_channel_rootly
+ - update_airtable_table_record
+ type: string
+ base_key:
+ description: The base key
+ type: string
+ table_name:
+ description: The table name
+ type: string
+ record_id:
+ description: The record id
+ type: string
+ custom_fields_mapping:
+ description: Custom field mappings. Can contain liquid markup and need to
+ be valid JSON
+ nullable: true
type: string
- channels:
- items:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- type: array
- escalation_policy_target:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- service_target:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- user_target:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- group_target:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- schedule_target:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
required:
- - channels
+ - base_key
+ - record_id
+ - table_name
type: object
- invite_to_slack_channel_pagerduty_task_params:
- anyOf: []
- nullable: true
+ update_asana_task_task_params:
properties:
task_type:
enum:
- - invite_to_slack_channel_pagerduty
+ - update_asana_task
type: string
- channels:
- items:
- properties:
- id:
- type: string
- name:
- type: string
- type: object
- type: array
- escalation_policy:
- properties:
- id:
- type: string
- name:
- type: string
- type: object
- schedule:
- properties:
- id:
- type: string
- name:
- type: string
- type: object
- service:
- properties:
- id:
- type: string
- name:
- type: string
- type: object
- required:
- - channels
- type: object
- invite_to_slack_channel_task_params:
- anyOf: []
- nullable: true
- properties:
- task_type:
+ task_id:
+ description: The task id
+ type: string
+ title:
+ description: The task title
+ type: string
+ notes:
+ type: string
+ assign_user_email:
+ description: The assigned user's email
+ type: string
+ completion:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ due_date:
+ description: The due date
+ type: string
+ custom_fields_mapping:
+ description: Custom field mappings. Can contain liquid markup and need to
+ be valid JSON
+ nullable: true
+ type: string
+ dependency_direction:
+ default: blocking
enum:
- - invite_to_slack_channel
+ - blocking
+ - blocked_by
type: string
- channel:
- properties:
- id:
- type: string
- name:
- type: string
- type: object
- slack_users:
- items:
- properties:
- id:
- type: string
- name:
- type: string
- type: object
- type: array
- slack_user_groups:
+ dependent_task_ids:
+ description: Dependent task ids. Supports liquid syntax
items:
- properties:
- id:
- type: string
- name:
- type: string
- type: object
+ type: string
+ nullable: true
type: array
- slack_emails:
- description: Comma separated list of emails to invite to the channel
- type: string
required:
- - channel
+ - completion
+ - task_id
type: object
- invite_to_slack_channel_victor_ops_task_params:
+ update_github_issue_task_params:
properties:
task_type:
enum:
- - invite_to_slack_channel_victor_ops
+ - update_github_issue
type: string
- channels:
+ issue_id:
+ description: The issue id
+ type: string
+ repository:
+ $ref: '#/components/schemas/update_github_issue_task_params_repository'
+ title:
+ description: The issue title
+ type: string
+ body:
+ description: The issue body
+ type: string
+ labels:
+ description: The issue labels
items:
$ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
type: array
- team:
+ labels_mode:
+ default: replace
+ description: How to apply labels. 'replace' (default) overwrites all existing
+ labels. 'append' adds to existing labels without removing them.
+ enum:
+ - replace
+ - append
+ type: string
+ issue_type:
+ $ref: '#/components/schemas/create_github_issue_task_params_issue_type'
+ completion:
$ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
required:
- - channels
- - team
+ - completion
+ - issue_id
type: object
- page_opsgenie_on_call_responders_task_params:
+ update_gitlab_issue_task_params:
properties:
task_type:
enum:
- - page_opsgenie_on_call_responders
+ - update_gitlab_issue
type: string
- title:
- description: Incident title.
- nullable: true
+ issue_id:
+ description: The issue id
type: string
- message:
- description: Message of the incident
+ issue_type:
+ description: The issue type
+ enum:
+ - issue
+ - incident
+ - test_case
+ - task
+ type: string
+ title:
+ description: The issue title
type: string
description:
- description: Description field of the incident that is generally used to
- provide a detailed information about the incident
+ description: The issue description
type: string
- teams:
- items:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- type: array
- users:
- items:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- type: array
- priority:
- default: P1
- enum:
- - P1
- - P2
- - P3
- - P4
- - P5
- - auto
+ labels:
+ description: The issue labels
type: string
+ due_date:
+ description: The due date
+ type: string
+ completion:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ required:
+ - completion
+ - issue_id
type: object
- create_opsgenie_alert_task_params:
+ update_incident_task_params:
properties:
task_type:
enum:
- - create_opsgenie_alert
+ - update_incident
type: string
- message:
- description: Message of the alert
+ attribute_to_query_by:
+ default: id
+ enum:
+ - id
+ - slug
+ - sequential_id
+ - pagerduty_incident_id
+ - opsgenie_incident_id
+ - victor_ops_incident_id
+ - jira_issue_id
+ - asana_task_id
+ - shortcut_task_id
+ - linear_issue_id
+ - zendesk_ticket_id
+ - motion_task_id
+ - trello_card_id
+ - airtable_record_id
+ - shortcut_story_id
+ - github_issue_id
+ - gitlab_issue_id
+ - freshservice_ticket_id
+ - freshservice_task_id
+ - clickup_task_id
type: string
- description:
- description: Description field of the alert that is generally used to provide
- a detailed information about the alert
+ incident_id:
+ description: The incident id to update or id of any attribute on the incident
type: string
- teams:
+ title:
+ description: The incident title
+ nullable: true
+ type: string
+ summary:
+ description: The incident summary
+ nullable: true
+ type: string
+ status:
+ nullable: true
+ type: string
+ severity_id:
+ nullable: true
+ type: string
+ incident_type_ids:
items:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ type: string
+ nullable: true
type: array
- users:
+ service_ids:
+ description: Array of service UUIDs
items:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ type: string
+ nullable: true
type: array
- schedules:
+ functionality_ids:
+ description: Array of functionality UUIDs
items:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ type: string
+ nullable: true
type: array
- escalations:
+ environment_ids:
items:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ type: string
+ nullable: true
+ type: array
+ group_ids:
+ description: Array of group/team UUIDs
+ items:
+ type: string
+ nullable: true
type: array
- priority:
- default: P1
- enum:
- - P1
- - P2
- - P3
- - P4
- - P5
- - auto
+ started_at:
+ nullable: true
type: string
- details:
- description: Details payload. Can contain liquid markup and need to be valid
- JSON
+ detected_at:
+ nullable: true
+ type: string
+ acknowledged_at:
+ nullable: true
+ type: string
+ mitigated_at:
+ nullable: true
+ type: string
+ resolved_at:
+ nullable: true
+ type: string
+ private:
+ type: boolean
+ custom_fields_mapping:
+ description: "Custom field mappings. Can contain liquid markup and need\
+ \ to be valid JSON. Use 'services', 'functionalities', or 'groups' keys\
+ \ with arrays of names/slugs for name/slug lookup"
nullable: true
type: string
required:
- - message
+ - incident_id
type: object
- update_opsgenie_alert_task_params:
+ update_incident_postmortem_task_params:
properties:
- alert_id:
- description: Opsgenie Alert ID
- type: string
task_type:
enum:
- - update_opsgenie_alert
+ - update_incident_postmortem
type: string
- message:
- description: Message of the alert
+ postmortem_id:
+ description: UUID of the retrospective that needs to be updated
type: string
- description:
- description: Description field of the alert that is generally used to provide
- a detailed information about the alert
+ title:
+ description: The incident title
+ nullable: true
type: string
- priority:
- enum:
- - P1
- - P2
- - P3
- - P4
- - P5
- - auto
+ status:
+ nullable: true
type: string
- completion:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
required:
- - alert_id
- - completion
- - priority
+ - postmortem_id
type: object
- update_opsgenie_incident_task_params:
+ update_jira_issue_task_params:
properties:
task_type:
enum:
- - update_opsgenie_incident
+ - update_jira_issue
type: string
- opsgenie_incident_id:
- description: "The Opsgenie incident ID, this can also be a Rootly incident\
- \ variable ex. {{ incident.opsgenie_incident_id }}"
+ integration:
+ $ref: '#/components/schemas/create_jira_issue_task_params_integration'
+ issue_id:
+ description: The issue id
type: string
- message:
- description: Message of the alert
+ title:
+ description: The issue title
type: string
description:
- description: Description field of the alert that is generally used to provide
- a detailed information about the alert
+ description: The issue description
type: string
- status:
- enum:
- - resolve
- - open
- - close
- - auto
+ labels:
+ description: The issue labels
+ type: string
+ assign_user_email:
+ description: The assigned user's email
+ type: string
+ reporter_user_email:
+ description: The reporter user's email
+ type: string
+ project_key:
+ description: The project key
+ type: string
+ due_date:
+ description: The due date
type: string
priority:
- enum:
- - P1
- - P2
- - P3
- - P4
- - P5
- - auto
+ $ref: '#/components/schemas/create_jira_issue_task_params_priority'
+ status:
+ $ref: '#/components/schemas/create_jira_issue_task_params_status'
+ custom_fields_mapping:
+ description: Custom field mappings. Can contain liquid markup and need to
+ be valid JSON
+ nullable: true
+ type: string
+ update_payload:
+ description: Update payload. Can contain liquid markup and need to be valid
+ JSON
+ nullable: true
type: string
required:
- - opsgenie_incident_id
+ - issue_id
+ - project_key
type: object
- page_rootly_on_call_responders_task_params:
+ update_linear_issue_task_params:
properties:
task_type:
enum:
- - page_rootly_on_call_responders
+ - update_linear_issue
type: string
- escalation_policy_target:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- service_target:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- user_target:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- group_target:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- alert_urgency_id:
- description: Alert urgency ID
+ issue_id:
+ description: The issue id
type: string
- summary:
- description: Alert title
+ title:
+ description: The issue title
type: string
description:
- description: Alert description
+ description: The issue description
type: string
- escalation_note:
+ state:
+ $ref: '#/components/schemas/update_linear_issue_task_params_state'
+ project:
+ $ref: '#/components/schemas/create_linear_issue_task_params_project'
+ labels:
+ items:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ type: array
+ priority:
+ $ref: '#/components/schemas/create_jira_issue_task_params_priority'
+ assign_user_email:
+ description: The assigned user's email
type: string
required:
- - summary
+ - issue_id
type: object
- page_pagerduty_on_call_responders_task_params:
+ update_service_now_incident_task_params:
properties:
task_type:
enum:
- - page_pagerduty_on_call_responders
+ - update_service_now_incident
type: string
- service:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- escalation_policies:
- items:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- type: array
- users:
- items:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- type: array
- title:
- description: Incident title.
- nullable: true
+ incident_id:
+ description: The incident id
type: string
- message:
+ title:
+ description: The incident title
type: string
- urgency:
- default: high
- enum:
- - high
- - low
- - auto
+ description:
+ description: The incident description
type: string
priority:
- description: "PagerDuty incident priority, selecting auto will let Rootly\
- \ auto map our incident severity"
+ $ref: '#/components/schemas/create_jira_issue_task_params_priority'
+ completion:
+ $ref: '#/components/schemas/create_service_now_incident_task_params_completion'
+ custom_fields_mapping:
+ description: Custom field mappings. Can contain liquid markup and need to
+ be valid JSON
+ nullable: true
type: string
- create_new_incident_on_conflict:
- default: false
- description: "Rootly only supports linking to a single PagerDuty incident.\
- \ If this feature is disabled Rootly will add responders from any additional\
- \ pages to the existing PagerDuty incident that is linked to the Rootly\
- \ incident. If enabled, Rootly will create a new PagerDuty incident that\
- \ is not linked to any Rootly incidents"
- type: boolean
required:
- - service
+ - incident_id
type: object
- page_victor_ops_on_call_responders_task_params:
- anyOf: []
- nullable: true
+ update_shortcut_story_task_params:
properties:
task_type:
enum:
- - page_victor_ops_on_call_responders
+ - update_shortcut_story
+ type: string
+ story_id:
+ description: The story id
type: string
- escalation_policies:
- items:
- properties:
- id:
- type: string
- name:
- type: string
- type: object
- type: array
- users:
- items:
- properties:
- id:
- type: string
- name:
- type: string
- type: object
- type: array
title:
- description: Alert title.
- nullable: true
+ description: The incident title
type: string
+ description:
+ description: The incident description
+ type: string
+ labels:
+ description: The story labels
+ type: string
+ due_date:
+ description: The due date
+ type: string
+ archivation:
+ $ref: '#/components/schemas/create_trello_card_task_params_archivation'
+ required:
+ - archivation
+ - story_id
type: object
- update_victor_ops_incident_task_params:
+ update_shortcut_task_task_params:
properties:
task_type:
enum:
- - update_victor_ops_incident
+ - update_shortcut_task
type: string
- victor_ops_incident_id:
- description: "The victor_ops incident ID, this can also be a Rootly incident\
- \ variable ex. {{ incident.victor_ops_incident_id }}"
+ task_id:
+ description: The task id
type: string
- status:
- enum:
- - resolve
- - ack
- - auto
+ parent_story_id:
+ description: The parent story
type: string
- resolution_message:
- description: Resolution message
+ description:
+ description: The task description
type: string
+ completion:
+ $ref: '#/components/schemas/create_service_now_incident_task_params_completion'
required:
- - status
- - victor_ops_incident_id
+ - completion
+ - parent_story_id
+ - task_id
type: object
- print_task_params:
+ update_slack_channel_topic_task_params:
properties:
task_type:
enum:
- - print
+ - update_slack_channel_topic
type: string
- message:
- description: The message to print
+ channel:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ topic:
type: string
required:
- - message
+ - channel
+ - topic
type: object
- publish_incident_task_params:
+ update_status_task_params:
properties:
task_type:
enum:
- - publish_incident
- type: string
- incident:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- public_title:
- type: string
- event:
- description: Incident event description
+ - update_status
type: string
status:
- default: resolved
enum:
- - investigating
- - identified
- - monitoring
+ - in_triage
+ - started
+ - mitigated
- resolved
- - scheduled
- - in_progress
- - verifying
- - completed
- type: string
- notify_subscribers:
- default: false
- description: When true notifies subscribers of the status page by email/text
- type: boolean
- should_tweet:
- default: false
- description: For Statuspage.io integrated pages auto publishes a tweet for
- your update
- type: boolean
- status_page_template:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- status_page_id:
+ - closed
+ - cancelled
type: string
- integration_payload:
- description: Additional API Payload you can pass to statuspage.io for example.
- Can contain liquid markup and need to be valid JSON
- nullable: true
+ inactivity_timeout:
+ description: "In format '1 hour', '1 day', etc"
+ example: 1 hour
type: string
required:
- - incident
- - public_title
- status
- - status_page_id
type: object
- redis_client_task_params:
+ update_incident_status_timestamp_task_params:
properties:
task_type:
enum:
- - redis_client
- type: string
- url:
- example: redis://redis-12345.c1.us-east-1-2.ec2.cloud.redislabs.com:12345
- type: string
- commands:
+ - update_status
type: string
- event_url:
+ sub_status_id:
+ description: Sub-status to update timestamp for
type: string
- event_message:
+ assigned_at:
+ description: Timestamp of when the sub-status was assigned
type: string
- post_to_incident_timeline:
- type: boolean
- post_to_slack_channels:
- items:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- type: array
required:
- - commands
- - url
+ - assigned_at
+ - sub_status_id
type: object
- rename_slack_channel_task_params:
+ update_trello_card_task_params:
properties:
task_type:
enum:
- - rename_slack_channel
+ - update_trello_card
+ type: string
+ card_id:
+ description: The card id
type: string
- channel:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
title:
+ description: The card title
type: string
- required:
- - channel
- - title
- type: object
- change_slack_channel_privacy_task_params:
- properties:
- task_type:
- enum:
- - rename_slack_channel
+ description:
+ description: The card description
type: string
- channel:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- privacy:
- enum:
- - private
- - public
+ due_date:
+ description: The due date
type: string
+ board:
+ $ref: '#/components/schemas/create_trello_card_task_params_board'
+ list:
+ $ref: '#/components/schemas/create_trello_card_task_params_list'
+ labels:
+ items:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ type: array
+ archivation:
+ $ref: '#/components/schemas/create_trello_card_task_params_archivation'
required:
- - privacy
- - title
+ - archivation
+ - card_id
type: object
- run_command_heroku_task_params:
+ update_clickup_task_task_params:
properties:
task_type:
enum:
- - run_command_heroku
+ - update_clickup_task
type: string
- command:
+ task_id:
+ description: The task id
type: string
- app_name:
+ title:
+ description: The task title
type: string
- size:
- enum:
- - standard-1X
- - standard-2X
+ description:
+ description: The task description
+ type: string
+ tags:
+ description: The task tags
+ type: string
+ priority:
+ $ref: '#/components/schemas/create_jira_issue_task_params_priority'
+ due_date:
+ description: The due date
+ type: string
+ custom_fields_mapping:
+ description: Custom field mappings. Can contain liquid markup and need to
+ be valid JSON
+ nullable: true
+ type: string
+ task_payload:
+ description: Additional ClickUp task attributes. Will be merged into whatever
+ was specified in this tasks current parameters. Can contain liquid markup
+ and need to be valid JSON
+ nullable: true
type: string
- post_to_incident_timeline:
- type: boolean
- post_to_slack_channels:
- items:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- type: array
required:
- - app_name
- - command
- - size
+ - task_id
type: object
- send_email_task_params:
+ update_motion_task_task_params:
properties:
task_type:
enum:
- - send_email
+ - update_motion_task
type: string
- from:
- default: Rootly
- description: The from email address. Need to use SMTP integration if different
- than rootly.com
+ task_id:
+ description: The task id
type: string
- to:
- items:
- description: To address email
- type: string
- type: array
- cc:
- items:
- description: Cc address email
- type: string
- type: array
- bcc:
+ title:
+ description: The task title
+ type: string
+ description:
+ description: The task description
+ type: string
+ labels:
items:
- description: Bcc address email
type: string
type: array
- subject:
- description: The subject
- type: string
- preheader:
- description: The preheader
- nullable: true
- type: string
- body:
- description: The email body
- nullable: true
+ priority:
+ $ref: '#/components/schemas/create_jira_issue_task_params_priority'
+ duration:
+ description: "The duration. Eg. \"NONE\", \"REMINDER\", or a integer greater\
+ \ than 0."
type: string
- include_header:
- type: boolean
- include_footer:
- type: boolean
- custom_logo_url:
- description: URL to your custom email logo
- nullable: true
+ due_date:
+ description: The due date
type: string
required:
- - body
- - subject
- - to
+ - task_id
type: object
- send_dashboard_report_task_params:
+ update_zendesk_ticket_task_params:
properties:
task_type:
enum:
- - send_dashboard_report
+ - update_zendesk_ticket
type: string
- dashboard_ids:
- items:
- type: string
- type: array
- from:
- default: Rootly
- description: The from email address. Need to use SMTP integration if different
- than rootly.com
+ ticket_id:
+ description: The ticket id
type: string
- to:
- items:
- description: The recipient
- type: string
- type: array
subject:
- description: The subject
+ description: The ticket subject
type: string
- preheader:
- description: The preheader
+ tags:
+ description: The ticket tags
+ type: string
+ priority:
+ $ref: '#/components/schemas/create_jira_issue_task_params_priority'
+ completion:
+ $ref: '#/components/schemas/create_service_now_incident_task_params_completion'
+ custom_fields_mapping:
+ description: Custom field mappings. Can contain liquid markup and need to
+ be valid JSON
nullable: true
type: string
- body:
- description: The email body
+ ticket_payload:
+ description: Additional Zendesk ticket attributes. Will be merged into whatever
+ was specified in this tasks current parameters. Can contain liquid markup
+ and need to be valid JSON
nullable: true
type: string
required:
- - body
- - dashboard_ids
- - subject
- - to
+ - ticket_id
type: object
- create_slack_channel_task_params:
+ update_attached_alerts_task_params:
properties:
task_type:
enum:
- - create_slack_channel
+ - update_attached_alerts
type: string
- workspace:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- title:
- description: Slack channel title
+ status:
+ enum:
+ - acknowledged
+ - resolved
type: string
- private:
- default: auto
+ required:
+ - status
+ type: object
+ trigger_workflow_task_params:
+ properties:
+ task_type:
enum:
- - auto
- - "true"
- - "false"
+ - trigger_workflow
+ type: string
+ kind:
+ default: incident
+ enum:
+ - incident
+ - post_mortem
+ - action_item
+ - pulse
+ - alert
+ type: string
+ attribute_to_query_by:
+ default: id
+ description: "[\"(incident) kind can only match [:id, :slug, :sequential_id,\
+ \ :pagerduty_incident_id, :opsgenie_incident_id, :victor_ops_incident_id,\
+ \ :jira_issue_id, :asana_task_id, :shortcut_task_id, :linear_issue_id,\
+ \ :zendesk_ticket_id, :motion_task_id, :trello_card_id, :airtable_record_id,\
+ \ :shortcut_story_id, :github_issue_id, :freshservice_ticket_id, :freshservice_task_id,\
+ \ :clickup_task_id]\", \"(post_mortem) kind can only match [:id]\", \"\
+ (action_item) kind can only match [:id, :jira_issue_id, :asana_task_id,\
+ \ :shortcut_task_id, :linear_issue_id, :zendesk_ticket_id, :motion_task_id,\
+ \ :trello_card_id, :airtable_record_id, :shortcut_story_id, :github_issue_id,\
+ \ :freshservice_ticket_id, :freshservice_task_id, :clickup_task_id]\"\
+ , \"(pulse) kind can only match [:id]\", \"(alert) kind can only match\
+ \ [:id]\"]"
+ enum:
+ - id
+ - slug
+ - sequential_id
+ - pagerduty_incident_id
+ - opsgenie_incident_id
+ - victor_ops_incident_id
+ - jira_issue_id
+ - asana_task_id
+ - shortcut_task_id
+ - linear_issue_id
+ - zendesk_ticket_id
+ - motion_task_id
+ - trello_card_id
+ - airtable_record_id
+ - shortcut_story_id
+ - github_issue_id
+ - freshservice_ticket_id
+ - freshservice_task_id
+ - clickup_task_id
type: string
+ resource:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ workflow:
+ $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ check_workflow_conditions:
+ type: boolean
required:
- - title
- - workspace
+ - attribute_to_query_by
+ - kind
+ - resource
+ - workflow
type: object
- send_slack_message_task_params:
+ send_slack_blocks_task_params:
anyOf: []
nullable: true
properties:
task_type:
enum:
- - send_slack_message
+ - send_slack_blocks
+ type: string
+ message:
+ type: string
+ blocks:
+ description: Support liquid markup. Needs to be a valid JSON string after
+ liquid is parsed
+ type: string
+ attachments:
+ description: Support liquid markup. Needs to be a valid JSON string after
+ liquid is parsed
type: string
channels:
items:
@@ -44511,44 +33402,17 @@ components:
type: string
type: object
type: array
- actionables:
- items:
- enum:
- - update_summary
- - update_status
- - archive_channel
- - manage_incident_roles
- - update_incident
- - all_commands
- - leave_feedback
- - manage_form_fields
- - manage_action_items
- - view_tasks
- - add_pagerduty_responders
- - add_opsgenie_responders
- - add_victor_ops_responders
- - update_status_page
- - pause_reminder
- - snooze_reminder
- - restart_reminder
- - cancel_incident
- - delete_message
- type: string
- type: array
broadcast_thread_reply_to_channel:
type: boolean
send_as_ephemeral:
type: boolean
- color:
- description: "A hex color ex. #FFFFFF"
- type: string
pin_to_channel:
type: boolean
- update_parent_message:
- type: boolean
thread_ts:
description: The thread to send the message into
type: string
+ update_parent_message:
+ type: boolean
parent_message_thread_task:
description: "A hash where [id] is the task id of the parent task that sent\
\ a message, and [name] is the name of the parent task"
@@ -44558,970 +33422,1993 @@ components:
name:
type: string
type: object
- text:
- description: The message text
- type: string
send_only_as_threaded_message:
description: "When set to true, if the parent for this threaded message\
\ cannot be found the message will be skipped."
type: boolean
required:
- - text
+ - blocks
type: object
- send_sms_task_params:
+ create_openai_chat_completion_task_params:
properties:
task_type:
enum:
- - send_sms
+ - openai_chat_completion
type: string
- phone_numbers:
- items:
- description: A recipient phone number
- example: "[\"14150001111\"]"
- type: string
- type: array
- name:
- description: The name
+ model:
+ $ref: '#/components/schemas/create_openai_chat_completion_task_params_model'
+ system_prompt:
+ description: The system prompt to send to OpenAI (optional)
type: string
- content:
- description: The SMS message
+ prompt:
+ description: The prompt to send to OpenAI
+ type: string
+ temperature:
+ description: Controls randomness in the response. Higher values make output
+ more random
+ maximum: 2.0
+ minimum: 0.0
+ type: number
+ max_tokens:
+ description: Maximum number of tokens to generate in the response
+ minimum: 1
+ type: integer
+ top_p:
+ description: Controls diversity via nucleus sampling. Lower values make
+ output more focused
+ maximum: 1.0
+ minimum: 0.0
+ type: number
+ reasoning_effort:
+ description: Constrains effort on reasoning for GPT-5 and o-series models
+ enum:
+ - minimal
+ - low
+ - medium
+ - high
+ type: string
+ reasoning_summary:
+ description: Summary of the reasoning performed by the model for GPT-5 and
+ o-series models
+ enum:
+ - auto
+ - concise
+ - detailed
type: string
required:
- - content
- - name
- - phone_numbers
+ - model
+ - prompt
type: object
- send_whatsapp_message_task_params:
+ create_watsonx_chat_completion_task_params:
properties:
task_type:
enum:
- - send_whatsapp_message
+ - create_watsonx_chat_completion_task
type: string
- phone_numbers:
- items:
- description: A recipient phone number
- example: "[\"14150001111\"]"
- type: string
- type: array
- name:
- description: The name
+ model:
+ $ref: '#/components/schemas/create_watsonx_chat_completion_task_params_model'
+ system_prompt:
+ description: The system prompt to send to WatsonX (optional)
type: string
- content:
- description: The WhatsApp message
+ prompt:
+ description: The prompt to send to WatsonX
+ type: string
+ project_id:
type: string
required:
- - content
- - name
- - phone_numbers
+ - model
+ - project_id
+ - prompt
type: object
- snapshot_datadog_graph_task_params:
+ create_google_gemini_chat_completion_task_params:
properties:
task_type:
enum:
- - snapshot_datadog_graph
+ - create_google_gemini_chat_completion_task
type: string
- dashboards:
+ model:
+ $ref: '#/components/schemas/create_google_gemini_chat_completion_task_params_model'
+ system_prompt:
+ description: The system prompt to send to Gemini (optional)
+ type: string
+ prompt:
+ description: The prompt to send to Gemini
+ type: string
+ required:
+ - model
+ - prompt
+ type: object
+ create_mistral_chat_completion_task_params:
+ properties:
+ task_type:
+ enum:
+ - create_mistral_chat_completion_task
+ type: string
+ model:
+ $ref: '#/components/schemas/create_mistral_chat_completion_task_params_model'
+ system_prompt:
+ description: The system prompt to send to Mistral (optional)
+ type: string
+ prompt:
+ description: The prompt to send to Mistral
+ type: string
+ temperature:
+ description: Sampling temperature (0.0-1.5). Higher values make output more
+ random.
+ maximum: 1.5
+ minimum: 0.0
+ type: number
+ max_tokens:
+ description: Maximum number of tokens to generate
+ minimum: 1
+ type: integer
+ top_p:
+ description: Nucleus sampling parameter (0.0-1.0)
+ maximum: 1.0
+ minimum: 0.0
+ type: number
+ required:
+ - model
+ - prompt
+ type: object
+ create_anthropic_chat_completion_task_params:
+ properties:
+ task_type:
+ enum:
+ - create_anthropic_chat_completion_task
+ type: string
+ model:
+ $ref: '#/components/schemas/create_anthropic_chat_completion_task_params_model'
+ system_prompt:
+ description: The system prompt to send to Anthropic (optional)
+ type: string
+ prompt:
+ description: The prompt to send to Anthropic
+ type: string
+ required:
+ - model
+ - prompt
+ type: object
+ new_workflow_task:
+ properties:
+ data:
+ $ref: '#/components/schemas/new_workflow_task_data'
+ required:
+ - data
+ type: object
+ update_workflow_task:
+ properties:
+ data:
+ $ref: '#/components/schemas/update_workflow_task_data'
+ required:
+ - data
+ type: object
+ workflow_task:
+ properties:
+ workflow_id:
+ description: The ID of the parent workflow
+ type: string
+ task_params:
+ $ref: '#/components/schemas/new_workflow_task_data_attributes_task_params'
+ name:
+ description: Name of the workflow task
+ type: string
+ position:
+ description: The position of the workflow task
+ type: integer
+ skip_on_failure:
+ description: Skip workflow task if any failures
+ type: boolean
+ enabled:
+ default: true
+ description: Enable/disable workflow task
+ type: boolean
+ created_at:
+ description: Date of creation
+ type: string
+ updated_at:
+ description: Date of last update
+ type: string
+ required:
+ - created_at
+ - enabled
+ - position
+ - skip_on_failure
+ - task_params
+ - updated_at
+ - workflow_id
+ type: object
+ workflow_task_response:
+ properties:
+ data:
+ $ref: '#/components/schemas/workflow_task_response_data'
+ required:
+ - data
+ type: object
+ workflow_task_list:
+ properties:
+ data:
items:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ $ref: '#/components/schemas/workflow_task_response_data'
type: array
- past_duration:
- description: "in format '1 minute', '30 days', '3 months', etc"
- example: 1 hour
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
+ required:
+ - data
+ - links
+ - meta
+ type: object
+ new_workflow_custom_field_selection:
+ properties:
+ data:
+ $ref: '#/components/schemas/new_workflow_custom_field_selection_data'
+ required:
+ - data
+ type: object
+ update_workflow_custom_field_selection:
+ properties:
+ data:
+ $ref: '#/components/schemas/update_workflow_custom_field_selection_data'
+ required:
+ - data
+ type: object
+ workflow_custom_field_selection:
+ properties:
+ workflow_id:
+ description: The workflow for this selection
type: string
- metric_queries:
+ custom_field_id:
+ description: The custom field for this selection
+ type: integer
+ incident_condition:
+ default: ANY
+ description: The trigger condition
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
+ type: string
+ values:
items:
+ description: The value to associate with the custom field trigger
type: string
type: array
- post_to_incident_timeline:
- type: boolean
- post_to_slack_channels:
+ selected_option_ids:
+ items:
+ description: The selected option id for select and multi_select kinds
+ type: integer
+ type: array
+ required:
+ - custom_field_id
+ - incident_condition
+ - selected_option_ids
+ - workflow_id
+ type: object
+ workflow_custom_field_selection_response:
+ properties:
+ data:
+ $ref: '#/components/schemas/workflow_custom_field_selection_response_data'
+ required:
+ - data
+ type: object
+ workflow_custom_field_selection_list:
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/workflow_custom_field_selection_response_data'
+ type: array
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
+ required:
+ - data
+ - links
+ - meta
+ type: object
+ new_workflow_form_field_condition:
+ properties:
+ data:
+ $ref: '#/components/schemas/new_workflow_form_field_condition_data'
+ required:
+ - data
+ type: object
+ update_workflow_form_field_condition:
+ properties:
+ data:
+ $ref: '#/components/schemas/update_workflow_form_field_condition_data'
+ required:
+ - data
+ type: object
+ workflow_form_field_condition:
+ properties:
+ workflow_id:
+ description: The workflow for this condition
+ type: string
+ form_field_id:
+ description: The custom field for this condition
+ type: string
+ incident_condition:
+ default: ANY
+ description: The trigger condition
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
+ type: string
+ values:
+ items:
+ description: The value to associate with the custom field trigger
+ type: string
+ type: array
+ selected_catalog_entity_ids:
+ items:
+ description: The selected catalog entities for select and multi_select
+ kinds
+ type: string
+ type: array
+ selected_functionality_ids:
+ items:
+ description: The selected functionalities for select and multi_select
+ kinds
+ type: string
+ type: array
+ selected_group_ids:
+ items:
+ description: The selected groups (teams) for select and multi_select kinds
+ type: string
+ type: array
+ selected_option_ids:
+ items:
+ description: The selected option id for select and multi_select kinds
+ type: string
+ type: array
+ selected_service_ids:
+ items:
+ description: The selected services for select and multi_select kinds
+ type: string
+ type: array
+ selected_user_ids:
+ items:
+ description: The selected user id for select and multi_select kinds
+ type: integer
+ type: array
+ selected_cause_ids:
+ items:
+ description: The selected causes for select and multi_select kinds
+ type: string
+ type: array
+ selected_environment_ids:
+ items:
+ description: The selected environments for select and multi_select kinds
+ type: string
+ type: array
+ selected_incident_type_ids:
+ items:
+ description: The selected incident types for select and multi_select kinds
+ type: string
+ type: array
+ required:
+ - form_field_id
+ - incident_condition
+ - selected_catalog_entity_ids
+ - selected_option_ids
+ - selected_user_ids
+ - workflow_id
+ type: object
+ workflow_form_field_condition_response:
+ properties:
+ data:
+ $ref: '#/components/schemas/workflow_form_field_condition_response_data'
+ required:
+ - data
+ type: object
+ workflow_form_field_condition_list:
+ properties:
+ data:
items:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ $ref: '#/components/schemas/workflow_form_field_condition_response_data'
type: array
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- - past_duration
+ - data
+ - links
+ - meta
type: object
- snapshot_grafana_dashboard_task_params:
+ new_workflow_group:
properties:
- task_type:
- enum:
- - snapshot_grafana_dashboard
- type: string
- dashboards:
- items:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- type: array
- post_to_incident_timeline:
- type: boolean
- post_to_slack_channels:
- items:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- type: array
+ data:
+ $ref: '#/components/schemas/new_workflow_group_data'
required:
- - dashboards
+ - data
type: object
- snapshot_looker_look_task_params:
+ update_workflow_group:
properties:
- task_type:
- enum:
- - snapshot_looker_look
- type: string
- dashboards:
- items:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- type: array
- post_to_incident_timeline:
- type: boolean
- post_to_slack_channels:
- items:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- type: array
+ data:
+ $ref: '#/components/schemas/update_workflow_group_data'
required:
- - dashboards
+ - data
type: object
- snapshot_new_relic_graph_task_params:
+ workflow_group:
properties:
- task_type:
+ kind:
+ description: The kind of the workflow group
enum:
- - snapshot_looker_graph
+ - simple
+ - incident
+ - post_mortem
+ - action_item
+ - pulse
+ - alert
+ nullable: true
type: string
- metric_query:
+ name:
+ description: The name of the workflow group.
type: string
- metric_type:
- enum:
- - APDEX
- - AREA
- - BAR
- - BASELINE
- - BILLBOARD
- - BULLET
- - EVENT_FEED
- - FUNNEL
- - HEATMAP
- - HISTOGRAM
- - LINE
- - PIE
- - SCATTER
- - STACKED_HORIZONTAL_BAR
- - TABLE
- - VERTICAL_BAR
+ slug:
+ description: The slug of the workflow group.
type: string
- post_to_incident_timeline:
+ description:
+ description: A description of the workflow group.
+ nullable: true
+ type: string
+ icon:
+ description: An emoji icon displayed next to the workflow group.
+ type: string
+ expanded:
+ description: Whether the group is expanded or collapsed.
type: boolean
- post_to_slack_channels:
+ position:
+ description: The position of the workflow group
+ type: integer
+ required:
+ - name
+ - position
+ type: object
+ workflow_group_response:
+ properties:
+ data:
+ $ref: '#/components/schemas/workflow_group_response_data'
+ required:
+ - data
+ type: object
+ workflow_group_list:
+ properties:
+ data:
items:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ $ref: '#/components/schemas/workflow_group_response_data'
type: array
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- - metric_query
- - metric_type
+ - data
+ - links
+ - meta
type: object
- tweet_twitter_message_task_params:
+ new_workflow_run:
properties:
- task_type:
- enum:
- - tweet_twitter_message
- type: string
- message:
- type: string
+ data:
+ $ref: '#/components/schemas/new_workflow_run_data'
required:
- - message
+ - data
type: object
- update_airtable_table_record_task_params:
+ workflow_run:
properties:
- task_type:
- enum:
- - update_airtable_table_record
+ workflow_id:
type: string
- base_key:
- description: The base key
+ status:
+ enum:
+ - queued
+ - started
+ - completed
+ - completed_with_errors
+ - failed
+ - canceled
type: string
- table_name:
- description: The table name
+ status_message:
+ nullable: true
type: string
- record_id:
- description: The record id
+ triggered_by:
+ enum:
+ - system
+ - user
+ - workflow
type: string
- custom_fields_mapping:
- description: Custom field mappings. Can contain liquid markup and need to
- be valid JSON
+ started_at:
nullable: true
type: string
- required:
- - base_key
- - record_id
- - table_name
- type: object
- update_asana_task_task_params:
- properties:
- task_type:
- enum:
- - update_asana_task
+ completed_at:
+ nullable: true
type: string
- task_id:
- description: The task id
+ failed_at:
+ nullable: true
type: string
- title:
- description: The task title
+ canceled_at:
+ nullable: true
type: string
- notes:
+ incident_id:
+ nullable: true
type: string
- assign_user_email:
- description: The assigned user's email
+ post_mortem_id:
+ nullable: true
type: string
- completion:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- due_date:
- description: The due date
+ action_item_id:
+ nullable: true
type: string
- custom_fields_mapping:
- description: Custom field mappings. Can contain liquid markup and need to
- be valid JSON
+ alert_id:
nullable: true
type: string
- dependency_direction:
- default: blocking
- enum:
- - blocking
- - blocked_by
+ pulse_id:
+ nullable: true
type: string
- dependent_task_ids:
- description: Dependent task ids. Supports liquid syntax
+ context:
+ additionalProperties: true
+ type: object
+ required:
+ - status
+ - triggered_by
+ - workflow_id
+ type: object
+ workflow_run_response:
+ properties:
+ data:
+ $ref: '#/components/schemas/workflow_run_response_data'
+ required:
+ - data
+ type: object
+ workflow_runs_list:
+ properties:
+ data:
items:
- type: string
- nullable: true
+ $ref: '#/components/schemas/workflow_run_response_data'
type: array
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- - completion
- - task_id
+ - data
+ - links
+ - meta
type: object
- update_github_issue_task_params:
+ new_workflow:
properties:
- task_type:
+ data:
+ $ref: '#/components/schemas/new_workflow_data'
+ required:
+ - data
+ type: object
+ incident_trigger_params:
+ properties:
+ trigger_type:
enum:
- - update_github_issue
+ - incident
type: string
- issue_id:
- description: The issue id
+ triggers:
+ items:
+ description: "Actions that trigger the workflow. One of custom_fields..updated,\
+ \ incident_in_triage, incident_created, incident_started, incident_updated,\
+ \ title_updated, summary_updated, status_updated, severity_updated,\
+ \ environments_added, environments_removed, environments_updated, incident_types_added,\
+ \ incident_types_removed, incident_types_updated, services_added, services_removed,\
+ \ services_updated, visibility_updated, functionalities_added, functionalities_removed,\
+ \ functionalities_updated, teams_added, teams_removed, teams_updated,\
+ \ causes_added, causes_removed, causes_updated, timeline_updated, status_page_timeline_updated,\
+ \ role_assignments_updated, role_assignments_added, role_assignments_removed,\
+ \ slack_command, slack_channel_created, slack_channel_converted, microsoft_teams_channel_created,\
+ \ microsoft_teams_chat_created, subscribers_updated, subscribers_added,\
+ \ subscribers_removed, user_joined_slack_channel, user_left_slack_channel"
+ type: string
+ type: array
+ incident_visibilities:
+ items:
+ type: boolean
+ type: array
+ incident_kinds:
+ items:
+ enum:
+ - test
+ - test_sub
+ - example
+ - example_sub
+ - normal
+ - normal_sub
+ - backfilled
+ - scheduled
+ - scheduled_sub
+ type: string
+ type: array
+ incident_statuses:
+ items:
+ enum:
+ - in_triage
+ - started
+ - detected
+ - acknowledged
+ - mitigated
+ - resolved
+ - closed
+ - cancelled
+ - scheduled
+ - in_progress
+ - completed
+ type: string
+ type: array
+ incident_inactivity_duration:
+ description: "ex. 10 min, 1h, 3 days, 2 weeks"
+ nullable: true
type: string
- title:
- description: The issue title
+ incident_condition:
+ default: ALL
+ enum:
+ - ALL
+ - ANY
+ - NONE
type: string
- body:
- description: The issue body
+ incident_condition_visibility:
+ default: ANY
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- completion:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- required:
- - completion
- - issue_id
- type: object
- update_gitlab_issue_task_params:
- properties:
- task_type:
+ incident_condition_kind:
+ default: IS
enum:
- - update_gitlab_issue
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- issue_id:
- description: The issue id
+ incident_condition_status:
+ default: ANY
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- issue_type:
- description: The issue type
+ incident_condition_sub_status:
+ default: ANY
enum:
- - issue
- - incident
- - test_case
- - task
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- title:
- description: The issue title
+ incident_condition_environment:
+ default: ANY
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- description:
- description: The issue description
+ incident_condition_severity:
+ default: ANY
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- labels:
- description: The issue labels
+ incident_condition_incident_type:
+ default: ANY
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- due_date:
- description: The due date
+ incident_condition_incident_roles:
+ default: ANY
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- completion:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- required:
- - completion
- - issue_id
- type: object
- update_incident_task_params:
- properties:
- task_type:
+ incident_condition_service:
+ default: ANY
enum:
- - update_incident
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- attribute_to_query_by:
- default: id
+ incident_condition_functionality:
+ default: ANY
enum:
- - id
- - slug
- - sequential_id
- - pagerduty_incident_id
- - opsgenie_incident_id
- - victor_ops_incident_id
- - jira_issue_id
- - asana_task_id
- - shortcut_task_id
- - linear_issue_id
- - zendesk_ticket_id
- - motion_task_id
- - trello_card_id
- - airtable_record_id
- - shortcut_story_id
- - github_issue_id
- - gitlab_issue_id
- - freshservice_ticket_id
- - freshservice_task_id
- - clickup_task_id
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
+ type: string
+ incident_condition_group:
+ default: ANY
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
+ type: string
+ incident_condition_cause:
+ default: ANY
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
+ type: string
+ incident_post_mortem_condition_cause:
+ default: ANY
+ description: "[DEPRECATED] Use incident_condition_cause instead"
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- incident_id:
- description: The incident id to update or id of any attribute on the incident
+ incident_condition_summary:
+ enum:
+ - SET
+ - UNSET
+ nullable: true
type: string
- title:
- description: The incident title
+ incident_condition_started_at:
+ enum:
+ - SET
+ - UNSET
nullable: true
type: string
- summary:
- description: The incident summary
+ incident_condition_detected_at:
+ enum:
+ - SET
+ - UNSET
nullable: true
type: string
- status:
+ incident_condition_acknowledged_at:
+ enum:
+ - SET
+ - UNSET
nullable: true
type: string
- severity_id:
+ incident_condition_mitigated_at:
+ enum:
+ - SET
+ - UNSET
nullable: true
type: string
- incident_type_ids:
- items:
- type: string
+ incident_condition_resolved_at:
+ enum:
+ - SET
+ - UNSET
nullable: true
- type: array
- service_ids:
+ type: string
+ incident_conditional_inactivity:
+ enum:
+ - IS
+ nullable: true
+ type: string
+ required:
+ - trigger_type
+ type: object
+ post_mortem_trigger_params:
+ properties:
+ trigger_type:
+ enum:
+ - post_mortem
+ type: string
+ triggers:
items:
+ description: "Actions that trigger the workflow. One of custom_fields..updated,\
+ \ post_mortem_created, post_mortem_updated, status_updated, slack_command"
type: string
- nullable: true
type: array
- functionality_ids:
+ incident_visibilities:
items:
- type: string
- nullable: true
+ type: boolean
type: array
- environment_ids:
+ incident_kinds:
items:
+ enum:
+ - test
+ - test_sub
+ - example
+ - example_sub
+ - normal
+ - normal_sub
+ - backfilled
+ - scheduled
+ - scheduled_sub
type: string
- nullable: true
type: array
- group_ids:
+ incident_statuses:
items:
+ enum:
+ - in_triage
+ - started
+ - detected
+ - acknowledged
+ - mitigated
+ - resolved
+ - closed
+ - cancelled
+ - scheduled
+ - in_progress
+ - completed
type: string
- nullable: true
type: array
- started_at:
- nullable: true
- type: string
- detected_at:
+ incident_inactivity_duration:
+ description: "ex. 10 min, 1h, 3 days, 2 weeks"
nullable: true
type: string
- acknowledged_at:
- nullable: true
+ incident_condition:
+ default: ALL
+ enum:
+ - ALL
+ - ANY
+ - NONE
type: string
- mitigated_at:
- nullable: true
+ incident_condition_visibility:
+ default: ANY
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- resolved_at:
- nullable: true
+ incident_condition_kind:
+ default: IS
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- private:
- type: boolean
- custom_fields_mapping:
- description: Custom field mappings. Can contain liquid markup and need to
- be valid JSON
- nullable: true
+ incident_condition_status:
+ default: ANY
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- required:
- - incident_id
- type: object
- update_incident_postmortem_task_params:
- properties:
- task_type:
+ incident_condition_sub_status:
+ default: ANY
enum:
- - update_incident_postmortem
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- postmortem_id:
- description: UUID of the retrospective that needs to be updated
+ incident_condition_environment:
+ default: ANY
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- title:
- description: The incident title
- nullable: true
+ incident_condition_severity:
+ default: ANY
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- status:
- nullable: true
+ incident_condition_incident_type:
+ default: ANY
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- required:
- - postmortem_id
- type: object
- update_jira_issue_task_params:
- properties:
- task_type:
+ incident_condition_incident_roles:
+ default: ANY
enum:
- - update_jira_issue
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- issue_id:
- description: The issue id
+ incident_condition_service:
+ default: ANY
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- title:
- description: The issue title
+ incident_condition_functionality:
+ default: ANY
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- description:
- description: The issue description
+ incident_condition_group:
+ default: ANY
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- labels:
- description: The issue labels
+ incident_condition_cause:
+ default: ANY
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- assign_user_email:
- description: The assigned user's email
+ incident_post_mortem_condition_cause:
+ default: ANY
+ description: "[DEPRECATED] Use incident_condition_cause instead"
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- reporter_user_email:
- description: The reporter user's email
+ incident_condition_summary:
+ enum:
+ - SET
+ - UNSET
+ nullable: true
type: string
- project_key:
- description: The project key
+ incident_condition_started_at:
+ enum:
+ - SET
+ - UNSET
+ nullable: true
type: string
- due_date:
- description: The due date
+ incident_condition_detected_at:
+ enum:
+ - SET
+ - UNSET
+ nullable: true
type: string
- priority:
- $ref: '#/components/schemas/create_jira_issue_task_params_priority'
- status:
- $ref: '#/components/schemas/create_jira_issue_task_params_status'
- custom_fields_mapping:
- description: Custom field mappings. Can contain liquid markup and need to
- be valid JSON
+ incident_condition_acknowledged_at:
+ enum:
+ - SET
+ - UNSET
nullable: true
type: string
- update_payload:
- description: Update payload. Can contain liquid markup and need to be valid
- JSON
+ incident_condition_mitigated_at:
+ enum:
+ - SET
+ - UNSET
nullable: true
type: string
- required:
- - issue_id
- - project_key
- type: object
- update_linear_issue_task_params:
- properties:
- task_type:
+ incident_condition_resolved_at:
enum:
- - update_linear_issue
+ - SET
+ - UNSET
+ nullable: true
type: string
- issue_id:
- description: The issue id
+ incident_conditional_inactivity:
+ enum:
+ - IS
+ nullable: true
type: string
- title:
- description: The issue title
+ incident_post_mortem_condition:
+ enum:
+ - ALL
+ - ANY
+ - NONE
type: string
- description:
- description: The issue description
+ incident_post_mortem_condition_status:
+ default: ANY
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- state:
- $ref: '#/components/schemas/create_linear_issue_task_params_state'
- project:
- $ref: '#/components/schemas/create_linear_issue_task_params_project'
- labels:
+ incident_post_mortem_statuses:
items:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ enum:
+ - draft
+ - published
+ type: string
type: array
- priority:
- $ref: '#/components/schemas/create_jira_issue_task_params_priority'
- assign_user_email:
- description: The assigned user's email
- type: string
required:
- - issue_id
+ - trigger_type
type: object
- update_service_now_incident_task_params:
+ action_item_trigger_params:
properties:
- task_type:
+ trigger_type:
enum:
- - update_service_now_incident
- type: string
- incident_id:
- description: The incident id
- type: string
- title:
- description: The incident title
- type: string
- description:
- description: The incident description
+ - action_item
type: string
- priority:
- $ref: '#/components/schemas/create_jira_issue_task_params_priority'
- completion:
- $ref: '#/components/schemas/create_service_now_incident_task_params_completion'
- custom_fields_mapping:
- description: Custom field mappings. Can contain liquid markup and need to
- be valid JSON
+ triggers:
+ items:
+ description: "Actions that trigger the workflow. One of custom_fields..updated,\
+ \ incident_updated, action_item_created, action_item_updated, assigned_user_updated,\
+ \ summary_updated, description_updated, status_updated, priority_updated,\
+ \ due_date_updated, teams_updated, slack_command"
+ type: string
+ type: array
+ incident_visibilities:
+ items:
+ type: boolean
+ type: array
+ incident_kinds:
+ items:
+ enum:
+ - test
+ - test_sub
+ - example
+ - example_sub
+ - normal
+ - normal_sub
+ - backfilled
+ - scheduled
+ - scheduled_sub
+ type: string
+ type: array
+ incident_statuses:
+ items:
+ enum:
+ - in_triage
+ - started
+ - detected
+ - acknowledged
+ - mitigated
+ - resolved
+ - closed
+ - cancelled
+ - scheduled
+ - in_progress
+ - completed
+ type: string
+ type: array
+ incident_inactivity_duration:
+ description: "ex. 10 min, 1h, 3 days, 2 weeks"
nullable: true
type: string
- required:
- - incident_id
- type: object
- update_shortcut_story_task_params:
- properties:
- task_type:
+ incident_condition:
+ default: ALL
enum:
- - update_shortcut_story
+ - ALL
+ - ANY
+ - NONE
type: string
- story_id:
- description: The story id
+ incident_condition_visibility:
+ default: ANY
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- title:
- description: The incident title
+ incident_condition_kind:
+ default: IS
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- description:
- description: The incident description
+ incident_condition_status:
+ default: ANY
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
+ type: string
+ incident_condition_sub_status:
+ default: ANY
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- labels:
- description: The story labels
+ incident_condition_environment:
+ default: ANY
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- due_date:
- description: The due date
+ incident_condition_severity:
+ default: ANY
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- archivation:
- $ref: '#/components/schemas/create_trello_card_task_params_archivation'
- required:
- - archivation
- - story_id
- type: object
- update_shortcut_task_task_params:
- properties:
- task_type:
+ incident_condition_incident_type:
+ default: ANY
enum:
- - update_shortcut_task
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- task_id:
- description: The task id
+ incident_condition_incident_roles:
+ default: ANY
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- parent_story_id:
- description: The parent story
+ incident_condition_service:
+ default: ANY
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- description:
- description: The task description
+ incident_condition_functionality:
+ default: ANY
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- completion:
- $ref: '#/components/schemas/create_service_now_incident_task_params_completion'
- required:
- - completion
- - parent_story_id
- - task_id
- type: object
- update_slack_channel_topic_task_params:
- properties:
- task_type:
+ incident_condition_group:
+ default: ANY
enum:
- - update_slack_channel_topic
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- channel:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- topic:
+ incident_condition_summary:
+ enum:
+ - SET
+ - UNSET
+ nullable: true
type: string
- required:
- - channel
- - topic
- type: object
- update_status_task_params:
- properties:
- task_type:
+ incident_condition_started_at:
enum:
- - update_status
+ - SET
+ - UNSET
+ nullable: true
type: string
- status:
+ incident_condition_detected_at:
enum:
- - in_triage
- - started
- - mitigated
- - resolved
- - closed
- - cancelled
+ - SET
+ - UNSET
+ nullable: true
type: string
- inactivity_timeout:
- description: "In format '1 hour', '1 day', etc"
- example: 1 hour
+ incident_condition_acknowledged_at:
+ enum:
+ - SET
+ - UNSET
+ nullable: true
type: string
- required:
- - status
- type: object
- update_incident_status_timestamp_task_params:
- properties:
- task_type:
+ incident_condition_mitigated_at:
enum:
- - update_status
+ - SET
+ - UNSET
+ nullable: true
type: string
- sub_status_id:
- description: Sub-status to update timestamp for
+ incident_condition_resolved_at:
+ enum:
+ - SET
+ - UNSET
+ nullable: true
type: string
- assigned_at:
- description: Timestamp of when the sub-status was assigned
+ incident_conditional_inactivity:
+ enum:
+ - IS
+ nullable: true
type: string
- required:
- - assigned_at
- - sub_status_id
- type: object
- update_trello_card_task_params:
- properties:
- task_type:
+ incident_action_item_condition:
enum:
- - update_trello_card
+ - ALL
+ - ANY
+ - NONE
type: string
- card_id:
- description: The card id
+ incident_action_item_condition_kind:
+ default: ANY
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- title:
- description: The card title
+ incident_action_item_kinds:
+ items:
+ enum:
+ - task
+ - follow_up
+ type: string
+ type: array
+ incident_action_item_condition_status:
+ default: ANY
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- description:
- description: The card description
+ incident_action_item_statuses:
+ items:
+ enum:
+ - open
+ - in_progress
+ - cancelled
+ - done
+ type: string
+ type: array
+ incident_action_item_condition_priority:
+ default: ANY
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- due_date:
- description: The due date
+ incident_action_item_priorities:
+ items:
+ enum:
+ - high
+ - medium
+ - low
+ type: string
+ type: array
+ incident_action_item_condition_group:
+ default: ANY
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- board:
- $ref: '#/components/schemas/create_trello_card_task_params_board'
- list:
- $ref: '#/components/schemas/create_trello_card_task_params_list'
- labels:
+ incident_action_item_group_ids:
items:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
+ type: string
type: array
- archivation:
- $ref: '#/components/schemas/create_trello_card_task_params_archivation'
required:
- - archivation
- - card_id
+ - trigger_type
type: object
- update_clickup_task_task_params:
+ alert_trigger_params:
properties:
- task_type:
+ trigger_type:
enum:
- - update_clickup_task
+ - alert
type: string
- task_id:
- description: The task id
+ triggers:
+ items:
+ description: Actions that trigger the workflow
+ enum:
+ - alert_created
+ - alert_status_updated
+ type: string
+ type: array
+ alert_condition:
+ enum:
+ - ALL
+ - ANY
+ - NONE
type: string
- title:
- description: The task title
+ alert_condition_source:
+ default: ANY
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- description:
- description: The task description
+ alert_condition_source_use_regexp:
+ default: false
+ type: boolean
+ alert_sources:
+ items:
+ type: string
+ type: array
+ alert_condition_label:
+ default: ANY
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- tags:
- description: The task tags
+ alert_condition_label_use_regexp:
+ default: false
+ type: boolean
+ alert_condition_status:
+ default: ANY
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- priority:
- $ref: '#/components/schemas/create_jira_issue_task_params_priority'
- due_date:
- description: The due date
+ alert_condition_status_use_regexp:
+ default: false
+ type: boolean
+ alert_statuses:
+ items:
+ type: string
+ type: array
+ alert_labels:
+ items:
+ type: string
+ type: array
+ alert_condition_urgency:
+ default: ANY
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- custom_fields_mapping:
- description: Custom field mappings. Can contain liquid markup and need to
- be valid JSON
- nullable: true
+ alert_urgency_ids:
+ items:
+ format: uuid
+ type: string
+ type: array
+ alert_condition_payload:
+ default: ANY
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- task_payload:
- description: Additional ClickUp task attributes. Will be merged into whatever
- was specified in this tasks current parameters. Can contain liquid markup
- and need to be valid JSON
+ alert_condition_payload_use_regexp:
+ default: false
+ type: boolean
+ alert_payload:
+ items:
+ type: string
+ type: array
+ alert_query_payload:
+ description: "You can use jsonpath syntax. eg: $.incident.teams[*]"
nullable: true
type: string
+ alert_field_conditions:
+ items:
+ $ref: '#/components/schemas/alert_trigger_params_alert_field_conditions_inner'
+ type: array
+ alert_payload_conditions:
+ $ref: '#/components/schemas/alert_trigger_params_alert_payload_conditions'
required:
- - task_id
+ - trigger_type
type: object
- update_motion_task_task_params:
+ pulse_trigger_params:
properties:
- task_type:
+ trigger_type:
enum:
- - update_motion_task
- type: string
- task_id:
- description: The task id
- type: string
- title:
- description: The task title
- type: string
- description:
- description: The task description
+ - pulse
type: string
- labels:
+ triggers:
items:
+ description: Actions that trigger the workflow
+ enum:
+ - pulse_created
type: string
type: array
- priority:
- $ref: '#/components/schemas/create_jira_issue_task_params_priority'
- duration:
- description: "The duration. Eg. \"NONE\", \"REMINDER\", or a integer greater\
- \ than 0."
- type: string
- due_date:
- description: The due date
- type: string
- required:
- - task_id
- type: object
- update_zendesk_ticket_task_params:
- properties:
- task_type:
+ pulse_condition:
enum:
- - update_zendesk_ticket
- type: string
- ticket_id:
- description: The ticket id
+ - ALL
+ - ANY
+ - NONE
type: string
- subject:
- description: The ticket subject
+ pulse_condition_source:
+ default: ANY
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- tags:
- description: The ticket tags
+ pulse_condition_source_use_regexp:
+ default: false
+ type: boolean
+ pulse_sources:
+ items:
+ type: string
+ type: array
+ pulse_condition_label:
+ default: ANY
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- priority:
- $ref: '#/components/schemas/create_jira_issue_task_params_priority'
- completion:
- $ref: '#/components/schemas/create_service_now_incident_task_params_completion'
- custom_fields_mapping:
- description: Custom field mappings. Can contain liquid markup and need to
- be valid JSON
- nullable: true
+ pulse_condition_label_use_regexp:
+ default: false
+ type: boolean
+ pulse_labels:
+ items:
+ type: string
+ type: array
+ pulse_condition_payload:
+ default: ANY
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
type: string
- ticket_payload:
- description: Additional Zendesk ticket attributes. Will be merged into whatever
- was specified in this tasks current parameters. Can contain liquid markup
- and need to be valid JSON
+ pulse_condition_payload_use_regexp:
+ default: false
+ type: boolean
+ pulse_payload:
+ items:
+ type: string
+ type: array
+ pulse_query_payload:
+ description: "You can use jsonpath syntax. eg: $.incident.teams[*]"
nullable: true
type: string
required:
- - ticket_id
+ - trigger_type
type: object
- update_attached_alerts_task_params:
+ simple_trigger_params:
properties:
- task_type:
- enum:
- - update_attached_alerts
- type: string
- status:
+ trigger_type:
enum:
- - acknowledged
- - resolved
+ - simple
type: string
+ triggers:
+ items:
+ description: Actions that trigger the workflow
+ enum:
+ - slack_command
+ type: string
+ type: array
required:
- - status
+ - trigger_type
type: object
- trigger_workflow_task_params:
+ update_workflow:
properties:
- task_type:
- enum:
- - trigger_workflow
+ data:
+ $ref: '#/components/schemas/update_workflow_data'
+ required:
+ - data
+ type: object
+ workflow:
+ properties:
+ name:
+ description: The title of the workflow
type: string
- kind:
- default: incident
- enum:
- - incident
- - post_mortem
- - action_item
- - pulse
- - alert
+ slug:
+ description: The slug of the workflow
type: string
- attribute_to_query_by:
- default: id
- description: "[\"(incident) kind can only match [:id, :slug, :sequential_id,\
- \ :pagerduty_incident_id, :opsgenie_incident_id, :victor_ops_incident_id,\
- \ :jira_issue_id, :asana_task_id, :shortcut_task_id, :linear_issue_id,\
- \ :zendesk_ticket_id, :motion_task_id, :trello_card_id, :airtable_record_id,\
- \ :shortcut_story_id, :github_issue_id, :freshservice_ticket_id, :freshservice_task_id,\
- \ :clickup_task_id]\", \"(post_mortem) kind can only match [:id]\", \"\
- (action_item) kind can only match [:id, :jira_issue_id, :asana_task_id,\
- \ :shortcut_task_id, :linear_issue_id, :zendesk_ticket_id, :motion_task_id,\
- \ :trello_card_id, :airtable_record_id, :shortcut_story_id, :github_issue_id,\
- \ :freshservice_ticket_id, :freshservice_task_id, :clickup_task_id]\"\
- , \"(pulse) kind can only match [:id]\", \"(alert) kind can only match\
- \ [:id]\"]"
- enum:
- - id
- - slug
- - sequential_id
- - pagerduty_incident_id
- - opsgenie_incident_id
- - victor_ops_incident_id
- - jira_issue_id
- - asana_task_id
- - shortcut_task_id
- - linear_issue_id
- - zendesk_ticket_id
- - motion_task_id
- - trello_card_id
- - airtable_record_id
- - shortcut_story_id
- - github_issue_id
- - freshservice_ticket_id
- - freshservice_task_id
- - clickup_task_id
+ description:
+ description: The description of the workflow
+ nullable: true
type: string
- resource:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- workflow:
- $ref: '#/components/schemas/add_action_item_task_params_post_to_slack_channels_inner'
- check_workflow_conditions:
+ command:
+ description: Workflow command
+ nullable: true
+ type: string
+ command_feedback_enabled:
+ description: This will notify you back when the workflow is starting
+ nullable: true
type: boolean
- required:
- - attribute_to_query_by
- - kind
- - resource
- - workflow
- type: object
- send_slack_blocks_task_params:
- anyOf: []
- nullable: true
- properties:
- task_type:
- enum:
- - send_slack_blocks
+ wait:
+ description: Wait this duration before executing
+ nullable: true
type: string
- message:
+ repeat_every_duration:
+ description: Repeat workflow every duration
+ nullable: true
type: string
- blocks:
- description: Support liquid markup. Needs to be a valid JSON string after
- liquid is parsed
+ repeat_condition_duration_since_first_run:
+ description: The workflow will stop repeating if its runtime since it's
+ first workflow run exceeds the duration set in this field
+ nullable: true
type: string
- attachments:
- description: Support liquid markup. Needs to be a valid JSON string after
- liquid is parsed
+ repeat_condition_number_of_repeats:
+ description: The workflow will stop repeating if the number of repeats exceeds
+ the value set in this field
+ type: integer
+ continuously_repeat:
+ description: "When continuously repeat is true, repeat workflows aren't\
+ \ automatically stopped when conditions aren't met. This setting won't\
+ \ override your conditions set by repeat_condition_duration_since_first_run\
+ \ and repeat_condition_number_of_repeats parameters."
+ type: boolean
+ repeat_on:
+ items:
+ description: Repeat on weekdays
+ enum:
+ - S
+ - M
+ - T
+ - W
+ - R
+ - F
+ - U
+ type: string
+ nullable: true
+ type: array
+ enabled:
+ type: boolean
+ locked:
+ description: Restricts workflow edits to admins when turned on. Only admins
+ can set this field.
+ type: boolean
+ position:
+ description: The order which the workflow should run with other workflows.
+ type: integer
+ workflow_group_id:
+ description: The group this workflow belongs to.
+ nullable: true
type: string
- channels:
+ trigger_params:
+ $ref: '#/components/schemas/new_workflow_data_attributes_trigger_params'
+ environment_ids:
items:
- properties:
- id:
- type: string
- name:
- type: string
- type: object
+ type: string
type: array
- slack_users:
+ severity_ids:
items:
- properties:
- id:
- type: string
- name:
- type: string
- type: object
+ type: string
type: array
- slack_user_groups:
+ incident_type_ids:
items:
- properties:
- id:
- type: string
- name:
- type: string
- type: object
+ type: string
type: array
- broadcast_thread_reply_to_channel:
- type: boolean
- send_as_ephemeral:
- type: boolean
- pin_to_channel:
- type: boolean
- thread_ts:
- description: The thread to send the message into
+ incident_role_ids:
+ items:
+ type: string
+ type: array
+ service_ids:
+ items:
+ type: string
+ type: array
+ functionality_ids:
+ items:
+ type: string
+ type: array
+ group_ids:
+ items:
+ type: string
+ type: array
+ cause_ids:
+ items:
+ type: string
+ type: array
+ sub_status_ids:
+ items:
+ type: string
+ type: array
+ created_at:
+ description: Date of creation
+ type: string
+ updated_at:
+ description: Date of last update
type: string
- update_parent_message:
- type: boolean
- parent_message_thread_task:
- description: "A hash where [id] is the task id of the parent task that sent\
- \ a message, and [name] is the name of the parent task"
- properties:
- id:
- type: string
- name:
- type: string
- type: object
- send_only_as_threaded_message:
- description: "When set to true, if the parent for this threaded message\
- \ cannot be found the message will be skipped."
- type: boolean
required:
- - blocks
+ - created_at
+ - name
+ - updated_at
type: object
- genius_create_openai_chat_completion_task_params:
+ workflow_response:
properties:
- task_type:
- enum:
- - genius_openai_chat_completion
- type: string
- model:
- $ref: '#/components/schemas/genius_create_openai_chat_completion_task_params_model'
- prompt:
- description: The prompt to send to OpenAI
- type: string
+ data:
+ $ref: '#/components/schemas/workflow_response_data'
required:
- - model
- - prompt
+ - data
type: object
- genius_create_watsonx_chat_completion_task_params:
+ workflow_list:
properties:
- task_type:
- enum:
- - genius_create_watsonx_chat_completion_task
- type: string
- model:
- $ref: '#/components/schemas/genius_create_watsonx_chat_completion_task_params_model'
- prompt:
- description: The prompt to send to WatsonX
- type: string
- project_id:
- type: string
+ data:
+ items:
+ $ref: '#/components/schemas/workflow_response_data'
+ type: array
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- - model
- - project_id
- - prompt
+ - data
+ - links
+ - meta
type: object
- new_workflow_task:
+ new_live_call_router:
properties:
data:
- $ref: '#/components/schemas/new_workflow_task_data'
+ $ref: '#/components/schemas/new_live_call_router_data'
required:
- data
type: object
- update_workflow_task:
+ update_live_call_router:
properties:
data:
- $ref: '#/components/schemas/update_workflow_task_data'
+ $ref: '#/components/schemas/update_live_call_router_data'
required:
- data
type: object
- workflow_task:
+ live_call_router:
properties:
- workflow_id:
- description: The ID of the parent workflow
+ kind:
+ description: The kind of the live_call_router
+ enum:
+ - voicemail
+ - live
type: string
- task_params:
- $ref: '#/components/schemas/new_workflow_task_data_attributes_task_params'
+ enabled:
+ description: Whether the live_call_router is enabled
+ type: boolean
name:
- description: Name of the workflow task
+ description: The name of the live_call_router
type: string
- position:
- description: The position of the workflow task
+ country_code:
+ description: The country code of the live_call_router
+ enum:
+ - AU
+ - CA
+ - DE
+ - NL
+ - NZ
+ - SE
+ - GB
+ - US
+ type: string
+ phone_type:
+ description: The phone type of the live_call_router
+ enum:
+ - local
+ - toll_free
+ - mobile
+ type: string
+ phone_number:
+ description: "You can select a phone number using [generate_phone_number](#//api/v1/live_call_routers/generate_phone_number)\
+ \ API and pass that phone number here to register"
+ type: string
+ voicemail_greeting:
+ description: The voicemail greeting of the live_call_router
+ type: string
+ caller_greeting:
+ description: The caller greeting message of the live_call_router
+ type: string
+ waiting_music_url:
+ description: The waiting music URL of the live_call_router
+ enum:
+ - https://storage.rootly.com/twilio/voicemail/ClockworkWaltz.mp3
+ - https://storage.rootly.com/twilio/voicemail/ith_brahms-116-4.mp3
+ - https://storage.rootly.com/twilio/voicemail/Mellotroniac_-_Flight_Of_Young_Hearts_Flute.mp3
+ - https://storage.rootly.com/twilio/voicemail/BusyStrings.mp3
+ - https://storage.rootly.com/twilio/voicemail/oldDog_-_endless_goodbye_%28instr.%29.mp3
+ - https://storage.rootly.com/twilio/voicemail/MARKOVICHAMP-Borghestral.mp3
+ - https://storage.rootly.com/twilio/voicemail/ith_chopin-15-2.mp3
+ type: string
+ sent_to_voicemail_delay:
+ description: The delay (seconds) after which the caller in redirected to
+ voicemail
type: integer
- skip_on_failure:
- description: Skip workflow task if any failures
+ should_redirect_to_voicemail_on_no_answer:
+ description: This prompts the caller to choose voicemail or connect live
type: boolean
- enabled:
- default: true
- description: Enable/disable workflow task
+ escalation_level_delay_in_seconds:
+ description: This overrides the delay (seconds) in escalation levels
+ type: integer
+ should_auto_resolve_alert_on_call_end:
+ description: This overrides the delay (seconds) in escalation levels
type: boolean
+ alert_urgency_id:
+ description: This is used in escalation paths to determine who to page
+ type: string
+ calling_tree_prompt:
+ description: "The audio instructions callers will hear when they call this\
+ \ number, prompting them to select from available options to route their\
+ \ call"
+ type: string
+ paging_targets:
+ description: Paging targets that callers can select from when this live
+ call router is configured as a phone tree.
+ items:
+ $ref: '#/components/schemas/new_live_call_router_data_attributes_paging_targets_inner'
+ type: array
+ escalation_policy_trigger_params:
+ $ref: '#/components/schemas/update_live_call_router_data_attributes_escalation_policy_trigger_params'
created_at:
description: Date of creation
type: string
@@ -45530,1551 +35417,1362 @@ components:
type: string
required:
- created_at
- - enabled
- - position
- - skip_on_failure
- - task_params
+ - name
- updated_at
- - workflow_id
type: object
- workflow_task_response:
+ live_call_router_response:
properties:
data:
- $ref: '#/components/schemas/workflow_task_response_data'
+ $ref: '#/components/schemas/live_call_router_response_data'
required:
- data
type: object
- workflow_task_list:
+ live_call_router_list:
properties:
data:
items:
- $ref: '#/components/schemas/workflow_task_response_data'
+ $ref: '#/components/schemas/live_call_router_response_data'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- new_workflow_custom_field_selection:
+ new_heartbeat:
properties:
data:
- $ref: '#/components/schemas/new_workflow_custom_field_selection_data'
+ $ref: '#/components/schemas/new_heartbeat_data'
required:
- data
type: object
- update_workflow_custom_field_selection:
+ update_heartbeat:
properties:
data:
- $ref: '#/components/schemas/update_workflow_custom_field_selection_data'
+ $ref: '#/components/schemas/update_heartbeat_data'
required:
- data
type: object
- workflow_custom_field_selection:
+ heartbeat:
properties:
- workflow_id:
- description: The workflow for this selection
+ name:
+ description: The name of the heartbeat
type: string
- custom_field_id:
- description: The custom field for this selection
+ description:
+ description: The description of the heartbeat
+ nullable: true
+ type: string
+ alert_summary:
+ description: Summary of alerts triggered when heartbeat expires.
+ type: string
+ alert_description:
+ description: Description of alerts triggered when heartbeat expires.
+ nullable: true
+ type: string
+ alert_urgency_id:
+ description: Urgency of alerts triggered when heartbeat expires.
+ nullable: true
+ type: string
+ interval:
type: integer
- incident_condition:
- default: ANY
- description: The trigger condition
+ interval_unit:
enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
+ - minutes
+ - hours
+ - days
+ type: string
+ notification_target_id:
+ type: string
+ notification_target_type:
+ description: The type of the notification target. Please contact support
+ if you encounter issues using `Functionality` as a target type.
+ enum:
+ - User
+ - Group
+ - Service
+ - EscalationPolicy
+ - Functionality
+ type: string
+ enabled:
+ description: Whether to trigger alerts when heartbeat is expired.
+ type: boolean
+ status:
+ enum:
+ - waiting
+ - active
+ - expired
+ type: string
+ ping_url:
+ description: URL to receive heartbeat pings.
+ nullable: true
+ type: string
+ secret:
+ description: Secret used as bearer token when pinging heartbeat.
+ nullable: true
+ type: string
+ email_address:
+ description: Email address to receive heartbeat pings.
+ type: string
+ last_pinged_at:
+ description: When the heartbeat was last pinged.
+ nullable: true
+ type: string
+ expires_at:
+ description: When heartbeat expires
+ nullable: true
+ type: string
+ created_at:
+ description: Date of creation
+ type: string
+ updated_at:
+ description: Date of last update
type: string
- values:
- items:
- description: The value to associate with the custom field trigger
- type: string
- type: array
- selected_option_ids:
- items:
- description: The selected option id for select and multi_select kinds
- type: integer
- type: array
required:
- - custom_field_id
- - incident_condition
- - selected_option_ids
- - workflow_id
+ - alert_summary
+ - created_at
+ - email_address
+ - enabled
+ - interval
+ - interval_unit
+ - name
+ - notification_target_id
+ - notification_target_type
+ - status
+ - updated_at
type: object
- workflow_custom_field_selection_response:
+ heartbeat_response:
properties:
data:
- $ref: '#/components/schemas/workflow_custom_field_selection_response_data'
+ $ref: '#/components/schemas/heartbeat_response_data'
required:
- data
type: object
- workflow_custom_field_selection_list:
+ heartbeat_list:
properties:
data:
items:
- $ref: '#/components/schemas/workflow_custom_field_selection_response_data'
+ $ref: '#/components/schemas/heartbeat_response_data'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- new_workflow_form_field_condition:
+ new_incident_action_item:
properties:
data:
- $ref: '#/components/schemas/new_workflow_form_field_condition_data'
+ $ref: '#/components/schemas/new_incident_action_item_data'
required:
- data
type: object
- update_workflow_form_field_condition:
+ update_incident_action_item:
properties:
data:
- $ref: '#/components/schemas/update_workflow_form_field_condition_data'
+ $ref: '#/components/schemas/update_incident_action_item_data'
required:
- data
type: object
- workflow_form_field_condition:
+ incident_action_item:
properties:
- workflow_id:
- description: The workflow for this condition
+ summary:
+ description: The summary of the action item
type: string
- form_field_id:
- description: The custom field for this condition
+ description:
+ description: The description of incident action item
+ nullable: true
type: string
- incident_condition:
- default: ANY
- description: The trigger condition
+ kind:
+ description: The kind of the action item
enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
+ - task
+ - follow_up
type: string
- values:
- items:
- description: The value to associate with the custom field trigger
- type: string
- type: array
- selected_catalog_entity_ids:
- items:
- description: The selected catalog entities for select and multi_select
- kinds
- type: string
- type: array
- selected_functionality_ids:
- items:
- description: The selected functionalities for select and multi_select
- kinds
- type: string
- type: array
- selected_group_ids:
- items:
- description: The selected groups (teams) for select and multi_select kinds
- type: string
- type: array
- selected_option_ids:
- items:
- description: The selected option id for select and multi_select kinds
- type: string
- type: array
- selected_service_ids:
+ assigned_to:
+ allOf:
+ - $ref: '#/components/schemas/user_flat_response'
+ description: User assigned to this action item
+ nullable: true
+ type: object
+ assigned_to_group_ids:
+ description: IDs of groups you wish to assign this action item
items:
- description: The selected services for select and multi_select kinds
type: string
+ nullable: true
type: array
- selected_user_ids:
- items:
- description: The selected user id for select and multi_select kinds
- type: integer
- type: array
+ priority:
+ description: The priority of the action item
+ enum:
+ - high
+ - medium
+ - low
+ type: string
+ status:
+ description: The status of the action item
+ enum:
+ - open
+ - in_progress
+ - cancelled
+ - done
+ type: string
+ due_date:
+ description: The due date of the action item
+ nullable: true
+ type: string
+ jira_issue_id:
+ description: The Jira issue ID.
+ nullable: true
+ type: string
+ jira_issue_key:
+ description: The Jira issue key.
+ nullable: true
+ type: string
+ jira_issue_url:
+ description: The Jira issue URL.
+ nullable: true
+ type: string
+ created_at:
+ description: Date of creation
+ type: string
+ updated_at:
+ description: Date of last update
+ type: string
required:
- - form_field_id
- - incident_condition
- - selected_catalog_entity_ids
- - selected_option_ids
- - selected_user_ids
- - workflow_id
+ - created_at
+ - summary
+ - updated_at
type: object
- workflow_form_field_condition_response:
+ incident_action_item_response:
properties:
data:
- $ref: '#/components/schemas/workflow_form_field_condition_response_data'
+ $ref: '#/components/schemas/incident_action_item_response_data'
required:
- data
type: object
- workflow_form_field_condition_list:
+ incident_action_item_list:
properties:
data:
items:
- $ref: '#/components/schemas/workflow_form_field_condition_response_data'
+ $ref: '#/components/schemas/incident_action_item_response_data'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- new_workflow_group:
+ new_incident_custom_field_selection:
properties:
data:
- $ref: '#/components/schemas/new_workflow_group_data'
+ $ref: '#/components/schemas/new_incident_custom_field_selection_data'
required:
- data
type: object
- update_workflow_group:
+ update_incident_custom_field_selection:
properties:
data:
- $ref: '#/components/schemas/update_workflow_group_data'
+ $ref: '#/components/schemas/update_incident_custom_field_selection_data'
required:
- data
type: object
- workflow_group:
+ incident_custom_field_selection:
properties:
- kind:
- description: The kind of the workflow group
- enum:
- - simple
- - incident
- - post_mortem
- - action_item
- - pulse
- - alert
- nullable: true
- type: string
- name:
- description: The name of the workflow group.
- type: string
- slug:
- description: The slug of the workflow group.
+ incident_id:
type: string
- description:
- description: A description of the workflow group.
+ custom_field_id:
+ type: integer
+ value:
+ description: The value of the incident_custom_field_selection
nullable: true
type: string
- icon:
- description: An emoji icon displayed next to the workflow group.
- type: string
- expanded:
- description: Whether the group is expanded or collapsed.
- type: boolean
- position:
- description: The position of the workflow group
- type: integer
+ selected_option_ids:
+ items:
+ description: The selected option id for select and multi_select kinds
+ type: integer
+ type: array
required:
- - name
- - position
+ - selected_option_ids
+ - value
type: object
- workflow_group_response:
+ incident_custom_field_selection_response:
properties:
data:
- $ref: '#/components/schemas/workflow_group_response_data'
+ $ref: '#/components/schemas/incident_custom_field_selection_response_data'
required:
- data
type: object
- workflow_group_list:
+ incident_custom_field_selection_list:
properties:
data:
items:
- $ref: '#/components/schemas/workflow_group_response_data'
+ $ref: '#/components/schemas/incident_custom_field_selection_response_data'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- new_workflow_run:
+ new_incident_event_functionality:
properties:
data:
- $ref: '#/components/schemas/new_workflow_run_data'
+ $ref: '#/components/schemas/new_incident_event_functionality_data'
required:
- data
type: object
- workflow_run:
+ update_incident_event_functionality:
properties:
- workflow_id:
- type: string
- status:
- enum:
- - queued
- - started
- - completed
- - completed_with_errors
- - failed
- - canceled
+ data:
+ $ref: '#/components/schemas/update_incident_event_functionality_data'
+ required:
+ - data
+ type: object
+ incident_event_functionality:
+ additionalProperties: false
+ properties:
+ incident_event_id:
+ description: The ID of the incident event.
type: string
- status_message:
- nullable: true
+ functionality_id:
+ description: The ID of the functionality.
type: string
- triggered_by:
+ status:
+ description: The status of the affected functionality
enum:
- - system
- - user
- - workflow
- type: string
- started_at:
- nullable: true
- type: string
- completed_at:
- nullable: true
- type: string
- failed_at:
- nullable: true
- type: string
- canceled_at:
- nullable: true
- type: string
- incident_id:
- nullable: true
- type: string
- post_mortem_id:
- nullable: true
- type: string
- action_item_id:
- nullable: true
- type: string
- alert_id:
- nullable: true
- type: string
- pulse_id:
- nullable: true
+ - operational
+ - partial_outage
+ - major_outage
type: string
- context:
- additionalProperties: true
- type: object
required:
+ - functionality_id
+ - incident_event_id
- status
- - triggered_by
- - workflow_id
type: object
- workflow_run_response:
+ incident_event_functionality_response:
properties:
data:
- $ref: '#/components/schemas/workflow_run_response_data'
+ $ref: '#/components/schemas/incident_event_functionality_response_data'
required:
- data
type: object
- workflow_runs_list:
+ incident_event_functionality_list:
properties:
data:
items:
- $ref: '#/components/schemas/workflow_run_response_data'
+ $ref: '#/components/schemas/incident_event_functionality_response_data'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- new_workflow:
+ new_incident_event_service:
properties:
data:
- $ref: '#/components/schemas/new_workflow_data'
+ $ref: '#/components/schemas/new_incident_event_service_data'
required:
- data
type: object
- incident_trigger_params:
+ update_incident_event_service:
properties:
- trigger_type:
- enum:
- - incident
- type: string
- triggers:
- items:
- description: "Actions that trigger the workflow. One of custom_fields..updated,\
- \ incident_in_triage, incident_created, incident_started, incident_updated,\
- \ title_updated, summary_updated, status_updated, severity_updated,\
- \ environments_added, environments_removed, environments_updated, incident_types_added,\
- \ incident_types_removed, incident_types_updated, services_added, services_removed,\
- \ services_updated, visibility_updated, functionalities_added, functionalities_removed,\
- \ functionalities_updated, teams_added, teams_removed, teams_updated,\
- \ causes_added, causes_removed, causes_updated, timeline_updated, status_page_timeline_updated,\
- \ role_assignments_updated, role_assignments_added, role_assignments_removed,\
- \ slack_command, slack_channel_created, slack_channel_converted, microsoft_teams_channel_created,\
- \ subscribers_updated, subscribers_added, subscribers_removed, user_joined_slack_channel,\
- \ user_left_slack_channel"
- type: string
- type: array
- incident_visibilities:
- items:
- type: boolean
- type: array
- incident_kinds:
- items:
- enum:
- - test
- - test_sub
- - example
- - example_sub
- - normal
- - normal_sub
- - backfilled
- - scheduled
- type: string
- type: array
- incident_statuses:
- items:
- enum:
- - in_triage
- - started
- - detected
- - acknowledged
- - mitigated
- - resolved
- - closed
- - cancelled
- - scheduled
- - in_progress
- - completed
- type: string
- type: array
- incident_inactivity_duration:
- description: "ex. 10 min, 1h, 3 days, 2 weeks"
- nullable: true
- type: string
- incident_condition:
- default: ALL
- enum:
- - ALL
- - ANY
- - NONE
- type: string
- incident_condition_visibility:
- default: ANY
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
- type: string
- incident_condition_kind:
- default: IS
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
- type: string
- incident_condition_status:
- default: ANY
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
- type: string
- incident_condition_sub_status:
- default: ANY
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
- type: string
- incident_condition_environment:
- default: ANY
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
- type: string
- incident_condition_severity:
- default: ANY
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
- type: string
- incident_condition_incident_type:
- default: ANY
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
- type: string
- incident_condition_incident_roles:
- default: ANY
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
- type: string
- incident_condition_service:
- default: ANY
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
- type: string
- incident_condition_functionality:
- default: ANY
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
- type: string
- incident_condition_group:
- default: ANY
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
- type: string
- incident_condition_cause:
- default: ANY
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
- type: string
- incident_post_mortem_condition_cause:
- default: ANY
- description: "[DEPRECATED] Use incident_condition_cause instead"
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
+ data:
+ $ref: '#/components/schemas/update_incident_event_service_data'
+ required:
+ - data
+ type: object
+ incident_event_service:
+ additionalProperties: false
+ properties:
+ incident_event_id:
+ description: The ID of the incident event.
type: string
- incident_condition_summary:
- enum:
- - SET
- - UNSET
- nullable: true
+ service_id:
+ description: The ID of the service.
type: string
- incident_condition_started_at:
+ status:
+ description: The status of the affected service
enum:
- - SET
- - UNSET
- nullable: true
+ - operational
+ - partial_outage
+ - major_outage
type: string
- incident_condition_detected_at:
- enum:
- - SET
- - UNSET
- nullable: true
+ required:
+ - incident_event_id
+ - service_id
+ - status
+ type: object
+ incident_event_service_response:
+ properties:
+ data:
+ $ref: '#/components/schemas/incident_event_service_response_data'
+ required:
+ - data
+ type: object
+ incident_event_service_list:
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/incident_event_service_response_data'
+ type: array
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
+ required:
+ - data
+ - links
+ - meta
+ type: object
+ new_incident_event:
+ properties:
+ data:
+ $ref: '#/components/schemas/new_incident_event_data'
+ required:
+ - data
+ type: object
+ update_incident_event:
+ properties:
+ data:
+ $ref: '#/components/schemas/update_incident_event_data'
+ required:
+ - data
+ type: object
+ incident_event:
+ properties:
+ event:
+ description: The summary of the incident event
type: string
- incident_condition_acknowledged_at:
+ visibility:
+ description: The visibility of the incident action item
enum:
- - SET
- - UNSET
- nullable: true
+ - internal
+ - external
type: string
- incident_condition_mitigated_at:
- enum:
- - SET
- - UNSET
- nullable: true
+ occurred_at:
+ description: Date of occurence
type: string
- incident_condition_resolved_at:
- enum:
- - SET
- - UNSET
- nullable: true
+ created_at:
+ description: Date of creation
type: string
- incident_conditional_inactivity:
- enum:
- - IS
- nullable: true
+ updated_at:
+ description: Date of last update
type: string
required:
- - trigger_type
+ - created_at
+ - event
+ - occurred_at
+ - updated_at
type: object
- post_mortem_trigger_params:
+ incident_event_response:
properties:
- trigger_type:
+ data:
+ $ref: '#/components/schemas/incident_event_response_data'
+ required:
+ - data
+ type: object
+ incident_event_list:
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/incident_event_response_data'
+ type: array
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
+ required:
+ - data
+ - links
+ - meta
+ type: object
+ new_incident_feedback:
+ properties:
+ data:
+ $ref: '#/components/schemas/new_incident_feedback_data'
+ required:
+ - data
+ type: object
+ update_incident_feedback:
+ properties:
+ data:
+ $ref: '#/components/schemas/update_incident_feedback_data'
+ required:
+ - data
+ type: object
+ incident_feedback:
+ properties:
+ feedback:
+ description: The feedback of the incident feedback
+ type: string
+ rating:
+ description: The rating of the incident feedback
enum:
- - post_mortem
+ - 4
+ - 3
+ - 2
+ - 1
+ - 0
+ type: integer
+ anonymous:
+ description: Is the feedback anonymous?
+ type: boolean
+ created_at:
+ description: Date of creation
type: string
- triggers:
+ updated_at:
+ description: Date of last update
+ type: string
+ required:
+ - anonymous
+ - created_at
+ - feedback
+ - rating
+ - updated_at
+ type: object
+ incident_feedback_response:
+ properties:
+ data:
+ $ref: '#/components/schemas/incident_feedback_response_data'
+ required:
+ - data
+ type: object
+ incident_feedback_list:
+ properties:
+ data:
items:
- description: "Actions that trigger the workflow. One of custom_fields..updated,\
- \ post_mortem_created, post_mortem_updated, status_updated, slack_command"
+ $ref: '#/components/schemas/incident_feedback_response_data'
+ type: array
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
+ required:
+ - data
+ - links
+ - meta
+ type: object
+ new_incident_form_field_selection:
+ properties:
+ data:
+ $ref: '#/components/schemas/new_incident_form_field_selection_data'
+ required:
+ - data
+ type: object
+ update_incident_form_field_selection:
+ properties:
+ data:
+ $ref: '#/components/schemas/update_incident_form_field_selection_data'
+ required:
+ - data
+ type: object
+ incident_form_field_selection:
+ properties:
+ incident_id:
+ type: string
+ form_field_id:
+ description: The custom field for this selection
+ type: string
+ value:
+ description: The selected value for text kind custom fields
+ nullable: true
+ type: string
+ selected_catalog_entity_ids:
+ items:
+ description: The selected catalog entities for select and multi_select
+ kinds
type: string
type: array
- incident_visibilities:
+ selected_group_ids:
items:
- type: boolean
+ description: The selected groups (teams) for select and multi_select kinds
+ type: string
type: array
- incident_kinds:
+ selected_option_ids:
items:
- enum:
- - test
- - test_sub
- - example
- - example_sub
- - normal
- - normal_sub
- - backfilled
- - scheduled
+ description: The selected options for select and multi_select kinds
type: string
type: array
- incident_statuses:
+ selected_service_ids:
items:
- enum:
- - in_triage
- - started
- - detected
- - acknowledged
- - mitigated
- - resolved
- - closed
- - cancelled
- - scheduled
- - in_progress
- - completed
+ description: The selected services for select and multi_select kinds
type: string
type: array
- incident_inactivity_duration:
- description: "ex. 10 min, 1h, 3 days, 2 weeks"
- nullable: true
- type: string
- incident_condition:
- default: ALL
- enum:
- - ALL
- - ANY
- - NONE
- type: string
- incident_condition_visibility:
- default: ANY
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
- type: string
- incident_condition_kind:
- default: IS
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
- type: string
- incident_condition_status:
- default: ANY
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
- type: string
- incident_condition_sub_status:
- default: ANY
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
- type: string
- incident_condition_environment:
- default: ANY
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
- type: string
- incident_condition_severity:
- default: ANY
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
- type: string
- incident_condition_incident_type:
- default: ANY
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
- type: string
- incident_condition_incident_roles:
- default: ANY
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
- type: string
- incident_condition_service:
- default: ANY
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
- type: string
- incident_condition_functionality:
- default: ANY
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
- type: string
- incident_condition_group:
- default: ANY
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
- type: string
- incident_condition_cause:
- default: ANY
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
- type: string
- incident_post_mortem_condition_cause:
- default: ANY
- description: "[DEPRECATED] Use incident_condition_cause instead"
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
+ selected_functionality_ids:
+ items:
+ description: The selected functionalities for select and multi_select
+ kinds
+ type: string
+ type: array
+ selected_user_ids:
+ items:
+ description: The selected users for select and multi_select kinds
+ type: integer
+ type: array
+ selected_environment_ids:
+ items:
+ description: The selected environments for select and multi_select kinds
+ type: string
+ type: array
+ selected_cause_ids:
+ items:
+ description: The selected causes for select and multi_select kinds
+ type: string
+ type: array
+ selected_incident_type_ids:
+ items:
+ description: The selected incident types for select and multi_select kinds
+ type: string
+ type: array
+ required:
+ - form_field_id
+ - incident_id
+ type: object
+ incident_form_field_selection_response:
+ properties:
+ data:
+ $ref: '#/components/schemas/incident_form_field_selection_response_data'
+ required:
+ - data
+ type: object
+ incident_form_field_selection_list:
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/incident_form_field_selection_response_data'
+ type: array
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
+ required:
+ - data
+ - links
+ - meta
+ type: object
+ new_incident_permission_set_boolean:
+ properties:
+ data:
+ $ref: '#/components/schemas/new_incident_permission_set_boolean_data'
+ required:
+ - data
+ type: object
+ update_incident_permission_set_boolean:
+ properties:
+ data:
+ $ref: '#/components/schemas/update_incident_permission_set_boolean_data'
+ required:
+ - data
+ type: object
+ incident_permission_set_boolean:
+ properties:
+ incident_permission_set_id:
type: string
- incident_condition_summary:
+ kind:
enum:
- - SET
- - UNSET
- nullable: true
+ - publish_to_status_page
+ - assign_incident_roles
+ - invite_subscribers
+ - update_summary
+ - update_timeline
+ - trigger_workflows
+ - create_communications
+ - read_communications
+ - update_communications
+ - delete_communications
+ - send_communications
+ - modify_custom_fields
type: string
- incident_condition_started_at:
- enum:
- - SET
- - UNSET
- nullable: true
+ private:
+ type: boolean
+ enabled:
+ type: boolean
+ created_at:
type: string
- incident_condition_detected_at:
- enum:
- - SET
- - UNSET
- nullable: true
+ updated_at:
type: string
- incident_condition_acknowledged_at:
- enum:
- - SET
- - UNSET
- nullable: true
+ required:
+ - created_at
+ - kind
+ - updated_at
+ type: object
+ incident_permission_set_boolean_response:
+ properties:
+ data:
+ $ref: '#/components/schemas/incident_permission_set_boolean_response_data'
+ required:
+ - data
+ type: object
+ incident_permission_set_boolean_list:
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/incident_permission_set_boolean_response_data'
+ type: array
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
+ required:
+ - data
+ - links
+ - meta
+ type: object
+ new_incident_permission_set_resource:
+ properties:
+ data:
+ $ref: '#/components/schemas/new_incident_permission_set_resource_data'
+ required:
+ - data
+ type: object
+ update_incident_permission_set_resource:
+ properties:
+ data:
+ $ref: '#/components/schemas/update_incident_permission_set_resource_data'
+ required:
+ - data
+ type: object
+ incident_permission_set_resource:
+ properties:
+ incident_permission_set_id:
type: string
- incident_condition_mitigated_at:
+ kind:
enum:
- - SET
- - UNSET
- nullable: true
+ - severities
+ - incident_types
+ - statuses
+ - sub_statuses
type: string
- incident_condition_resolved_at:
- enum:
- - SET
- - UNSET
- nullable: true
+ private:
+ type: boolean
+ resource_id:
type: string
- incident_conditional_inactivity:
- enum:
- - IS
- nullable: true
+ resource_type:
type: string
- incident_post_mortem_condition:
- enum:
- - ALL
- - ANY
- - NONE
+ created_at:
type: string
- incident_post_mortem_condition_status:
- default: ANY
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
+ updated_at:
type: string
- incident_post_mortem_statuses:
+ required:
+ - created_at
+ - incident_permission_set_id
+ - kind
+ - updated_at
+ type: object
+ incident_permission_set_resource_response:
+ properties:
+ data:
+ $ref: '#/components/schemas/incident_permission_set_resource_response_data'
+ required:
+ - data
+ type: object
+ incident_permission_set_resource_list:
+ properties:
+ data:
items:
- enum:
- - draft
- - published
- type: string
+ $ref: '#/components/schemas/incident_permission_set_resource_response_data'
type: array
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- - trigger_type
+ - data
+ - links
+ - meta
type: object
- action_item_trigger_params:
+ new_incident_permission_set:
properties:
- trigger_type:
- enum:
- - action_item
+ data:
+ $ref: '#/components/schemas/new_incident_permission_set_data'
+ required:
+ - data
+ type: object
+ update_incident_permission_set:
+ properties:
+ data:
+ $ref: '#/components/schemas/update_incident_permission_set_data'
+ required:
+ - data
+ type: object
+ incident_permission_set:
+ properties:
+ name:
+ description: The incident permission set name.
type: string
- triggers:
- items:
- description: "Actions that trigger the workflow. One of custom_fields..updated,\
- \ incident_updated, action_item_created, action_item_updated, assigned_user_updated,\
- \ summary_updated, description_updated, status_updated, priority_updated,\
- \ due_date_updated, teams_updated, slack_command"
- type: string
- type: array
- incident_visibilities:
- items:
- type: boolean
- type: array
- incident_kinds:
+ slug:
+ description: The incident permission set slug.
+ type: string
+ description:
+ description: The incident permission set description.
+ nullable: true
+ type: string
+ private_incident_permissions:
items:
enum:
- - test
- - test_sub
- - example
- - example_sub
- - normal
- - normal_sub
- - backfilled
- - scheduled
+ - create
+ - read
+ - update
+ - delete
type: string
type: array
- incident_statuses:
+ public_incident_permissions:
items:
enum:
- - in_triage
- - started
- - detected
- - acknowledged
- - mitigated
- - resolved
- - closed
- - cancelled
- - scheduled
- - in_progress
- - completed
+ - create
+ - read
+ - update
+ - delete
type: string
type: array
- incident_inactivity_duration:
- description: "ex. 10 min, 1h, 3 days, 2 weeks"
- nullable: true
- type: string
- incident_condition:
- default: ALL
- enum:
- - ALL
- - ANY
- - NONE
- type: string
- incident_condition_visibility:
- default: ANY
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
- type: string
- incident_condition_kind:
- default: IS
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
- type: string
- incident_condition_status:
- default: ANY
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
- type: string
- incident_condition_sub_status:
- default: ANY
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
- type: string
- incident_condition_environment:
- default: ANY
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
- type: string
- incident_condition_severity:
- default: ANY
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
- type: string
- incident_condition_incident_type:
- default: ANY
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
- type: string
- incident_condition_incident_roles:
- default: ANY
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
- type: string
- incident_condition_service:
- default: ANY
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
- type: string
- incident_condition_functionality:
- default: ANY
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
- type: string
- incident_condition_group:
- default: ANY
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
+ created_at:
type: string
- incident_condition_summary:
- enum:
- - SET
- - UNSET
- nullable: true
+ updated_at:
type: string
- incident_condition_started_at:
- enum:
- - SET
- - UNSET
- nullable: true
+ required:
+ - created_at
+ - name
+ - updated_at
+ type: object
+ incident_permission_set_response:
+ properties:
+ data:
+ $ref: '#/components/schemas/incident_permission_set_response_data'
+ required:
+ - data
+ type: object
+ incident_permission_set_list:
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/incident_permission_set_response_data'
+ type: array
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
+ required:
+ - data
+ - links
+ - meta
+ type: object
+ update_incident_post_mortem:
+ properties:
+ data:
+ $ref: '#/components/schemas/update_incident_post_mortem_data'
+ required:
+ - data
+ type: object
+ incident_post_mortem:
+ properties:
+ title:
+ description: The title of the incident retrospective
type: string
- incident_condition_detected_at:
- enum:
- - SET
- - UNSET
+ content:
+ description: The content of the incident retrospective (Only if internal)
nullable: true
type: string
- incident_condition_acknowledged_at:
+ status:
+ description: The status of the incident retrospective
enum:
- - SET
- - UNSET
- nullable: true
+ - draft
+ - published
type: string
- incident_condition_mitigated_at:
- enum:
- - SET
- - UNSET
+ started_at:
+ description: Date of started at
nullable: true
type: string
- incident_condition_resolved_at:
- enum:
- - SET
- - UNSET
+ mitigated_at:
+ description: Date of mitigation
nullable: true
type: string
- incident_conditional_inactivity:
- enum:
- - IS
+ resolved_at:
+ description: Date of resolution
nullable: true
type: string
- incident_action_item_condition:
- enum:
- - ALL
- - ANY
- - NONE
- type: string
- incident_action_item_condition_kind:
- default: ANY
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
- type: string
- incident_action_item_kinds:
- items:
- enum:
- - task
- - follow_up
- type: string
- type: array
- incident_action_item_condition_status:
- default: ANY
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
- type: string
- incident_action_item_statuses:
- items:
- enum:
- - open
- - in_progress
- - cancelled
- - done
- type: string
- type: array
- incident_action_item_condition_priority:
- default: ANY
+ show_timeline:
+ description: Show events timeline of the incident retrospective
+ type: boolean
+ show_timeline_trail:
+ description: Show trail events in the timeline of the incident retrospective
+ type: boolean
+ show_timeline_genius:
+ description: Show workflow events in the timeline of the incident retrospective
+ type: boolean
+ show_timeline_tasks:
+ description: Show tasks in the timeline of the incident retrospective
+ type: boolean
+ show_timeline_action_items:
+ description: Show action items in the timeline of the incident retrospective
+ type: boolean
+ show_timeline_order:
+ default: desc
+ description: The order of the incident retrospective timeline
enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
+ - asc
+ - desc
type: string
- incident_action_item_priorities:
- items:
- enum:
- - high
- - medium
- - low
- type: string
- type: array
- incident_action_item_condition_group:
- default: ANY
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
+ show_services_impacted:
+ description: Show functionalities impacted of the incident retrospective
+ type: boolean
+ show_functionalities_impacted:
+ description: Show services impacted of the incident retrospective
+ type: boolean
+ show_groups_impacted:
+ description: Show groups impacted of the incident retrospective
+ type: boolean
+ show_alerts_attached:
+ description: Show alerts attached to the incident
+ type: boolean
+ url:
+ description: The url to the incident retrospective
type: string
- incident_action_item_group_ids:
+ created_at:
+ description: Date of creation
+ type: string
+ updated_at:
+ description: Date of last update
+ type: string
+ required:
+ - created_at
+ - title
+ - updated_at
+ type: object
+ incident_post_mortem_response:
+ properties:
+ data:
+ $ref: '#/components/schemas/incident_post_mortem_response_data'
+ required:
+ - data
+ type: object
+ incident_post_mortem_list:
+ properties:
+ data:
items:
- type: string
+ $ref: '#/components/schemas/incident_post_mortem_response_data'
type: array
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- - trigger_type
+ - data
+ - links
+ - meta
type: object
- alert_trigger_params:
+ update_incident_retrospective_step:
properties:
- trigger_type:
- enum:
- - alert
+ data:
+ $ref: '#/components/schemas/update_incident_retrospective_step_data'
+ required:
+ - data
+ type: object
+ incident_retrospective_step:
+ properties:
+ retrospective_step_id:
type: string
- triggers:
- items:
- description: Actions that trigger the workflow
- enum:
- - alert_created
- - alert_status_updated
- type: string
- type: array
- alert_condition:
- enum:
- - ALL
- - ANY
- - NONE
+ incident_id:
type: string
- alert_condition_source:
- default: ANY
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
+ title:
+ description: The name of the step
type: string
- alert_condition_source_use_regexp:
- default: false
- type: boolean
- alert_sources:
- items:
- type: string
- type: array
- alert_condition_label:
- default: ANY
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
+ description:
+ description: The description of the step
+ nullable: true
type: string
- alert_condition_label_use_regexp:
- default: false
- type: boolean
- alert_condition_status:
- default: ANY
+ status:
+ description: Status of the incident retrospective step
enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
+ - todo
+ - in_progress
+ - completed
+ - skipped
+ nullable: false
type: string
- alert_condition_status_use_regexp:
- default: false
- type: boolean
- alert_statuses:
- items:
- type: string
- type: array
- alert_labels:
- items:
- type: string
- type: array
- alert_condition_payload:
- default: ANY
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
+ kind:
+ description: Due date
+ nullable: true
type: string
- alert_condition_payload_use_regexp:
- default: false
- type: boolean
- alert_payload:
- items:
- type: string
- type: array
- alert_query_payload:
- description: "You can use jsonpath syntax. eg: $.incident.teams[*]"
+ due_date:
+ description: Due date
nullable: true
type: string
+ position:
+ description: Position of the step
+ type: integer
+ skippable:
+ description: Is the step skippable?
+ type: boolean
+ created_at:
+ description: Date of creation
+ type: string
+ updated_at:
+ description: Date of last update
+ type: string
required:
- - trigger_type
+ - created_at
+ - incident_id
+ - retrospective_step_id
+ - title
+ - updated_at
type: object
- pulse_trigger_params:
+ incident_retrospective_step_response:
properties:
- trigger_type:
- enum:
- - pulse
+ data:
+ $ref: '#/components/schemas/incident_retrospective_step_response_data'
+ required:
+ - data
+ type: object
+ new_incident_role_task:
+ properties:
+ data:
+ $ref: '#/components/schemas/new_incident_role_task_data'
+ required:
+ - data
+ type: object
+ update_incident_role_task:
+ properties:
+ data:
+ $ref: '#/components/schemas/update_incident_role_task_data'
+ required:
+ - data
+ type: object
+ incident_role_task:
+ properties:
+ incident_role_id:
type: string
- triggers:
- items:
- description: Actions that trigger the workflow
- enum:
- - pulse_created
- type: string
- type: array
- pulse_condition:
- enum:
- - ALL
- - ANY
- - NONE
+ task:
+ description: The task of the incident task
type: string
- pulse_condition_source:
- default: ANY
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
+ description:
+ description: The description of incident task
+ nullable: true
type: string
- pulse_condition_source_use_regexp:
- default: false
- type: boolean
- pulse_sources:
- items:
- type: string
- type: array
- pulse_condition_label:
- default: ANY
+ priority:
+ description: The priority of the incident task
enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
+ - high
+ - medium
+ - low
type: string
- pulse_condition_label_use_regexp:
- default: false
- type: boolean
- pulse_labels:
- items:
- type: string
- type: array
- pulse_condition_payload:
- default: ANY
- enum:
- - IS
- - ANY
- - CONTAINS
- - CONTAINS_ALL
- - CONTAINS_NONE
- - NONE
- - SET
- - UNSET
+ created_at:
+ description: Date of creation
type: string
- pulse_condition_payload_use_regexp:
- default: false
- type: boolean
- pulse_payload:
- items:
- type: string
- type: array
- pulse_query_payload:
- description: "You can use jsonpath syntax. eg: $.incident.teams[*]"
- nullable: true
+ updated_at:
+ description: Date of last update
type: string
required:
- - trigger_type
+ - created_at
+ - task
+ - updated_at
type: object
- simple_trigger_params:
+ incident_role_task_response:
properties:
- trigger_type:
- enum:
- - simple
- type: string
- triggers:
+ data:
+ $ref: '#/components/schemas/incident_role_task_response_data'
+ required:
+ - data
+ type: object
+ incident_role_task_list:
+ properties:
+ data:
items:
- description: Actions that trigger the workflow
- enum:
- - slack_command
- type: string
+ $ref: '#/components/schemas/incident_role_task_response_data'
type: array
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- - trigger_type
+ - data
+ - links
+ - meta
type: object
- update_workflow:
+ new_incident_role:
properties:
data:
- $ref: '#/components/schemas/update_workflow_data'
+ $ref: '#/components/schemas/new_incident_role_data'
required:
- data
type: object
- workflow:
+ update_incident_role:
+ properties:
+ data:
+ $ref: '#/components/schemas/update_incident_role_data'
+ required:
+ - data
+ type: object
+ incident_role:
properties:
name:
- description: The title of the workflow
+ description: The name of the incident role
type: string
slug:
- description: The slug of the workflow
+ description: The slug of the incident role
type: string
- description:
- description: The description of the workflow
+ summary:
+ description: The summary of the incident role
nullable: true
type: string
- command:
- description: Workflow command
+ description:
+ description: The description of the incident role
nullable: true
type: string
- command_feedback_enabled:
- description: This will notify you back when the workflow is starting
+ position:
+ description: Position of the incident role
nullable: true
+ type: integer
+ optional:
type: boolean
- wait:
- description: Wait this duration before executing
- nullable: true
+ enabled:
+ type: boolean
+ allow_multi_user_assignment:
+ type: boolean
+ created_at:
+ description: Date of creation
type: string
- repeat_every_duration:
- description: Repeat workflow every duration
- nullable: true
+ updated_at:
+ description: Date of last update
type: string
- repeat_condition_duration_since_first_run:
- description: The workflow will stop repeating if its runtime since it's
- first workflow run exceeds the duration set in this field
- nullable: true
+ required:
+ - created_at
+ - name
+ - updated_at
+ type: object
+ incident_role_response:
+ properties:
+ data:
+ $ref: '#/components/schemas/incident_role_response_data'
+ required:
+ - data
+ type: object
+ incident_role_list:
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/incident_role_response_data'
+ type: array
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
+ required:
+ - data
+ - links
+ - meta
+ type: object
+ new_incident_status_page_event:
+ properties:
+ data:
+ $ref: '#/components/schemas/new_incident_status_page_event_data'
+ required:
+ - data
+ type: object
+ update_incident_status_page_event:
+ properties:
+ data:
+ $ref: '#/components/schemas/update_incident_status_page_event_data'
+ required:
+ - data
+ type: object
+ incident_status_page_event:
+ properties:
+ event:
+ description: The summary of the incident event
type: string
- repeat_condition_number_of_repeats:
- description: The workflow will stop repeating if the number of repeats exceeds
- the value set in this field
- type: integer
- continuously_repeat:
- description: "When continuously repeat is true, repeat workflows aren't\
- \ automatically stopped when conditions aren't met. This setting won't\
- \ override your conditions set by repeat_condition_duration_since_first_run\
- \ and repeat_condition_number_of_repeats parameters."
+ status_page_id:
+ description: Unique ID of the status page you wish to post the event to
+ type: string
+ status:
+ description: The status of the incident event
+ enum:
+ - investigating
+ - identified
+ - monitoring
+ - resolved
+ - scheduled
+ - in_progress
+ - completed
+ type: string
+ notify_subscribers:
+ description: Notify all status pages subscribers
type: boolean
- repeat_on:
+ should_tweet:
+ description: For Statuspage.io integrated pages auto publishes a tweet for
+ your update
+ type: boolean
+ started_at:
+ description: Date of start
+ type: string
+ created_at:
+ description: Date of creation
+ type: string
+ updated_at:
+ description: Date of last update
+ type: string
+ required:
+ - created_at
+ - event
+ - started_at
+ - updated_at
+ type: object
+ incident_status_page_event_response:
+ properties:
+ data:
+ $ref: '#/components/schemas/incident_status_page_event_response_data'
+ required:
+ - data
+ type: object
+ incident_status_page_event_list:
+ properties:
+ data:
items:
- description: Repeat on weekdays
- enum:
- - S
- - M
- - T
- - W
- - R
- - F
- - U
- type: string
+ $ref: '#/components/schemas/incident_status_page_event_response_data'
+ type: array
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
+ required:
+ - data
+ - links
+ - meta
+ type: object
+ new_incident_type:
+ properties:
+ data:
+ $ref: '#/components/schemas/new_incident_type_data'
+ required:
+ - data
+ type: object
+ update_incident_type:
+ properties:
+ data:
+ $ref: '#/components/schemas/update_incident_type_data'
+ required:
+ - data
+ type: object
+ incident_type:
+ properties:
+ name:
+ description: The name of the incident type
+ type: string
+ slug:
+ description: The slug of the incident type
+ type: string
+ description:
+ description: The description of the incident type
nullable: true
- type: array
- enabled:
- type: boolean
- locked:
- description: Restricts workflow edits to admins when turned on. Only admins
- can set this field.
- type: boolean
- position:
- description: The order which the workflow should run with other workflows.
- type: integer
- workflow_group_id:
- description: The group this workflow belongs to.
+ type: string
+ color:
+ description: The hex color of the incident type
nullable: true
type: string
- trigger_params:
- $ref: '#/components/schemas/new_workflow_data_attributes_trigger_params'
- environment_ids:
- items:
- type: string
- type: array
- severity_ids:
- items:
- type: string
- type: array
- incident_type_ids:
- items:
- type: string
- type: array
- incident_role_ids:
- items:
- type: string
- type: array
- service_ids:
- items:
- type: string
- type: array
- functionality_ids:
+ position:
+ description: Position of the incident type
+ nullable: true
+ type: integer
+ notify_emails:
+ description: Emails to attach to the incident type
items:
type: string
+ nullable: true
type: array
- group_ids:
+ slack_channels:
+ description: Slack Channels associated with this incident type
items:
- type: string
+ $ref: '#/components/schemas/new_environment_data_attributes_slack_channels_inner'
+ nullable: true
type: array
- cause_ids:
+ slack_aliases:
+ description: Slack Aliases associated with this incident type
items:
- type: string
+ $ref: '#/components/schemas/new_environment_data_attributes_slack_aliases_inner'
+ nullable: true
type: array
- sub_status_ids:
+ properties:
+ description: Array of property values for this incident type.
items:
- type: string
+ $ref: '#/components/schemas/new_cause_data_attributes_properties_inner'
type: array
created_at:
description: Date of creation
@@ -47087,101 +36785,611 @@ components:
- name
- updated_at
type: object
- workflow_response:
+ incident_type_response:
properties:
data:
- $ref: '#/components/schemas/workflow_response_data'
+ $ref: '#/components/schemas/incident_type_response_data'
required:
- data
type: object
- workflow_list:
+ incident_type_list:
properties:
data:
items:
- $ref: '#/components/schemas/workflow_response_data'
+ $ref: '#/components/schemas/incident_type_response_data'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- new_live_call_router:
+ new_incident:
properties:
data:
- $ref: '#/components/schemas/new_live_call_router_data'
+ $ref: '#/components/schemas/new_incident_data'
required:
- data
type: object
- update_live_call_router:
+ update_incident:
properties:
data:
- $ref: '#/components/schemas/update_live_call_router_data'
+ $ref: '#/components/schemas/update_incident_data'
required:
- data
type: object
- live_call_router:
+ in_triage_incident:
+ properties:
+ data:
+ $ref: '#/components/schemas/in_triage_incident_data'
+ required:
+ - data
+ type: object
+ restart_incident:
+ properties:
+ data:
+ $ref: '#/components/schemas/restart_incident_data'
+ required:
+ - data
+ type: object
+ mitigate_incident:
+ properties:
+ data:
+ $ref: '#/components/schemas/mitigate_incident_data'
+ required:
+ - data
+ type: object
+ resolve_incident:
+ properties:
+ data:
+ $ref: '#/components/schemas/resolve_incident_data'
+ required:
+ - data
+ type: object
+ cancel_incident:
+ properties:
+ data:
+ $ref: '#/components/schemas/cancel_incident_data'
+ required:
+ - data
+ type: object
+ duplicate_incident:
+ properties:
+ data:
+ $ref: '#/components/schemas/duplicate_incident_data'
+ required:
+ - data
+ type: object
+ add_subscribers:
properties:
+ data:
+ $ref: '#/components/schemas/add_subscribers_data'
+ required:
+ - data
+ type: object
+ remove_subscribers:
+ properties:
+ data:
+ $ref: '#/components/schemas/remove_subscribers_data'
+ required:
+ - data
+ type: object
+ assign_role_to_user:
+ properties:
+ data:
+ $ref: '#/components/schemas/assign_role_to_user_data'
+ required:
+ - data
+ type: object
+ unassign_role_from_user:
+ properties:
+ data:
+ $ref: '#/components/schemas/unassign_role_from_user_data'
+ required:
+ - data
+ type: object
+ incident:
+ properties:
+ id:
+ description: Unique ID of the incident
+ type: string
+ sequential_id:
+ description: Sequential ID of the incident
+ type: integer
+ title:
+ description: The title of the incident
+ type: string
kind:
- description: The kind of the live_call_router
- enum:
- - voicemail
- - live
+ description: The kind of the incident
type: string
- enabled:
- description: Whether the live_call_router is enabled
+ slug:
+ description: The slug of the incident
+ type: string
+ parent_incident_id:
+ description: ID of parent incident
+ nullable: true
+ type: string
+ duplicate_incident_id:
+ description: ID of duplicated incident
+ nullable: true
+ type: string
+ summary:
+ description: The summary of the incident
+ nullable: true
+ type: string
+ private:
+ default: false
+ description: The visibility of the incident
type: boolean
- name:
- description: The name of the live_call_router
+ source:
+ description: The source of the incident
+ nullable: true
type: string
- country_code:
- description: The country code of the live_call_router
- enum:
- - US
- - GB
- - NZ
- - CA
- - AU
+ status:
+ description: The status of the incident
+ nullable: true
type: string
- phone_type:
- description: The phone type of the live_call_router
- enum:
- - local
- - toll_free
+ url:
+ description: The url to the incident
+ nullable: true
type: string
- phone_number:
- description: "You can select a phone number using [generate_phone_number](#//api/v1/live_call_routers/generate_phone_number)\
- \ API and pass that phone number here to register"
+ short_url:
+ description: The short url to the incident
+ nullable: true
type: string
- voicemail_greeting:
- description: The voicemail greeting of the live_call_router
+ public_title:
+ description: The public title of the incident
+ nullable: true
type: string
- caller_greeting:
- description: The caller greeting message of the live_call_router
+ user:
+ description: The user who created the incident
+ nullable: true
+ type: object
+ severity:
+ allOf:
+ - $ref: '#/components/schemas/severity_response'
+ description: The Severity of the incident
+ nullable: true
+ type: object
+ environments:
+ description: The Environments of the incident
+ items:
+ allOf:
+ - $ref: '#/components/schemas/environment_response'
+ type: object
+ nullable: true
+ type: array
+ incident_types:
+ description: The Incident Types of the incident
+ items:
+ allOf:
+ - $ref: '#/components/schemas/incident_type_response'
+ type: object
+ nullable: true
+ type: array
+ services:
+ description: The Services of the incident
+ items:
+ allOf:
+ - $ref: '#/components/schemas/service_response'
+ type: object
+ nullable: true
+ type: array
+ functionalities:
+ description: The Functionalities of the incident
+ items:
+ allOf:
+ - $ref: '#/components/schemas/functionality_response'
+ type: object
+ nullable: true
+ type: array
+ groups:
+ description: The Teams of to the incident
+ items:
+ allOf:
+ - $ref: '#/components/schemas/team_response'
+ type: object
+ nullable: true
+ type: array
+ labels:
+ description: "Labels to attach to the incidents. eg: {\"platform\":\"osx\"\
+ , \"version\": \"1.29\"}"
+ nullable: true
+ type: object
+ slack_channel_id:
+ description: Slack channel id
+ nullable: true
type: string
- waiting_music_url:
- description: The waiting music URL of the live_call_router
+ slack_channel_name:
+ description: Slack channel name
+ nullable: true
type: string
- sent_to_voicemail_delay:
- description: The delay (seconds) after which the caller in redirected to
- voicemail
- type: integer
- should_redirect_to_voicemail_on_no_answer:
- description: This prompts the caller to choose voicemail or connect live
- type: boolean
- escalation_level_delay_in_seconds:
- description: This overrides the delay (seconds) in escalation levels
- type: integer
- should_auto_resolve_alert_on_call_end:
- description: This overrides the delay (seconds) in escalation levels
+ slack_channel_url:
+ description: Slack channel url
+ nullable: true
+ type: string
+ slack_channel_short_url:
+ description: Slack channel short url
+ nullable: true
+ type: string
+ slack_channel_deep_link:
+ description: Slack channel deep link
+ nullable: true
+ type: string
+ slack_channel_archived:
+ description: Whether the Slack channel is archived
+ nullable: true
type: boolean
- alert_urgency_id:
- description: This is used in escalation paths to determine who to page
+ slack_last_message_ts:
+ description: Timestamp of last Slack message
+ nullable: true
+ type: string
+ zoom_meeting_id:
+ description: Zoom meeting ID
+ nullable: true
+ type: string
+ zoom_meeting_start_url:
+ description: Zoom meeting start URL
+ nullable: true
+ type: string
+ zoom_meeting_join_url:
+ description: Zoom meeting join URL
+ nullable: true
+ type: string
+ zoom_meeting_password:
+ description: Zoom meeting password
+ nullable: true
+ type: string
+ zoom_meeting_pstn_password:
+ description: Zoom meeting PSTN password
+ nullable: true
+ type: string
+ zoom_meeting_h323_password:
+ description: Zoom meeting H323 password
+ nullable: true
+ type: string
+ zoom_meeting_global_dial_in_numbers:
+ description: Zoom meeting global dial-in numbers
+ items:
+ $ref: '#/components/schemas/incident_zoom_meeting_global_dial_in_numbers_inner'
+ nullable: true
+ type: array
+ google_drive_id:
+ description: Google Drive document ID
+ nullable: true
+ type: string
+ google_drive_parent_id:
+ description: Google Drive parent folder ID
+ nullable: true
+ type: string
+ google_drive_url:
+ description: Google Drive URL
+ nullable: true
+ type: string
+ google_meeting_id:
+ description: Google meeting ID
+ nullable: true
+ type: string
+ google_meeting_url:
+ description: Google meeting URL
+ nullable: true
+ type: string
+ jira_issue_key:
+ description: Jira issue key
+ nullable: true
+ type: string
+ jira_issue_id:
+ description: Jira issue ID
+ nullable: true
+ type: string
+ jira_issue_url:
+ description: Jira issue URL
+ nullable: true
+ type: string
+ github_issue_id:
+ description: GitHub issue ID
+ nullable: true
+ type: string
+ github_issue_url:
+ description: GitHub issue URL
+ nullable: true
+ type: string
+ gitlab_issue_id:
+ description: GitLab issue ID
+ nullable: true
+ type: string
+ gitlab_issue_url:
+ description: GitLab issue URL
+ nullable: true
+ type: string
+ asana_task_id:
+ description: Asana task ID
+ nullable: true
+ type: string
+ asana_task_url:
+ description: Asana task URL
+ nullable: true
+ type: string
+ linear_issue_id:
+ description: Linear issue ID
+ nullable: true
+ type: string
+ linear_issue_url:
+ description: Linear issue URL
+ nullable: true
+ type: string
+ trello_card_id:
+ description: Trello card ID
+ nullable: true
+ type: string
+ trello_card_url:
+ description: Trello card URL
+ nullable: true
+ type: string
+ zendesk_ticket_id:
+ description: Zendesk ticket ID
+ nullable: true
+ type: string
+ zendesk_ticket_url:
+ description: Zendesk ticket URL
+ nullable: true
+ type: string
+ pagerduty_incident_id:
+ description: PagerDuty incident ID
+ nullable: true
+ type: string
+ pagerduty_incident_number:
+ description: PagerDuty incident number
+ nullable: true
+ type: string
+ pagerduty_incident_url:
+ description: PagerDuty incident URL
+ nullable: true
+ type: string
+ opsgenie_incident_id:
+ description: Opsgenie incident ID
+ nullable: true
+ type: string
+ opsgenie_incident_url:
+ description: Opsgenie incident URL
+ nullable: true
+ type: string
+ opsgenie_alert_id:
+ description: Opsgenie alert ID
+ nullable: true
+ type: string
+ opsgenie_alert_url:
+ description: Opsgenie alert URL
+ nullable: true
+ type: string
+ service_now_incident_id:
+ description: ServiceNow incident ID
+ nullable: true
+ type: string
+ service_now_incident_key:
+ description: ServiceNow incident key
+ nullable: true
+ type: string
+ service_now_incident_url:
+ description: ServiceNow incident URL
+ nullable: true
+ type: string
+ mattermost_channel_id:
+ description: Mattermost channel ID
+ nullable: true
+ type: string
+ mattermost_channel_name:
+ description: Mattermost channel name
+ nullable: true
+ type: string
+ mattermost_channel_url:
+ description: Mattermost channel URL
+ nullable: true
+ type: string
+ confluence_page_id:
+ description: Confluence page ID
+ nullable: true
+ type: string
+ confluence_page_url:
+ description: Confluence page URL
+ nullable: true
+ type: string
+ datadog_notebook_id:
+ description: Datadog notebook ID
+ nullable: true
+ type: string
+ datadog_notebook_url:
+ description: Datadog notebook URL
+ nullable: true
+ type: string
+ shortcut_story_id:
+ description: Shortcut story ID
+ nullable: true
+ type: string
+ shortcut_story_url:
+ description: Shortcut story URL
+ nullable: true
+ type: string
+ shortcut_task_id:
+ description: Shortcut task ID
+ nullable: true
+ type: string
+ shortcut_task_url:
+ description: Shortcut task URL
+ nullable: true
+ type: string
+ motion_task_id:
+ description: Motion task ID
+ nullable: true
+ type: string
+ motion_task_url:
+ description: Motion task URL
+ nullable: true
+ type: string
+ clickup_task_id:
+ description: ClickUp task ID
+ nullable: true
+ type: string
+ clickup_task_url:
+ description: ClickUp task URL
+ nullable: true
+ type: string
+ victor_ops_incident_id:
+ description: VictorOps incident ID
+ nullable: true
+ type: string
+ victor_ops_incident_url:
+ description: VictorOps incident URL
+ nullable: true
+ type: string
+ quip_page_id:
+ description: Quip page ID
+ nullable: true
+ type: string
+ quip_page_url:
+ description: Quip page URL
+ nullable: true
+ type: string
+ sharepoint_page_id:
+ description: SharePoint page ID
+ nullable: true
+ type: string
+ sharepoint_page_url:
+ description: SharePoint page URL
+ nullable: true
+ type: string
+ airtable_base_key:
+ description: Airtable base key
+ nullable: true
+ type: string
+ airtable_table_name:
+ description: Airtable table name
+ nullable: true
+ type: string
+ airtable_record_id:
+ description: Airtable record ID
+ nullable: true
+ type: string
+ airtable_record_url:
+ description: Airtable record URL
+ nullable: true
+ type: string
+ freshservice_ticket_id:
+ description: Freshservice ticket ID
+ nullable: true
+ type: string
+ freshservice_ticket_url:
+ description: Freshservice ticket URL
+ nullable: true
+ type: string
+ freshservice_task_id:
+ description: Freshservice task ID
+ nullable: true
+ type: string
+ freshservice_task_url:
+ description: Freshservice task URL
+ nullable: true
+ type: string
+ mitigation_message:
+ description: How was the incident mitigated?
+ nullable: true
+ type: string
+ resolution_message:
+ description: How was the incident resolved?
+ nullable: true
+ type: string
+ cancellation_message:
+ description: Why was the incident cancelled?
+ nullable: true
+ type: string
+ scheduled_for:
+ description: Date of when the maintenance begins
+ nullable: true
+ type: string
+ scheduled_until:
+ description: Date of when the maintenance ends
+ nullable: true
+ type: string
+ muted_service_ids:
+ description: "The Service IDs to mute alerts for during maintenance. Alerts\
+ \ for these services will still be triggered and attached to the incident,\
+ \ but won't page responders."
+ items:
+ type: string
+ nullable: true
+ type: array
+ retrospective_progress_status:
+ description: The status of the retrospective progress
+ enum:
+ - not_started
+ - active
+ - completed
+ - skipped
+ nullable: true
+ type: string
+ in_triage_by:
+ description: The user who triaged the incident
+ nullable: true
+ type: object
+ started_by:
+ description: The user who started the incident
+ nullable: true
+ type: object
+ mitigated_by:
+ description: The user who mitigated the incident
+ nullable: true
+ type: object
+ resolved_by:
+ description: The user who resolved the incident
+ nullable: true
+ type: object
+ closed_by:
+ description: The user who closed the incident
+ nullable: true
+ type: object
+ cancelled_by:
+ description: The user who cancelled the incident
+ nullable: true
+ type: object
+ in_triage_at:
+ description: Date of triage
+ nullable: true
+ type: string
+ started_at:
+ description: Date of start
+ nullable: true
+ type: string
+ detected_at:
+ description: Date of detection
+ nullable: true
+ type: string
+ acknowledged_at:
+ description: Date of acknowledgment
+ nullable: true
+ type: string
+ mitigated_at:
+ description: Date of mitigation
+ nullable: true
+ type: string
+ resolved_at:
+ description: Date of resolution
+ nullable: true
+ type: string
+ closed_at:
+ description: Date of closure
+ nullable: true
+ type: string
+ cancelled_at:
+ description: Date of cancellation
+ nullable: true
type: string
- escalation_policy_trigger_params:
- $ref: '#/components/schemas/update_live_call_router_data_attributes_escalation_policy_trigger_params'
created_at:
description: Date of creation
type: string
@@ -47190,433 +37398,766 @@ components:
type: string
required:
- created_at
- - name
+ - title
- updated_at
type: object
- live_call_router_response:
+ incident_response:
properties:
data:
- $ref: '#/components/schemas/live_call_router_response_data'
+ $ref: '#/components/schemas/incident_response_data'
required:
- data
type: object
- live_call_router_list:
+ incident_list:
properties:
data:
items:
- $ref: '#/components/schemas/live_call_router_response_data'
+ $ref: '#/components/schemas/incident_response_data'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- new_heartbeat:
+ ip_ranges:
properties:
- data:
- $ref: '#/components/schemas/new_heartbeat_data'
+ integrations_ipv4:
+ description: IPv4 addresses associated with Rootly integrations.
+ items:
+ type: string
+ type: array
+ integrations_ipv6:
+ description: IPv6 addresses associated with Rootly integrations.
+ items:
+ type: string
+ type: array
+ webhooks_ipv4:
+ description: IPv4 addresses associated with Rootly webhooks.
+ items:
+ type: string
+ type: array
+ webhooks_ipv6:
+ description: IPv6 addresses associated with Rootly webhooks.
+ items:
+ type: string
+ type: array
required:
- - data
+ - integrations_ipv4
+ - integrations_ipv6
+ - webhooks_ipv4
+ - webhooks_ipv6
type: object
- update_heartbeat:
+ ip_ranges_response:
properties:
data:
- $ref: '#/components/schemas/update_heartbeat_data'
+ $ref: '#/components/schemas/ip_ranges_response_data'
required:
- data
type: object
- heartbeat:
+ links:
properties:
- name:
- description: The name of the heartbeat
- type: string
- description:
- description: The description of the heartbeat
- nullable: true
+ self:
type: string
- alert_summary:
- description: Summary of alerts triggered when heartbeat expires.
+ first:
type: string
- alert_urgency_id:
- description: Urgency of alerts triggered when heartbeat expires.
+ prev:
nullable: true
type: string
- interval:
- type: integer
- interval_unit:
- enum:
- - seconds
- - minutes
- - hours
+ next:
+ nullable: true
type: string
- notification_target_id:
+ last:
+ nullable: true
type: string
- notification_target_type:
+ required:
+ - first
+ - last
+ - next
+ - prev
+ - self
+ type: object
+ meeting_recording:
+ properties:
+ platform:
+ description: Meeting platform
enum:
- - User
- - Group
- - Service
- - EscalationPolicy
+ - zoom
+ - google_meet
+ - microsoft_teams
+ - webex
type: string
- enabled:
- description: Whether to trigger alerts when heartbeat is expired.
- type: boolean
+ session_number:
+ description: "Session number within the incident for this platform (starts\
+ \ at 1, increments on re-invite)"
+ type: integer
status:
+ description: Current recording lifecycle status
enum:
- - waiting
- - active
- - expired
+ - pending
+ - recording
+ - paused
+ - call_ended
+ - analyzing
+ - completed
+ - failed
type: string
- ping_url:
- description: URL to receive heartbeat pings.
+ started_at:
+ description: When the bot started recording (null if bot never joined)
+ format: date-time
nullable: true
type: string
- secret:
- description: Secret used as bearer token when pinging heartbeat.
+ ended_at:
+ description: When the recording ended
+ format: date-time
nullable: true
type: string
- last_pinged_at:
- description: When the heartbeat was last pinged.
+ duration_minutes:
+ description: Recording duration in minutes (null if not started)
nullable: true
- type: string
- expires_at:
- description: When heartbeat expires
+ type: number
+ speaker_count:
+ description: Number of unique speakers detected in the transcript
+ type: integer
+ word_count:
+ description: Total word count across all transcript segments
+ type: integer
+ transcript_summary:
+ description: AI-generated summary of the meeting transcript (null if no
+ transcript or not yet analyzed)
nullable: true
type: string
+ has_video:
+ description: Whether a video recording file is attached
+ type: boolean
created_at:
- description: Date of creation
+ description: When the recording session was created
+ format: date-time
type: string
updated_at:
- description: Date of last update
+ description: When the recording session was last updated
+ format: date-time
type: string
required:
- - alert_summary
- created_at
- - enabled
- - interval
- - interval_unit
- - name
- - notification_target_id
- - notification_target_type
+ - platform
+ - session_number
- status
- updated_at
type: object
- heartbeat_response:
- properties:
- data:
- $ref: '#/components/schemas/heartbeat_response_data'
- required:
- - data
- type: object
- heartbeat_list:
+ meeting_recording_list:
properties:
data:
items:
- $ref: '#/components/schemas/heartbeat_response_data'
+ $ref: '#/components/schemas/meeting_recording_list_data_inner'
type: array
- links:
+ meta:
allOf:
- - $ref: '#/components/schemas/links'
+ - $ref: '#/components/schemas/meta'
type: object
required:
- data
- - links
type: object
- new_incident_action_item:
+ meta:
+ properties:
+ next_cursor:
+ nullable: true
+ type: string
+ current_page:
+ nullable: true
+ type: integer
+ next_page:
+ nullable: true
+ type: integer
+ prev_page:
+ nullable: true
+ type: integer
+ total_count:
+ type: integer
+ total_pages:
+ type: integer
+ required:
+ - current_page
+ - next_page
+ - prev_page
+ - total_count
+ - total_pages
+ type: object
+ new_on_call_pay_report:
properties:
data:
- $ref: '#/components/schemas/new_incident_action_item_data'
+ $ref: '#/components/schemas/new_on_call_pay_report_data'
required:
- data
type: object
- update_incident_action_item:
+ update_on_call_pay_report:
properties:
data:
- $ref: '#/components/schemas/update_incident_action_item_data'
+ $ref: '#/components/schemas/update_on_call_pay_report_data'
required:
- data
type: object
- incident_action_item:
+ on_call_pay_report:
properties:
- summary:
- description: The summary of the action item
+ status:
+ description: The current status of the report.
+ enum:
+ - processing
+ - generated
+ - downloaded
type: string
- description:
- description: The description of incident action item
- nullable: true
+ start_date:
+ description: The start date of the report period.
+ format: date
type: string
- kind:
- description: The kind of the action item
- enum:
- - task
- - follow_up
+ end_date:
+ description: The end date of the report period.
+ format: date
type: string
- assigned_to_user_id:
- description: ID of user you wish to assign this action item
- nullable: true
+ total_duration:
+ description: Total on-call duration in seconds.
type: integer
- assigned_to_group_ids:
- description: IDs of groups you wish to assign this action item
- items:
- type: string
- nullable: true
- type: array
- priority:
- description: The priority of the action item
- enum:
- - high
- - medium
- - low
+ users_count:
+ description: Number of users included in the report.
+ type: integer
+ currency:
+ description: The currency code for monetary values.
type: string
- status:
- description: The status of the action item
+ pay_type:
+ description: The pay calculation type.
enum:
- - open
- - in_progress
- - cancelled
- - done
+ - hourly
+ - daily
type: string
- due_date:
- description: The due date of the action item
+ hourly_rate_cents:
+ description: Hourly pay rate in cents.
+ type: integer
+ daily_rate_cents:
+ description: Daily pay rate in cents.
+ type: integer
+ total_pay_cents:
+ description: Total pay amount in cents.
+ type: integer
+ include_shadow:
+ description: Whether shadow shifts are included.
+ type: boolean
+ show_individual_shift_data:
+ description: Whether individual shift data is shown.
+ type: boolean
+ has_single_rate:
+ description: Whether a single rate is applied to all users.
+ type: boolean
+ enabled_granular_time_breakdown:
+ description: Whether granular time breakdown is enabled.
+ type: boolean
+ last_generated_at:
+ description: When the report was last generated.
+ format: date-time
nullable: true
type: string
- jira_issue_id:
- description: The Jira issue ID.
+ time_zone:
+ description: The team's IANA timezone used to interpret start_date and end_date.
nullable: true
type: string
- jira_issue_url:
- description: The Jira issue URL.
+ csv_file_url:
+ description: Download URL for the generated CSV report. Null until the report
+ is generated.
+ format: uri
+ nullable: true
+ type: string
+ xlsx_file_url:
+ description: Download URL for the generated XLSX report. Null until the
+ report is generated.
+ format: uri
nullable: true
type: string
created_at:
- description: Date of creation
+ format: date-time
type: string
updated_at:
- description: Date of last update
+ format: date-time
type: string
required:
- created_at
- - summary
+ - end_date
+ - start_date
+ - status
- updated_at
type: object
- incident_action_item_response:
+ on_call_pay_report_response:
properties:
data:
- $ref: '#/components/schemas/incident_action_item_response_data'
+ $ref: '#/components/schemas/on_call_pay_report_response_data'
required:
- data
type: object
- incident_action_item_list:
+ on_call_pay_report_list:
properties:
data:
items:
- $ref: '#/components/schemas/incident_action_item_response_data'
+ $ref: '#/components/schemas/on_call_pay_report_response_data'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- new_incident_custom_field_selection:
+ new_on_call_shadow:
properties:
data:
- $ref: '#/components/schemas/new_incident_custom_field_selection_data'
+ $ref: '#/components/schemas/new_on_call_shadow_data'
required:
- data
type: object
- update_incident_custom_field_selection:
+ update_on_call_shadow:
properties:
data:
- $ref: '#/components/schemas/update_incident_custom_field_selection_data'
+ $ref: '#/components/schemas/update_on_call_shadow_data'
required:
- data
type: object
- incident_custom_field_selection:
+ on_call_shadow:
properties:
- incident_id:
+ schedule_id:
+ description: ID of schedule the shadow shift belongs to
+ nullable: false
type: string
- custom_field_id:
+ shadowable_type:
+ enum:
+ - User
+ - Schedule
+ type: string
+ shadowable_id:
+ description: ID of schedule or user the shadow user is shadowing
+ nullable: false
+ type: string
+ shadow_user_id:
+ description: Which user the shadow shift belongs to.
+ nullable: false
type: integer
- value:
- description: The value of the incident_custom_field_selection
- nullable: true
+ starts_at:
+ description: Start datetime of shadow shift
+ format: date-time
+ nullable: false
+ type: string
+ ends_at:
+ description: End datetime for shadow shift
+ format: date-time
+ nullable: false
+ type: string
+ created_at:
+ description: Date of creation
+ type: string
+ updated_at:
+ description: Date of last update
type: string
- selected_option_ids:
- items:
- description: The selected option id for select and multi_select kinds
- type: integer
- type: array
required:
- - selected_option_ids
- - value
+ - ends_at
+ - schedule_id
+ - shadow_user_id
+ - shadowable_id
+ - shadowable_type
+ - starts_at
type: object
- incident_custom_field_selection_response:
+ on_call_shadow_response:
properties:
data:
- $ref: '#/components/schemas/incident_custom_field_selection_response_data'
+ $ref: '#/components/schemas/on_call_shadow_response_data'
required:
- data
type: object
- incident_custom_field_selection_list:
+ on_call_shadows_list:
properties:
data:
items:
- $ref: '#/components/schemas/incident_custom_field_selection_response_data'
+ $ref: '#/components/schemas/on_call_shadows_list_data_inner'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- new_incident_event_functionality:
+ new_on_call_role:
properties:
data:
- $ref: '#/components/schemas/new_incident_event_functionality_data'
+ $ref: '#/components/schemas/new_on_call_role_data'
required:
- data
type: object
- update_incident_event_functionality:
+ update_on_call_role:
properties:
data:
- $ref: '#/components/schemas/update_incident_event_functionality_data'
+ $ref: '#/components/schemas/update_on_call_role_data'
required:
- data
type: object
- incident_event_functionality:
- additionalProperties: false
+ on_call_role:
properties:
- incident_event_id:
- description: The ID of the incident event.
+ name:
+ description: The role name.
type: string
- functionality_id:
- description: The ID of the functionality.
+ slug:
+ description: The role slug.
type: string
- status:
- description: The status of the affected functionality
- enum:
- - operational
- - partial_outage
- - major_outage
+ system_role:
+ description: The kind of role
+ items:
+ enum:
+ - admin
+ - user
+ - custom
+ - observer
+ - no_access
+ type: string
+ type: array
+ alert_sources_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ alert_urgency_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ alert_fields_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ alert_groups_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ alert_routing_rules_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ on_call_readiness_report_permissions:
+ items:
+ enum:
+ - read
+ type: string
+ type: array
+ on_call_roles_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ alerts_permissions:
+ items:
+ enum:
+ - create
+ - update
+ - read
+ - delete
+ type: string
+ type: array
+ api_keys_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ audits_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ contacts_permissions:
+ items:
+ enum:
+ - read
+ type: string
+ type: array
+ escalation_policies_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ groups_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ heartbeats_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ integrations_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ invitations_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ live_call_routing_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ schedule_override_permissions:
+ items:
+ enum:
+ - create
+ - update
+ type: string
+ type: array
+ schedules_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ services_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ webhooks_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ workflows_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ created_at:
+ type: string
+ updated_at:
type: string
required:
- - functionality_id
- - incident_event_id
- - status
+ - created_at
+ - name
+ - updated_at
type: object
- incident_event_functionality_response:
+ on_call_role_response:
properties:
data:
- $ref: '#/components/schemas/incident_event_functionality_response_data'
+ $ref: '#/components/schemas/on_call_role_response_data'
required:
- data
type: object
- incident_event_functionality_list:
+ on_call_role_list:
properties:
data:
items:
- $ref: '#/components/schemas/incident_event_functionality_response_data'
+ $ref: '#/components/schemas/on_call_role_response_data'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- new_incident_event_service:
+ new_override_shift:
properties:
data:
- $ref: '#/components/schemas/new_incident_event_service_data'
+ $ref: '#/components/schemas/new_override_shift_data'
required:
- data
type: object
- update_incident_event_service:
+ update_override_shift:
properties:
data:
- $ref: '#/components/schemas/update_incident_event_service_data'
+ $ref: '#/components/schemas/update_override_shift_data'
required:
- data
type: object
- incident_event_service:
- additionalProperties: false
+ override_shift:
properties:
- incident_event_id:
- description: The ID of the incident event.
+ schedule_id:
+ description: ID of schedule
+ nullable: false
type: string
- service_id:
- description: The ID of the service.
+ rotation_id:
+ description: ID of rotation
+ nullable: true
type: string
- status:
- description: The status of the affected service
- enum:
- - operational
- - partial_outage
- - major_outage
+ starts_at:
+ description: Start datetime of shift
+ nullable: false
+ type: string
+ ends_at:
+ description: End datetime of shift
+ nullable: false
+ type: string
+ is_override:
+ description: Denotes shift is an override shift
+ type: boolean
+ created_at:
+ description: Date of creation
+ type: string
+ updated_at:
+ description: Date of last update
type: string
+ shift_override:
+ allOf:
+ - $ref: '#/components/schemas/shift_override_response'
+ description: Override metadata
+ nullable: true
+ type: object
+ user_id:
+ description: Override shift user
+ nullable: false
+ type: integer
+ user:
+ allOf:
+ - $ref: '#/components/schemas/user_response'
+ description: User metadata
+ nullable: false
+ type: object
required:
- - incident_event_id
- - service_id
- - status
+ - ends_at
+ - is_override
+ - rotation_id
+ - schedule_id
+ - starts_at
type: object
- incident_event_service_response:
+ override_shift_response:
properties:
data:
- $ref: '#/components/schemas/incident_event_service_response_data'
+ $ref: '#/components/schemas/override_shift_response_data'
required:
- data
type: object
- incident_event_service_list:
+ override_shift_list:
properties:
data:
items:
- $ref: '#/components/schemas/incident_event_service_response_data'
+ $ref: '#/components/schemas/override_shift_response_data'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- new_incident_event:
- properties:
- data:
- $ref: '#/components/schemas/new_incident_event_data'
- required:
- - data
- type: object
- update_incident_event:
- properties:
- data:
- $ref: '#/components/schemas/update_incident_event_data'
- required:
- - data
- type: object
- incident_event:
+ shift_override:
properties:
- event:
- description: The summary of the incident event
- type: string
- visibility:
- description: The visibility of the incident action item
- enum:
- - internal
- - external
- type: string
- occurred_at:
- description: Date of occurence
+ shift_id:
+ description: ID of shift
+ nullable: false
type: string
+ created_by_user_id:
+ description: User who created the override
+ nullable: false
+ type: integer
created_at:
description: Date of creation
type: string
@@ -47624,63 +38165,45 @@ components:
description: Date of last update
type: string
required:
- - created_at
- - event
- - occurred_at
- - updated_at
- type: object
- incident_event_response:
- properties:
- data:
- $ref: '#/components/schemas/incident_event_response_data'
- required:
- - data
+ - created_by_user_id
+ - shift_id
type: object
- incident_event_list:
+ shift_override_response:
properties:
data:
- items:
- $ref: '#/components/schemas/incident_event_response_data'
- type: array
- links:
- allOf:
- - $ref: '#/components/schemas/links'
- type: object
+ $ref: '#/components/schemas/shift_override_response_data'
required:
- data
- - links
type: object
- new_incident_feedback:
+ new_playbook_task:
properties:
data:
- $ref: '#/components/schemas/new_incident_feedback_data'
+ $ref: '#/components/schemas/new_playbook_task_data'
required:
- data
type: object
- update_incident_feedback:
+ update_playbook_task:
properties:
data:
- $ref: '#/components/schemas/update_incident_feedback_data'
+ $ref: '#/components/schemas/update_playbook_task_data'
required:
- data
type: object
- incident_feedback:
+ playbook_task:
properties:
- feedback:
- description: The feedback of the incident feedback
+ playbook_id:
type: string
- rating:
- description: The rating of the incident feedback
- enum:
- - 4
- - 3
- - 2
- - 1
- - 0
+ task:
+ description: The task of the task
+ type: string
+ description:
+ description: The description of task
+ nullable: true
+ type: string
+ position:
+ description: The position of the task
+ nullable: true
type: integer
- anonymous:
- description: Is the feedback anonymous?
- type: boolean
created_at:
description: Date of creation
type: string
@@ -47688,390 +38211,478 @@ components:
description: Date of last update
type: string
required:
- - anonymous
- created_at
- - feedback
- - rating
+ - task
- updated_at
type: object
- incident_feedback_response:
+ playbook_task_response:
properties:
data:
- $ref: '#/components/schemas/incident_feedback_response_data'
+ $ref: '#/components/schemas/playbook_task_response_data'
required:
- data
type: object
- incident_feedback_list:
+ playbook_task_list:
properties:
data:
items:
- $ref: '#/components/schemas/incident_feedback_response_data'
+ $ref: '#/components/schemas/playbook_task_response_data'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- new_incident_form_field_selection:
+ new_playbook:
properties:
data:
- $ref: '#/components/schemas/new_incident_form_field_selection_data'
+ $ref: '#/components/schemas/new_playbook_data'
required:
- data
type: object
- update_incident_form_field_selection:
+ update_playbook:
properties:
data:
- $ref: '#/components/schemas/update_incident_form_field_selection_data'
+ $ref: '#/components/schemas/update_playbook_data'
required:
- data
type: object
- incident_form_field_selection:
+ playbook:
properties:
- incident_id:
+ title:
+ description: The title of the playbook
type: string
- form_field_id:
- description: The custom field for this selection
+ summary:
+ description: The summary of the playbook
+ nullable: true
type: string
- value:
- description: The selected value for text kind custom fields
+ external_url:
+ description: The external url of the playbook
nullable: true
type: string
- selected_catalog_entity_ids:
+ severity_ids:
+ description: The Severity IDs to attach to the incident
items:
- description: The selected catalog entities for select and multi_select
- kinds
type: string
+ nullable: true
type: array
- selected_group_ids:
+ environment_ids:
+ description: The Environment IDs to attach to the incident
items:
- description: The selected groups (teams) for select and multi_select kinds
type: string
+ nullable: true
type: array
- selected_option_ids:
+ functionality_ids:
+ description: The Functionality IDs to attach to the incident
items:
- description: The selected options for select and multi_select kinds
type: string
+ nullable: true
type: array
- selected_service_ids:
+ service_ids:
+ description: The Service IDs to attach to the incident
items:
- description: The selected services for select and multi_select kinds
type: string
+ nullable: true
type: array
- selected_functionality_ids:
+ group_ids:
+ description: The Team IDs to attach to the incident
items:
- description: The selected functionalities for select and multi_select
- kinds
type: string
+ nullable: true
type: array
- selected_user_ids:
+ incident_type_ids:
+ description: The Incident Type IDs to attach to the incident
items:
- description: The selected users for select and multi_select kinds
- type: integer
+ type: string
+ nullable: true
type: array
+ created_at:
+ description: Date of creation
+ type: string
+ updated_at:
+ description: Date of last update
+ type: string
required:
- - form_field_id
- - incident_id
+ - created_at
+ - title
+ - updated_at
type: object
- incident_form_field_selection_response:
+ playbook_response:
properties:
data:
- $ref: '#/components/schemas/incident_form_field_selection_response_data'
+ $ref: '#/components/schemas/playbook_response_data'
required:
- data
type: object
- incident_form_field_selection_list:
+ playbook_list:
properties:
data:
items:
- $ref: '#/components/schemas/incident_form_field_selection_response_data'
+ $ref: '#/components/schemas/playbook_response_data'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- new_incident_permission_set_boolean:
+ new_post_mortem_template:
properties:
data:
- $ref: '#/components/schemas/new_incident_permission_set_boolean_data'
+ $ref: '#/components/schemas/new_post_mortem_template_data'
required:
- data
type: object
- update_incident_permission_set_boolean:
+ update_post_mortem_template:
properties:
data:
- $ref: '#/components/schemas/update_incident_permission_set_boolean_data'
+ $ref: '#/components/schemas/update_post_mortem_template_data'
required:
- data
type: object
- incident_permission_set_boolean:
+ post_mortem_template:
properties:
- incident_permission_set_id:
+ name:
+ description: The name of the postmortem template
type: string
- kind:
- enum:
- - publish_to_status_page
- - assign_incident_roles
- - invite_subscribers
- - update_summary
- - update_timeline
- - trigger_workflows
- - create_communications
- - read_communications
- - update_communications
- - delete_communications
- - send_communications
- - modify_custom_fields
+ slug:
+ description: The slugified name of the postmortem template
type: string
- private:
- type: boolean
- enabled:
+ default:
+ description: Default selected template when editing a postmortem
+ nullable: true
type: boolean
+ content:
+ description: The postmortem template. Liquid syntax and markdown are supported
+ type: string
+ content_html:
+ description: The postmortem template in HTML format with TipTap blocks support.
+ Supports followup and timeline components. Liquid syntax is supported.
+ nullable: true
+ type: string
+ content_json:
+ description: The postmortem template in TipTap JSON format
+ nullable: true
+ type: object
+ format:
+ description: The format of the input
+ enum:
+ - html
+ - markdown
+ type: string
created_at:
+ description: Date of creation
type: string
updated_at:
+ description: Date of last update
type: string
required:
- created_at
- - kind
+ - name
- updated_at
type: object
- incident_permission_set_boolean_response:
+ tiptap_block_schema:
+ description: TipTap block component schema for post mortem templates
+ properties:
+ followup_component:
+ $ref: '#/components/schemas/tiptap_block_schema_followup_component'
+ timeline_component:
+ $ref: '#/components/schemas/tiptap_block_schema_timeline_component'
+ type: object
+ post_mortem_template_response:
properties:
data:
- $ref: '#/components/schemas/incident_permission_set_boolean_response_data'
+ $ref: '#/components/schemas/post_mortem_template_response_data'
required:
- data
type: object
- incident_permission_set_boolean_list:
+ post_mortem_template_list:
properties:
data:
items:
- $ref: '#/components/schemas/incident_permission_set_boolean_response_data'
+ $ref: '#/components/schemas/post_mortem_template_response_data'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- new_incident_permission_set_resource:
+ new_pulse:
properties:
data:
- $ref: '#/components/schemas/new_incident_permission_set_resource_data'
+ $ref: '#/components/schemas/new_pulse_data'
required:
- data
type: object
- update_incident_permission_set_resource:
+ update_pulse:
properties:
data:
- $ref: '#/components/schemas/update_incident_permission_set_resource_data'
+ $ref: '#/components/schemas/update_pulse_data'
required:
- data
type: object
- incident_permission_set_resource:
+ pulse:
properties:
- incident_permission_set_id:
- type: string
- kind:
- enum:
- - severities
- - incident_types
- - statuses
- - sub_statuses
+ source:
+ description: "The source of the pulse (eg: k8s)"
+ nullable: true
type: string
- private:
- type: boolean
- resource_id:
+ summary:
+ description: The summary of the pulse
type: string
- resource_type:
+ services:
+ description: Services attached to the pulse
+ items:
+ allOf:
+ - $ref: '#/components/schemas/service'
+ type: object
+ type: array
+ environments:
+ description: Environments attached to the pulse
+ items:
+ allOf:
+ - $ref: '#/components/schemas/environment'
+ type: object
+ type: array
+ external_url:
+ description: The external url of the pulse
+ nullable: true
type: string
+ labels:
+ items:
+ $ref: '#/components/schemas/new_pulse_data_attributes_labels_inner'
+ type: array
+ refs:
+ items:
+ $ref: '#/components/schemas/new_pulse_data_attributes_refs_inner'
+ type: array
+ data:
+ description: Additional data
+ nullable: true
+ type: object
created_at:
+ description: Date of creation
type: string
updated_at:
+ description: Date of last update
type: string
required:
- created_at
- - incident_permission_set_id
- - kind
+ - summary
- updated_at
type: object
- incident_permission_set_resource_response:
+ pulse_response:
properties:
data:
- $ref: '#/components/schemas/incident_permission_set_resource_response_data'
+ $ref: '#/components/schemas/pulse_response_data'
required:
- data
type: object
- incident_permission_set_resource_list:
+ pulse_list:
properties:
data:
items:
- $ref: '#/components/schemas/incident_permission_set_resource_response_data'
+ $ref: '#/components/schemas/pulse_response_data'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- new_incident_permission_set:
+ update_retrospective_configuration:
properties:
data:
- $ref: '#/components/schemas/new_incident_permission_set_data'
+ $ref: '#/components/schemas/update_retrospective_configuration_data'
required:
- data
type: object
- update_incident_permission_set:
+ retrospective_configuration:
+ properties:
+ kind:
+ description: The kind of the configuration.
+ enum:
+ - skip
+ - mandatory
+ type: string
+ severity_ids:
+ description: The Severity IDs to attach to the retrospective configuration
+ items:
+ type: string
+ nullable: true
+ type: array
+ group_ids:
+ description: The Team IDs to attach to the retrospective configuration
+ items:
+ type: string
+ nullable: true
+ type: array
+ incident_type_ids:
+ description: The Incident Type IDs to attach to the retrospective configuration
+ items:
+ type: string
+ nullable: true
+ type: array
+ created_at:
+ description: Date of creation
+ type: string
+ updated_at:
+ description: Date of last update
+ type: string
+ type: object
+ retrospective_configuration_response:
properties:
data:
- $ref: '#/components/schemas/update_incident_permission_set_data'
+ $ref: '#/components/schemas/retrospective_configuration_response_data'
required:
- data
type: object
- incident_permission_set:
+ retrospective_configuration_list:
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/retrospective_configuration_list_data_inner'
+ type: array
+ required:
+ - data
+ type: object
+ new_retrospective_process:
+ properties:
+ data:
+ $ref: '#/components/schemas/new_retrospective_process_data'
+ required:
+ - data
+ type: object
+ update_retrospective_process:
+ properties:
+ data:
+ $ref: '#/components/schemas/update_retrospective_process_data'
+ required:
+ - data
+ type: object
+ retrospective_process:
properties:
name:
- description: The incident permission set name.
- type: string
- slug:
- description: The incident permission set slug.
+ description: The name of the retrospective process
type: string
description:
- description: The incident permission set description.
+ description: The description of the retrospective process
nullable: true
type: string
- private_incident_permissions:
- items:
- enum:
- - create
- - read
- - update
- - delete
- type: string
- type: array
- public_incident_permissions:
- items:
- enum:
- - create
- - read
- - update
- - delete
- type: string
- type: array
+ is_default:
+ description: Indicates the default process that Rootly created. This will
+ be used as a fallback if no processes match the incident's conditions.
+ The default process cannot have conditions and cannot be changed.
+ nullable: true
+ type: boolean
created_at:
+ description: Date of creation
type: string
updated_at:
+ description: Date of last update
type: string
- required:
- - created_at
- - name
- - slug
- - updated_at
+ retrospective_process_matching_criteria:
+ $ref: '#/components/schemas/new_retrospective_process_data_attributes_retrospective_process_matching_criteria'
type: object
- incident_permission_set_response:
+ retrospective_process_response:
properties:
data:
- $ref: '#/components/schemas/incident_permission_set_response_data'
+ $ref: '#/components/schemas/retrospective_process_response_data'
required:
- data
type: object
- incident_permission_set_list:
+ retrospective_process_list:
properties:
data:
items:
- $ref: '#/components/schemas/incident_permission_set_response_data'
+ $ref: '#/components/schemas/retrospective_process_list_data_inner'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- update_incident_post_mortem:
+ new_retrospective_step:
properties:
data:
- $ref: '#/components/schemas/update_incident_post_mortem_data'
+ $ref: '#/components/schemas/new_retrospective_step_data'
required:
- data
type: object
- incident_post_mortem:
+ update_retrospective_step:
properties:
- title:
- description: The title of the incident retrospective
+ data:
+ $ref: '#/components/schemas/update_retrospective_step_data'
+ required:
+ - data
+ type: object
+ retrospective_step:
+ properties:
+ retrospective_process_id:
type: string
- content:
- description: The content of the incident retrospective (Only if internal)
- nullable: true
+ title:
+ description: The name of the step
type: string
- status:
- description: The status of the incident retrospective
- enum:
- - draft
- - published
+ slug:
+ description: The slug of the step
type: string
- started_at:
- description: Date of started at
+ description:
+ description: The description of the step
nullable: true
type: string
- mitigated_at:
- description: Date of mitigation
+ incident_role_id:
+ description: Users assigned to the selected incident role will be the default
+ owners for this step
nullable: true
type: string
- resolved_at:
- description: Date of resolution
+ due_after_days:
+ description: Due date in days
nullable: true
- type: string
- show_timeline:
- description: Show events timeline of the incident retrospective
- type: boolean
- show_timeline_trail:
- description: Show trail events in the timeline of the incident retrospective
- type: boolean
- show_timeline_genius:
- description: Show workflow events in the timeline of the incident retrospective
- type: boolean
- show_timeline_tasks:
- description: Show tasks in the timeline of the incident retrospective
- type: boolean
- show_timeline_action_items:
- description: Show action items in the timeline of the incident retrospective
- type: boolean
- show_timeline_order:
- default: desc
- description: The order of the incident retrospective timeline
- enum:
- - asc
- - desc
- type: string
- show_services_impacted:
- description: Show functionalities impacted of the incident retrospective
- type: boolean
- show_functionalities_impacted:
- description: Show services impacted of the incident retrospective
- type: boolean
- show_groups_impacted:
- description: Show groups impacted of the incident retrospective
- type: boolean
- show_alerts_attached:
- description: Show alerts attached to the incident
+ type: integer
+ position:
+ description: Position of the step
+ type: integer
+ skippable:
+ description: Is the step skippable?
type: boolean
- url:
- description: The url to the incident retrospective
- type: string
created_at:
description: Date of creation
type: string
@@ -48080,125 +38691,432 @@ components:
type: string
required:
- created_at
+ - retrospective_process_id
- title
- updated_at
type: object
- incident_post_mortem_response:
+ retrospective_step_response:
properties:
data:
- $ref: '#/components/schemas/incident_post_mortem_response_data'
+ $ref: '#/components/schemas/retrospective_step_response_data'
required:
- data
type: object
- incident_post_mortem_list:
+ retrospective_step_list:
properties:
data:
items:
- $ref: '#/components/schemas/incident_post_mortem_response_data'
+ $ref: '#/components/schemas/retrospective_step_response_data'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- update_incident_retrospective_step:
+ new_role:
properties:
data:
- $ref: '#/components/schemas/update_incident_retrospective_step_data'
+ $ref: '#/components/schemas/new_role_data'
required:
- data
type: object
- incident_retrospective_step:
+ update_role:
properties:
- retrospective_step_id:
- type: string
- incident_id:
- type: string
- title:
- description: The name of the step
- type: string
- description:
- description: The description of the step
- nullable: true
- type: string
- status:
- description: Status of the incident retrospective step
- enum:
- - todo
- - in_progress
- - completed
- - skipped
- nullable: false
+ data:
+ $ref: '#/components/schemas/update_role_data'
+ required:
+ - data
+ type: object
+ role:
+ properties:
+ name:
+ description: The role name.
type: string
- kind:
- description: Due date
- nullable: true
+ slug:
+ description: The role slug.
type: string
- due_date:
- description: Due date
+ incident_permission_set_id:
+ description: Associated incident permissions set.
nullable: true
type: string
- position:
- description: Position of the step
- type: integer
- skippable:
- description: Is the step skippable?
+ is_deletable:
+ description: Whether the role can be deleted.
+ type: boolean
+ is_editable:
+ description: Whether the role can be edited.
type: boolean
+ alerts_permissions:
+ items:
+ enum:
+ - create
+ - read
+ type: string
+ type: array
+ api_keys_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ audits_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ billing_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ environments_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ form_fields_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ functionalities_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ groups_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ incident_causes_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ incident_feedbacks_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ incident_roles_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ incident_types_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ incidents_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ integrations_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ invitations_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ playbooks_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ private_incidents_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ pulses_permissions:
+ items:
+ enum:
+ - create
+ - update
+ - read
+ type: string
+ type: array
+ retrospective_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ roles_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ secrets_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ services_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ severities_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ status_pages_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ webhooks_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ workflows_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ catalogs_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ sub_statuses_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ edge_connector_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ slas_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ paging_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ incident_communication_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ - send
+ type: string
+ type: array
+ communication_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
created_at:
- description: Date of creation
type: string
updated_at:
- description: Date of last update
type: string
required:
- created_at
- - incident_id
- - retrospective_step_id
- - title
+ - name
- updated_at
type: object
- incident_retrospective_step_response:
+ role_response:
properties:
data:
- $ref: '#/components/schemas/incident_retrospective_step_response_data'
+ $ref: '#/components/schemas/role_response_data'
required:
- data
type: object
- new_incident_role_task:
+ role_list:
properties:
data:
- $ref: '#/components/schemas/new_incident_role_task_data'
+ items:
+ $ref: '#/components/schemas/role_response_data'
+ type: array
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
+ - links
+ - meta
type: object
- update_incident_role_task:
+ new_schedule_rotation_active_day:
properties:
data:
- $ref: '#/components/schemas/update_incident_role_task_data'
+ $ref: '#/components/schemas/new_schedule_rotation_active_day_data'
required:
- data
type: object
- incident_role_task:
+ update_schedule_rotation_active_day:
properties:
- incident_role_id:
- type: string
- task:
- description: The task of the incident task
- type: string
- description:
- description: The description of incident task
- nullable: true
+ data:
+ $ref: '#/components/schemas/update_schedule_rotation_active_day_data'
+ required:
+ - data
+ type: object
+ schedule_rotation_active_day:
+ properties:
+ schedule_rotation_id:
type: string
- priority:
- description: The priority of the incident task
+ day_name:
+ description: Schedule rotation day name for which active times to be created
enum:
- - high
- - medium
- - low
+ - S
+ - M
+ - T
+ - W
+ - R
+ - F
+ - U
type: string
+ active_time_attributes:
+ description: Schedule rotation active times per day
+ items:
+ $ref: '#/components/schemas/new_schedule_rotation_active_day_data_attributes_active_time_attributes_inner'
+ type: array
created_at:
description: Date of creation
type: string
@@ -48206,71 +39124,57 @@ components:
description: Date of last update
type: string
required:
+ - active_time_attributes
- created_at
- - task
+ - day_name
+ - schedule_rotation_id
- updated_at
- type: object
- incident_role_task_response:
+ schedule_rotation_active_day_response:
properties:
data:
- $ref: '#/components/schemas/incident_role_task_response_data'
- required:
- - data
+ $ref: '#/components/schemas/schedule_rotation_active_day_response_data'
type: object
- incident_role_task_list:
+ schedule_rotation_active_day_list:
properties:
data:
items:
- $ref: '#/components/schemas/incident_role_task_response_data'
+ $ref: '#/components/schemas/schedule_rotation_active_day_list_data_inner'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- new_incident_role:
+ new_schedule_rotation_user:
properties:
data:
- $ref: '#/components/schemas/new_incident_role_data'
- required:
- - data
+ $ref: '#/components/schemas/new_schedule_rotation_user_data'
type: object
- update_incident_role:
+ update_schedule_rotation_user:
properties:
data:
- $ref: '#/components/schemas/update_incident_role_data'
+ $ref: '#/components/schemas/update_schedule_rotation_user_data'
required:
- data
type: object
- incident_role:
+ schedule_rotation_user:
properties:
- name:
- description: The name of the incident role
- type: string
- slug:
- description: The slug of the incident role
- type: string
- summary:
- description: The summary of the incident role
- nullable: true
- type: string
- description:
- description: The description of the incident role
- nullable: true
+ schedule_rotation_id:
type: string
+ user_id:
+ description: Schedule rotation user
+ type: integer
position:
- description: Position of the incident role
- nullable: true
+ description: Position of the user inside rotation
type: integer
- optional:
- type: boolean
- enabled:
- type: boolean
- allow_multi_user_assignment:
- type: boolean
created_at:
description: Date of creation
type: string
@@ -48279,159 +39183,198 @@ components:
type: string
required:
- created_at
- - name
+ - position
+ - schedule_rotation_id
- updated_at
+ - user_id
type: object
- incident_role_response:
- properties:
- data:
- $ref: '#/components/schemas/incident_role_response_data'
- required:
- - data
- type: object
- incident_role_list:
+ schedule_rotation_user_list:
properties:
data:
items:
- $ref: '#/components/schemas/incident_role_response_data'
+ $ref: '#/components/schemas/schedule_rotation_user_list_data_inner'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- new_incident_status_page_event:
+ schedule_rotation_user_response:
properties:
data:
- $ref: '#/components/schemas/new_incident_status_page_event_data'
+ $ref: '#/components/schemas/schedule_rotation_user_list_data_inner'
required:
- data
type: object
- update_incident_status_page_event:
+ new_schedule_rotation:
properties:
data:
- $ref: '#/components/schemas/update_incident_status_page_event_data'
+ $ref: '#/components/schemas/new_schedule_rotation_data'
required:
- data
type: object
- incident_status_page_event:
+ update_schedule_rotation:
properties:
- event:
- description: The summary of the incident event
+ data:
+ $ref: '#/components/schemas/update_schedule_rotation_data'
+ required:
+ - data
+ type: object
+ schedule_rotation:
+ properties:
+ schedule_id:
+ description: The ID of parent schedule
type: string
- status_page_id:
- description: Unique ID of the status page you wish to post the event to
+ name:
+ description: The name of the schedule rotation
type: string
- status:
- description: The status of the incident event
+ position:
+ description: Position of the schedule rotation
+ type: integer
+ schedule_rotationable_type:
+ description: Schedule rotation type
enum:
- - investigating
- - identified
- - monitoring
- - resolved
- - scheduled
- - in_progress
- - verifying
- - completed
+ - ScheduleDailyRotation
+ - ScheduleWeeklyRotation
+ - ScheduleBiweeklyRotation
+ - ScheduleMonthlyRotation
+ - ScheduleCustomRotation
type: string
- notify_subscribers:
- description: Notify all status pages subscribers
- type: boolean
- should_tweet:
- description: For Statuspage.io integrated pages auto publishes a tweet for
- your update
+ active_all_week:
+ default: true
+ description: Schedule rotation active all week?
type: boolean
- started_at:
- description: Date of start
+ active_days:
+ items:
+ description: Schedule rotation active days
+ enum:
+ - S
+ - M
+ - T
+ - W
+ - R
+ - F
+ - U
+ type: string
+ type: array
+ active_time_type:
+ items:
+ default: all_day
+ description: Schedule rotation active time type
+ enum:
+ - all_day
+ - same_time
+ - custom
+ type: string
+ type: array
+ active_time_attributes:
+ description: Schedule rotation's active times
+ items:
+ $ref: '#/components/schemas/new_schedule_rotation_data_attributes_active_time_attributes_inner'
+ type: array
+ time_zone:
+ default: Etc/UTC
+ description: A valid IANA time zone name.
type: string
- created_at:
- description: Date of creation
+ schedule_rotationable_attributes:
+ $ref: '#/components/schemas/new_schedule_rotation_data_attributes_schedule_rotationable_attributes'
+ start_time:
+ description: RFC3339 date-time when rotation starts. Shifts will only be
+ created after this time.
+ format: date-time
+ nullable: true
type: string
- updated_at:
- description: Date of last update
+ end_time:
+ description: RFC3339 date-time when rotation ends. Shifts will only be created
+ before this time.
+ format: date-time
+ nullable: true
type: string
required:
- - created_at
- - event
- - started_at
- - updated_at
+ - name
+ - schedule_id
+ - schedule_rotationable_attributes
+ - schedule_rotationable_type
type: object
- incident_status_page_event_response:
+ schedule_rotation_response:
properties:
data:
- $ref: '#/components/schemas/incident_status_page_event_response_data'
+ $ref: '#/components/schemas/schedule_rotation_response_data'
required:
- data
type: object
- incident_status_page_event_list:
+ schedule_rotation_list:
properties:
data:
items:
- $ref: '#/components/schemas/incident_status_page_event_response_data'
+ $ref: '#/components/schemas/schedule_rotation_response_data'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- new_incident_type:
+ new_schedule:
properties:
data:
- $ref: '#/components/schemas/new_incident_type_data'
+ $ref: '#/components/schemas/new_schedule_data'
required:
- data
type: object
- update_incident_type:
+ update_schedule:
properties:
data:
- $ref: '#/components/schemas/update_incident_type_data'
+ $ref: '#/components/schemas/update_schedule_data'
required:
- data
type: object
- incident_type:
+ schedule:
properties:
name:
- description: The name of the incident type
- type: string
- slug:
- description: The slug of the incident type
+ description: The name of the schedule
type: string
description:
- description: The description of the incident type
- nullable: true
- type: string
- color:
- description: The hex color of the incident type
+ description: The description of the schedule
nullable: true
type: string
- position:
- description: Position of the incident type
+ all_time_coverage:
+ description: 24/7 coverage of the schedule
nullable: true
- type: integer
- notify_emails:
- description: Emails to attach to the incident type
+ type: boolean
+ slack_user_group:
+ $ref: '#/components/schemas/schedule_slack_user_group'
+ slack_channel:
+ $ref: '#/components/schemas/schedule_slack_channel'
+ owner_group_ids:
+ description: Owning teams.
items:
type: string
- nullable: true
- type: array
- slack_channels:
- description: Slack Channels associated with this incident type
- items:
- $ref: '#/components/schemas/new_environment_data_attributes_slack_channels_inner'
- nullable: true
- type: array
- slack_aliases:
- description: Slack Aliases associated with this incident type
- items:
- $ref: '#/components/schemas/new_environment_data_attributes_slack_aliases_inner'
- nullable: true
type: array
+ owner_user_id:
+ description: ID of user assigned as owner of the schedule
+ type: integer
+ shift_start_notifications_enabled:
+ description: Whether shift-start notifications are enabled
+ type: boolean
+ shift_update_notifications_enabled:
+ description: Whether shift-update notifications are enabled
+ type: boolean
created_at:
description: Date of creation
type: string
@@ -48441,261 +39384,265 @@ components:
required:
- created_at
- name
+ - owner_user_id
- updated_at
type: object
- incident_type_response:
+ schedule_response:
properties:
data:
- $ref: '#/components/schemas/incident_type_response_data'
+ $ref: '#/components/schemas/schedule_response_data'
required:
- data
type: object
- incident_type_list:
+ schedule_list:
properties:
data:
items:
- $ref: '#/components/schemas/incident_type_response_data'
+ $ref: '#/components/schemas/schedule_list_data_inner'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- new_incident:
- properties:
- data:
- $ref: '#/components/schemas/new_incident_data'
- required:
- - data
- type: object
- update_incident:
- properties:
- data:
- $ref: '#/components/schemas/update_incident_data'
- required:
- - data
- type: object
- in_triage_incident:
- properties:
- data:
- $ref: '#/components/schemas/in_triage_incident_data'
- required:
- - data
- type: object
- restart_incident:
- properties:
- data:
- $ref: '#/components/schemas/restart_incident_data'
- required:
- - data
- type: object
- mitigate_incident:
- properties:
- data:
- $ref: '#/components/schemas/mitigate_incident_data'
- required:
- - data
- type: object
- resolve_incident:
+ new_secret:
properties:
data:
- $ref: '#/components/schemas/resolve_incident_data'
+ $ref: '#/components/schemas/new_secret_data'
required:
- data
type: object
- cancel_incident:
+ update_secret:
properties:
data:
- $ref: '#/components/schemas/cancel_incident_data'
+ $ref: '#/components/schemas/update_secret_data'
required:
- data
type: object
- duplicate_incident:
+ secret:
properties:
- data:
- $ref: '#/components/schemas/duplicate_incident_data'
+ name:
+ description: The name of the secret
+ type: string
+ secret:
+ description: The redacted secret
+ type: string
+ hashicorp_vault_mount:
+ description: The HashiCorp Vault secret mount path
+ type: string
+ hashicorp_vault_path:
+ description: The HashiCorp Vault secret path
+ nullable: true
+ type: string
+ hashicorp_vault_version:
+ description: The HashiCorp Vault secret version
+ type: integer
+ created_at:
+ description: Date of creation
+ type: string
+ updated_at:
+ description: Date of last update
+ type: string
required:
- - data
+ - created_at
+ - name
+ - updated_at
type: object
- add_subscribers:
+ secret_response:
properties:
data:
- $ref: '#/components/schemas/add_subscribers_data'
+ $ref: '#/components/schemas/secret_response_data'
required:
- data
type: object
- remove_subscribers:
+ secret_list:
properties:
data:
- $ref: '#/components/schemas/remove_subscribers_data'
+ items:
+ $ref: '#/components/schemas/secret_response_data'
+ type: array
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
type: object
- assign_role_to_user:
+ new_service:
properties:
data:
- $ref: '#/components/schemas/assign_role_to_user_data'
+ $ref: '#/components/schemas/new_service_data'
required:
- data
type: object
- unassign_role_from_user:
+ update_service:
properties:
data:
- $ref: '#/components/schemas/unassign_role_from_user_data'
+ $ref: '#/components/schemas/update_service_data'
required:
- data
type: object
- incident:
+ service:
properties:
- title:
- description: The title of the incident
- type: string
- kind:
- description: The kind of the incident
+ name:
+ description: The name of the service
type: string
slug:
- description: The slug of the incident
- type: string
- parent_incident_id:
- description: ID of parent incident
- nullable: true
+ description: The slug of the service
type: string
- duplicate_incident_id:
- description: ID of duplicated incident
+ description:
+ description: The description of the service
nullable: true
type: string
- summary:
- description: The summary of the incident
+ public_description:
+ description: The public description of the service
nullable: true
type: string
- private:
- default: false
- description: Create an incident as private
- nullable: true
- type: boolean
- severity:
- allOf:
- - $ref: '#/components/schemas/severity_response'
- description: The Severity of the incident
- nullable: true
- type: object
- environments:
- description: The Environments of the incident
- items:
- allOf:
- - $ref: '#/components/schemas/environment_response'
- type: object
- nullable: true
- type: array
- incident_types:
- description: The Incident Types of the incident
- items:
- allOf:
- - $ref: '#/components/schemas/incident_type_response'
- type: object
- nullable: true
- type: array
- services:
- description: The Services of the incident
+ notify_emails:
+ description: Emails attached to the service
items:
- allOf:
- - $ref: '#/components/schemas/service_response'
- type: object
+ type: string
nullable: true
type: array
- functionalities:
- description: The Functionalities of the incident
- items:
- allOf:
- - $ref: '#/components/schemas/functionality_response'
- type: object
+ color:
+ description: The hex color of the service
nullable: true
- type: array
- groups:
- description: The Teams of to the incident
- items:
- allOf:
- - $ref: '#/components/schemas/team_response'
- type: object
+ type: string
+ position:
+ description: Position of the service
nullable: true
- type: array
- labels:
- description: "Labels to attach to the incidents. eg: {\"platform\":\"osx\"\
- , \"version\": \"1.29\"}"
+ type: integer
+ backstage_id:
+ description: "The Backstage entity id associated to this service. eg: :namespace/:kind/:entity_name"
nullable: true
- type: object
- slack_channel_id:
- description: Slack channel id
+ type: string
+ external_id:
+ description: The external id associated to this service
nullable: true
type: string
- slack_channel_name:
- description: Slack channel name
+ pagerduty_id:
+ description: The PagerDuty service id associated to this service
nullable: true
type: string
- slack_channel_url:
- description: Slack channel url
+ opsgenie_id:
+ description: The Opsgenie service id associated to this service
nullable: true
type: string
- mitigation_message:
- description: How was the incident mitigated?
+ cortex_id:
+ description: The Cortex group id associated to this service
nullable: true
type: string
- resolution_message:
- description: How was the incident resolved?
+ service_now_ci_sys_id:
+ description: The Service Now CI sys id associated to this service
nullable: true
type: string
- cancellation_message:
- description: Why was the incident cancelled?
+ github_repository_name:
+ description: "The GitHub repository name associated to this service. eg:\
+ \ rootlyhq/my-service"
nullable: true
type: string
- scheduled_for:
- description: Date of when the maintenance begins
+ github_repository_branch:
+ description: "The GitHub repository branch associated to this service. eg:\
+ \ main"
nullable: true
type: string
- scheduled_until:
- description: Date of when the maintenance ends
+ gitlab_repository_name:
+ description: "The GitLab repository name associated to this service. eg:\
+ \ rootlyhq/my-service"
nullable: true
type: string
- retrospective_progress_status:
- description: The status of the retrospective progress
- enum:
- - not_started
- - active
- - completed
- - skipped
+ gitlab_repository_branch:
+ description: "The GitLab repository branch associated to this service. eg:\
+ \ main"
nullable: true
type: string
- in_triage_at:
- description: Date of triage
+ kubernetes_deployment_name:
+ description: "The Kubernetes deployment name associated to this service.\
+ \ eg: namespace/deployment-name"
nullable: true
type: string
- started_at:
- description: Date of start
+ environment_ids:
+ description: Environments associated with this service
+ items:
+ type: string
+ nullable: true
+ type: array
+ service_ids:
+ description: Services dependent on this service
+ items:
+ type: string
+ nullable: true
+ type: array
+ owner_group_ids:
+ description: Owner Teams associated with this service
+ items:
+ type: string
+ nullable: true
+ type: array
+ owner_user_ids:
+ description: Owner Users associated with this service
+ items:
+ type: integer
+ nullable: true
+ type: array
+ alert_urgency_id:
+ description: The alert urgency id of the service
nullable: true
type: string
- detected_at:
- description: Date of detection
+ escalation_policy_id:
+ description: The escalation policy id of the service
nullable: true
type: string
- acknowledged_at:
- description: Date of acknowledgment
+ alerts_email_enabled:
+ description: Enable alerts through email
+ nullable: true
+ type: boolean
+ alerts_email_address:
+ description: Email generated to send alerts to
nullable: true
type: string
- mitigated_at:
- description: Date of mitigation
+ slack_channels:
+ description: Slack Channels associated with this service
+ items:
+ $ref: '#/components/schemas/new_environment_data_attributes_slack_channels_inner'
nullable: true
- type: string
- resolved_at:
- description: Date of resolution
+ type: array
+ slack_aliases:
+ description: Slack Aliases associated with this service
+ items:
+ $ref: '#/components/schemas/new_environment_data_attributes_slack_aliases_inner'
nullable: true
- type: string
- cancelled_at:
- description: Date of cancellation
+ type: array
+ alert_broadcast_enabled:
+ description: Enable alerts to be broadcasted to a specific channel
nullable: true
- type: string
+ type: boolean
+ alert_broadcast_channel:
+ $ref: '#/components/schemas/service_alert_broadcast_channel'
+ incident_broadcast_enabled:
+ description: Enable incidents to be broadcasted to a specific channel
+ nullable: true
+ type: boolean
+ incident_broadcast_channel:
+ $ref: '#/components/schemas/service_incident_broadcast_channel'
+ properties:
+ description: Array of property values for this service.
+ items:
+ $ref: '#/components/schemas/new_cause_data_attributes_properties_inner'
+ nullable: true
+ type: array
created_at:
description: Date of creation
type: string
@@ -48704,130 +39651,240 @@ components:
type: string
required:
- created_at
- - slug
- - title
+ - name
- updated_at
type: object
- incident_response:
+ service_response:
properties:
data:
- $ref: '#/components/schemas/incident_response_data'
+ $ref: '#/components/schemas/service_response_data'
required:
- data
type: object
- incident_list:
+ service_list:
properties:
data:
items:
- $ref: '#/components/schemas/incident_response_data'
+ $ref: '#/components/schemas/service_response_data'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- ip_ranges:
+ new_severity:
properties:
- integrations_ipv4:
- description: IPv4 addresses associated with Rootly integrations.
- items:
- type: string
- type: array
- integrations_ipv6:
- description: IPv6 addresses associated with Rootly integrations.
- items:
- type: string
- type: array
- webhooks_ipv4:
- description: IPv4 addresses associated with Rootly webhooks.
- items:
- type: string
- type: array
- webhooks_ipv6:
- description: IPv6 addresses associated with Rootly webhooks.
- items:
- type: string
- type: array
+ data:
+ $ref: '#/components/schemas/new_severity_data'
required:
- - integrations_ipv4
- - integrations_ipv6
- - webhooks_ipv4
- - webhooks_ipv6
+ - data
type: object
- ip_ranges_response:
+ update_severity:
properties:
data:
- $ref: '#/components/schemas/ip_ranges_response_data'
+ $ref: '#/components/schemas/update_severity_data'
required:
- data
type: object
- links:
+ severity:
properties:
- self:
+ name:
+ description: The name of the severity
type: string
- first:
+ slug:
+ description: The slug of the severity
type: string
- prev:
+ description:
+ description: The description of the severity
nullable: true
type: string
- next:
+ severity:
+ description: The severity of the severity
+ enum:
+ - critical
+ - high
+ - medium
+ - low
+ type: string
+ color:
+ description: The hex color of the severity
nullable: true
type: string
- last:
+ position:
+ description: Position of the severity
+ nullable: true
+ type: integer
+ notify_emails:
+ description: Emails to attach to the severity
+ items:
+ type: string
+ nullable: true
+ type: array
+ slack_channels:
+ description: Slack Channels associated with this severity
+ items:
+ $ref: '#/components/schemas/new_environment_data_attributes_slack_channels_inner'
+ nullable: true
+ type: array
+ slack_aliases:
+ description: Slack Aliases associated with this severity
+ items:
+ $ref: '#/components/schemas/new_environment_data_attributes_slack_aliases_inner'
+ nullable: true
+ type: array
+ created_at:
+ description: Date of creation
+ type: string
+ updated_at:
+ description: Date of last update
type: string
required:
- - first
- - last
- - next
- - prev
- - self
+ - created_at
+ - name
+ - updated_at
type: object
- new_on_call_shadow:
+ severity_response:
properties:
data:
- $ref: '#/components/schemas/new_on_call_shadow_data'
+ $ref: '#/components/schemas/severity_response_data'
required:
- data
type: object
- update_on_call_shadow:
+ severity_list:
properties:
data:
- $ref: '#/components/schemas/update_on_call_shadow_data'
+ items:
+ $ref: '#/components/schemas/severity_response_data'
+ type: array
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
+ - links
+ - meta
type: object
- on_call_shadow:
+ shift:
properties:
schedule_id:
- description: ID of schedule the shadow shift belongs to
+ description: ID of schedule
nullable: false
type: string
- shadowable_type:
- enum:
- - User
- - Schedule
+ rotation_id:
+ description: ID of rotation
+ nullable: true
type: string
- shadowable_id:
- description: ID of schedule or user the shadow user is shadowing
+ starts_at:
+ description: Start datetime of shift
nullable: false
type: string
- shadow_user_id:
- description: Which user the shadow shift belongs to.
+ ends_at:
+ description: End datetime of shift
nullable: false
+ type: string
+ is_override:
+ description: Denotes shift is an override shift
+ type: boolean
+ is_shadow:
+ description: Denotes shift is a shadow shift
+ type: boolean
+ user_id:
+ description: ID of user on shift
+ nullable: true
type: integer
- starts_at:
- description: Start datetime of shadow shift
- format: date-time
- nullable: false
+ required:
+ - ends_at
+ - is_override
+ - is_shadow
+ - rotation_id
+ - schedule_id
+ - starts_at
+ type: object
+ shift_list:
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/shift_list_data_inner'
+ type: array
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
+ required:
+ - data
+ type: object
+ shift_relationships:
+ properties:
+ shift_override:
+ $ref: '#/components/schemas/shift_relationships_shift_override'
+ user:
+ $ref: '#/components/schemas/shift_relationships_user'
+ assignee:
+ $ref: '#/components/schemas/shift_relationships_assignee'
+ type: object
+ new_status_page_template:
+ properties:
+ data:
+ $ref: '#/components/schemas/new_status_page_template_data'
+ required:
+ - data
+ type: object
+ update_status_page_template:
+ properties:
+ data:
+ $ref: '#/components/schemas/update_status_page_template_data'
+ required:
+ - data
+ type: object
+ status_page_template:
+ properties:
+ status_page_id:
type: string
- ends_at:
- description: End datetime for shadow shift
- format: date-time
+ title:
+ description: Title of the template
+ type: string
+ update_title:
+ description: Title that will be used for the status page update
+ nullable: true
+ type: string
+ body:
+ description: Description of the event the template will populate
+ type: string
+ update_status:
+ description: Status of the event the template will populate
+ nullable: true
+ type: string
+ kind:
+ description: The kind of the status page template
+ enum:
+ - normal
+ - scheduled
nullable: false
type: string
+ should_notify_subscribers:
+ description: Controls if incident subscribers should be notified
+ nullable: true
+ type: boolean
+ enabled:
+ description: Enable / Disable the status page template
+ nullable: true
+ type: boolean
+ position:
+ description: Position of the workflow task
+ type: integer
created_at:
description: Date of creation
type: string
@@ -48835,628 +39892,792 @@ components:
description: Date of last update
type: string
required:
- - ends_at
- - schedule_id
- - shadow_user_id
- - shadowable_id
- - shadowable_type
- - starts_at
+ - body
+ - created_at
+ - status_page_id
+ - title
+ - updated_at
type: object
- on_call_shadow_response:
+ status_page_template_response:
properties:
data:
- $ref: '#/components/schemas/on_call_shadow_response_data'
+ $ref: '#/components/schemas/status_page_template_response_data'
required:
- data
type: object
- on_call_shadows_list:
+ status_page_template_list:
properties:
data:
items:
- $ref: '#/components/schemas/on_call_shadows_list_data_inner'
+ $ref: '#/components/schemas/status_page_template_list_data_inner'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- new_on_call_role:
+ new_status_page:
properties:
data:
- $ref: '#/components/schemas/new_on_call_role_data'
+ $ref: '#/components/schemas/new_status_page_data'
required:
- data
type: object
- update_on_call_role:
+ update_status_page:
properties:
data:
- $ref: '#/components/schemas/update_on_call_role_data'
+ $ref: '#/components/schemas/update_status_page_data'
required:
- data
type: object
- on_call_role:
+ status_page:
properties:
- name:
- description: The role name.
+ title:
+ description: The title of the status page
type: string
slug:
- description: The role slug.
+ description: The slug of the status page
type: string
- system_role:
- description: The kind of role
- items:
- enum:
- - admin
- - user
- - custom
- - no_access
- type: string
- type: array
- alert_sources_permissions:
- items:
- enum:
- - create
- - update
- - delete
- type: string
- type: array
- alert_urgency_permissions:
- items:
- enum:
- - create
- - read
- - update
- - delete
- type: string
- type: array
- alerts_permissions:
- items:
- enum:
- - create
- - update
- - read
- type: string
- type: array
- api_keys_permissions:
- items:
- enum:
- - create
- - read
- - update
- - delete
- type: string
- type: array
- audits_permissions:
- items:
- enum:
- - create
- - read
- - update
- - delete
- type: string
- type: array
- contacts_permissions:
- items:
- enum:
- - read
- type: string
- type: array
- escalation_policies_permissions:
- items:
- enum:
- - create
- - read
- - update
- - delete
- type: string
- type: array
- groups_permissions:
- items:
- enum:
- - create
- - read
- - update
- - delete
- type: string
- type: array
- heartbeats_permissions:
- items:
- enum:
- - create
- - read
- - update
- - delete
- type: string
- type: array
- integrations_permissions:
- items:
- enum:
- - create
- - read
- - update
- - delete
- type: string
- type: array
- invitations_permissions:
- items:
- enum:
- - create
- - read
- - update
- - delete
- type: string
- type: array
- live_call_routing_permissions:
- items:
- enum:
- - create
- - read
- - update
- - delete
- type: string
- type: array
- schedule_override_permissions:
- items:
- enum:
- - create
- - update
- type: string
- type: array
- schedules_permissions:
+ public_title:
+ description: The public title of the status page
+ nullable: true
+ type: string
+ description:
+ description: The description of the status page
+ nullable: true
+ type: string
+ public_description:
+ description: The public description of the status page
+ nullable: true
+ type: string
+ header_color:
+ description: The color of the header. Eg. "#0061F2"
+ nullable: true
+ type: string
+ footer_color:
+ description: The color of the footer. Eg. "#1F2F41"
+ nullable: true
+ type: string
+ allow_search_engine_index:
+ description: Allow search engines to include your public status page in
+ search results
+ nullable: true
+ type: boolean
+ show_uptime:
+ description: Show uptime
+ nullable: true
+ type: boolean
+ show_uptime_last_days:
+ description: Show uptime over x days
+ enum:
+ - 30
+ - 60
+ - 90
+ nullable: true
+ type: integer
+ success_message:
+ description: Message showing when all components are operational
+ nullable: true
+ type: string
+ failure_message:
+ description: Message showing when at least one component is not operational
+ nullable: true
+ type: string
+ authentication_method:
+ default: none
+ description: Authentication method
+ enum:
+ - none
+ - password
+ - saml
+ nullable: true
+ type: string
+ authentication_enabled:
+ default: false
+ deprecated: true
+ description: Enable authentication (deprecated - use authentication_method
+ instead)
+ nullable: true
+ type: boolean
+ authentication_password:
+ description: Authentication password
+ nullable: true
+ type: string
+ saml_idp_sso_service_url:
+ description: SAML IdP SSO service URL
+ nullable: true
+ type: string
+ saml_idp_slo_service_url:
+ description: SAML IdP SLO service URL
+ nullable: true
+ type: string
+ saml_idp_cert:
+ description: SAML IdP certificate
+ nullable: true
+ type: string
+ saml_idp_cert_fingerprint:
+ description: SAML IdP certificate fingerprint
+ nullable: true
+ type: string
+ saml_name_identifier_format:
+ description: SAML name identifier format
+ enum:
+ - urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress
+ - urn:oasis:names:tc:SAML:2.0:nameid-format:persistent
+ - urn:oasis:names:tc:SAML:2.0:nameid-format:transient
+ - urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified
+ nullable: true
+ type: string
+ section_order:
+ description: Order of sections on the status page
items:
enum:
- - create
- - read
- - update
- - delete
+ - maintenance
+ - system_status
+ - incidents
type: string
+ nullable: true
type: array
- services_permissions:
+ website_url:
+ description: Website URL
+ nullable: true
+ type: string
+ website_privacy_url:
+ description: Website Privacy URL
+ nullable: true
+ type: string
+ website_support_url:
+ description: Website Support URL
+ nullable: true
+ type: string
+ ga_tracking_id:
+ description: Google Analytics tracking ID
+ nullable: true
+ type: string
+ time_zone:
+ default: Etc/UTC
+ description: A valid IANA time zone name.
+ nullable: true
+ type: string
+ public:
+ description: Make the status page accessible to the public
+ nullable: true
+ type: boolean
+ service_ids:
+ description: Services attached to the status page
items:
- enum:
- - create
- - read
- - update
- - delete
type: string
type: array
- webhooks_permissions:
+ functionality_ids:
+ description: Functionalities attached to the status page
items:
- enum:
- - create
- - read
- - update
- - delete
type: string
type: array
- workflows_permissions:
+ external_domain_names:
+ description: External domain names attached to the status page
items:
- enum:
- - create
- - read
- - update
- - delete
type: string
type: array
+ cname_records:
+ additionalProperties:
+ type: string
+ description: CNAME records mapping external domain names to their DNS target
+ values. These are populated asynchronously after setting external_domain_names.
+ nullable: true
+ readOnly: true
+ type: object
+ enabled:
+ description: Enabled / Disable the status page
+ nullable: true
+ type: boolean
created_at:
+ description: Date of creation
type: string
updated_at:
+ description: Date of last update
type: string
required:
- created_at
- - name
- - slug
- - system_role
+ - title
- updated_at
type: object
- on_call_role_response:
+ status_page_response:
properties:
data:
- $ref: '#/components/schemas/on_call_role_response_data'
+ $ref: '#/components/schemas/status_page_response_data'
required:
- data
type: object
- on_call_role_list:
+ status_page_list:
properties:
data:
items:
- $ref: '#/components/schemas/on_call_role_response_data'
+ $ref: '#/components/schemas/status_page_response_data'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- new_override_shift:
+ new_team:
properties:
data:
- $ref: '#/components/schemas/new_override_shift_data'
+ $ref: '#/components/schemas/new_team_data'
required:
- data
type: object
- update_override_shift:
+ update_team:
properties:
data:
- $ref: '#/components/schemas/update_override_shift_data'
+ $ref: '#/components/schemas/update_team_data'
required:
- data
type: object
- override_shift:
+ team:
properties:
- schedule_id:
- description: ID of schedule
- nullable: false
+ name:
+ description: The name of the team
type: string
- rotation_id:
- description: ID of rotation
+ slug:
+ type: string
+ description:
+ description: The description of the team
nullable: true
type: string
- starts_at:
- description: Start datetime of shift
- nullable: false
+ notify_emails:
+ description: Emails to attach to the team
+ items:
+ type: string
+ nullable: true
+ type: array
+ color:
+ description: The hex color of the team
+ nullable: true
type: string
- ends_at:
- description: End datetime of shift
- nullable: false
+ position:
+ description: Position of the team
+ nullable: true
+ type: integer
+ backstage_id:
+ description: "The Backstage entity id associated to this team. eg: :namespace/:kind/:entity_name"
+ nullable: true
type: string
- is_override:
- description: Denotes shift is an override shift
+ external_id:
+ description: The external id associated to this team
+ nullable: true
+ type: string
+ pagerduty_id:
+ description: The PagerDuty group id associated to this team
+ nullable: true
+ type: string
+ pagerduty_service_id:
+ description: The PagerDuty service id associated to this team
+ nullable: true
+ type: string
+ opsgenie_id:
+ description: The Opsgenie group id associated to this team
+ nullable: true
+ type: string
+ victor_ops_id:
+ description: The VictorOps group id associated to this team
+ nullable: true
+ type: string
+ pagertree_id:
+ description: The PagerTree group id associated to this team
+ nullable: true
+ type: string
+ cortex_id:
+ description: The Cortex group id associated to this team
+ nullable: true
+ type: string
+ service_now_ci_sys_id:
+ description: The Service Now CI sys id associated to this team
+ nullable: true
+ type: string
+ user_ids:
+ description: The user ids of the members of this team.
+ items:
+ type: integer
+ nullable: true
+ type: array
+ admin_ids:
+ description: The user ids of the admins of this team. These users must also
+ be present in user_ids attribute.
+ items:
+ type: integer
+ nullable: true
+ type: array
+ alerts_email_enabled:
+ description: Enable alerts through email
+ nullable: true
+ type: boolean
+ alerts_email_address:
+ description: Email generated to send alerts to
+ nullable: true
+ type: string
+ alert_urgency_id:
+ description: The alert urgency id of the team
+ nullable: true
+ type: string
+ slack_channels:
+ description: Slack Channels associated with this team
+ items:
+ $ref: '#/components/schemas/new_environment_data_attributes_slack_channels_inner'
+ nullable: true
+ type: array
+ slack_aliases:
+ description: Slack Aliases associated with this team
+ items:
+ $ref: '#/components/schemas/new_environment_data_attributes_slack_aliases_inner'
+ nullable: true
+ type: array
+ alert_broadcast_enabled:
+ description: Enable alerts to be broadcasted to a specific channel
+ nullable: true
+ type: boolean
+ alert_broadcast_channel:
+ $ref: '#/components/schemas/service_alert_broadcast_channel'
+ incident_broadcast_enabled:
+ description: Enable incidents to be broadcasted to a specific channel
+ nullable: true
+ type: boolean
+ incident_broadcast_channel:
+ $ref: '#/components/schemas/service_incident_broadcast_channel'
+ auto_add_members_when_attached:
+ description: Auto add members to incident channel when team is attached
+ nullable: true
type: boolean
+ properties:
+ description: Array of property values for this team.
+ items:
+ $ref: '#/components/schemas/new_cause_data_attributes_properties_inner'
+ nullable: true
+ type: array
created_at:
description: Date of creation
type: string
updated_at:
description: Date of last update
type: string
- shift_override:
- allOf:
- - $ref: '#/components/schemas/shift_override_response'
- description: Override metadata
- nullable: true
- type: object
- user:
- allOf:
- - $ref: '#/components/schemas/user_response'
- description: User metadata
- nullable: false
- type: object
required:
- - ends_at
- - is_override
- - rotation_id
- - schedule_id
- - starts_at
+ - created_at
+ - name
+ - updated_at
type: object
- override_shift_response:
+ team_response:
properties:
data:
- $ref: '#/components/schemas/override_shift_response_data'
+ $ref: '#/components/schemas/team_response_data'
required:
- data
type: object
- override_shift_list:
+ team_list:
properties:
data:
items:
- $ref: '#/components/schemas/override_shift_response_data'
+ $ref: '#/components/schemas/team_response_data'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- shift_override:
- properties:
- shift_id:
- description: ID of shift
- nullable: false
- type: string
- created_by_user_id:
- description: User who created the override
- nullable: false
- type: integer
- created_at:
- description: Date of creation
- type: string
- updated_at:
- description: Date of last update
- type: string
- required:
- - created_by_user_id
- - shift_id
- type: object
- shift_override_response:
- properties:
- data:
- $ref: '#/components/schemas/shift_override_response_data'
- required:
- - data
- type: object
- new_playbook_task:
+ new_user_notification_rule:
properties:
data:
- $ref: '#/components/schemas/new_playbook_task_data'
+ $ref: '#/components/schemas/new_user_notification_rule_data'
required:
- data
type: object
- update_playbook_task:
+ update_user_notification_rule:
properties:
data:
- $ref: '#/components/schemas/update_playbook_task_data'
+ $ref: '#/components/schemas/update_user_notification_rule_data'
required:
- data
type: object
- playbook_task:
+ user_notification_rule:
properties:
- playbook_id:
+ user_id:
+ type: integer
+ delay:
+ description: Delay after which rule gets triggered
+ nullable: true
+ type: integer
+ position:
+ description: Position of the rule
+ nullable: true
+ type: integer
+ user_email_address_id:
+ description: User email address to which notification to be sent
+ nullable: true
type: string
- task:
- description: The task of the task
+ user_call_number_id:
+ description: User phone number to which notification to be sent
+ nullable: true
type: string
- description:
- description: The description of task
+ user_sms_number_id:
+ description: User sms number to which notification to be sent
nullable: true
type: string
- position:
- description: The position of the task
+ user_device_id:
+ description: User device to which notification to be sent
nullable: true
- type: integer
+ type: string
+ enabled_contact_types:
+ description: Contact types for which notification needs to be enabled
+ items:
+ enum:
+ - email
+ - sms
+ - call
+ - device
+ - non_critical_device
+ - slack
+ type: string
+ nullable: false
+ type: array
+ notification_type:
+ description: "Type of notification rule (audible or quiet). Audible notifications\
+ \ use sound/vibration to alert users, while quiet notifications are silent."
+ enum:
+ - audible
+ - quiet
+ nullable: false
+ type: string
created_at:
description: Date of creation
type: string
updated_at:
description: Date of last update
type: string
- required:
- - created_at
- - task
- - updated_at
type: object
- playbook_task_response:
+ user_notification_rule_response:
properties:
data:
- $ref: '#/components/schemas/playbook_task_response_data'
+ $ref: '#/components/schemas/user_notification_rule_response_data'
required:
- data
type: object
- playbook_task_list:
+ user_notification_rule_list:
properties:
data:
items:
- $ref: '#/components/schemas/playbook_task_response_data'
+ $ref: '#/components/schemas/user_notification_rule_response_data'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- new_playbook:
+ new_user_phone_number:
properties:
data:
- $ref: '#/components/schemas/new_playbook_data'
+ $ref: '#/components/schemas/new_user_phone_number_data'
required:
- data
type: object
- update_playbook:
+ update_user_phone_number:
properties:
data:
- $ref: '#/components/schemas/update_playbook_data'
+ $ref: '#/components/schemas/update_user_phone_number_data'
required:
- data
type: object
- playbook:
+ user_phone_number:
properties:
- title:
- description: The title of the playbook
- type: string
- summary:
- description: The summary of the playbook
- nullable: true
+ user_id:
+ type: integer
+ phone:
+ description: Phone number in international format
type: string
- external_url:
- description: The external url of the playbook
+ primary:
+ description: Whether this is the primary phone number
+ type: boolean
+ verified_at:
+ description: Date when phone number was verified
+ format: date-time
nullable: true
type: string
- severity_ids:
- description: The Severity ID's to attach to the incident
- items:
- type: string
- nullable: true
- type: array
- environment_ids:
- description: The Environment ID's to attach to the incident
- items:
- type: string
- nullable: true
- type: array
- functionality_ids:
- description: The Functionality ID's to attach to the incident
- items:
- type: string
- nullable: true
- type: array
- service_ids:
- description: The Service ID's to attach to the incident
- items:
- type: string
- nullable: true
- type: array
- group_ids:
- description: The Team ID's to attach to the incident
- items:
- type: string
- nullable: true
- type: array
- incident_type_ids:
- description: The Incident Type ID's to attach to the incident
- items:
- type: string
- nullable: true
- type: array
+ verification_attempts_today:
+ description: Number of verification attempts made today
+ type: integer
created_at:
description: Date of creation
type: string
updated_at:
description: Date of last update
type: string
- required:
- - created_at
- - title
- - updated_at
type: object
- playbook_response:
+ user_phone_number_response:
properties:
data:
- $ref: '#/components/schemas/playbook_response_data'
+ $ref: '#/components/schemas/user_phone_number_response_data'
required:
- data
type: object
- playbook_list:
+ user_phone_number_list:
properties:
data:
items:
- $ref: '#/components/schemas/playbook_response_data'
+ $ref: '#/components/schemas/user_phone_number_response_data'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- new_post_mortem_template:
+ verify_phone_number_request:
+ properties:
+ code:
+ description: 6-digit verification code
+ pattern: "^[0-9]{6}$"
+ type: string
+ required:
+ - code
+ type: object
+ phone_verification_response:
+ properties:
+ message:
+ description: Success message
+ type: string
+ error:
+ description: Error message
+ type: string
+ type: object
+ new_user_email_address:
properties:
data:
- $ref: '#/components/schemas/new_post_mortem_template_data'
+ $ref: '#/components/schemas/new_user_email_address_data'
required:
- data
type: object
- update_post_mortem_template:
+ update_user_email_address:
properties:
data:
- $ref: '#/components/schemas/update_post_mortem_template_data'
+ $ref: '#/components/schemas/update_user_email_address_data'
required:
- data
type: object
- post_mortem_template:
+ user_email_address:
properties:
- name:
- description: The name of the postmortem template
- type: string
- slug:
- description: The slugified name of the postmortem template
+ user_id:
+ type: integer
+ email:
+ description: Email address
type: string
- default:
- description: Default selected template when editing a postmortem
- nullable: true
+ primary:
+ description: Whether this is the primary email address
type: boolean
- content:
- description: The postmortem template. Liquid syntax and markdown are supported
- type: string
- format:
- description: The format of the input
- enum:
- - html
- - markdown
- type: string
created_at:
description: Date of creation
type: string
updated_at:
description: Date of last update
type: string
- required:
- - created_at
- - name
- - updated_at
type: object
- post_mortem_template_response:
+ user_email_address_response:
properties:
data:
- $ref: '#/components/schemas/post_mortem_template_response_data'
+ $ref: '#/components/schemas/user_email_address_response_data'
required:
- data
type: object
- post_mortem_template_list:
+ user_email_address_list:
properties:
data:
items:
- $ref: '#/components/schemas/post_mortem_template_response_data'
+ $ref: '#/components/schemas/user_email_address_response_data'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- new_pulse:
+ user:
+ properties:
+ email:
+ description: The email of the user
+ type: string
+ first_name:
+ description: First name of the user
+ nullable: true
+ type: string
+ last_name:
+ description: Last name of the user
+ nullable: true
+ type: string
+ full_name:
+ description: The full name of the user
+ nullable: true
+ type: string
+ full_name_with_team:
+ description: The full name with team of the user
+ nullable: true
+ type: string
+ time_zone:
+ description: Configured time zone
+ nullable: true
+ type: string
+ created_at:
+ description: Date of creation
+ type: string
+ updated_at:
+ description: Date of last update
+ type: string
+ required:
+ - created_at
+ - email
+ - updated_at
+ type: object
+ user_flat_response:
+ description: Flat user object as returned by serializer
+ properties:
+ id:
+ description: User ID
+ type: integer
+ email:
+ description: User email
+ type: string
+ first_name:
+ description: User first name
+ nullable: true
+ type: string
+ last_name:
+ description: User last name
+ nullable: true
+ type: string
+ full_name:
+ description: User full name
+ nullable: true
+ type: string
+ full_name_with_team:
+ description: User full name with team
+ nullable: true
+ type: string
+ time_zone:
+ description: User time zone
+ nullable: true
+ type: string
+ created_at:
+ description: User creation timestamp
+ type: string
+ updated_at:
+ description: User last update timestamp
+ type: string
+ required:
+ - created_at
+ - email
+ - id
+ - updated_at
+ type: object
+ role_relationship:
properties:
data:
- $ref: '#/components/schemas/new_pulse_data'
+ $ref: '#/components/schemas/role_relationship_data'
+ type: object
+ on_call_role_relationship:
+ properties:
+ data:
+ $ref: '#/components/schemas/on_call_role_relationship_data'
+ type: object
+ user_relationships:
+ properties:
+ role:
+ $ref: '#/components/schemas/role_relationship'
+ on_call_role:
+ $ref: '#/components/schemas/on_call_role_relationship'
+ type: object
+ update_user:
+ properties:
+ data:
+ $ref: '#/components/schemas/update_user_data'
required:
- data
type: object
- update_pulse:
+ user_response:
properties:
data:
- $ref: '#/components/schemas/update_pulse_data'
+ $ref: '#/components/schemas/user_response_data'
required:
- data
type: object
- pulse:
+ user_list:
properties:
- source:
- description: "The source of the pulse (eg: k8s)"
- nullable: true
- type: string
- summary:
- description: The summary of the pulse
- type: string
- services:
- description: Services attached to the pulse
- items:
- allOf:
- - $ref: '#/components/schemas/service'
- type: object
- type: array
- environments:
- description: Environments attached to the pulse
+ data:
items:
- allOf:
- - $ref: '#/components/schemas/environment'
- type: object
+ $ref: '#/components/schemas/user_response_data'
type: array
- external_url:
- description: The external url of the pulse
- nullable: true
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
+ required:
+ - data
+ - links
+ - meta
+ type: object
+ webhooks_delivery:
+ properties:
+ endpoint_id:
type: string
- labels:
- items:
- $ref: '#/components/schemas/new_alert_data_attributes_labels_inner'
- type: array
- refs:
- items:
- $ref: '#/components/schemas/new_pulse_data_attributes_refs_inner'
- type: array
- data:
- description: Additional data
+ payload:
+ type: string
+ delivered_at:
nullable: true
- type: object
+ type: string
created_at:
description: Date of creation
type: string
@@ -49465,602 +40686,521 @@ components:
type: string
required:
- created_at
- - summary
+ - delivered_at
+ - endpoint_id
+ - payload
- updated_at
type: object
- pulse_response:
+ webhooks_delivery_response:
properties:
data:
- $ref: '#/components/schemas/pulse_response_data'
+ $ref: '#/components/schemas/webhooks_delivery_response_data'
required:
- data
type: object
- pulse_list:
+ webhooks_delivery_list:
properties:
data:
items:
- $ref: '#/components/schemas/pulse_response_data'
+ $ref: '#/components/schemas/webhooks_delivery_response_data'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- - links
type: object
- update_retrospective_configuration:
+ new_webhooks_endpoint:
properties:
data:
- $ref: '#/components/schemas/update_retrospective_configuration_data'
+ $ref: '#/components/schemas/new_webhooks_endpoint_data'
required:
- data
type: object
- retrospective_configuration:
+ update_webhooks_endpoint:
properties:
- kind:
- description: The kind of the configuration.
- enum:
- - skip
- - mandatory
+ data:
+ $ref: '#/components/schemas/update_webhooks_endpoint_data'
+ required:
+ - data
+ type: object
+ webhooks_endpoint:
+ properties:
+ name:
+ description: The name of the endpoint
type: string
- severity_ids:
- description: The Severity ID's to attach to the retrospective configuration
- items:
- type: string
- nullable: true
- type: array
- group_ids:
- description: The Team ID's to attach to the retrospective configuration
- items:
- type: string
- nullable: true
- type: array
- incident_type_ids:
- description: The Incident Type ID's to attach to the retrospective configuration
+ slug:
+ description: The slug of the endpoint
+ type: string
+ url:
+ description: The URL of the endpoint.
+ type: string
+ event_types:
items:
+ enum:
+ - incident.created
+ - incident.updated
+ - incident.in_triage
+ - incident.mitigated
+ - incident.resolved
+ - incident.cancelled
+ - incident.deleted
+ - incident.scheduled.created
+ - incident.scheduled.updated
+ - incident.scheduled.in_progress
+ - incident.scheduled.completed
+ - incident.scheduled.deleted
+ - incident_post_mortem.created
+ - incident_post_mortem.updated
+ - incident_post_mortem.published
+ - incident_post_mortem.deleted
+ - incident_status_page_event.created
+ - incident_status_page_event.updated
+ - incident_status_page_event.deleted
+ - incident_event.created
+ - incident_event.updated
+ - incident_event.deleted
+ - alert.created
+ - pulse.created
+ - genius_workflow_run.queued
+ - genius_workflow_run.started
+ - genius_workflow_run.completed
+ - genius_workflow_run.failed
+ - genius_workflow_run.canceled
+ - audit_log.created
type: string
- nullable: true
type: array
+ secret:
+ description: The webhook signing secret used to verify webhook requests.
+ type: string
+ enabled:
+ type: boolean
created_at:
description: Date of creation
type: string
updated_at:
description: Date of last update
type: string
+ required:
+ - created_at
+ - enabled
+ - event_types
+ - name
+ - secret
+ - updated_at
+ - url
type: object
- retrospective_configuration_response:
+ webhooks_endpoint_response:
properties:
data:
- $ref: '#/components/schemas/retrospective_configuration_response_data'
+ $ref: '#/components/schemas/webhooks_endpoint_response_data'
required:
- data
type: object
- retrospective_configuration_list:
+ webhooks_endpoint_list:
properties:
data:
items:
- $ref: '#/components/schemas/retrospective_configuration_list_data_inner'
+ $ref: '#/components/schemas/webhooks_endpoint_response_data'
type: array
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
type: object
- new_retrospective_process:
- properties:
- data:
- $ref: '#/components/schemas/new_retrospective_process_data'
- required:
- - data
- type: object
- update_retrospective_process:
- properties:
- data:
- $ref: '#/components/schemas/update_retrospective_process_data'
- required:
- - data
- type: object
- retrospective_process:
+ status:
properties:
name:
- description: The name of the retrospective process
+ type: string
+ slug:
type: string
description:
- description: The description of the retrospective process
nullable: true
type: string
- is_default:
- description: Indicates the default process that Rootly created. This will
- be used as a fallback if no processes match the incident's conditions.
- The default process cannot have conditions and cannot be changed.
- nullable: true
+ color:
+ type: string
+ enabled:
type: boolean
created_at:
- description: Date of creation
type: string
updated_at:
- description: Date of last update
type: string
- retrospective_process_matching_criteria:
- $ref: '#/components/schemas/new_retrospective_process_data_attributes_retrospective_process_matching_criteria'
+ required:
+ - color
+ - created_at
+ - enabled
+ - name
+ - updated_at
type: object
- retrospective_process_response:
+ status_response:
properties:
data:
- $ref: '#/components/schemas/retrospective_process_response_data'
+ $ref: '#/components/schemas/status_response_data'
required:
- data
type: object
- retrospective_process_list:
+ status_list:
properties:
data:
items:
- $ref: '#/components/schemas/retrospective_process_list_data_inner'
+ $ref: '#/components/schemas/status_response_data'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- new_retrospective_step:
+ new_sub_status:
properties:
data:
- $ref: '#/components/schemas/new_retrospective_step_data'
+ $ref: '#/components/schemas/new_sub_status_data'
required:
- data
type: object
- update_retrospective_step:
+ update_sub_status:
properties:
data:
- $ref: '#/components/schemas/update_retrospective_step_data'
+ $ref: '#/components/schemas/update_sub_status_data'
required:
- data
type: object
- retrospective_step:
+ sub_status:
properties:
- retrospective_process_id:
- type: string
- title:
- description: The name of the step
+ name:
type: string
slug:
- description: The slug of the step
type: string
description:
- description: The description of the step
nullable: true
type: string
- incident_role_id:
- description: Users assigned to the selected incident role will be the default
- owners for this step
- nullable: true
+ parent_status:
+ enum:
+ - in_triage
+ - started
+ - resolved
+ - closed
+ - cancelled
+ - planning
+ - scheduled
+ - in_progress
+ - verifying
+ - completed
type: string
- due_after_days:
- description: Due date in days
- nullable: true
- type: integer
position:
- description: Position of the step
+ nullable: true
type: integer
- skippable:
- description: Is the step skippable?
- type: boolean
created_at:
- description: Date of creation
type: string
updated_at:
- description: Date of last update
type: string
required:
- created_at
- - retrospective_process_id
- - title
+ - name
+ - parent_status
- updated_at
type: object
- retrospective_step_response:
+ sub_status_response:
properties:
data:
- $ref: '#/components/schemas/retrospective_step_response_data'
+ $ref: '#/components/schemas/sub_status_response_data'
required:
- data
type: object
- retrospective_step_list:
+ sub_status_list:
properties:
data:
items:
- $ref: '#/components/schemas/retrospective_step_response_data'
+ $ref: '#/components/schemas/sub_status_response_data'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- new_role:
+ new_incident_sub_status:
properties:
data:
- $ref: '#/components/schemas/new_role_data'
+ $ref: '#/components/schemas/new_incident_sub_status_data'
required:
- data
type: object
- update_role:
+ update_incident_sub_status:
properties:
data:
- $ref: '#/components/schemas/update_role_data'
+ $ref: '#/components/schemas/update_incident_sub_status_data'
required:
- data
type: object
- role:
+ incident_sub_status:
properties:
- name:
- description: The role name.
+ incident_id:
type: string
- slug:
- description: The role slug.
+ sub_status_id:
+ description: "Note: To change an incident's sub-status, use the PATCH /incidents/:id\
+ \ endpoint and set the sub_status_id attribute. This endpoint is for modifying\
+ \ the timestamp of when an incident's sub-status was assigned."
type: string
- incident_permission_set_id:
- description: Associated incident permissions set.
- nullable: true
+ assigned_at:
type: string
- is_deletable:
- description: Whether the role can be deleted.
- type: boolean
- is_editable:
- description: Whether the role can be edited.
- type: boolean
- alerts_permissions:
- items:
- enum:
- - create
- - read
- type: string
- type: array
- api_keys_permissions:
- items:
- enum:
- - create
- - read
- - update
- - delete
- type: string
- type: array
- audits_permissions:
- items:
- enum:
- - create
- - read
- - update
- - delete
- type: string
- type: array
- billing_permissions:
- items:
- enum:
- - create
- - read
- - update
- - delete
- type: string
- type: array
- environments_permissions:
- items:
- enum:
- - create
- - read
- - update
- - delete
- type: string
- type: array
- form_fields_permissions:
- items:
- enum:
- - create
- - read
- - update
- - delete
- type: string
- type: array
- functionalities_permissions:
- items:
- enum:
- - create
- - read
- - update
- - delete
- type: string
- type: array
- groups_permissions:
- items:
- enum:
- - create
- - read
- - update
- - delete
- type: string
- type: array
- incident_causes_permissions:
- items:
- enum:
- - create
- - read
- - update
- - delete
- type: string
- type: array
- incident_feedbacks_permissions:
- items:
- enum:
- - create
- - read
- - update
- - delete
- type: string
- type: array
- incident_roles_permissions:
- items:
- enum:
- - create
- - read
- - update
- - delete
- type: string
- type: array
- incident_types_permissions:
- items:
- enum:
- - create
- - read
- - update
- - delete
- type: string
- type: array
- incidents_permissions:
- items:
- enum:
- - create
- - read
- - update
- - delete
- type: string
- type: array
- integrations_permissions:
- items:
- enum:
- - create
- - read
- - update
- - delete
- type: string
- type: array
- invitations_permissions:
- items:
- enum:
- - create
- - read
- - update
- - delete
- type: string
- type: array
- playbooks_permissions:
- items:
- enum:
- - create
- - read
- - update
- - delete
- type: string
- type: array
- private_incidents_permissions:
- items:
- enum:
- - create
- - read
- - update
- - delete
- type: string
- type: array
- pulses_permissions:
- items:
- enum:
- - create
- - update
- - read
- type: string
- type: array
- retrospective_permissions:
- items:
- enum:
- - create
- - read
- - update
- - delete
- type: string
- type: array
- roles_permissions:
- items:
- enum:
- - create
- - read
- - update
- - delete
- type: string
- type: array
- secrets_permissions:
- items:
- enum:
- - create
- - read
- - update
- - delete
- type: string
- type: array
- services_permissions:
- items:
- enum:
- - create
- - read
- - update
- - delete
- type: string
- type: array
- severities_permissions:
- items:
- enum:
- - create
- - read
- - update
- - delete
- type: string
- type: array
- status_pages_permissions:
- items:
- enum:
- - create
- - read
- - update
- - delete
- type: string
- type: array
- webhooks_permissions:
- items:
- enum:
- - create
- - read
- - update
- - delete
- type: string
- type: array
- workflows_permissions:
+ assigned_by_user_id:
+ nullable: true
+ type: integer
+ required:
+ - assigned_at
+ - incident_id
+ - sub_status_id
+ type: object
+ incident_sub_status_response:
+ properties:
+ data:
+ $ref: '#/components/schemas/incident_sub_status_response_data'
+ required:
+ - data
+ type: object
+ incident_sub_status_list:
+ properties:
+ data:
items:
- enum:
- - create
- - read
- - update
- - delete
- type: string
+ $ref: '#/components/schemas/incident_sub_status_response_data'
type: array
- created_at:
+ links:
+ allOf:
+ - $ref: '#/components/schemas/links'
+ type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
+ required:
+ - data
+ - links
+ - meta
+ type: object
+ new_retrospective_process_group:
+ properties:
+ data:
+ $ref: '#/components/schemas/new_retrospective_process_group_data'
+ required:
+ - data
+ type: object
+ update_retrospective_process_group:
+ properties:
+ data:
+ $ref: '#/components/schemas/update_retrospective_process_group_data'
+ required:
+ - data
+ type: object
+ retrospective_process_group:
+ properties:
+ retrospective_process_id:
type: string
- updated_at:
+ sub_status_id:
type: string
+ position:
+ type: integer
required:
- - created_at
- - name
- - slug
- - updated_at
+ - position
+ - retrospective_process_id
+ - sub_status_id
type: object
- role_response:
+ retrospective_process_group_response:
properties:
data:
- $ref: '#/components/schemas/role_response_data'
+ $ref: '#/components/schemas/retrospective_process_group_response_data'
required:
- data
type: object
- role_list:
+ retrospective_process_group_list:
properties:
data:
items:
- $ref: '#/components/schemas/role_response_data'
+ $ref: '#/components/schemas/retrospective_process_group_response_data'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- new_schedule_rotation_active_day:
+ new_retrospective_process_group_step:
properties:
data:
- $ref: '#/components/schemas/new_schedule_rotation_active_day_data'
+ $ref: '#/components/schemas/new_retrospective_process_group_step_data'
required:
- data
type: object
- update_schedule_rotation_active_day:
+ update_retrospective_process_group_step:
properties:
data:
- $ref: '#/components/schemas/update_schedule_rotation_active_day_data'
+ $ref: '#/components/schemas/update_retrospective_process_group_step_data'
required:
- data
type: object
- schedule_rotation_active_day:
+ retrospective_process_group_step:
properties:
- schedule_rotation_id:
- type: string
- day_name:
- description: Schedule rotation day name for which active times to be created
- enum:
- - S
- - M
- - T
- - W
- - R
- - F
- - U
- type: string
- active_time_attributes:
- description: Schedule rotation active times per day
- items:
- $ref: '#/components/schemas/new_schedule_rotation_active_day_data_attributes_active_time_attributes_inner'
- type: array
- created_at:
- description: Date of creation
+ retrospective_process_group_id:
type: string
- updated_at:
- description: Date of last update
+ retrospective_step_id:
type: string
+ position:
+ type: integer
required:
- - active_time_attributes
- - created_at
- - day_name
- - schedule_rotation_id
- - updated_at
- schedule_rotation_active_day_response:
+ - position
+ - retrospective_process_group_id
+ - retrospective_step_id
+ type: object
+ retrospective_process_group_step_response:
properties:
data:
- $ref: '#/components/schemas/schedule_rotation_active_day_response_data'
+ $ref: '#/components/schemas/retrospective_process_group_step_response_data'
+ required:
+ - data
type: object
- schedule_rotation_active_day_list:
+ retrospective_process_group_step_list:
properties:
data:
items:
- $ref: '#/components/schemas/schedule_rotation_active_day_list_data_inner'
+ $ref: '#/components/schemas/retrospective_process_group_step_response_data'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- new_schedule_rotation_user:
+ new_sla:
properties:
data:
- $ref: '#/components/schemas/new_schedule_rotation_user_data'
+ $ref: '#/components/schemas/new_sla_data'
+ required:
+ - data
type: object
- update_schedule_rotation_user:
+ update_sla:
properties:
data:
- $ref: '#/components/schemas/update_schedule_rotation_user_data'
+ $ref: '#/components/schemas/update_sla_data'
required:
- data
type: object
- schedule_rotation_user:
+ sla:
properties:
- schedule_rotation_id:
+ slug:
+ description: The slug of the SLA
+ type: string
+ name:
+ description: The name of the SLA
+ type: string
+ description:
+ description: A description of the SLA
+ nullable: true
type: string
- user_id:
- description: Schedule rotation user
- type: integer
position:
- description: Position of the user inside rotation
+ description: Position of the SLA for ordering
+ type: integer
+ entity_type:
+ description: The entity type this SLA applies to
+ enum:
+ - follow_up
+ type: string
+ condition_match_type:
+ description: Whether all or any conditions must match
+ enum:
+ - ALL
+ - ANY
+ type: string
+ manager_role_id:
+ description: The ID of the manager incident role. Exactly one of `manager_role_id`
+ or `manager_user_id` must be provided.
+ format: uuid
+ nullable: true
+ type: string
+ manager_user_id:
+ description: The ID of the manager user. Exactly one of `manager_role_id`
+ or `manager_user_id` must be provided.
+ nullable: true
+ type: integer
+ assignment_deadline_days:
+ description: Number of days for the assignment deadline
+ type: integer
+ assignment_deadline_parent_status:
+ description: The incident parent status that triggers the assignment deadline
+ type: string
+ assignment_deadline_sub_status_id:
+ description: Sub-status for the assignment deadline. Required when custom
+ lifecycle statuses are enabled on the team.
+ format: uuid
+ nullable: true
+ type: string
+ assignment_skip_weekends:
+ description: Whether to skip weekends when calculating the assignment deadline
+ type: boolean
+ completion_deadline_days:
+ description: Number of days for the completion deadline
type: integer
+ completion_deadline_parent_status:
+ description: The incident parent status that triggers the completion deadline
+ type: string
+ completion_deadline_sub_status_id:
+ description: Sub-status for the completion deadline. Required when custom
+ lifecycle statuses are enabled on the team.
+ format: uuid
+ nullable: true
+ type: string
+ completion_skip_weekends:
+ description: Whether to skip weekends when calculating the completion deadline
+ type: boolean
+ conditions:
+ description: Conditions that determine which incidents this SLA applies
+ to
+ items:
+ $ref: '#/components/schemas/sla_conditions_inner'
+ type: array
+ notification_configurations:
+ description: Notification timing configurations
+ items:
+ $ref: '#/components/schemas/sla_notification_configurations_inner'
+ type: array
created_at:
description: Date of creation
type: string
@@ -50068,3223 +41208,4221 @@ components:
description: Date of last update
type: string
required:
+ - assignment_deadline_days
+ - assignment_deadline_parent_status
+ - completion_deadline_days
+ - completion_deadline_parent_status
+ - condition_match_type
- created_at
- - position
- - schedule_rotation_id
+ - name
- updated_at
- - user_id
type: object
- schedule_rotation_user_list:
+ sla_response:
+ properties:
+ data:
+ $ref: '#/components/schemas/sla_response_data'
+ required:
+ - data
+ type: object
+ sla_list:
properties:
data:
items:
- $ref: '#/components/schemas/schedule_rotation_user_list_data_inner'
+ $ref: '#/components/schemas/sla_response_data'
type: array
links:
allOf:
- $ref: '#/components/schemas/links'
type: object
+ meta:
+ allOf:
+ - $ref: '#/components/schemas/meta'
+ type: object
required:
- data
- links
+ - meta
type: object
- schedule_rotation_user_response:
+ getAlertField_id_parameter:
+ anyOf:
+ - description: Resource UUID
+ format: uuid
+ type: string
+ - description: Resource slug
+ pattern: "^[a-z0-9_-]+$"
+ type: string
+ deleteAlertRoute_200_response_data_attributes:
+ properties:
+ deleted:
+ type: boolean
+ type: object
+ deleteAlertRoute_200_response_data:
+ properties:
+ id:
+ type: string
+ type:
+ type: string
+ attributes:
+ $ref: '#/components/schemas/deleteAlertRoute_200_response_data_attributes'
+ type: object
+ deleteAlertRoute_200_response:
properties:
data:
- $ref: '#/components/schemas/schedule_rotation_user_list_data_inner'
+ $ref: '#/components/schemas/deleteAlertRoute_200_response_data'
+ type: object
+ createEdgeConnectorAction_request_action_metadata_parameters_inner:
+ properties:
+ name:
+ type: string
+ type:
+ enum:
+ - string
+ - number
+ - boolean
+ type: string
+ required:
+ type: boolean
+ description:
+ type: string
+ options:
+ items:
+ type: string
+ type: array
+ type: object
+ createEdgeConnectorAction_request_action_metadata:
+ properties:
+ description:
+ type: string
+ timeout:
+ type: integer
+ parameters:
+ items:
+ $ref: '#/components/schemas/createEdgeConnectorAction_request_action_metadata_parameters_inner'
+ type: array
+ type: object
+ createEdgeConnectorAction_request_action:
+ properties:
+ name:
+ description: Action name
+ type: string
+ action_type:
+ description: Action type
+ enum:
+ - script
+ - http
+ type: string
+ metadata:
+ $ref: '#/components/schemas/createEdgeConnectorAction_request_action_metadata'
required:
- - data
+ - action_type
+ - name
type: object
- new_schedule_rotation:
+ createEdgeConnectorAction_request:
+ properties:
+ action:
+ $ref: '#/components/schemas/createEdgeConnectorAction_request_action'
+ type: object
+ updateEdgeConnectorAction_request_action:
+ properties:
+ name:
+ type: string
+ action_type:
+ enum:
+ - script
+ - http
+ type: string
+ metadata:
+ type: object
+ type: object
+ updateEdgeConnectorAction_request:
+ properties:
+ action:
+ $ref: '#/components/schemas/updateEdgeConnectorAction_request_action'
+ type: object
+ createEdgeConnector_request_data_attributes:
+ properties:
+ name:
+ description: Connector name
+ type: string
+ description:
+ description: Connector description
+ type: string
+ status:
+ description: Connector status
+ enum:
+ - active
+ - paused
+ type: string
+ subscriptions:
+ description: Array of event types to subscribe to
+ items:
+ type: string
+ type: array
+ required:
+ - name
+ type: object
+ createEdgeConnector_request_data:
+ properties:
+ type:
+ enum:
+ - edge_connectors
+ type: string
+ attributes:
+ $ref: '#/components/schemas/createEdgeConnector_request_data_attributes'
+ required:
+ - attributes
+ - type
+ type: object
+ createEdgeConnector_request:
properties:
data:
- $ref: '#/components/schemas/new_schedule_rotation_data'
+ $ref: '#/components/schemas/createEdgeConnector_request_data'
required:
- data
type: object
- update_schedule_rotation:
+ updateEdgeConnector_request_data_attributes:
+ properties:
+ name:
+ type: string
+ description:
+ type: string
+ status:
+ enum:
+ - active
+ - paused
+ type: string
+ subscriptions:
+ items:
+ type: string
+ type: array
+ type: object
+ updateEdgeConnector_request_data:
+ properties:
+ type:
+ enum:
+ - edge_connectors
+ type: string
+ id:
+ type: string
+ attributes:
+ $ref: '#/components/schemas/updateEdgeConnector_request_data_attributes'
+ type: object
+ updateEdgeConnector_request:
properties:
data:
- $ref: '#/components/schemas/update_schedule_rotation_data'
+ $ref: '#/components/schemas/updateEdgeConnector_request_data'
+ type: object
+ getTeam_id_parameter:
+ anyOf:
+ - description: Team UUID
+ format: uuid
+ type: string
+ - description: Team slug
+ pattern: "^[a-z0-9_-]+$"
+ type: string
+ attach_alert_data_attributes:
+ additionalProperties: false
+ properties:
+ alert_ids:
+ description: Alert Id to attach to the incident
+ items:
+ type: string
+ nullable: true
+ type: array
required:
- - data
+ - alert_ids
type: object
- schedule_rotation:
+ attach_alert_data:
properties:
- schedule_id:
- description: The ID of parent schedule
+ type:
+ enum:
+ - alerts
+ type: string
+ attributes:
+ $ref: '#/components/schemas/attach_alert_data_attributes'
+ required:
+ - attributes
+ - type
+ type: object
+ new_alert_data_attributes_labels_inner_value:
+ description: Value of the tag
+ oneOf:
+ - type: string
+ - type: number
+ - type: boolean
+ new_alert_data_attributes_labels_inner:
+ nullable: true
+ properties:
+ key:
+ description: Key of the tag
+ type: string
+ value:
+ $ref: '#/components/schemas/new_alert_data_attributes_labels_inner_value'
+ required:
+ - key
+ - value
+ type: object
+ new_alert_data_attributes_alert_field_values_attributes_inner:
+ nullable: true
+ properties:
+ alert_field_id:
+ description: ID of the custom alert field
+ type: string
+ value:
+ description: Value for the alert field
+ type: string
+ required:
+ - alert_field_id
+ - value
+ type: object
+ new_alert_data_attributes:
+ additionalProperties: false
+ properties:
+ noise:
+ description: Whether the alert is marked as noise
+ enum:
+ - noise
+ - not_noise
+ nullable: true
+ type: string
+ source:
+ description: The source of the alert
+ enum:
+ - rootly
+ - manual
+ - api
+ - heartbeat
+ - web
+ - slack
+ - email
+ - workflow
+ - live_call_routing
+ - mobile
+ - pagerduty
+ - opsgenie
+ - victorops
+ - pagertree
+ - datadog
+ - dynatrace
+ - nobl9
+ - zendesk
+ - asana
+ - clickup
+ - sentry
+ - rollbar
+ - jira
+ - honeycomb
+ - service_now
+ - linear
+ - grafana
+ - alertmanager
+ - google_cloud
+ - generic_webhook
+ - cloud_watch
+ - aws_sns
+ - azure
+ - splunk
+ - chronosphere
+ - app_optics
+ - bug_snag
+ - monte_carlo
+ - nagios
+ - prtg
+ - catchpoint
+ - app_dynamics
+ - checkly
+ - new_relic
+ - gitlab
+ type: string
+ status:
+ description: "Only available for organizations with Rootly On-Call enabled.\
+ \ Can be one of open, triggered."
+ enum:
+ - open
+ - triggered
+ type: string
+ summary:
+ description: The summary of the alert
+ type: string
+ description:
+ description: The description of the alert
+ nullable: true
+ type: string
+ service_ids:
+ description: The Service IDs to attach to the alert. If your organization
+ has On-Call enabled and your notification target is a Service. This field
+ will be automatically set for you.
+ items:
+ type: string
+ nullable: true
+ type: array
+ group_ids:
+ description: The Group IDs to attach to the alert. If your organization
+ has On-Call enabled and your notification target is a Group. This field
+ will be automatically set for you.
+ items:
+ type: string
+ nullable: true
+ type: array
+ environment_ids:
+ description: The Environment IDs to attach to the alert
+ items:
+ type: string
+ nullable: true
+ type: array
+ started_at:
+ description: Alert start datetime
+ format: date-time
+ nullable: true
+ type: string
+ ended_at:
+ description: Alert end datetime
+ format: date-time
+ nullable: true
+ type: string
+ external_id:
+ description: External ID
+ nullable: true
+ type: string
+ external_url:
+ description: External Url
+ nullable: true
+ type: string
+ alert_urgency_id:
+ description: The ID of the alert urgency
+ nullable: true
+ type: string
+ notification_target_type:
+ description: "Only available for organizations with Rootly On-Call enabled.\
+ \ Can be one of Group, Service, EscalationPolicy, Functionality, User.\
+ \ Please contact support if you encounter issues using `Functionality`\
+ \ as a notification target type."
+ enum:
+ - User
+ - Group
+ - EscalationPolicy
+ - Service
+ - Functionality
+ nullable: true
+ type: string
+ notification_target_id:
+ description: Only available for organizations with Rootly On-Call enabled.
+ The _identifier_ of the notification target object.
+ nullable: true
+ type: string
+ labels:
+ items:
+ $ref: '#/components/schemas/new_alert_data_attributes_labels_inner'
+ type: array
+ data:
+ description: Additional data
+ nullable: true
+ type: object
+ deduplication_key:
+ description: Alerts sharing the same deduplication key are treated as a
+ single alert.
+ nullable: true
+ type: string
+ alert_field_values_attributes:
+ description: Custom alert field values to create with the alert
+ items:
+ $ref: '#/components/schemas/new_alert_data_attributes_alert_field_values_attributes_inner'
+ type: array
+ required:
+ - source
+ - summary
+ type: object
+ new_alert_data:
+ properties:
+ type:
+ enum:
+ - alerts
+ type: string
+ attributes:
+ $ref: '#/components/schemas/new_alert_data_attributes'
+ required:
+ - attributes
+ - type
+ type: object
+ update_alert_data_attributes:
+ additionalProperties: false
+ properties:
+ noise:
+ description: Whether the alert is marked as noise
+ enum:
+ - noise
+ - not_noise
+ nullable: true
+ type: string
+ source:
+ description: The source of the alert
+ enum:
+ - rootly
+ - manual
+ - api
+ - heartbeat
+ - web
+ - slack
+ - email
+ - workflow
+ - live_call_routing
+ - mobile
+ - pagerduty
+ - opsgenie
+ - victorops
+ - pagertree
+ - datadog
+ - dynatrace
+ - nobl9
+ - zendesk
+ - asana
+ - clickup
+ - sentry
+ - rollbar
+ - jira
+ - honeycomb
+ - service_now
+ - linear
+ - grafana
+ - alertmanager
+ - google_cloud
+ - generic_webhook
+ - cloud_watch
+ - aws_sns
+ - azure
+ - splunk
+ - chronosphere
+ - app_optics
+ - bug_snag
+ - monte_carlo
+ - nagios
+ - prtg
+ - catchpoint
+ - app_dynamics
+ - checkly
+ - new_relic
+ - gitlab
type: string
- name:
- description: The name of the schedule rotation
+ summary:
+ description: The summary of the alert
type: string
- position:
- description: Position of the schedule rotation
- type: integer
- schedule_rotationable_type:
- description: Schedule rotation type
- enum:
- - ScheduleDailyRotation
- - ScheduleWeeklyRotation
- - ScheduleBiweeklyRotation
- - ScheduleMonthlyRotation
- - ScheduleCustomRotation
+ description:
+ description: The description of the alert
+ nullable: true
type: string
- active_all_week:
- default: true
- description: Schedule rotation active all week?
- type: boolean
- active_days:
+ service_ids:
+ description: The Service IDs to attach to the alert
items:
- description: Schedule rotation active days
- enum:
- - S
- - M
- - T
- - W
- - R
- - F
- - U
type: string
+ nullable: true
type: array
- active_time_type:
+ group_ids:
+ description: The Group IDs to attach to the alert
items:
- default: all_day
- description: Schedule rotation active time type
- enum:
- - all_day
- - same_time
- - custom
type: string
+ nullable: true
type: array
- active_time_attributes:
- description: Schedule rotation's active times
+ environment_ids:
+ description: The Environment IDs to attach to the alert
items:
- $ref: '#/components/schemas/new_schedule_rotation_data_attributes_active_time_attributes_inner'
+ type: string
+ nullable: true
type: array
- time_zone:
- default: Etc/UTC
- description: A valid IANA time zone name.
+ started_at:
+ description: Alert start datetime
+ format: date-time
+ nullable: true
type: string
- schedule_rotationable_attributes:
- $ref: '#/components/schemas/new_schedule_rotation_data_attributes_schedule_rotationable_attributes'
- required:
- - name
- - schedule_id
- - schedule_rotationable_attributes
- - schedule_rotationable_type
- type: object
- schedule_rotation_response:
- properties:
- data:
- $ref: '#/components/schemas/schedule_rotation_response_data'
- required:
- - data
- type: object
- schedule_rotation_list:
- properties:
- data:
+ ended_at:
+ description: Alert end datetime
+ format: date-time
+ nullable: true
+ type: string
+ external_id:
+ description: External ID
+ nullable: true
+ type: string
+ external_url:
+ description: External Url
+ nullable: true
+ type: string
+ alert_urgency_id:
+ description: The ID of the alert urgency
+ nullable: true
+ type: string
+ labels:
items:
- $ref: '#/components/schemas/schedule_rotation_response_data'
+ $ref: '#/components/schemas/new_alert_data_attributes_labels_inner'
type: array
- links:
- allOf:
- - $ref: '#/components/schemas/links'
+ data:
+ description: Additional data
+ nullable: true
type: object
- required:
- - data
- - links
+ deduplication_key:
+ description: Alerts sharing the same deduplication key are treated as a
+ single alert.
+ nullable: true
+ type: string
+ alert_field_values_attributes:
+ description: Custom alert field values to create with the alert
+ items:
+ $ref: '#/components/schemas/new_alert_data_attributes_alert_field_values_attributes_inner'
+ type: array
type: object
- new_schedule:
+ update_alert_data:
properties:
- data:
- $ref: '#/components/schemas/new_schedule_data'
+ type:
+ enum:
+ - alerts
+ type: string
+ attributes:
+ $ref: '#/components/schemas/update_alert_data_attributes'
required:
- - data
+ - attributes
+ - source
+ - summary
type: object
- update_schedule:
+ alert_response_data:
properties:
- data:
- $ref: '#/components/schemas/update_schedule_data'
+ id:
+ description: Unique ID of the alert
+ type: string
+ source:
+ description: The source of the alert
+ enum:
+ - rootly
+ - manual
+ - api
+ - heartbeat
+ - web
+ - slack
+ - email
+ - workflow
+ - live_call_routing
+ - mobile
+ - pagerduty
+ - opsgenie
+ - victorops
+ - pagertree
+ - datadog
+ - dynatrace
+ - nobl9
+ - zendesk
+ - asana
+ - clickup
+ - sentry
+ - rollbar
+ - jira
+ - honeycomb
+ - service_now
+ - linear
+ - grafana
+ - alertmanager
+ - google_cloud
+ - generic_webhook
+ - cloud_watch
+ - aws_sns
+ - azure
+ - splunk
+ - chronosphere
+ - app_optics
+ - bug_snag
+ - monte_carlo
+ - nagios
+ - prtg
+ - catchpoint
+ - app_dynamics
+ - checkly
+ - new_relic
+ - gitlab
+ type: string
+ type:
+ enum:
+ - alerts
+ type: string
+ attributes:
+ allOf:
+ - $ref: '#/components/schemas/alert'
+ type: object
required:
- - data
+ - attributes
+ - id
+ - type
type: object
- schedule:
+ resolve_alert_data_attributes:
+ additionalProperties: false
properties:
- name:
- description: The name of the schedule
- type: string
- description:
- description: The description of the schedule
+ resolution_message:
+ description: How was the alert resolved?
nullable: true
type: string
- all_time_coverage:
- description: 24/7 coverage of the schedule
+ resolve_related_incidents:
+ description: Resolve all associated incidents
nullable: true
type: boolean
- slack_user_group:
- $ref: '#/components/schemas/schedule_slack_user_group'
- owner_group_ids:
- description: Owning teams.
- items:
- type: string
- type: array
- owner_user_id:
- description: ID of user assigned as owner of the schedule
- nullable: true
- type: integer
- created_at:
- description: Date of creation
- type: string
- updated_at:
- description: Date of last update
- type: string
- required:
- - created_at
- - name
- - updated_at
type: object
- schedule_response:
+ resolve_alert_data:
properties:
- data:
- $ref: '#/components/schemas/schedule_response_data'
- required:
- - data
+ type:
+ enum:
+ - alerts
+ type: string
+ attributes:
+ $ref: '#/components/schemas/resolve_alert_data_attributes'
type: object
- schedule_list:
+ snooze_alert_data_attributes:
+ additionalProperties: false
properties:
- data:
- items:
- $ref: '#/components/schemas/schedule_list_data_inner'
- type: array
- links:
- allOf:
- - $ref: '#/components/schemas/links'
- type: object
+ delay_minutes:
+ description: Number of minutes to snooze the alert for
+ maximum: 1440
+ minimum: 1
+ type: integer
required:
- - data
- - links
+ - delay_minutes
type: object
- new_secret:
+ snooze_alert_data:
properties:
- data:
- $ref: '#/components/schemas/new_secret_data'
+ type:
+ enum:
+ - alerts
+ type: string
+ attributes:
+ $ref: '#/components/schemas/snooze_alert_data_attributes'
required:
- - data
+ - attributes
+ - type
type: object
- update_secret:
+ escalate_alert_data_attributes:
+ additionalProperties: false
properties:
- data:
- $ref: '#/components/schemas/update_secret_data'
- required:
- - data
+ escalation_policy_id:
+ description: "The ID of the escalation policy to escalate to. If omitted,\
+ \ uses the alert's current escalation policy from metadata. Required for\
+ \ resolved alerts whose metadata may have been cleared."
+ type: string
+ escalation_policy_level:
+ description: "The escalation policy level to escalate to. If omitted, defaults\
+ \ to the next level (same EP) or level 1 (different EP)."
+ minimum: 1
+ type: integer
type: object
- secret:
+ escalate_alert_data:
properties:
- name:
- description: The name of the secret
- type: string
- secret:
- description: The redacted secret
- type: string
- hashicorp_vault_mount:
- description: The HashiCorp Vault secret mount path
+ type:
+ enum:
+ - alerts
type: string
- hashicorp_vault_path:
- description: The HashiCorp Vault secret path
- nullable: true
+ attributes:
+ $ref: '#/components/schemas/escalate_alert_data_attributes'
+ type: object
+ new_alert_event_data_attributes:
+ additionalProperties: false
+ properties:
+ kind:
+ enum:
+ - note
type: string
- hashicorp_vault_version:
- description: The HashiCorp Vault secret version
+ user_id:
+ description: Author of the note.
type: integer
- created_at:
- description: Date of creation
- type: string
- updated_at:
- description: Date of last update
+ details:
+ description: Note message.
type: string
required:
- - created_at
- - name
- - updated_at
+ - details
+ - kind
type: object
- secret_response:
+ new_alert_event_data:
properties:
- data:
- $ref: '#/components/schemas/secret_response_data'
+ type:
+ enum:
+ - alert_events
+ type: string
+ attributes:
+ $ref: '#/components/schemas/new_alert_event_data_attributes'
required:
- - data
+ - attributes
+ - type
type: object
- secret_list:
+ update_alert_event_data_attributes:
+ additionalProperties: false
properties:
- data:
- items:
- $ref: '#/components/schemas/secret_response_data'
- type: array
- links:
- allOf:
- - $ref: '#/components/schemas/links'
- type: object
+ user_id:
+ description: Author of the note.
+ type: integer
+ details:
+ description: Note message.
+ type: string
required:
- - data
+ - details
type: object
- new_service:
+ update_alert_event_data:
properties:
- data:
- $ref: '#/components/schemas/new_service_data'
+ type:
+ enum:
+ - alert_events
+ type: string
+ attributes:
+ $ref: '#/components/schemas/update_alert_event_data_attributes'
required:
- - data
+ - attributes
+ - type
type: object
- update_service:
+ alert_event_response_data:
properties:
- data:
- $ref: '#/components/schemas/update_service_data'
+ id:
+ description: Unique ID of the alert event
+ type: string
+ type:
+ enum:
+ - alert_events
+ type: string
+ attributes:
+ allOf:
+ - $ref: '#/components/schemas/alert_event'
+ type: object
required:
- - data
+ - attributes
+ - id
+ - type
type: object
- service:
+ new_alerts_source_data_attributes_alert_template_attributes:
+ nullable: true
properties:
- name:
- description: The name of the service
- type: string
- slug:
- description: The slug of the service
- type: string
- description:
- description: The description of the service
+ title:
+ description: The alert title.
nullable: true
type: string
- public_description:
- description: The public description of the service
+ description:
+ description: The alert description.
nullable: true
type: string
- notify_emails:
- description: Emails attached to the service
- items:
- type: string
- nullable: true
- type: array
- color:
- description: The hex color of the service
+ external_url:
+ description: The alert URL.
nullable: true
type: string
- position:
- description: Position of the service
- nullable: true
- type: integer
- backstage_id:
- description: "The Backstage entity id associated to this service. eg: :namespace/:kind/:entity_name"
+ type: object
+ new_alerts_source_data_attributes_alert_source_urgency_rules_attributes_inner:
+ properties:
+ json_path:
+ description: JSON path expression to extract a specific value from the alert's
+ payload for evaluation
nullable: true
type: string
- external_id:
- description: The external id associated to this service
- nullable: true
+ operator:
+ description: Comparison operator used to evaluate the extracted value against
+ the specified condition
+ enum:
+ - is
+ - is_not
+ - contains
+ - does_not_contain
type: string
- pagerduty_id:
- description: The PagerDuty service id associated to this service
- nullable: true
+ value:
+ description: Value that the extracted payload data is compared to using
+ the specified operator to determine a match
type: string
- opsgenie_id:
- description: The Opsgenie service id associated to this service
+ conditionable_type:
+ description: The type of the conditionable
+ enum:
+ - AlertField
nullable: true
type: string
- cortex_id:
- description: The Cortex group id associated to this service
+ conditionable_id:
+ description: "The ID of the conditionable. If conditionable_type is AlertField,\
+ \ this is the ID of the alert field."
nullable: true
type: string
- service_now_ci_sys_id:
- description: The Service Now CI sys id associated to this service
- nullable: true
+ kind:
+ description: The kind of the conditionable
+ enum:
+ - payload
+ - alert_field
type: string
- github_repository_name:
- description: "The GitHub repository name associated to this service. eg:\
- \ rootlyhq/my-service"
- nullable: true
+ alert_urgency_id:
+ description: The ID of the alert urgency
type: string
- github_repository_branch:
- description: "The GitHub repository branch associated to this service. eg:\
- \ main"
- nullable: true
+ type: object
+ new_alerts_source_data_attributes_sourceable_attributes_field_mappings_attributes_inner:
+ properties:
+ field:
+ description: Select the field on which the condition to be evaluated
+ enum:
+ - external_id
+ - state
+ - alert_title
+ - alert_description
+ - alert_external_url
+ - notification_target_type
+ - notification_target_id
type: string
- gitlab_repository_name:
- description: "The GitLab repository name associated to this service. eg:\
- \ rootlyhq/my-service"
- nullable: true
+ json_path:
+ description: JSON path expression to extract a specific value from the alert's
+ payload for evaluation
type: string
- gitlab_repository_branch:
- description: "The GitLab repository branch associated to this service. eg:\
- \ main"
+ type: object
+ new_alerts_source_data_attributes_sourceable_attributes:
+ description: Provide additional attributes for generic_webhook alerts source
+ nullable: true
+ properties:
+ auto_resolve:
+ description: Set this to true to auto-resolve alerts based on field_mappings_attributes
+ conditions
+ type: boolean
+ resolve_state:
+ description: This value is matched with the value extracted from alerts
+ payload using JSON path in field_mappings_attributes
nullable: true
type: string
- environment_ids:
- description: Environments associated with this service
- items:
- type: string
- nullable: true
- type: array
- service_ids:
- description: Services dependent on this service
- items:
- type: string
- nullable: true
- type: array
- owners_group_ids:
- description: Owner Teams associated with this service
- items:
- type: string
- nullable: true
- type: array
- owners_user_ids:
- description: Owner Users associated with this service
+ accept_threaded_emails:
+ description: Set this to false to reject threaded emails
+ type: boolean
+ field_mappings_attributes:
+ description: Specify rules to auto resolve alerts
items:
- type: integer
- nullable: true
+ $ref: '#/components/schemas/new_alerts_source_data_attributes_sourceable_attributes_field_mappings_attributes_inner'
type: array
- alert_urgency_id:
- description: The alert urgency id of the service
+ type: object
+ new_alerts_source_data_attributes_resolution_rule_attributes_conditions_attributes_inner:
+ properties:
+ field:
+ description: JSON path expression to extract a specific value from the alert's
+ payload for evaluation
nullable: true
type: string
- alerts_email_enabled:
- description: Enable alerts through email
+ operator:
+ description: Comparison operator used to evaluate the extracted value against
+ the specified condition
+ enum:
+ - is
+ - is_not
+ - contains
+ - does_not_contain
+ - starts_with
+ - ends_with
+ type: string
+ value:
+ description: Value that the extracted payload data is compared to using
+ the specified operator to determine a match
+ type: string
+ conditionable_type:
+ description: The type of the conditionable
+ enum:
+ - AlertField
+ nullable: true
+ type: string
+ conditionable_id:
+ description: "The ID of the conditionable. If conditionable_type is AlertField,\
+ \ this is the ID of the alert field."
nullable: true
+ type: string
+ kind:
+ description: The kind of the conditionable
+ enum:
+ - payload
+ - alert_field
+ type: string
+ type: object
+ new_alerts_source_data_attributes_resolution_rule_attributes:
+ description: Provide additional attributes for email alerts source
+ nullable: true
+ properties:
+ enabled:
+ description: Set this to true to enable the auto resolution rule
type: boolean
- alerts_email_address:
- description: Email generated to send alerts to
+ condition_type:
+ description: The type of condition to evaluate to apply auto resolution
+ rule
+ enum:
+ - all
+ - any
+ type: string
+ identifier_matchable_type:
+ description: The type of the identifier matchable
+ enum:
+ - AlertField
nullable: true
type: string
- slack_channels:
- description: Slack Channels associated with this service
- items:
- $ref: '#/components/schemas/new_environment_data_attributes_slack_channels_inner'
+ identifier_matchable_id:
+ description: "The ID of the identifier matchable. If identifier_matchable_type\
+ \ is AlertField, this is the ID of the alert field."
nullable: true
- type: array
- slack_aliases:
- description: Slack Aliases associated with this service
- items:
- $ref: '#/components/schemas/new_environment_data_attributes_slack_aliases_inner'
+ type: string
+ identifier_reference_kind:
+ description: The kind of the identifier reference
+ enum:
+ - payload
+ - alert_field
+ type: string
+ identifier_json_path:
+ description: JSON path expression to extract unique alert identifier used
+ to match triggered alerts with resolving alerts
nullable: true
- type: array
- created_at:
- description: Date of creation
type: string
- updated_at:
- description: Date of last update
+ identifier_value_regex:
+ description: Regex group to further specify the part of the string used
+ as a unique identifier
+ nullable: true
type: string
- required:
- - created_at
- - name
- - updated_at
- type: object
- service_response:
- properties:
- data:
- $ref: '#/components/schemas/service_response_data'
- required:
- - data
- type: object
- service_list:
- properties:
- data:
+ conditions_attributes:
+ description: List of conditions to evaluate for auto resolution
items:
- $ref: '#/components/schemas/service_response_data'
+ $ref: '#/components/schemas/new_alerts_source_data_attributes_resolution_rule_attributes_conditions_attributes_inner'
type: array
- links:
- allOf:
- - $ref: '#/components/schemas/links'
- type: object
- required:
- - data
- - links
type: object
- new_severity:
- properties:
- data:
- $ref: '#/components/schemas/new_severity_data'
- required:
- - data
- type: object
- update_severity:
+ new_alerts_source_data_attributes_alert_source_fields_attributes_inner:
properties:
- data:
- $ref: '#/components/schemas/update_severity_data'
- required:
- - data
+ alert_field_id:
+ description: The ID of the alert field
+ type: string
+ template_body:
+ description: Liquid expression to extract a specific value from the alert's
+ payload for evaluation
+ nullable: true
+ type: string
type: object
- severity:
+ new_alerts_source_data_attributes:
+ additionalProperties: false
properties:
name:
- description: The name of the severity
+ description: The name of the alert source
type: string
- slug:
- description: The slug of the severity
+ source_type:
+ description: The alert source type
+ enum:
+ - email
+ - app_dynamics
+ - catchpoint
+ - datadog
+ - dynatrace
+ - alertmanager
+ - google_cloud
+ - grafana
+ - sentry
+ - generic_webhook
+ - cloud_watch
+ - aws_sns
+ - checkly
+ - azure
+ - new_relic
+ - splunk
+ - chronosphere
+ - app_optics
+ - bug_snag
+ - honeycomb
+ - monte_carlo
+ - nagios
+ - prtg
type: string
- description:
- description: The description of the severity
- nullable: true
+ alert_urgency_id:
+ description: ID for the default alert urgency assigned to this alert source
type: string
- severity:
- description: The severity of the severity
+ deduplicate_alerts_by_key:
+ description: "Toggle alert deduplication using deduplication key. If enabled,\
+ \ deduplication_key_kind and deduplication_key_path are required."
+ type: boolean
+ deduplication_key_kind:
+ description: Kind of deduplication key.
enum:
- - critical
- - high
- - medium
- - low
+ - payload
type: string
- color:
- description: The hex color of the severity
+ deduplication_key_path:
+ description: Path to deduplication key. This is a JSON Path to extract the
+ deduplication key from the request body.
nullable: true
type: string
- position:
- description: Position of the severity
+ deduplication_key_regexp:
+ description: Regular expression to extract key from value found at key path.
nullable: true
- type: integer
- notify_emails:
- description: Emails to attach to the severity
+ type: string
+ owner_group_ids:
+ description: List of team IDs that will own the alert source
items:
type: string
- nullable: true
type: array
- slack_channels:
- description: Slack Channels associated with this severity
+ alert_template_attributes:
+ $ref: '#/components/schemas/new_alerts_source_data_attributes_alert_template_attributes'
+ alert_source_urgency_rules_attributes:
+ description: List of rules that define the conditions under which the alert
+ urgency will be set automatically based on the alert payload
items:
- $ref: '#/components/schemas/new_environment_data_attributes_slack_channels_inner'
- nullable: true
+ $ref: '#/components/schemas/new_alerts_source_data_attributes_alert_source_urgency_rules_attributes_inner'
type: array
- slack_aliases:
- description: Slack Aliases associated with this severity
+ sourceable_attributes:
+ $ref: '#/components/schemas/new_alerts_source_data_attributes_sourceable_attributes'
+ resolution_rule_attributes:
+ $ref: '#/components/schemas/new_alerts_source_data_attributes_resolution_rule_attributes'
+ alert_source_fields_attributes:
+ description: "List of alert fields to be added to the alert source. Note:\
+ \ This attribute requires the alert field feature to be enabled on your\
+ \ account. Contact Rootly customer support if you need assistance with\
+ \ this feature."
items:
- $ref: '#/components/schemas/new_environment_data_attributes_slack_aliases_inner'
- nullable: true
+ $ref: '#/components/schemas/new_alerts_source_data_attributes_alert_source_fields_attributes_inner'
type: array
- created_at:
- description: Date of creation
- type: string
- updated_at:
- description: Date of last update
- type: string
required:
- - created_at
- name
- - updated_at
- type: object
- severity_response:
- properties:
- data:
- $ref: '#/components/schemas/severity_response_data'
- required:
- - data
type: object
- severity_list:
+ new_alerts_source_data:
properties:
- data:
- items:
- $ref: '#/components/schemas/severity_response_data'
- type: array
- links:
- allOf:
- - $ref: '#/components/schemas/links'
- type: object
+ type:
+ enum:
+ - alert_sources
+ type: string
+ attributes:
+ $ref: '#/components/schemas/new_alerts_source_data_attributes'
required:
- - data
- - links
+ - attributes
+ - type
type: object
- shift:
+ update_alerts_source_data_attributes:
+ additionalProperties: false
properties:
- schedule_id:
- description: ID of schedule
- nullable: false
- type: string
- rotation_id:
- description: ID of rotation
- nullable: true
+ name:
+ description: The name of the alert source
type: string
- starts_at:
- description: Start datetime of shift
- nullable: false
+ source_type:
+ description: The alert source type
+ enum:
+ - email
+ - app_dynamics
+ - catchpoint
+ - datadog
+ - dynatrace
+ - alertmanager
+ - google_cloud
+ - grafana
+ - sentry
+ - generic_webhook
+ - cloud_watch
+ - aws_sns
+ - checkly
+ - azure
+ - new_relic
+ - splunk
+ - chronosphere
+ - app_optics
+ - bug_snag
+ - honeycomb
+ - monte_carlo
+ - nagios
+ - prtg
type: string
- ends_at:
- description: End datetime of shift
- nullable: false
+ alert_urgency_id:
+ description: ID for the default alert urgency assigned to this alert source
type: string
- is_override:
- description: Denotes shift is an override shift
+ deduplicate_alerts_by_key:
+ description: "Toggle alert deduplication using deduplication key. If enabled,\
+ \ deduplication_key_kind and deduplication_key_path are required."
type: boolean
- shift_override:
- allOf:
- - $ref: '#/components/schemas/shift_override_response'
- description: Override metadata
+ deduplication_key_kind:
+ description: Kind of deduplication key.
+ enum:
+ - payload
+ type: string
+ deduplication_key_path:
+ description: Path to deduplication key. This is a JSON Path to extract the
+ deduplication key from the request body.
nullable: true
- type: object
- user:
- allOf:
- - $ref: '#/components/schemas/user_response'
- description: User metadata
- nullable: false
- type: object
- required:
- - ends_at
- - is_override
- - rotation_id
- - schedule_id
- - starts_at
- type: object
- shift_list:
- properties:
- data:
+ type: string
+ deduplication_key_regexp:
+ description: Regular expression to extract key from value found at key path.
+ nullable: true
+ type: string
+ owner_group_ids:
+ description: List of team IDs that will own the alert source
items:
- $ref: '#/components/schemas/shift_list_data_inner'
+ type: string
+ type: array
+ alert_template_attributes:
+ $ref: '#/components/schemas/new_alerts_source_data_attributes_alert_template_attributes'
+ alert_source_urgency_rules_attributes:
+ description: List of rules that define the conditions under which the alert
+ urgency will be set automatically based on the alert payload
+ items:
+ $ref: '#/components/schemas/new_alerts_source_data_attributes_alert_source_urgency_rules_attributes_inner'
+ type: array
+ sourceable_attributes:
+ $ref: '#/components/schemas/new_alerts_source_data_attributes_sourceable_attributes'
+ resolution_rule_attributes:
+ $ref: '#/components/schemas/new_alerts_source_data_attributes_resolution_rule_attributes'
+ alert_source_fields_attributes:
+ description: "List of alert fields to be added to the alert source. Note:\
+ \ This attribute requires the alert field feature to be enabled on your\
+ \ account. Contact Rootly customer support if you need assistance with\
+ \ this feature."
+ items:
+ $ref: '#/components/schemas/new_alerts_source_data_attributes_alert_source_fields_attributes_inner'
type: array
- required:
- - data
- type: object
- new_status_page_template:
- properties:
- data:
- $ref: '#/components/schemas/new_status_page_template_data'
- required:
- - data
type: object
- update_status_page_template:
+ update_alerts_source_data:
properties:
- data:
- $ref: '#/components/schemas/update_status_page_template_data'
+ type:
+ enum:
+ - alert_sources
+ type: string
+ attributes:
+ $ref: '#/components/schemas/update_alerts_source_data_attributes'
required:
- - data
+ - attributes
+ - type
type: object
- status_page_template:
+ alerts_source_response_data:
properties:
- status_page_id:
- type: string
- title:
- description: Title of the template
- type: string
- body:
- description: Description of the event the template will populate
- type: string
- update_status:
- description: Status of the event the template will populate
- nullable: true
+ id:
+ description: Unique ID of the alert source
type: string
- kind:
- description: The kind of the status page template
+ type:
enum:
- - normal
- - scheduled
- nullable: false
- type: string
- should_notify_subscribers:
- description: Controls if incident subscribers should be notified
- nullable: true
- type: boolean
- enabled:
- description: Enable / Disable the status page template
- nullable: true
- type: boolean
- position:
- description: Position of the workflow task
- type: integer
- created_at:
- description: Date of creation
- type: string
- updated_at:
- description: Date of last update
+ - alert_sources
type: string
- required:
- - body
- - created_at
- - status_page_id
- - title
- - updated_at
- type: object
- status_page_template_response:
- properties:
- data:
- $ref: '#/components/schemas/status_page_template_response_data'
- required:
- - data
- type: object
- status_page_template_list:
- properties:
- data:
- items:
- $ref: '#/components/schemas/status_page_template_list_data_inner'
- type: array
- links:
+ attributes:
allOf:
- - $ref: '#/components/schemas/links'
+ - $ref: '#/components/schemas/alerts_source'
type: object
required:
- - data
- - links
- type: object
- new_status_page:
- properties:
- data:
- $ref: '#/components/schemas/new_status_page_data'
- required:
- - data
+ - attributes
+ - id
+ - type
type: object
- update_status_page:
+ new_alert_route_data_attributes_rules_inner_destinations_inner:
properties:
- data:
- $ref: '#/components/schemas/update_status_page_data'
+ target_type:
+ description: The type of the target. Please contact support if you encounter
+ issues using `Functionality` as a target type.
+ enum:
+ - Service
+ - Group
+ - Functionality
+ - EscalationPolicy
+ type: string
+ target_id:
+ description: The ID of the target
+ format: uuid
+ type: string
required:
- - data
+ - target_id
+ - target_type
type: object
- status_page:
+ new_alert_route_data_attributes_rules_inner_condition_groups_inner_conditions_inner:
properties:
- title:
- description: The title of the status page
- type: string
- public_title:
- description: The public title of the status page
- nullable: true
- type: string
- description:
- description: The description of the status page
- nullable: true
- type: string
- public_description:
- description: The public description of the status page
- nullable: true
- type: string
- header_color:
- description: The color of the header. Eg. "#0061F2"
- nullable: true
- type: string
- footer_color:
- description: The color of the footer. Eg. "#1F2F41"
- nullable: true
- type: string
- allow_search_engine_index:
- description: Allow search engines to include your public status page in
- search results
- nullable: true
- type: boolean
- show_uptime:
- description: Show uptime
- nullable: true
- type: boolean
- show_uptime_last_days:
- description: Show uptime over x days
+ property_field_condition_type:
enum:
- - 30
- - 60
- - 90
- - 180
- - 360
- nullable: true
- type: integer
- success_message:
- description: Message showing when all components are operational
- nullable: true
- type: string
- failure_message:
- description: Message showing when at least one component is not operational
- nullable: true
- type: string
- authentication_enabled:
- default: false
- description: Enable authentication
- nullable: true
- type: boolean
- authentication_password:
- description: Authentication password
- nullable: true
- type: string
- website_url:
- description: Website URL
- nullable: true
- type: string
- website_privacy_url:
- description: Website Privacy URL
- nullable: true
- type: string
- website_support_url:
- description: Website Support URL
- nullable: true
+ - is_one_of
+ - is_not_one_of
+ - contains
+ - does_not_contain
+ - starts_with
+ - ends_with
+ - matches_regex
+ - is_empty
type: string
- ga_tracking_id:
- description: Google Analytics tracking ID
- nullable: true
+ property_field_name:
+ description: The name of the property field
type: string
- time_zone:
- default: Etc/UTC
- description: A valid IANA time zone name.
- nullable: true
+ property_field_type:
+ enum:
+ - attribute
+ - payload
+ - alert_field
type: string
- public:
- description: Make the status page accessible to the public
+ property_field_value:
+ description: The value of the property field
nullable: true
- type: boolean
- service_ids:
- description: Services attached to the status page
- items:
- type: string
- type: array
- functionality_ids:
- description: Functionalities attached to the status page
+ type: string
+ property_field_values:
items:
type: string
+ nullable: true
type: array
- external_domain_names:
- description: External domain names attached to the status page
+ alert_urgency_ids:
+ description: The Alert Urgency IDs to check in the condition
items:
type: string
+ nullable: true
type: array
- enabled:
- description: Enabled / Disable the status page
+ conditionable_type:
+ description: The type of the conditionable
+ enum:
+ - AlertField
nullable: true
- type: boolean
- created_at:
- description: Date of creation
type: string
- updated_at:
- description: Date of last update
+ conditionable_id:
+ description: The ID of the conditionable
+ format: uuid
+ nullable: true
type: string
required:
- - created_at
- - title
- - updated_at
+ - property_field_condition_type
+ - property_field_type
type: object
- status_page_response:
+ new_alert_route_data_attributes_rules_inner_condition_groups_inner:
properties:
- data:
- $ref: '#/components/schemas/status_page_response_data'
+ position:
+ description: The position of the condition group
+ type: integer
+ conditions:
+ items:
+ $ref: '#/components/schemas/new_alert_route_data_attributes_rules_inner_condition_groups_inner_conditions_inner'
+ type: array
required:
- - data
+ - conditions
type: object
- status_page_list:
+ new_alert_route_data_attributes_rules_inner:
properties:
- data:
+ name:
+ description: The name of the alert routing rule
+ type: string
+ position:
+ description: The position of the alert routing rule for ordering evaluation
+ type: integer
+ fallback_rule:
+ default: false
+ description: Whether this is a fallback rule
+ type: boolean
+ destinations:
items:
- $ref: '#/components/schemas/status_page_response_data'
+ $ref: '#/components/schemas/new_alert_route_data_attributes_rules_inner_destinations_inner'
+ type: array
+ condition_groups:
+ items:
+ $ref: '#/components/schemas/new_alert_route_data_attributes_rules_inner_condition_groups_inner'
type: array
- links:
- allOf:
- - $ref: '#/components/schemas/links'
- type: object
required:
- - data
- - links
+ - condition_groups
+ - destinations
+ - name
type: object
- new_team:
+ new_alert_route_data_attributes:
properties:
- data:
- $ref: '#/components/schemas/new_team_data'
+ name:
+ description: The name of the alert route
+ type: string
+ enabled:
+ description: Whether the alert route is enabled
+ type: boolean
+ alerts_source_ids:
+ items:
+ description: The ID of the alerts source
+ format: uuid
+ type: string
+ type: array
+ owning_team_ids:
+ items:
+ description: The ID of the owning team
+ format: uuid
+ type: string
+ type: array
+ rules:
+ items:
+ $ref: '#/components/schemas/new_alert_route_data_attributes_rules_inner'
+ type: array
required:
- - data
+ - alerts_source_ids
+ - name
type: object
- update_team:
+ new_alert_route_data:
properties:
- data:
- $ref: '#/components/schemas/update_team_data'
- required:
- - data
+ type:
+ enum:
+ - alert_routes
+ type: string
+ attributes:
+ $ref: '#/components/schemas/new_alert_route_data_attributes'
type: object
- team:
+ update_alert_route_data_attributes:
+ additionalProperties: false
properties:
name:
- description: The name of the team
- type: string
- slug:
+ description: The name of the alert route
type: string
- description:
- description: The description of the team
- nullable: true
- type: string
- notify_emails:
- description: Emails to attach to the team
+ enabled:
+ description: Whether the alert route is enabled
+ type: boolean
+ alerts_source_ids:
items:
+ description: The ID of the alerts source
+ format: uuid
type: string
- nullable: true
type: array
- color:
- description: The hex color of the team
- nullable: true
- type: string
- position:
- description: Position of the team
- nullable: true
- type: integer
- backstage_id:
- description: "The Backstage entity id associated to this team. eg: :namespace/:kind/:entity_name"
- nullable: true
+ owning_team_ids:
+ items:
+ description: The ID of the owning team
+ format: uuid
+ type: string
+ type: array
+ rules:
+ items:
+ $ref: '#/components/schemas/new_alert_route_data_attributes_rules_inner'
+ type: array
+ type: object
+ update_alert_route_data:
+ properties:
+ type:
+ enum:
+ - alert_routes
type: string
- external_id:
- description: The external id associated to this team
- nullable: true
+ attributes:
+ $ref: '#/components/schemas/update_alert_route_data_attributes'
+ required:
+ - attributes
+ - type
+ type: object
+ patch_alert_route_data_attributes_rules_inner_destinations_inner:
+ properties:
+ id:
+ description: The ID of the destination. Required for updating or deleting
+ existing destinations.
+ format: uuid
type: string
- pagerduty_id:
- description: The PagerDuty group id associated to this team
- nullable: true
+ _destroy:
+ description: Set to true to delete this destination
+ type: boolean
+ target_type:
+ description: The type of the target. Please contact support if you encounter
+ issues using `Functionality` as a target type.
+ enum:
+ - Service
+ - Group
+ - Functionality
+ - EscalationPolicy
type: string
- pagerduty_service_id:
- description: The PagerDuty service id associated to this team
- nullable: true
+ target_id:
+ description: The ID of the target
+ format: uuid
type: string
- opsgenie_id:
- description: The Opsgenie group id associated to this team
- nullable: true
+ type: object
+ patch_alert_route_data_attributes_rules_inner_condition_groups_inner_conditions_inner:
+ properties:
+ id:
+ description: The ID of the condition. Required for updating or deleting
+ existing conditions.
+ format: uuid
type: string
- victor_ops_id:
- description: The VictorOps group id associated to this team
- nullable: true
+ _destroy:
+ description: Set to true to delete this condition
+ type: boolean
+ property_field_condition_type:
+ enum:
+ - is_one_of
+ - is_not_one_of
+ - contains
+ - does_not_contain
+ - starts_with
+ - ends_with
+ - matches_regex
+ - is_empty
type: string
- pagertree_id:
- description: The PagerTree group id associated to this team
- nullable: true
+ property_field_name:
+ description: The name of the property field
type: string
- cortex_id:
- description: The Cortex group id associated to this team
- nullable: true
+ property_field_type:
+ enum:
+ - attribute
+ - payload
+ - alert_field
type: string
- service_now_ci_sys_id:
- description: The Service Now CI sys id associated to this team
+ property_field_value:
+ description: The value of the property field
nullable: true
type: string
- user_ids:
- description: The user ids of the members of this team.
+ property_field_values:
items:
- type: integer
+ type: string
nullable: true
type: array
- admin_ids:
- description: The user ids of the admins of this team. These users must also
- be present in user_ids attribute.
+ alert_urgency_ids:
+ description: The Alert Urgency IDs to check in the condition
items:
- type: integer
+ type: string
nullable: true
type: array
- alerts_email_enabled:
- description: Enable alerts through email
- nullable: true
- type: boolean
- alerts_email_address:
- description: Email generated to send alerts to
+ conditionable_type:
+ description: The type of the conditionable
+ enum:
+ - AlertField
nullable: true
type: string
- alert_urgency_id:
- description: The alert urgency id of the team
+ conditionable_id:
+ description: The ID of the conditionable
+ format: uuid
nullable: true
type: string
- slack_channels:
- description: Slack Channels associated with this team
- items:
- $ref: '#/components/schemas/new_environment_data_attributes_slack_channels_inner'
- nullable: true
- type: array
- slack_aliases:
- description: Slack Aliases associated with this team
+ type: object
+ patch_alert_route_data_attributes_rules_inner_condition_groups_inner:
+ properties:
+ id:
+ description: The ID of the condition group. Required for updating or deleting
+ existing condition groups.
+ format: uuid
+ type: string
+ _destroy:
+ description: Set to true to delete this condition group
+ type: boolean
+ position:
+ description: The position of the condition group
+ type: integer
+ conditions:
items:
- $ref: '#/components/schemas/new_environment_data_attributes_slack_aliases_inner'
- nullable: true
+ $ref: '#/components/schemas/patch_alert_route_data_attributes_rules_inner_condition_groups_inner_conditions_inner'
type: array
- created_at:
- description: Date of creation
- type: string
- updated_at:
- description: Date of last update
- type: string
- required:
- - created_at
- - name
- - updated_at
type: object
- team_response:
+ patch_alert_route_data_attributes_rules_inner:
properties:
- data:
- $ref: '#/components/schemas/team_response_data'
- required:
- - data
+ id:
+ description: The ID of the alert routing rule. Required for updating or
+ deleting existing rules.
+ format: uuid
+ type: string
+ _destroy:
+ description: "Set to true to delete this rule. When true, only the id field\
+ \ is required."
+ type: boolean
+ name:
+ description: The name of the alert routing rule
+ type: string
+ position:
+ description: The position of the alert routing rule for ordering evaluation
+ type: integer
+ fallback_rule:
+ default: false
+ description: Whether this is a fallback rule
+ type: boolean
+ destinations:
+ items:
+ $ref: '#/components/schemas/patch_alert_route_data_attributes_rules_inner_destinations_inner'
+ type: array
+ condition_groups:
+ items:
+ $ref: '#/components/schemas/patch_alert_route_data_attributes_rules_inner_condition_groups_inner'
+ type: array
type: object
- team_list:
+ patch_alert_route_data_attributes:
+ additionalProperties: false
properties:
- data:
+ name:
+ description: The name of the alert route
+ type: string
+ enabled:
+ description: Whether the alert route is enabled
+ type: boolean
+ alerts_source_ids:
items:
- $ref: '#/components/schemas/team_response_data'
+ description: The ID of the alerts source
+ format: uuid
+ type: string
+ type: array
+ owning_team_ids:
+ items:
+ description: The ID of the owning team
+ format: uuid
+ type: string
+ type: array
+ rules:
+ items:
+ $ref: '#/components/schemas/patch_alert_route_data_attributes_rules_inner'
type: array
- links:
- allOf:
- - $ref: '#/components/schemas/links'
- type: object
- required:
- - data
- - links
type: object
- new_user_notification_rule:
+ patch_alert_route_data:
properties:
- data:
- $ref: '#/components/schemas/new_user_notification_rule_data'
+ type:
+ enum:
+ - alert_routes
+ type: string
+ attributes:
+ $ref: '#/components/schemas/patch_alert_route_data_attributes'
required:
- - data
+ - attributes
+ - type
type: object
- update_user_notification_rule:
+ alert_route_response_data:
properties:
- data:
- $ref: '#/components/schemas/update_user_notification_rule_data'
+ id:
+ description: Unique ID of the alert route
+ type: string
+ type:
+ enum:
+ - alert_routes
+ type: string
+ attributes:
+ allOf:
+ - $ref: '#/components/schemas/alert_route'
+ type: object
required:
- - data
+ - attributes
+ - id
+ - type
type: object
- user_notification_rule:
+ new_alert_routing_rule_data_attributes_conditions_inner:
properties:
- user_id:
- type: integer
- delay:
- description: Delay after which rule gets triggered
- nullable: true
- type: integer
- position:
- description: Position of the rule
- nullable: true
- type: integer
- user_email_address_id:
- description: User email address to which notification to be sent
- nullable: true
+ property_field_type:
+ description: The type of the property field
+ enum:
+ - attribute
+ - payload
type: string
- user_call_number_id:
- description: User phone number to which notification to be sent
- nullable: true
+ property_field_name:
+ description: "The name of the property field. If the property field type\
+ \ is selected as 'attribute', then the allowed property field names are\
+ \ 'summary' (for Title), 'description', 'alert_urgency' and 'external_url'\
+ \ (for Alert Source URL). If the property field type is selected as 'payload',\
+ \ then the property field name should be supplied in JSON Path syntax."
type: string
- user_sms_number_id:
- description: User sms number to which notification to be sent
- nullable: true
+ property_field_condition_type:
+ description: The condition type of the property field
+ enum:
+ - is_one_of
+ - is_not_one_of
+ - contains
+ - does_not_contain
+ - starts_with
+ - ends_with
+ - matches_regex
+ - is_empty
type: string
- user_device_id:
- description: User device to which notification to be sent
- nullable: true
+ property_field_value:
+ description: The value of the property field. Can be null if the property
+ field condition type is 'is_one_of' or 'is_not_one_of'
type: string
- enabled_contact_types:
- description: Contact types for which notification needs to be enabled
+ property_field_values:
+ description: The values of the property field. Need to be passed if the
+ property field condition type is 'is_one_of' or 'is_not_one_of' except
+ for when property field name is 'alert_urgency'
items:
- enum:
- - email
- - sms
- - call
- - device
- - non_critical_device
type: string
- nullable: false
type: array
- created_at:
- description: Date of creation
- type: string
- updated_at:
- description: Date of last update
- type: string
- type: object
- user_notification_rule_response:
- properties:
- data:
- $ref: '#/components/schemas/user_notification_rule_response_data'
required:
- - data
+ - property_field_condition_type
+ - property_field_name
+ - property_field_type
type: object
- user_notification_rule_list:
+ new_alert_routing_rule_data_attributes:
+ additionalProperties: false
properties:
- data:
+ name:
+ description: The name of the alert routing rule
+ type: string
+ enabled:
+ description: Whether the alert routing rule is enabled
+ type: boolean
+ owning_team_ids:
+ description: "The IDs of the teams which own the alert routing rule. If\
+ \ the user doesn't have Alert Routing Create Permission in On-Call Roles,\
+ \ then this field is required and can contain Team IDs the user is an\
+ \ admin of."
items:
- $ref: '#/components/schemas/user_notification_rule_response_data'
+ format: uuid
+ type: string
type: array
- links:
- allOf:
- - $ref: '#/components/schemas/links'
- type: object
- required:
- - data
- - links
- type: object
- user:
- properties:
- email:
- description: The email of the user
- type: string
- first_name:
- description: First name of the user
- nullable: true
- type: string
- last_name:
- description: Last name of the user
- nullable: true
- type: string
- full_name:
- description: The full name of the user
- nullable: true
- type: string
- full_name_with_team:
- description: The full name with team of the user
- nullable: true
- type: string
- time_zone:
- description: Configured time zone
- nullable: true
- type: string
- created_at:
- description: Date of creation
+ alerts_source_id:
+ description: The ID of the alerts source
+ format: uuid
type: string
- updated_at:
- description: Date of last update
+ position:
+ description: The position of the alert routing rule for ordering evaluation
+ type: integer
+ condition_type:
+ description: The type of condition for the alert routing rule
+ enum:
+ - all
+ - any
type: string
- required:
- - created_at
- - email
- - updated_at
- type: object
- role_relationship:
- properties:
- data:
- $ref: '#/components/schemas/role_relationship_data'
- type: object
- on_call_role_relationship:
- properties:
- data:
- $ref: '#/components/schemas/on_call_role_relationship_data'
- type: object
- user_relationships:
- properties:
- role:
- $ref: '#/components/schemas/role_relationship'
- on_call_role:
- $ref: '#/components/schemas/on_call_role_relationship'
- type: object
- update_user:
- properties:
- data:
- $ref: '#/components/schemas/update_user_data'
- required:
- - data
- type: object
- user_response:
- properties:
- data:
- $ref: '#/components/schemas/user_response_data'
- required:
- - data
- type: object
- user_list:
- properties:
- data:
+ conditions:
items:
- $ref: '#/components/schemas/user_response_data'
+ $ref: '#/components/schemas/new_alert_routing_rule_data_attributes_conditions_inner'
type: array
- links:
- allOf:
- - $ref: '#/components/schemas/links'
- type: object
+ destination:
+ $ref: '#/components/schemas/new_alert_route_data_attributes_rules_inner_destinations_inner'
+ required:
+ - alerts_source_id
+ - destination
+ - name
+ type: object
+ new_alert_routing_rule_data:
+ properties:
+ type:
+ enum:
+ - alert_routing_rules
+ type: string
+ attributes:
+ $ref: '#/components/schemas/new_alert_routing_rule_data_attributes'
required:
- - data
- - links
+ - attributes
+ - type
type: object
- webhooks_delivery:
+ update_alert_routing_rule_data_attributes_conditions_inner:
properties:
- endpoint_id:
+ id:
+ description: The ID of the alert routing rule condition
+ format: uuid
type: string
- payload:
+ property_field_type:
+ description: The type of the property field
+ enum:
+ - attribute
+ - payload
type: string
- delivered_at:
- nullable: true
+ property_field_name:
+ description: "The name of the property field. If the property field type\
+ \ is selected as 'attribute', then the allowed property field names are\
+ \ 'summary' (for Title), 'description', 'alert_urgency' and 'external_url'\
+ \ (for Alert Source URL). If the property field type is selected as 'payload',\
+ \ then the property field name should be supplied in JSON Path syntax."
type: string
- created_at:
- description: Date of creation
+ property_field_condition_type:
+ description: The condition type of the property field
+ enum:
+ - is_one_of
+ - is_not_one_of
+ - contains
+ - does_not_contain
+ - starts_with
+ - ends_with
+ - matches_regex
+ - is_empty
type: string
- updated_at:
- description: Date of last update
+ property_field_value:
+ description: The value of the property field. Can be null if the property
+ field condition type is 'is_one_of' or 'is_not_one_of'
+ nullable: true
type: string
- required:
- - created_at
- - delivered_at
- - endpoint_id
- - payload
- - updated_at
- type: object
- webhooks_delivery_response:
- properties:
- data:
- $ref: '#/components/schemas/webhooks_delivery_response_data'
- required:
- - data
- type: object
- webhooks_delivery_list:
- properties:
- data:
+ property_field_values:
+ description: The values of the property field. Used if the property field
+ condition type is 'is_one_of' or 'is_not_one_of' except for when property
+ field name is 'alert_urgency'
items:
- $ref: '#/components/schemas/webhooks_delivery_response_data'
+ type: string
type: array
- links:
- allOf:
- - $ref: '#/components/schemas/links'
- type: object
- required:
- - data
type: object
- new_webhooks_endpoint:
- properties:
- data:
- $ref: '#/components/schemas/new_webhooks_endpoint_data'
- required:
- - data
- type: object
- update_webhooks_endpoint:
+ update_alert_routing_rule_data_attributes_destination:
properties:
- data:
- $ref: '#/components/schemas/update_webhooks_endpoint_data'
- required:
- - data
+ target_type:
+ description: The type of the target. Please contact support if you encounter
+ issues using `Functionality` as a target type.
+ enum:
+ - Service
+ - Group
+ - Functionality
+ - EscalationPolicy
+ type: string
+ target_id:
+ description: The ID of the target
+ format: uuid
+ type: string
type: object
- webhooks_endpoint:
+ update_alert_routing_rule_data_attributes:
+ additionalProperties: false
properties:
name:
- description: The name of the endpoint
- type: string
- slug:
- description: The slug of the endpoint
+ description: The name of the alert routing rule
type: string
- url:
- description: The URL of the endpoint.
+ enabled:
+ description: Whether the alert routing rule is enabled
+ type: boolean
+ alerts_source_id:
+ description: The ID of the alerts source
+ format: uuid
type: string
- event_types:
+ position:
+ description: The position of the alert routing rule for ordering evaluation
+ type: integer
+ owning_team_ids:
+ description: The IDs of the teams that own the alert routing rule
items:
- enum:
- - incident.created
- - incident.updated
- - incident.in_triage
- - incident.mitigated
- - incident.resolved
- - incident.cancelled
- - incident.deleted
- - incident.scheduled.created
- - incident.scheduled.updated
- - incident.scheduled.in_progress
- - incident.scheduled.completed
- - incident.scheduled.deleted
- - incident_post_mortem.created
- - incident_post_mortem.updated
- - incident_post_mortem.published
- - incident_post_mortem.deleted
- - incident_status_page_event.created
- - incident_status_page_event.updated
- - incident_status_page_event.deleted
- - incident_event.created
- - incident_event.updated
- - incident_event.deleted
- - alert.created
- - pulse.created
- - genius_workflow_run.queued
- - genius_workflow_run.started
- - genius_workflow_run.completed
- - genius_workflow_run.failed
- - genius_workflow_run.canceled
+ format: uuid
type: string
type: array
- secret:
- description: The webhook signing secret used to verify webhook requests.
- type: string
- enabled:
- type: boolean
- created_at:
- description: Date of creation
- type: string
- updated_at:
- description: Date of last update
+ condition_type:
+ description: The type of condition for the alert routing rule
+ enum:
+ - all
+ - any
type: string
- required:
- - created_at
- - enabled
- - event_types
- - name
- - secret
- - slug
- - updated_at
- - url
+ conditions:
+ items:
+ $ref: '#/components/schemas/update_alert_routing_rule_data_attributes_conditions_inner'
+ type: array
+ destination:
+ $ref: '#/components/schemas/update_alert_routing_rule_data_attributes_destination'
type: object
- webhooks_endpoint_response:
+ update_alert_routing_rule_data:
properties:
- data:
- $ref: '#/components/schemas/webhooks_endpoint_response_data'
+ type:
+ enum:
+ - alert_routing_rules
+ type: string
+ attributes:
+ $ref: '#/components/schemas/update_alert_routing_rule_data_attributes'
required:
- - data
+ - attributes
+ - type
type: object
- webhooks_endpoint_list:
+ alert_routing_rule_conditions_inner:
properties:
- data:
+ property_field_type:
+ description: The type of the property field
+ enum:
+ - attribute
+ - payload
+ type: string
+ property_field_name:
+ description: "The name of the property field. If the property field type\
+ \ is selected as 'attribute', then the allowed property field names are\
+ \ 'summary' (for Title), 'description', 'alert_urgency' and 'external_url'\
+ \ (for Alert Source URL). If the property field type is selected as 'payload',\
+ \ then the property field name should be supplied in JSON Path syntax."
+ type: string
+ property_field_condition_type:
+ description: The condition type of the property field
+ enum:
+ - is_one_of
+ - is_not_one_of
+ - contains
+ - does_not_contain
+ - starts_with
+ - ends_with
+ - matches_regex
+ - is_empty
+ type: string
+ property_field_value:
+ description: The value of the property field. Can be null if the property
+ field condition type is 'is_one_of' or 'is_not_one_of'
+ nullable: true
+ type: string
+ property_field_values:
+ description: The values of the property field. Used if the property field
+ condition type is 'is_one_of' or 'is_not_one_of' except for when property
+ field name is 'alert_urgency'
items:
- $ref: '#/components/schemas/webhooks_endpoint_response_data'
+ type: string
type: array
- links:
- allOf:
- - $ref: '#/components/schemas/links'
- type: object
- required:
- - data
- type: object
- new_sub_status:
- properties:
- data:
- $ref: '#/components/schemas/new_sub_status_data'
required:
- - data
+ - property_field_condition_type
+ - property_field_name
+ - property_field_type
type: object
- update_sub_status:
+ alert_routing_rule_destination:
+ description: The destinations for the alert routing rule
+ nullable: true
properties:
- data:
- $ref: '#/components/schemas/update_sub_status_data'
+ target_type:
+ description: The type of the target. Please contact support if you encounter
+ issues using `Functionality` as a target type.
+ enum:
+ - Service
+ - Group
+ - Functionality
+ - EscalationPolicy
+ type: string
+ target_id:
+ description: The ID of the target
+ format: uuid
+ type: string
required:
- - data
+ - target_id
+ - target_type
type: object
- sub_status:
+ alert_routing_rule_condition_groups_inner_conditions_inner:
properties:
- name:
+ id:
+ description: Unique ID of the condition
+ format: uuid
type: string
- slug:
+ property_field_type:
+ description: The type of the property field
+ enum:
+ - attribute
+ - payload
type: string
- description:
- nullable: true
+ property_field_name:
+ description: The name of the property field
type: string
- parent_status:
+ property_field_condition_type:
+ description: The condition type of the property field
enum:
- - in_triage
- - started
- - resolved
- - closed
- - cancelled
- - scheduled
- - in_progress
- - completed
+ - is_one_of
+ - is_not_one_of
+ - contains
+ - does_not_contain
+ - starts_with
+ - ends_with
+ - matches_regex
+ - is_empty
type: string
- position:
+ property_field_value:
+ description: The value of the property field
nullable: true
- type: integer
+ type: string
+ property_field_values:
+ description: The values of the property field
+ items:
+ type: string
+ nullable: true
+ type: array
+ conditionable_id:
+ description: The ID of the conditionable object
+ format: uuid
+ nullable: true
+ type: string
+ conditionable_type:
+ description: The type of the conditionable object
+ nullable: true
+ type: string
created_at:
+ description: Date of creation
type: string
updated_at:
+ description: Date of last update
type: string
required:
- - created_at
- - name
- - parent_status
- - updated_at
- type: object
- sub_status_response:
- properties:
- data:
- $ref: '#/components/schemas/sub_status_response_data'
- required:
- - data
+ - property_field_condition_type
+ - property_field_name
+ - property_field_type
type: object
- sub_status_list:
+ alert_routing_rule_condition_groups_inner:
properties:
- data:
+ id:
+ description: Unique ID of the condition group
+ format: uuid
+ type: string
+ position:
+ description: The position of the condition group for ordering
+ type: integer
+ conditions:
+ description: The conditions within this group
items:
- $ref: '#/components/schemas/sub_status_response_data'
+ $ref: '#/components/schemas/alert_routing_rule_condition_groups_inner_conditions_inner'
type: array
- links:
- allOf:
- - $ref: '#/components/schemas/links'
- type: object
- required:
- - data
- - links
- type: object
- new_incident_sub_status:
- properties:
- data:
- $ref: '#/components/schemas/new_incident_sub_status_data'
- required:
- - data
- type: object
- update_incident_sub_status:
- properties:
- data:
- $ref: '#/components/schemas/update_incident_sub_status_data'
- required:
- - data
- type: object
- incident_sub_status:
- properties:
- incident_id:
- type: string
- sub_status_id:
- description: "Note: To change an incident's sub-status, use the PATCH /incidents/:id\
- \ endpoint and set the sub_status_id attribute. This endpoint is for modifying\
- \ the timestamp of when an incident's sub-status was assigned."
+ created_at:
+ description: Date of creation
type: string
- assigned_at:
+ updated_at:
+ description: Date of last update
type: string
- assigned_by_user_id:
- nullable: true
- type: integer
- required:
- - assigned_at
- - incident_id
- - sub_status_id
- type: object
- incident_sub_status_response:
- properties:
- data:
- $ref: '#/components/schemas/incident_sub_status_response_data'
required:
- - data
+ - position
type: object
- incident_sub_status_list:
+ alert_routing_rule_response_data:
properties:
- data:
- items:
- $ref: '#/components/schemas/incident_sub_status_response_data'
- type: array
- links:
+ id:
+ description: Unique ID of the alert_routing_rule
+ type: string
+ type:
+ enum:
+ - alert_routing_rules
+ type: string
+ attributes:
allOf:
- - $ref: '#/components/schemas/links'
+ - $ref: '#/components/schemas/alert_routing_rule'
type: object
required:
- - data
- - links
+ - attributes
+ - id
+ - type
type: object
- new_retrospective_process_group:
+ new_alert_field_data_attributes:
+ additionalProperties: false
properties:
- data:
- $ref: '#/components/schemas/new_retrospective_process_group_data'
+ name:
+ description: The name of the alert field
+ type: string
required:
- - data
+ - name
type: object
- update_retrospective_process_group:
+ new_alert_field_data:
properties:
- data:
- $ref: '#/components/schemas/update_retrospective_process_group_data'
+ type:
+ enum:
+ - alert_fields
+ type: string
+ attributes:
+ $ref: '#/components/schemas/new_alert_field_data_attributes'
required:
- - data
+ - attributes
+ - type
type: object
- retrospective_process_group:
+ update_alert_field_data_attributes:
+ additionalProperties: false
properties:
- retrospective_process_id:
- type: string
- sub_status_id:
+ name:
+ description: The name of the alert field
type: string
- position:
- type: integer
- required:
- - position
- - retrospective_process_id
- - sub_status_id
type: object
- retrospective_process_group_response:
+ update_alert_field_data:
properties:
- data:
- $ref: '#/components/schemas/retrospective_process_group_response_data'
+ type:
+ enum:
+ - alert_fields
+ type: string
+ attributes:
+ $ref: '#/components/schemas/update_alert_field_data_attributes'
required:
- - data
+ - attributes
+ - type
type: object
- retrospective_process_group_list:
+ alert_field_response_data:
properties:
- data:
- items:
- $ref: '#/components/schemas/retrospective_process_group_response_data'
- type: array
- links:
+ id:
+ description: The ID of the alert field
+ type: string
+ type:
+ enum:
+ - alert_fields
+ type: string
+ attributes:
allOf:
- - $ref: '#/components/schemas/links'
+ - $ref: '#/components/schemas/alert_field'
type: object
required:
- - data
- - links
- type: object
- new_retrospective_process_group_step:
- properties:
- data:
- $ref: '#/components/schemas/new_retrospective_process_group_step_data'
- required:
- - data
+ - attributes
+ - type
type: object
- update_retrospective_process_group_step:
+ alert_field_list_data_inner:
properties:
- data:
- $ref: '#/components/schemas/update_retrospective_process_group_step_data'
+ id:
+ description: The ID of the alert field
+ type: string
+ type:
+ enum:
+ - alert_fields
+ type: string
+ attributes:
+ allOf:
+ - $ref: '#/components/schemas/alert_field'
+ type: object
required:
- - data
+ - attributes
+ - id
+ - type
type: object
- retrospective_process_group_step:
+ new_alert_urgency_data_attributes:
+ additionalProperties: false
properties:
- retrospective_process_group_id:
+ name:
+ description: The name of the alert urgency
type: string
- retrospective_step_id:
+ description:
+ description: The description of the alert urgency
type: string
position:
- type: integer
- required:
- - position
- - retrospective_process_group_id
- - retrospective_step_id
- type: object
- retrospective_process_group_step_response:
- properties:
- data:
- $ref: '#/components/schemas/retrospective_process_group_step_response_data'
+ description: Position of the alert urgency
+ nullable: true
+ type: integer
required:
- - data
+ - description
+ - name
type: object
- retrospective_process_group_step_list:
+ new_alert_urgency_data:
properties:
- data:
- items:
- $ref: '#/components/schemas/retrospective_process_group_step_response_data'
- type: array
- links:
- allOf:
- - $ref: '#/components/schemas/links'
- type: object
+ type:
+ enum:
+ - alert_urgencies
+ type: string
+ attributes:
+ $ref: '#/components/schemas/new_alert_urgency_data_attributes'
required:
- - data
- - links
+ - attributes
+ - type
type: object
- attach_alert_data_attributes:
+ update_alert_urgency_data_attributes:
additionalProperties: false
properties:
- alert_ids:
- description: Alert Id to attach to the incident
- items:
- type: string
+ name:
+ description: The name of the alert urgency
+ type: string
+ description:
+ description: The description of the alert urgency
+ type: string
+ position:
+ description: Position of the alert urgency
nullable: true
- type: array
- required:
- - alert_ids
+ type: integer
type: object
- attach_alert_data:
+ update_alert_urgency_data:
properties:
type:
enum:
- - alerts
+ - alert_urgencies
type: string
attributes:
- $ref: '#/components/schemas/attach_alert_data_attributes'
+ $ref: '#/components/schemas/update_alert_urgency_data_attributes'
required:
- attributes
- type
type: object
- new_alert_data_attributes_labels_inner:
- nullable: true
+ alert_urgency_response_data:
properties:
- key:
- description: Key of the tag
+ id:
+ description: Unique ID of the alert urgency
type: string
- value:
- description: Value of the tag
+ type:
+ enum:
+ - alert_urgencies
type: string
+ attributes:
+ allOf:
+ - $ref: '#/components/schemas/alert_urgency'
+ type: object
required:
- - key
- - value
+ - attributes
+ - id
+ - type
type: object
- new_alert_data_attributes:
- additionalProperties: false
+ new_alert_group_data_attributes_targets_inner:
properties:
- noise:
- description: Whether the alert is marked as noise
+ target_type:
+ description: The type of the target. Please contact support if you encounter
+ issues using `Functionality` as a target type.
enum:
- - noise
- - not_noise
- nullable: true
+ - Group
+ - Service
+ - EscalationPolicy
+ - Functionality
type: string
- source:
- description: The source of the alert
- enum:
- - rootly
- - manual
- - api
- - web
- - slack
- - email
- - workflow
- - live_call_routing
- - pagerduty
- - opsgenie
- - victorops
- - pagertree
- - datadog
- - nobl9
- - zendesk
- - asana
- - clickup
- - sentry
- - rollbar
- - jira
- - honeycomb
- - service_now
- - linear
- - grafana
- - alertmanager
- - google_cloud
- - generic_webhook
- - cloud_watch
- - azure
- - splunk
- - chronosphere
- - app_optics
- - bug_snag
- - monte_carlo
- - nagios
- - prtg
- - catchpoint
- - app_dynamics
- - checkly
- - new_relic
- - gitlab
+ target_id:
+ description: "id for the Group, Service, EscalationPolicy or Functionality"
+ format: uuid
type: string
- status:
- description: "Only available for organizations with Rootly On-Call enabled.\
- \ Can be one of open, triggered."
+ required:
+ - target_id
+ - target_type
+ type: object
+ new_alert_group_data_attributes_attributes_inner:
+ properties:
+ json_path:
+ description: The JSON path to the value to group by.
+ type: string
+ type: object
+ new_alert_group_data_attributes_conditions_inner:
+ properties:
+ property_field_type:
+ description: The type of the property field
enum:
- - open
- - triggered
+ - attribute
+ - payload
+ - alert_field
type: string
- summary:
- description: The summary of the alert
+ property_field_name:
+ description: "The name of the property field. If the property field type\
+ \ is selected as 'attribute', then the allowed property field names are\
+ \ 'summary' (for Title), 'description', 'alert_urgency' and 'external_url'\
+ \ (for Alert Source URL). If the property field type is selected as 'payload',\
+ \ then the property field name should be supplied in JSON Path syntax."
type: string
- description:
- description: The description of the alert
- nullable: true
+ property_field_condition_type:
+ description: The condition type of the property field
+ enum:
+ - is_one_of
+ - is_not_one_of
+ - contains
+ - does_not_contain
+ - starts_with
+ - ends_with
+ - matches_regex
+ - is_empty
+ - matches_existing_alert
type: string
- service_ids:
- description: The Service ID's to attach to the alert. If your organization
- has On-Call enabled and your notification target is a Service. This field
- will be automatically set for you.
- items:
- type: string
- nullable: true
- type: array
- group_ids:
- description: The Group ID's to attach to the alert. If your organization
- has On-Call enabled and your notification target is a Group. This field
- will be automatically set for you.
+ property_field_value:
+ description: The value of the property field. Can be null if the property
+ field condition type is 'is_one_of' or 'is_not_one_of'
+ type: string
+ property_field_values:
+ description: The values of the property field. Need to be passed if the
+ property field condition type is 'is_one_of' or 'is_not_one_of' except
+ for when property field name is 'alert_urgency'
items:
type: string
- nullable: true
type: array
- environment_ids:
- description: The Environment ID's to attach to the alert
+ alert_urgency_ids:
+ description: "The Alert Urgency IDs to check in the condition. Only need\
+ \ to be set when the property field type is 'attribute', the property\
+ \ field name is 'alert_urgency' and the property field condition type\
+ \ is 'is_one_of' or 'is_not_one_of'"
items:
type: string
nullable: true
type: array
- started_at:
- description: Alert start datetime
- format: date-time
- nullable: true
- type: string
- ended_at:
- description: Alert end datetime
- format: date-time
- nullable: true
+ conditionable_type:
+ description: The type of the conditionable
+ enum:
+ - AlertField
type: string
- external_id:
- description: External ID
- nullable: true
+ conditionable_id:
+ description: "The ID of the conditionable. If conditionable_type is AlertField,\
+ \ this is the ID of the alert field."
type: string
- external_url:
- description: External Url
- nullable: true
+ required:
+ - property_field_condition_type
+ - property_field_type
+ type: object
+ new_alert_group_data_attributes:
+ additionalProperties: false
+ properties:
+ name:
+ description: The name of the alert group
type: string
- alert_urgency_id:
- description: The ID of the alert urgency
+ description:
+ description: The description of the alert urgency
nullable: true
type: string
- notification_target_type:
- description: "Only available for organizations with Rootly On-Call enabled.\
- \ Can be one of Group, Service, EscalationPolicy, User."
+ time_window:
+ description: The length of time an Alert Group should stay open and accept
+ new alerts
+ type: integer
+ targets:
+ items:
+ $ref: '#/components/schemas/new_alert_group_data_attributes_targets_inner'
+ type: array
+ attributes:
+ deprecated: true
+ description: "This field is deprecated. Please use the `conditions` field\
+ \ instead, `attributes` will be removed in the future."
+ items:
+ $ref: '#/components/schemas/new_alert_group_data_attributes_attributes_inner'
+ type: array
+ group_by_alert_title:
+ deprecated: true
+ description: "[DEPRECATED] Whether the alerts should be grouped by titles.\
+ \ This field is deprecated. Please use the `conditions` field with advanced\
+ \ alert grouping instead."
enum:
- - User
- - Group
- - EscalationPolicy
- - Service
- nullable: true
- type: string
- notification_target_id:
- description: Only available for organizations with Rootly On-Call enabled.
- The _identifier_ of the notification target object.
- nullable: true
+ - 1
+ - 0
+ type: integer
+ group_by_alert_urgency:
+ deprecated: true
+ description: "[DEPRECATED] Whether the alerts should be grouped by urgencies.\
+ \ This field is deprecated. Please use the `conditions` field with advanced\
+ \ alert grouping instead."
+ enum:
+ - 1
+ - 0
+ type: integer
+ condition_type:
+ description: Group alerts when ANY or ALL of the fields are matching.
+ enum:
+ - all
+ - any
type: string
- labels:
+ conditions:
items:
- $ref: '#/components/schemas/new_alert_data_attributes_labels_inner'
+ $ref: '#/components/schemas/new_alert_group_data_attributes_conditions_inner'
type: array
- data:
- description: Additional data
- nullable: true
- type: object
required:
- - source
- - summary
+ - name
type: object
- new_alert_data:
+ new_alert_group_data:
properties:
type:
enum:
- - alerts
+ - alert_groups
type: string
attributes:
- $ref: '#/components/schemas/new_alert_data_attributes'
+ $ref: '#/components/schemas/new_alert_group_data_attributes'
required:
- attributes
- type
type: object
- update_alert_data_attributes:
+ update_alert_group_data_attributes:
additionalProperties: false
properties:
- noise:
- description: Whether the alert is marked as noise
- enum:
- - noise
- - not_noise
- nullable: true
- type: string
- source:
- description: The source of the alert
- enum:
- - rootly
- - manual
- - api
- - web
- - slack
- - email
- - workflow
- - live_call_routing
- - pagerduty
- - opsgenie
- - victorops
- - pagertree
- - datadog
- - nobl9
- - zendesk
- - asana
- - clickup
- - sentry
- - rollbar
- - jira
- - honeycomb
- - service_now
- - linear
- - grafana
- - alertmanager
- - google_cloud
- - generic_webhook
- - cloud_watch
- - azure
- - splunk
- - chronosphere
- - app_optics
- - bug_snag
- - monte_carlo
- - nagios
- - prtg
- - catchpoint
- - app_dynamics
- - checkly
- - new_relic
- - gitlab
- type: string
- summary:
- description: The summary of the alert
+ name:
+ description: The name of the alert group
type: string
description:
- description: The description of the alert
+ description: The description of the alert group
nullable: true
type: string
- service_ids:
- description: The Service ID's to attach to the alert
+ time_window:
+ description: The length of time an Alert Group should stay open and accept
+ new alerts
+ type: integer
+ targets:
items:
- type: string
- nullable: true
+ $ref: '#/components/schemas/new_alert_group_data_attributes_targets_inner'
type: array
- group_ids:
- description: The Group ID's to attach to the alert
+ attributes:
+ deprecated: true
+ description: "This field is deprecated. Please use the `conditions` field\
+ \ instead, `attributes` will be removed in the future."
items:
- type: string
- nullable: true
+ $ref: '#/components/schemas/new_alert_group_data_attributes_attributes_inner'
type: array
- environment_ids:
- description: The Environment ID's to attach to the alert
+ group_by_alert_title:
+ deprecated: true
+ description: "[DEPRECATED] Whether the alerts should be grouped by titles.\
+ \ This field is deprecated. Please use the `conditions` field with advanced\
+ \ alert grouping instead."
+ enum:
+ - 1
+ - 0
+ type: integer
+ group_by_alert_urgency:
+ deprecated: true
+ description: "[DEPRECATED] Whether the alerts should be grouped by urgencies.\
+ \ This field is deprecated. Please use the `conditions` field with advanced\
+ \ alert grouping instead."
+ enum:
+ - 1
+ - 0
+ type: integer
+ condition_type:
+ description: Group alerts when ANY or ALL of the fields are matching.
+ enum:
+ - all
+ - any
+ type: string
+ conditions:
items:
- type: string
- nullable: true
+ $ref: '#/components/schemas/new_alert_group_data_attributes_conditions_inner'
type: array
- started_at:
- description: Alert start datetime
- format: date-time
- nullable: true
+ type: object
+ update_alert_group_data:
+ properties:
+ type:
+ enum:
+ - alert_groups
type: string
- ended_at:
- description: Alert end datetime
- format: date-time
- nullable: true
+ attributes:
+ $ref: '#/components/schemas/update_alert_group_data_attributes'
+ required:
+ - attributes
+ - type
+ type: object
+ alert_group_conditions_inner_values_inner:
+ nullable: true
+ properties:
+ record_id:
+ description: ID of the Alert Urgency to set.
type: string
- external_id:
- description: External ID
- nullable: true
+ record_type:
+ description: Should be "AlertUrgency".
type: string
- external_url:
- description: External Url
+ required:
+ - record_id
+ - record_type
+ type: object
+ alert_group_conditions_inner:
+ properties:
+ property_field_type:
+ description: The type of the property field
+ enum:
+ - attribute
+ - payload
+ - alert_field
+ type: string
+ property_field_name:
+ description: "The name of the property field. If the property field type\
+ \ is selected as 'attribute', then the allowed property field names are\
+ \ 'summary' (for Title), 'description', 'alert_urgency' and 'external_url'\
+ \ (for Alert Source URL). If the property field type is selected as 'payload',\
+ \ then the property field name should be supplied in JSON Path syntax."
nullable: true
type: string
- alert_urgency_id:
- description: The ID of the alert urgency
+ property_field_condition_type:
+ description: The condition type of the property field
+ enum:
+ - is_one_of
+ - is_not_one_of
+ - contains
+ - does_not_contain
+ - starts_with
+ - ends_with
+ - matches_regex
+ - is_empty
+ - matches_existing_alert
+ type: string
+ property_field_value:
+ description: The value of the property field. Can be null if the property
+ field condition type is 'is_one_of' or 'is_not_one_of'
nullable: true
type: string
- labels:
+ property_field_values:
+ description: The values of the property field. Used if the property field
+ condition type is 'is_one_of' or 'is_not_one_of' except for when property
+ field name is 'alert_urgency'
items:
- $ref: '#/components/schemas/new_alert_data_attributes_labels_inner'
+ type: string
type: array
- data:
- description: Additional data
+ values:
+ items:
+ $ref: '#/components/schemas/alert_group_conditions_inner_values_inner'
+ type: array
+ alert_urgency_ids:
+ description: "The Alert Urgency IDs to check in the condition. Only need\
+ \ to be set when the property field type is 'attribute', the property\
+ \ field name is 'alert_urgency' and the property field condition type\
+ \ is 'is_one_of' or 'is_not_one_of'"
+ items:
+ type: string
nullable: true
- type: object
- type: object
- update_alert_data:
- properties:
- type:
+ type: array
+ conditionable_type:
+ description: The type of the conditionable
enum:
- - alerts
+ - AlertField
+ nullable: true
+ type: string
+ conditionable_id:
+ description: "The ID of the conditionable. If conditionable_type is AlertField,\
+ \ this is the ID of the alert field."
+ nullable: true
type: string
- attributes:
- $ref: '#/components/schemas/update_alert_data_attributes'
required:
- - attributes
- - source
- - summary
+ - property_field_condition_type
+ - property_field_type
type: object
- alert_response_data:
+ alert_group_response_data:
properties:
id:
- description: Unique ID of the alert
- type: string
- source:
- description: The source of the alert
- enum:
- - rootly
- - manual
- - api
- - web
- - slack
- - email
- - workflow
- - live_call_routing
- - pagerduty
- - opsgenie
- - victorops
- - pagertree
- - datadog
- - nobl9
- - zendesk
- - asana
- - clickup
- - sentry
- - rollbar
- - jira
- - honeycomb
- - service_now
- - linear
- - grafana
- - alertmanager
- - google_cloud
- - generic_webhook
- - cloud_watch
- - azure
- - splunk
- - chronosphere
- - app_optics
- - bug_snag
- - monte_carlo
- - nagios
- - prtg
- - catchpoint
- - app_dynamics
- - checkly
- - new_relic
- - gitlab
+ description: Unique ID of the alert group
type: string
type:
enum:
- - alerts
+ - alert_groups
type: string
attributes:
allOf:
- - $ref: '#/components/schemas/alert'
+ - $ref: '#/components/schemas/alert_group'
type: object
required:
- attributes
- id
- type
type: object
- resolve_alert_data_attributes:
+ new_api_key_data_attributes:
additionalProperties: false
properties:
- resolution_message:
- description: How was the alert resolved?
+ name:
+ description: The name of the API key
+ type: string
+ description:
+ description: A description of the API key
nullable: true
type: string
- resolve_related_incidents:
- description: Resolve all associated incidents
+ kind:
+ description: The kind of the API key
+ enum:
+ - personal
+ - team
+ - organization
+ type: string
+ expires_at:
+ description: The expiration date of the API key (ISO 8601)
+ format: date-time
+ type: string
+ group_id:
+ description: The group (team) ID. Required when kind is 'team'.
nullable: true
- type: boolean
+ type: string
+ role_id:
+ description: The role ID for organization API keys
+ nullable: true
+ type: string
+ on_call_role_id:
+ description: The on-call role ID for organization API keys
+ nullable: true
+ type: string
+ required:
+ - expires_at
+ - kind
+ - name
type: object
- resolve_alert_data:
+ new_api_key_data:
properties:
type:
enum:
- - alerts
+ - api_keys
type: string
attributes:
- $ref: '#/components/schemas/resolve_alert_data_attributes'
+ $ref: '#/components/schemas/new_api_key_data_attributes'
+ required:
+ - attributes
+ - type
type: object
- new_alert_event_data_attributes:
+ update_api_key_data_attributes:
additionalProperties: false
properties:
- kind:
- enum:
- - note
+ name:
+ description: The name of the API key
type: string
- user_id:
- description: Author of the note.
- type: integer
- details:
- description: Note message.
+ description:
+ description: A description of the API key
+ nullable: true
+ type: string
+ expires_at:
+ description: The expiration date of the API key (ISO 8601)
+ format: date-time
+ nullable: true
type: string
- required:
- - details
- - kind
type: object
- new_alert_event_data:
+ update_api_key_data:
properties:
type:
enum:
- - alert_events
+ - api_keys
type: string
attributes:
- $ref: '#/components/schemas/new_alert_event_data_attributes'
+ $ref: '#/components/schemas/update_api_key_data_attributes'
required:
- attributes
- type
type: object
- update_alert_event_data_attributes:
+ rotate_api_key_data_attributes:
additionalProperties: false
properties:
- user_id:
- description: Author of the note.
- type: integer
- details:
- description: Note message.
+ expires_at:
+ description: The new expiration date after rotation (ISO 8601)
+ format: date-time
+ nullable: true
type: string
- required:
- - details
+ grace_period_minutes:
+ default: 30
+ description: How many minutes to keep the old token valid. Only applies
+ when the grace period feature is enabled for your organization. Defaults
+ to 30.
+ maximum: 1440
+ minimum: 0
+ type: integer
type: object
- update_alert_event_data:
+ rotate_api_key_data:
properties:
type:
enum:
- - alert_events
+ - api_keys
type: string
attributes:
- $ref: '#/components/schemas/update_alert_event_data_attributes'
+ $ref: '#/components/schemas/rotate_api_key_data_attributes'
required:
- attributes
- type
type: object
- alert_event_response_data:
+ api_key_response_data:
properties:
id:
- description: Unique ID of the alert event
+ description: Unique ID of the API key
type: string
type:
enum:
- - alert_events
+ - api_keys
type: string
attributes:
allOf:
- - $ref: '#/components/schemas/alert_event'
+ - $ref: '#/components/schemas/api_key'
type: object
required:
- attributes
- id
- type
type: object
- new_alerts_source_data_attributes_alert_template_attributes:
+ api_key_with_token_response_data_attributes:
+ allOf:
+ - $ref: '#/components/schemas/api_key'
+ - properties:
+ token:
+ description: The API key token (only shown once)
+ type: string
+ required:
+ - token
+ type: object
+ type: object
+ api_key_with_token_response_data:
properties:
- title:
- description: The alert title.
- nullable: true
- type: string
- description:
- description: The alert description.
- nullable: true
+ id:
+ description: Unique ID of the API key
type: string
- external_url:
- description: The alert URL.
- nullable: true
+ type:
+ enum:
+ - api_keys
type: string
+ attributes:
+ $ref: '#/components/schemas/api_key_with_token_response_data_attributes'
+ required:
+ - attributes
+ - id
+ - type
type: object
- new_alerts_source_data_attributes_alert_source_urgency_rules_attributes_inner:
+ audits_list_data_inner:
properties:
- json_path:
- description: JSON path expression to extract a specific value from the alert's
- payload for evaluation
+ id:
+ description: Unique ID of the audit log item
type: string
- operator:
- description: Comparison operator used to evaluate the extracted value against
- the specified condition
+ type:
enum:
- - is
- - is_not
- - contains
- - does_not_contain
- type: string
- value:
- description: Value that the extracted payload data is compared to using
- the specified operator to determine a match
+ - audits
type: string
+ attributes:
+ allOf:
+ - $ref: '#/components/schemas/audit'
+ type: object
+ required:
+ - attributes
+ - id
+ - type
type: object
- new_alerts_source_data_attributes_sourceable_attributes_field_mappings_attributes_inner:
+ new_authorization_data_attributes:
+ additionalProperties: false
properties:
- field:
- description: Select the field on which the condition to be evaluated
+ authorizable_id:
+ description: The id of the resource being accessed.
+ type: string
+ authorizable_type:
+ description: The type of resource being accessed.
enum:
- - external_id
- - state
- - alert_title
- - alert_external_url
- - notification_target_type
- - notification_target_id
+ - Dashboard
type: string
- json_path:
- description: JSON path expression to extract a specific value from the alert's
- payload for evaluation
+ grantee_id:
+ description: The resource id granted access.
type: string
- type: object
- new_alerts_source_data_attributes_sourceable_attributes:
- description: Provide additional attributes for generic_webhook alerts source
- properties:
- auto_resolve:
- description: Set this to true to auto-resolve alerts based on field_mappings_attributes
- conditions
- type: boolean
- resolve_state:
- description: This value is matched with the value extracted from alerts
- payload using JSON path in field_mappings_attributes
+ grantee_type:
+ description: The type of resource granted access.
+ enum:
+ - User
+ - Team
type: string
- accept_threaded_emails:
- description: Set this to false to reject threaded emails
- type: boolean
- field_mappings_attributes:
- description: Specify rules to auto resolve alerts
+ permissions:
items:
- $ref: '#/components/schemas/new_alerts_source_data_attributes_sourceable_attributes_field_mappings_attributes_inner'
+ enum:
+ - read
+ - update
+ - authorize
+ - destroy
+ type: string
type: array
+ required:
+ - authorizable_id
+ - authorizable_type
+ - grantee_id
+ - grantee_type
+ - permissions
type: object
- new_alerts_source_data_attributes_resolution_rule_attributes_conditions_attributes_inner:
+ new_authorization_data:
properties:
- field:
- description: JSON path expression to extract a specific value from the alert's
- payload for evaluation
- type: string
- operator:
- description: Comparison operator used to evaluate the extracted value against
- the specified condition
+ type:
enum:
- - is
- - is_not
- - contains
- - does_not_contain
- - starts_with
- - ends_with
- type: string
- value:
- description: Value that the extracted payload data is compared to using
- the specified operator to determine a match
+ - authorizations
type: string
+ attributes:
+ $ref: '#/components/schemas/new_authorization_data_attributes'
+ required:
+ - attributes
+ - type
type: object
- new_alerts_source_data_attributes_resolution_rule_attributes:
- description: Provide additional attributes for email alerts source
+ update_authorization_data_attributes:
+ additionalProperties: false
properties:
- enabled:
- description: Set this to true to enable the auto resolution rule
- type: boolean
- condition_type:
- description: The type of condition to evaluate to apply auto resolution
- rule
+ permissions:
+ items:
+ enum:
+ - read
+ - update
+ - authorize
+ - destroy
+ type: string
+ type: array
+ type: object
+ update_authorization_data:
+ properties:
+ type:
enum:
- - all
- - any
+ - authorizations
type: string
- identifier_json_path:
- description: JSON path expression to extract unique alert identifier used
- to match triggered alerts with resolving alerts
+ attributes:
+ $ref: '#/components/schemas/update_authorization_data_attributes'
+ required:
+ - attributes
+ - type
+ type: object
+ authorization_response_data:
+ properties:
+ id:
+ description: Unique ID of the authorization
type: string
- identifier_value_regex:
- description: Regex group to further specify the part of the string used
- as a unique identifier
+ type:
+ enum:
+ - authorizations
type: string
- conditions_attributes:
- description: List of conditions to evaluate for auto resolution
- items:
- $ref: '#/components/schemas/new_alerts_source_data_attributes_resolution_rule_attributes_conditions_attributes_inner'
- type: array
+ attributes:
+ allOf:
+ - $ref: '#/components/schemas/authorization'
+ type: object
+ required:
+ - attributes
+ - id
+ - type
type: object
- new_alerts_source_data_attributes:
+ new_catalog_data_attributes:
additionalProperties: false
properties:
name:
- description: The name of the alert source
type: string
- source_type:
- description: The alert source type
- enum:
- - email
- - app_dynamics
- - catchpoint
- - datadog
- - alertmanager
- - google_cloud
- - grafana
- - sentry
- - generic_webhook
- - cloud_watch
- - checkly
- - azure
- - new_relic
- - splunk
- - chronosphere
- - app_optics
- - bug_snag
- - honeycomb
- - monte_carlo
- - nagios
- - prtg
+ description:
+ nullable: true
type: string
- alert_urgency_id:
- description: ID for the default alert urgency assigned to this alert source
+ icon:
+ enum:
+ - globe-alt
+ - server-stack
+ - users
+ - user-group
+ - chart-bar
+ - shapes
+ - light-bulb
+ - cursor-arrow-ripple
type: string
- owner_group_ids:
- description: List of team IDs that will own the alert source
- items:
- type: string
- type: array
- alert_template_attributes:
- $ref: '#/components/schemas/new_alerts_source_data_attributes_alert_template_attributes'
- alert_source_urgency_rules_attributes:
- description: List of rules that define the conditions under which the alert
- urgency will be set automatically based on the alert payload
- items:
- $ref: '#/components/schemas/new_alerts_source_data_attributes_alert_source_urgency_rules_attributes_inner'
- type: array
- sourceable_attributes:
- $ref: '#/components/schemas/new_alerts_source_data_attributes_sourceable_attributes'
- resolution_rule_attributes:
- $ref: '#/components/schemas/new_alerts_source_data_attributes_resolution_rule_attributes'
+ position:
+ description: Default position of the catalog when displayed in a list.
+ nullable: true
+ type: integer
required:
- name
type: object
- new_alerts_source_data:
+ new_catalog_data:
properties:
type:
enum:
- - alert_sources
+ - catalogs
type: string
attributes:
- $ref: '#/components/schemas/new_alerts_source_data_attributes'
+ $ref: '#/components/schemas/new_catalog_data_attributes'
required:
- attributes
- type
type: object
- update_alerts_source_data_attributes:
+ update_catalog_data_attributes:
additionalProperties: false
properties:
name:
- description: The name of the alert source
type: string
- source_type:
- description: The alert source type
- enum:
- - email
- - app_dynamics
- - catchpoint
- - datadog
- - alertmanager
- - google_cloud
- - grafana
- - sentry
- - generic_webhook
- - cloud_watch
- - checkly
- - azure
- - new_relic
- - splunk
- - chronosphere
- - app_optics
- - bug_snag
- - honeycomb
- - monte_carlo
- - nagios
- - prtg
+ description:
+ nullable: true
type: string
- alert_urgency_id:
- description: ID for the default alert urgency assigned to this alert source
+ icon:
+ enum:
+ - globe-alt
+ - server-stack
+ - users
+ - user-group
+ - chart-bar
+ - shapes
+ - light-bulb
+ - cursor-arrow-ripple
type: string
- owner_group_ids:
- description: List of team IDs that will own the alert source
- items:
- type: string
- type: array
- alert_template_attributes:
- $ref: '#/components/schemas/new_alerts_source_data_attributes_alert_template_attributes'
- alert_source_urgency_rules_attributes:
- description: List of rules that define the conditions under which the alert
- urgency will be set automatically based on the alert payload
- items:
- $ref: '#/components/schemas/new_alerts_source_data_attributes_alert_source_urgency_rules_attributes_inner'
- type: array
- sourceable_attributes:
- $ref: '#/components/schemas/new_alerts_source_data_attributes_sourceable_attributes'
- resolution_rule_attributes:
- $ref: '#/components/schemas/new_alerts_source_data_attributes_resolution_rule_attributes'
+ position:
+ description: Default position of the catalog when displayed in a list.
+ nullable: true
+ type: integer
type: object
- update_alerts_source_data:
+ update_catalog_data:
properties:
type:
enum:
- - alert_sources
+ - catalogs
type: string
attributes:
- $ref: '#/components/schemas/update_alerts_source_data_attributes'
+ $ref: '#/components/schemas/update_catalog_data_attributes'
required:
- attributes
- type
type: object
- alerts_source_response_data:
+ catalog_response_data:
properties:
id:
- description: Unique ID of the alert source
+ description: Unique ID of the catalog
type: string
type:
enum:
- - alert_sources
+ - catalogs
type: string
attributes:
allOf:
- - $ref: '#/components/schemas/alerts_source'
+ - $ref: '#/components/schemas/catalog'
type: object
required:
- attributes
- id
- type
type: object
- new_alert_routing_rule_data_attributes_conditions_inner:
+ new_catalog_field_data_attributes:
+ additionalProperties: false
properties:
- property_field_type:
- description: The type of the property field
+ name:
+ type: string
+ kind:
enum:
- - attribute
- - payload
+ - text
+ - reference
+ - boolean
+ - reference
+ - service
+ - functionality
+ - environment
+ - group
+ - cause
+ - incident_type
+ - user
type: string
- property_field_name:
- description: "The name of the property field. If the property field type\
- \ is selected as 'attribute', then the allowed property field names are\
- \ 'summary' (for Title), 'description', 'alert_urgency' and 'external_url'\
- \ (for Alert Source URL). If the property field type is selected as 'payload',\
- \ then the property field name should be supplied in JSON Path syntax."
+ kind_catalog_id:
+ description: Restricts values to items of specified catalog.
+ nullable: true
type: string
- property_field_condition_type:
- description: The condition type of the property field
+ multiple:
+ description: Whether the attribute accepts multiple values.
+ type: boolean
+ position:
+ description: Default position of the item when displayed in a list.
+ nullable: true
+ type: integer
+ required:
+ description: Whether the field is required.
+ type: boolean
+ catalog_type:
+ description: The type of catalog the field belongs to.
enum:
- - is_one_of
- - is_not_one_of
- - contains
- - does_not_contain
- - starts_with
- - ends_with
- - matches_regex
- - is_empty
+ - catalog
+ - cause
+ - environment
+ - functionality
+ - incident_type
+ - service
+ - team
type: string
- property_field_value:
- description: The value of the property field. Can be null if the property
- field condition type is 'is_one_of' or 'is_not_one_of'
+ required:
+ - kind
+ - name
+ type: object
+ new_catalog_field_data:
+ properties:
+ type:
+ enum:
+ - catalog_properties
+ type: string
+ attributes:
+ $ref: '#/components/schemas/new_catalog_field_data_attributes'
+ required:
+ - attributes
+ - type
+ type: object
+ update_catalog_field_data_attributes:
+ additionalProperties: false
+ properties:
+ name:
+ type: string
+ kind:
+ enum:
+ - text
+ - reference
+ - boolean
+ - reference
+ - service
+ - functionality
+ - environment
+ - group
+ - cause
+ - incident_type
+ - user
+ type: string
+ kind_catalog_id:
+ description: Restricts values to items of specified catalog.
+ nullable: true
+ type: string
+ position:
+ description: Default position of the item when displayed in a list.
+ nullable: true
+ type: integer
+ required:
+ description: Whether the field is required.
+ type: boolean
+ catalog_type:
+ description: The type of catalog the field belongs to.
+ enum:
+ - catalog
+ - cause
+ - environment
+ - functionality
+ - incident_type
+ - service
+ - team
+ type: string
+ type: object
+ update_catalog_field_data:
+ properties:
+ type:
+ enum:
+ - catalog_properties
type: string
- property_field_values:
- description: The values of the property field. Need to be passed if the
- property field condition type is 'is_one_of' or 'is_not_one_of' except
- for when property field name is 'alert_urgency'
- items:
- type: string
- type: array
+ attributes:
+ $ref: '#/components/schemas/update_catalog_field_data_attributes'
required:
- - property_field_condition_type
- - property_field_name
- - property_field_type
+ - attributes
+ - type
type: object
- new_alert_routing_rule_data_attributes_destination:
+ catalog_field_response_data:
properties:
- target_type:
- description: The type of the target
- enum:
- - Group
- - Service
- - EscalationPolicy
+ id:
+ description: Unique ID of the catalog_field
type: string
- target_id:
- description: The ID of the target
- format: uuid
+ type:
+ enum:
+ - catalog_properties
type: string
+ attributes:
+ allOf:
+ - $ref: '#/components/schemas/catalog_field'
+ type: object
required:
- - target_id
- - target_type
+ - attributes
+ - id
+ - type
type: object
- new_alert_routing_rule_data_attributes:
+ new_catalog_property_data_attributes:
additionalProperties: false
properties:
name:
- description: The name of the alert routing rule
type: string
- enabled:
- description: Whether the alert routing rule is enabled
- type: boolean
- owning_team_ids:
- description: "The IDs of the teams which own the alert routing rule. If\
- \ the user doesn't have Alert Routing Create Permission in On-Call Roles,\
- \ then this field is required and can contain Team IDs the user is an\
- \ admin of."
- items:
- format: uuid
- type: string
- type: array
- alerts_source_id:
- description: The ID of the alerts source
- format: uuid
+ kind:
+ enum:
+ - text
+ - reference
+ - boolean
+ - reference
+ - service
+ - functionality
+ - environment
+ - group
+ - cause
+ - incident_type
+ - user
type: string
- condition_type:
- description: The type of condition for the alert routing rule
+ kind_catalog_id:
+ description: Restricts values to items of specified catalog.
+ nullable: true
+ type: string
+ multiple:
+ description: Whether the attribute accepts multiple values.
+ type: boolean
+ position:
+ description: Default position of the item when displayed in a list.
+ nullable: true
+ type: integer
+ required:
+ description: Whether the property is required.
+ type: boolean
+ catalog_type:
+ description: The type of catalog the property belongs to.
enum:
- - all
- - any
+ - catalog
+ - cause
+ - environment
+ - functionality
+ - incident_type
+ - service
+ - team
type: string
- conditions:
- items:
- $ref: '#/components/schemas/new_alert_routing_rule_data_attributes_conditions_inner'
- type: array
- destination:
- $ref: '#/components/schemas/new_alert_routing_rule_data_attributes_destination'
required:
- - alerts_source_id
- - destination
+ - kind
- name
type: object
- new_alert_routing_rule_data:
+ new_catalog_property_data:
properties:
type:
enum:
- - alert_routing_rules
+ - catalog_properties
type: string
attributes:
- $ref: '#/components/schemas/new_alert_routing_rule_data_attributes'
+ $ref: '#/components/schemas/new_catalog_property_data_attributes'
required:
- attributes
- type
type: object
- update_alert_routing_rule_data_attributes_conditions_inner:
+ update_catalog_property_data_attributes:
+ additionalProperties: false
properties:
- id:
- description: The ID of the alert routing rule condition
- format: uuid
+ name:
type: string
- property_field_type:
- description: The type of the property field
+ kind:
enum:
- - attribute
- - payload
+ - text
+ - reference
+ - boolean
+ - reference
+ - service
+ - functionality
+ - environment
+ - group
+ - cause
+ - incident_type
+ - user
type: string
- property_field_name:
- description: "The name of the property field. If the property field type\
- \ is selected as 'attribute', then the allowed property field names are\
- \ 'summary' (for Title), 'description', 'alert_urgency' and 'external_url'\
- \ (for Alert Source URL). If the property field type is selected as 'payload',\
- \ then the property field name should be supplied in JSON Path syntax."
+ kind_catalog_id:
+ description: Restricts values to items of specified catalog.
+ nullable: true
type: string
- property_field_condition_type:
- description: The condition type of the property field
+ position:
+ description: Default position of the item when displayed in a list.
+ nullable: true
+ type: integer
+ required:
+ description: Whether the property is required.
+ type: boolean
+ catalog_type:
+ description: The type of catalog the property belongs to.
enum:
- - is_one_of
- - is_not_one_of
- - contains
- - does_not_contain
- - starts_with
- - ends_with
- - matches_regex
- - is_empty
+ - catalog
+ - cause
+ - environment
+ - functionality
+ - incident_type
+ - service
+ - team
type: string
- property_field_value:
- description: The value of the property field. Can be null if the property
- field condition type is 'is_one_of' or 'is_not_one_of'
- nullable: true
+ type: object
+ update_catalog_property_data:
+ properties:
+ type:
+ enum:
+ - catalog_properties
type: string
- property_field_values:
- description: The values of the property field. Used if the property field
- condition type is 'is_one_of' or 'is_not_one_of' except for when property
- field name is 'alert_urgency'
- items:
- type: string
- type: array
+ attributes:
+ $ref: '#/components/schemas/update_catalog_property_data_attributes'
+ required:
+ - attributes
+ - type
type: object
- update_alert_routing_rule_data_attributes_destination:
+ catalog_property_response_data:
properties:
- target_type:
- description: The type of the target
+ id:
+ description: Unique ID of the catalog_property
+ type: string
+ type:
enum:
- - Group
- - Service
- - EscalationPolicy
+ - catalog_properties
type: string
- target_id:
- description: The ID of the target
- format: uuid
+ attributes:
+ allOf:
+ - $ref: '#/components/schemas/catalog_property'
+ type: object
+ required:
+ - attributes
+ - id
+ - type
+ type: object
+ new_catalog_entity_data_attributes_properties_inner:
+ properties:
+ catalog_property_id:
+ description: Unique ID of the catalog property
+ type: string
+ value:
+ description: The value for this property
type: string
+ required:
+ - catalog_property_id
+ - value
type: object
- update_alert_routing_rule_data_attributes:
+ new_catalog_entity_data_attributes:
additionalProperties: false
properties:
name:
- description: The name of the alert routing rule
type: string
- enabled:
- description: Whether the alert routing rule is enabled
- type: boolean
- alerts_source_id:
- description: The ID of the alerts source
- format: uuid
+ description:
+ nullable: true
type: string
- owning_team_ids:
- description: The IDs of the teams that own the alert routing rule
- items:
- format: uuid
- type: string
- type: array
- condition_type:
- description: The type of condition for the alert routing rule
- enum:
- - all
- - any
+ position:
+ description: Default position of the item when displayed in a list.
+ nullable: true
+ type: integer
+ backstage_id:
+ description: The Backstage entity ID this catalog entity is linked to.
+ nullable: true
type: string
- conditions:
+ properties:
+ description: Array of property values for this catalog entity
items:
- $ref: '#/components/schemas/update_alert_routing_rule_data_attributes_conditions_inner'
+ $ref: '#/components/schemas/new_catalog_entity_data_attributes_properties_inner'
type: array
- destination:
- $ref: '#/components/schemas/update_alert_routing_rule_data_attributes_destination'
+ required:
+ - name
type: object
- update_alert_routing_rule_data:
+ new_catalog_entity_data:
properties:
type:
enum:
- - alert_routing_rules
+ - catalog_entities
type: string
attributes:
- $ref: '#/components/schemas/update_alert_routing_rule_data_attributes'
+ $ref: '#/components/schemas/new_catalog_entity_data_attributes'
required:
- attributes
- type
type: object
- alert_routing_rule_conditions_inner:
+ update_catalog_entity_data_attributes:
+ additionalProperties: false
properties:
- property_field_type:
- description: The type of the property field
- enum:
- - attribute
- - payload
- type: string
- property_field_name:
- description: "The name of the property field. If the property field type\
- \ is selected as 'attribute', then the allowed property field names are\
- \ 'summary' (for Title), 'description', 'alert_urgency' and 'external_url'\
- \ (for Alert Source URL). If the property field type is selected as 'payload',\
- \ then the property field name should be supplied in JSON Path syntax."
+ name:
type: string
- property_field_condition_type:
- description: The condition type of the property field
- enum:
- - is_one_of
- - is_not_one_of
- - contains
- - does_not_contain
- - starts_with
- - ends_with
- - matches_regex
- - is_empty
+ description:
+ nullable: true
type: string
- property_field_value:
- description: The value of the property field. Can be null if the property
- field condition type is 'is_one_of' or 'is_not_one_of'
+ position:
+ description: Default position of the item when displayed in a list.
+ nullable: true
+ type: integer
+ backstage_id:
+ description: The Backstage entity ID this catalog entity is linked to.
nullable: true
type: string
- property_field_values:
- description: The values of the property field. Used if the property field
- condition type is 'is_one_of' or 'is_not_one_of' except for when property
- field name is 'alert_urgency'
+ properties:
+ description: Array of property values for this catalog entity
items:
- type: string
+ $ref: '#/components/schemas/new_catalog_entity_data_attributes_properties_inner'
type: array
- required:
- - property_field_condition_type
- - property_field_name
- - property_field_type
type: object
- alert_routing_rule_destination:
- description: The destinations for the alert routing rule
+ update_catalog_entity_data:
properties:
- target_type:
- description: The type of the target
+ type:
enum:
- - Group
- - Service
- - EscalationPolicy
- type: string
- target_id:
- description: The ID of the target
- format: uuid
+ - catalog_entities
type: string
+ attributes:
+ $ref: '#/components/schemas/update_catalog_entity_data_attributes'
required:
- - target_id
- - target_type
+ - attributes
+ - type
type: object
- alert_routing_rule_response_data:
+ catalog_entity_response_data:
properties:
id:
- description: Unique ID of the alert_routing_rule
+ description: Unique ID of the catalog_entity
type: string
type:
enum:
- - alert_routing_rules
+ - catalog_entities
type: string
attributes:
allOf:
- - $ref: '#/components/schemas/alert_routing_rule'
+ - $ref: '#/components/schemas/catalog_entity'
type: object
required:
- attributes
- id
- type
type: object
- new_alert_urgency_data_attributes:
+ new_catalog_entity_property_data_attributes:
additionalProperties: false
+ description: Maximum of 50 values allowed per catalog field.
properties:
- name:
- description: The name of the alert urgency
+ catalog_entity_id:
type: string
- description:
- description: The description of the alert urgency
+ catalog_field_id:
+ type: string
+ key:
+ enum:
+ - text
+ - catalog_entity
+ - slack
+ type: string
+ value:
type: string
- position:
- description: Position of the alert urgency
- nullable: true
- type: integer
required:
- - description
- - name
+ - catalog_field_id
+ - key
+ - value
type: object
- new_alert_urgency_data:
+ new_catalog_entity_property_data:
properties:
type:
enum:
- - alert_urgencies
+ - catalog_entity_properties
type: string
attributes:
- $ref: '#/components/schemas/new_alert_urgency_data_attributes'
+ $ref: '#/components/schemas/new_catalog_entity_property_data_attributes'
required:
- attributes
- type
type: object
- update_alert_urgency_data_attributes:
+ update_catalog_entity_property_data_attributes:
additionalProperties: false
properties:
- name:
- description: The name of the alert urgency
+ key:
+ enum:
+ - text
+ - catalog_entity
+ - slack
type: string
- description:
- description: The description of the alert urgency
+ value:
type: string
- position:
- description: Position of the alert urgency
- nullable: true
- type: integer
type: object
- update_alert_urgency_data:
+ update_catalog_entity_property_data:
properties:
type:
enum:
- - alert_urgencies
+ - catalog_entity_properties
type: string
attributes:
- $ref: '#/components/schemas/update_alert_urgency_data_attributes'
+ $ref: '#/components/schemas/update_catalog_entity_property_data_attributes'
required:
- attributes
- type
type: object
- alert_urgency_response_data:
+ catalog_entity_property_response_data:
properties:
id:
- description: Unique ID of the alert urgency
+ description: Unique ID of the catalog_entity_property
type: string
type:
enum:
- - alert_urgencies
+ - catalog_entity_properties
type: string
attributes:
allOf:
- - $ref: '#/components/schemas/alert_urgency'
+ - $ref: '#/components/schemas/catalog_entity_property'
type: object
required:
- attributes
- id
- type
type: object
- new_alert_group_data_attributes_targets_inner:
+ Builtin_field:
properties:
- target_type:
- description: The type of the target.
+ field_source:
enum:
- - Group
- - Service
- - EscalationPolicy
+ - builtin
type: string
- target_id:
- description: "id for the Group, Service or EscalationPolicy"
- format: uuid
+ field_key:
+ description: Key identifying the builtin field
type: string
required:
- - target_id
- - target_type
+ - field_key
+ - field_source
+ title: Builtin field
+ Custom_field:
+ properties:
+ field_source:
+ enum:
+ - custom
+ type: string
+ catalog_property_id:
+ description: ID of the catalog property
+ type: string
+ field_key:
+ description: Ignored for custom fields (auto-derived from catalog property)
+ type: string
+ required:
+ - catalog_property_id
+ - field_source
+ title: Custom field
+ new_catalog_checklist_template_data_attributes_fields_inner:
+ oneOf:
+ - $ref: '#/components/schemas/Builtin_field'
+ - $ref: '#/components/schemas/Custom_field'
type: object
- new_alert_group_data_attributes_attributes_inner:
+ new_catalog_checklist_template_data_attributes_owners_inner:
properties:
- json_path:
- description: The JSON path to the value to group by.
+ id:
+ description: "User ID for user owners, or field key for field owners"
+ type: string
+ type:
+ description: Type of owner
+ enum:
+ - field
+ - user
type: string
+ required:
+ - id
+ - type
type: object
- new_alert_group_data_attributes:
+ new_catalog_checklist_template_data_attributes:
additionalProperties: false
properties:
name:
- description: The name of the alert group
+ description: The name of the checklist template
type: string
description:
- description: The description of the alert urgency
+ description: The description of the checklist template
nullable: true
type: string
- time_window:
- description: The length of time an Alert Group should stay open and accept
- new alerts
- type: integer
- targets:
+ catalog_type:
+ description: The catalog type
+ enum:
+ - Service
+ - Functionality
+ - Environment
+ - Group
+ - Cause
+ - IncidentType
+ - Catalog
+ type: string
+ scope_type:
+ description: The scope type
+ enum:
+ - Team
+ - Catalog
+ type: string
+ scope_id:
+ description: The scope ID (team or catalog UUID)
+ type: string
+ fields:
+ description: Template fields. Position is determined by array order.
items:
- $ref: '#/components/schemas/new_alert_group_data_attributes_targets_inner'
+ $ref: '#/components/schemas/new_catalog_checklist_template_data_attributes_fields_inner'
+ nullable: true
type: array
- attributes:
+ owners:
+ description: Template owners
items:
- $ref: '#/components/schemas/new_alert_group_data_attributes_attributes_inner'
+ $ref: '#/components/schemas/new_catalog_checklist_template_data_attributes_owners_inner'
+ nullable: true
type: array
- group_by_alert_title:
- description: Whether the alerts should be grouped by titles.
- enum:
- - 1
- - 0
- type: integer
- group_by_alert_urgency:
- description: Whether the alerts should be grouped by urgencies.
- enum:
- - 1
- - 0
- type: integer
- condition_type:
- description: Group alerts when ANY or ALL of the fields are matching.
- enum:
- - all
- - any
- type: string
required:
+ - catalog_type
- name
+ - scope_type
type: object
- new_alert_group_data:
+ new_catalog_checklist_template_data:
properties:
type:
enum:
- - alert_groups
+ - catalog_checklist_templates
type: string
attributes:
- $ref: '#/components/schemas/new_alert_group_data_attributes'
+ $ref: '#/components/schemas/new_catalog_checklist_template_data_attributes'
required:
- attributes
- type
type: object
- update_alert_group_data_attributes:
+ update_catalog_checklist_template_data_attributes:
additionalProperties: false
properties:
name:
- description: The name of the alert group
+ description: The name of the checklist template
type: string
description:
- description: The description of the alert group
+ description: The description of the checklist template
nullable: true
type: string
- time_window:
- description: The length of time an Alert Group should stay open and accept
- new alerts
- type: integer
- targets:
+ fields:
+ description: Template fields. Position is determined by array order. Replaces
+ all existing fields.
items:
- $ref: '#/components/schemas/new_alert_group_data_attributes_targets_inner'
+ $ref: '#/components/schemas/new_catalog_checklist_template_data_attributes_fields_inner'
+ nullable: true
type: array
- attributes:
+ owners:
+ description: Template owners. Replaces all existing owners.
items:
- $ref: '#/components/schemas/new_alert_group_data_attributes_attributes_inner'
+ $ref: '#/components/schemas/new_catalog_checklist_template_data_attributes_owners_inner'
+ nullable: true
type: array
- group_by_alert_title:
- description: Whether the alerts should be grouped by titles.
+ type: object
+ update_catalog_checklist_template_data:
+ properties:
+ type:
enum:
- - 1
- - 0
- type: integer
- group_by_alert_urgency:
- description: Whether the alerts should be grouped by urgencies.
+ - catalog_checklist_templates
+ type: string
+ attributes:
+ $ref: '#/components/schemas/update_catalog_checklist_template_data_attributes'
+ required:
+ - attributes
+ - type
+ type: object
+ catalog_checklist_template_fields_inner:
+ properties:
+ field_source:
+ description: Source of the field
enum:
- - 1
- - 0
- type: integer
- condition_type:
- description: Group alerts when ANY or ALL of the fields are matching.
+ - builtin
+ - custom
+ type: string
+ field_key:
+ description: Key identifying the field
+ type: string
+ catalog_property_id:
+ description: ID of the catalog property for custom fields
+ nullable: true
+ type: string
+ type: object
+ catalog_checklist_template_owners_inner:
+ properties:
+ id:
+ description: "User ID for user owners, or field key for field owners"
+ type: string
+ type:
+ description: Type of owner
enum:
- - all
- - any
+ - field
+ - user
+ type: string
+ type: object
+ catalog_checklist_template_response_data:
+ properties:
+ id:
+ description: Unique ID of the checklist template
+ type: string
+ type:
+ enum:
+ - catalog_checklist_templates
+ type: string
+ attributes:
+ allOf:
+ - $ref: '#/components/schemas/catalog_checklist_template'
+ type: object
+ required:
+ - attributes
+ - id
+ - type
+ type: object
+ catalog_entity_checklist_checklist_fields_inner_data_attributes:
+ properties:
+ catalog_entity_checklist_id:
+ description: The ID of the parent checklist
+ type: string
+ catalog_checklist_template_field_id:
+ description: The ID of the template field
+ nullable: true
+ type: string
+ field_key:
+ description: The field key
+ type: string
+ checked:
+ description: Whether the field is checked
+ type: boolean
+ value_snapshot:
+ description: The value snapshot at time of checking
+ nullable: true
+ type: object
+ completed_by_user_id:
+ description: The ID of the user who checked the field
+ nullable: true
+ type: string
+ completed_at:
+ description: When the field was checked
+ nullable: true
+ type: string
+ created_at:
+ description: Date of creation
+ type: string
+ updated_at:
+ description: Date of last update
type: string
type: object
- update_alert_group_data:
+ catalog_entity_checklist_checklist_fields_inner_data:
properties:
+ id:
+ description: ID of the checklist field
+ type: string
type:
enum:
- - alert_groups
+ - catalog_entity_checklist_fields
type: string
attributes:
- $ref: '#/components/schemas/update_alert_group_data_attributes'
- required:
- - attributes
- - type
+ $ref: '#/components/schemas/catalog_entity_checklist_checklist_fields_inner_data_attributes'
type: object
- alert_group_response_data:
+ catalog_entity_checklist_checklist_fields_inner:
+ properties:
+ data:
+ $ref: '#/components/schemas/catalog_entity_checklist_checklist_fields_inner_data'
+ type: object
+ catalog_entity_checklist_checklist_owners_inner_data_attributes:
+ properties:
+ catalog_entity_checklist_id:
+ description: The ID of the parent checklist
+ type: string
+ owner_user_id:
+ description: The ID of the owner user
+ type: string
+ created_at:
+ description: Date of creation
+ type: string
+ updated_at:
+ description: Date of last update
+ type: string
+ type: object
+ catalog_entity_checklist_checklist_owners_inner_data:
properties:
id:
- description: Unique ID of the alert group
+ description: ID of the checklist owner
type: string
type:
enum:
- - alert_groups
+ - catalog_entity_checklist_owners
type: string
attributes:
- allOf:
- - $ref: '#/components/schemas/alert_group'
- type: object
- required:
- - attributes
- - id
- - type
+ $ref: '#/components/schemas/catalog_entity_checklist_checklist_owners_inner_data_attributes'
type: object
- audits_list_data_inner:
+ catalog_entity_checklist_checklist_owners_inner:
+ properties:
+ data:
+ $ref: '#/components/schemas/catalog_entity_checklist_checklist_owners_inner_data'
+ type: object
+ catalog_entity_checklist_response_data:
properties:
id:
- description: Unique ID of the audit log item
+ description: Unique ID of the entity checklist
type: string
type:
enum:
- - audits
+ - catalog_entity_checklists
type: string
attributes:
allOf:
- - $ref: '#/components/schemas/audit'
+ - $ref: '#/components/schemas/catalog_entity_checklist'
type: object
required:
- attributes
- id
- type
type: object
- new_authorization_data_attributes:
- additionalProperties: false
+ new_cause_data_attributes_properties_inner:
+ description: Set a value for a catalog property
properties:
- authorizable_id:
- description: The id of the resource being accessed.
+ catalog_property_id:
+ description: Catalog property ID
type: string
- authorizable_type:
- description: The type of resource being accessed.
- enum:
- - Dashboard
+ value:
+ description: The property value
type: string
- grantee_id:
- description: The resource id granted access.
+ required:
+ - catalog_property_id
+ - value
+ type: object
+ new_cause_data_attributes:
+ additionalProperties: false
+ properties:
+ name:
+ description: The name of the cause
type: string
- grantee_type:
- description: The type of resource granted access.
- enum:
- - User
- - Team
+ description:
+ description: The description of the cause
+ nullable: true
type: string
- permissions:
+ position:
+ description: Position of the cause
+ nullable: true
+ type: integer
+ properties:
+ description: Array of property values for this cause.
items:
- enum:
- - read
- - update
- - authorize
- - destroy
- type: string
+ $ref: '#/components/schemas/new_cause_data_attributes_properties_inner'
type: array
required:
- - authorizable_id
- - authorizable_type
- - grantee_id
- - grantee_type
- - permissions
+ - name
type: object
- new_authorization_data:
+ new_cause_data:
properties:
type:
enum:
- - authorizations
+ - causes
type: string
attributes:
- $ref: '#/components/schemas/new_authorization_data_attributes'
+ $ref: '#/components/schemas/new_cause_data_attributes'
required:
- attributes
- type
type: object
- update_authorization_data_attributes:
+ update_cause_data_attributes:
additionalProperties: false
properties:
- permissions:
+ name:
+ description: The name of the cause
+ type: string
+ description:
+ description: The description of the cause
+ nullable: true
+ type: string
+ position:
+ description: Position of the cause
+ nullable: true
+ type: integer
+ properties:
+ description: Array of property values for this cause.
items:
- enum:
- - read
- - update
- - authorize
- - destroy
- type: string
+ $ref: '#/components/schemas/new_cause_data_attributes_properties_inner'
type: array
type: object
- update_authorization_data:
+ update_cause_data:
properties:
type:
enum:
- - authorizations
+ - causes
type: string
attributes:
- $ref: '#/components/schemas/update_authorization_data_attributes'
+ $ref: '#/components/schemas/update_cause_data_attributes'
required:
- attributes
- type
type: object
- authorization_response_data:
+ cause_response_data:
properties:
id:
- description: Unique ID of the authorization
+ description: Unique ID of the cause
type: string
type:
enum:
- - authorizations
+ - causes
type: string
attributes:
allOf:
- - $ref: '#/components/schemas/authorization'
+ - $ref: '#/components/schemas/cause'
type: object
required:
- attributes
- id
- type
type: object
- new_catalog_data_attributes:
+ new_communications_stage_data_attributes:
additionalProperties: false
properties:
name:
+ description: The name of the communications stage
type: string
description:
+ description: The description of the communications stage
nullable: true
type: string
- icon:
- enum:
- - globe-alt
- - server-stack
- - users
- - user-group
- - chart-bar
- - shapes
- - light-bulb
- - cursor-arrow-ripple
- type: string
position:
- description: Default position of the catalog when displayed in a list.
+ description: Position of the communications stage
nullable: true
type: integer
required:
- name
type: object
- new_catalog_data:
+ new_communications_stage_data:
properties:
type:
enum:
- - catalogs
+ - communications_stages
type: string
attributes:
- $ref: '#/components/schemas/new_catalog_data_attributes'
+ $ref: '#/components/schemas/new_communications_stage_data_attributes'
required:
- attributes
- type
type: object
- update_catalog_data_attributes:
+ update_communications_stage_data_attributes:
additionalProperties: false
properties:
name:
+ description: The name of the communications stage
type: string
description:
+ description: The description of the communications stage
nullable: true
type: string
- icon:
- enum:
- - globe-alt
- - server-stack
- - users
- - user-group
- - chart-bar
- - shapes
- - light-bulb
- - cursor-arrow-ripple
- type: string
position:
- description: Default position of the catalog when displayed in a list.
+ description: Position of the communications stage
nullable: true
type: integer
type: object
- update_catalog_data:
+ update_communications_stage_data:
properties:
type:
enum:
- - catalogs
+ - communications_stages
type: string
attributes:
- $ref: '#/components/schemas/update_catalog_data_attributes'
+ $ref: '#/components/schemas/update_communications_stage_data_attributes'
required:
- attributes
- type
type: object
- catalog_response_data:
+ communications_stage_response_data:
properties:
id:
- description: Unique ID of the catalog
+ description: Unique ID of the communications stage
type: string
type:
enum:
- - catalogs
+ - communications_stages
type: string
attributes:
allOf:
- - $ref: '#/components/schemas/catalog'
+ - $ref: '#/components/schemas/communications_stage'
type: object
required:
- attributes
- id
- type
type: object
- new_catalog_field_data_attributes:
+ new_communications_type_data_attributes:
additionalProperties: false
properties:
name:
+ description: The name of the communications type
type: string
- kind:
- enum:
- - text
- - reference
+ description:
+ description: The description of the communications type
+ nullable: true
type: string
- kind_catalog_id:
- description: Restricts values to items of specified catalog.
+ color:
+ description: The color of the communications type
nullable: true
type: string
- multiple:
- description: Whether the attribute accepts multiple values.
- type: boolean
position:
- description: Default position of the item when displayed in a list.
+ description: Position of the communications type
nullable: true
type: integer
required:
- - kind
+ - color
- name
type: object
- new_catalog_field_data:
+ new_communications_type_data:
properties:
type:
enum:
- - catalog_fields
+ - communications_types
type: string
attributes:
- $ref: '#/components/schemas/new_catalog_field_data_attributes'
+ $ref: '#/components/schemas/new_communications_type_data_attributes'
required:
- attributes
- type
type: object
- update_catalog_field_data_attributes:
+ update_communications_type_data_attributes:
additionalProperties: false
properties:
name:
+ description: The name of the communications type
type: string
- slug:
- type: string
- kind:
- enum:
- - text
- - reference
+ description:
+ description: The description of the communications type
+ nullable: true
type: string
- kind_catalog_id:
- description: Restricts values to items of specified catalog.
+ color:
+ description: The color of the communications type
nullable: true
type: string
position:
- description: Default position of the item when displayed in a list.
+ description: Position of the communications type
nullable: true
type: integer
type: object
- update_catalog_field_data:
+ update_communications_type_data:
properties:
type:
enum:
- - catalog_fields
+ - communications_types
type: string
attributes:
- $ref: '#/components/schemas/update_catalog_field_data_attributes'
+ $ref: '#/components/schemas/update_communications_type_data_attributes'
required:
- attributes
- type
type: object
- catalog_field_response_data:
+ communications_type_response_data:
properties:
id:
- description: Unique ID of the catalog_field
+ description: Unique ID of the communications type
type: string
type:
enum:
- - catalog_fields
+ - communications_types
type: string
attributes:
allOf:
- - $ref: '#/components/schemas/catalog_field'
+ - $ref: '#/components/schemas/communications_type'
type: object
required:
- attributes
- id
- type
type: object
- new_catalog_entity_data_attributes:
+ new_communications_template_data_attributes_communication_template_stages_attributes_inner:
+ properties:
+ communication_stage_id:
+ description: The communication stage ID
+ type: string
+ sms_content:
+ description: SMS content for the stage
+ nullable: true
+ type: string
+ email_subject:
+ description: Email subject for the stage
+ nullable: true
+ type: string
+ email_body:
+ description: Email body for the stage
+ nullable: true
+ type: string
+ slack_content:
+ description: Slack content for the stage
+ nullable: true
+ type: string
+ type: object
+ new_communications_template_data_attributes:
additionalProperties: false
properties:
name:
+ description: The name of the communications template
type: string
description:
+ description: The description of the communications template
nullable: true
type: string
+ communication_type_id:
+ description: The communication type ID
+ type: string
position:
- description: Default position of the item when displayed in a list.
+ description: Position of the communications template
nullable: true
type: integer
+ communication_template_stages_attributes:
+ description: Template stages attributes
+ items:
+ $ref: '#/components/schemas/new_communications_template_data_attributes_communication_template_stages_attributes_inner'
+ nullable: true
+ type: array
required:
+ - communication_type_id
- name
type: object
- new_catalog_entity_data:
+ new_communications_template_data:
properties:
type:
enum:
- - catalog_entities
+ - communications_templates
type: string
attributes:
- $ref: '#/components/schemas/new_catalog_entity_data_attributes'
+ $ref: '#/components/schemas/new_communications_template_data_attributes'
required:
- attributes
- type
type: object
- update_catalog_entity_data_attributes:
+ update_communications_template_data_attributes_communication_template_stages_attributes_inner:
+ properties:
+ id:
+ description: ID of the communication template stage
+ nullable: true
+ type: string
+ sms_content:
+ description: SMS content for the stage
+ nullable: true
+ type: string
+ email_subject:
+ description: Email subject for the stage
+ nullable: true
+ type: string
+ email_body:
+ description: Email body for the stage
+ nullable: true
+ type: string
+ slack_content:
+ description: Slack content for the stage
+ nullable: true
+ type: string
+ type: object
+ update_communications_template_data_attributes:
additionalProperties: false
properties:
name:
+ description: The name of the communications template
type: string
description:
+ description: The description of the communications template
nullable: true
type: string
+ communication_type_id:
+ description: The communication type ID
+ type: string
position:
- description: Default position of the item when displayed in a list.
+ description: Position of the communications template
nullable: true
type: integer
+ communication_template_stages_attributes:
+ description: Template stages attributes
+ items:
+ $ref: '#/components/schemas/update_communications_template_data_attributes_communication_template_stages_attributes_inner'
+ nullable: true
+ type: array
type: object
- update_catalog_entity_data:
+ update_communications_template_data:
properties:
type:
enum:
- - catalog_entities
+ - communications_templates
type: string
attributes:
- $ref: '#/components/schemas/update_catalog_entity_data_attributes'
+ $ref: '#/components/schemas/update_communications_template_data_attributes'
required:
- attributes
- type
type: object
- catalog_entity_response_data:
+ communications_template_communication_template_stages_inner_data_attributes_communication_stage:
properties:
id:
- description: Unique ID of the catalog_entity
+ description: The communication stage ID
type: string
- type:
- enum:
- - catalog_entities
+ name:
+ description: The communication stage name
type: string
- attributes:
- allOf:
- - $ref: '#/components/schemas/catalog_entity'
- type: object
- required:
- - attributes
- - id
- - type
type: object
- new_catalog_entity_property_data_attributes:
- additionalProperties: false
+ communications_template_communication_template_stages_inner_data_attributes_communication_template:
properties:
- catalog_entity_id:
+ id:
+ description: The communication template ID
type: string
- catalog_field_id:
+ name:
+ description: The communication template name
type: string
- key:
- enum:
- - text
- - catalog_entity
+ type: object
+ communications_template_communication_template_stages_inner_data_attributes:
+ properties:
+ email_body:
+ description: Email body for the stage
+ nullable: true
type: string
- value:
+ email_subject:
+ description: Email subject for the stage
+ nullable: true
type: string
- required:
- - catalog_field_id
- - key
- - value
+ slack_content:
+ description: Slack content for the stage
+ nullable: true
+ type: string
+ sms_content:
+ description: SMS content for the stage
+ nullable: true
+ type: string
+ created_at:
+ description: Date of creation
+ type: string
+ updated_at:
+ description: Date of last update
+ type: string
+ communication_stage:
+ $ref: '#/components/schemas/communications_template_communication_template_stages_inner_data_attributes_communication_stage'
+ communication_template:
+ $ref: '#/components/schemas/communications_template_communication_template_stages_inner_data_attributes_communication_template'
type: object
- new_catalog_entity_property_data:
+ communications_template_communication_template_stages_inner_data:
properties:
+ id:
+ description: ID of the communication template stage
+ type: string
type:
enum:
- - catalog_entity_properties
+ - communications_template_stages
type: string
attributes:
- $ref: '#/components/schemas/new_catalog_entity_property_data_attributes'
- required:
- - attributes
- - type
+ $ref: '#/components/schemas/communications_template_communication_template_stages_inner_data_attributes'
type: object
- update_catalog_entity_property_data_attributes:
- additionalProperties: false
+ communications_template_communication_template_stages_inner:
properties:
- key:
- enum:
- - text
- - catalog_entity
- type: string
- value:
- type: string
+ data:
+ $ref: '#/components/schemas/communications_template_communication_template_stages_inner_data'
type: object
- update_catalog_entity_property_data:
+ communications_template_communication_type:
properties:
- type:
- enum:
- - catalog_entity_properties
+ id:
+ description: ID of the communication type
+ type: string
+ name:
+ description: Name of the communication type
type: string
- attributes:
- $ref: '#/components/schemas/update_catalog_entity_property_data_attributes'
- required:
- - attributes
- - type
type: object
- catalog_entity_property_response_data:
+ communications_template_response_data:
properties:
id:
- description: Unique ID of the catalog_entity_property
+ description: Unique ID of the communications template
type: string
type:
enum:
- - catalog_entity_properties
+ - communications_templates
type: string
attributes:
allOf:
- - $ref: '#/components/schemas/catalog_entity_property'
+ - $ref: '#/components/schemas/communications_template'
type: object
required:
- attributes
- id
- type
type: object
- new_cause_data_attributes:
+ new_communications_group_data_attributes_communication_group_conditions_inner:
+ properties:
+ property_type:
+ description: Property type
+ enum:
+ - service
+ - severity
+ - functionality
+ - group
+ - incident_type
+ type: string
+ service_ids:
+ description: Array of service IDs
+ items:
+ type: string
+ nullable: true
+ type: array
+ severity_ids:
+ description: Array of severity IDs
+ items:
+ type: string
+ nullable: true
+ type: array
+ functionality_ids:
+ description: Array of functionality IDs
+ items:
+ type: string
+ nullable: true
+ type: array
+ group_ids:
+ description: Array of group IDs
+ items:
+ type: string
+ nullable: true
+ type: array
+ incident_type_ids:
+ description: Array of incident type IDs
+ items:
+ type: string
+ nullable: true
+ type: array
+ type: object
+ new_communications_group_data_attributes_communication_external_group_members_inner:
+ properties:
+ name:
+ description: Name of the external member
+ type: string
+ email:
+ description: Email of the external member
+ type: string
+ phone_number:
+ description: Phone number of the external member
+ type: string
+ type: object
+ new_communications_group_data_attributes:
additionalProperties: false
properties:
name:
- description: The name of the cause
+ description: The name of the communications group
type: string
description:
- description: The description of the cause
+ description: The description of the communications group
nullable: true
type: string
- position:
- description: Position of the cause
+ communication_type_id:
+ description: The communication type ID
+ type: string
+ is_private:
+ description: Whether the group is private
nullable: true
- type: integer
+ type: boolean
+ condition_type:
+ description: Condition type
+ enum:
+ - any
+ - all
+ nullable: true
+ type: string
+ sms_channel:
+ description: SMS channel enabled
+ nullable: true
+ type: boolean
+ email_channel:
+ description: Email channel enabled
+ nullable: true
+ type: boolean
+ member_ids:
+ description: Array of member user IDs
+ items:
+ type: integer
+ nullable: true
+ type: array
+ slack_channel_ids:
+ description: Array of Slack channel IDs
+ items:
+ type: string
+ nullable: true
+ type: array
+ communication_group_conditions:
+ description: Group conditions attributes
+ items:
+ $ref: '#/components/schemas/new_communications_group_data_attributes_communication_group_conditions_inner'
+ nullable: true
+ type: array
+ communication_external_group_members:
+ description: External group members attributes
+ items:
+ $ref: '#/components/schemas/new_communications_group_data_attributes_communication_external_group_members_inner'
+ nullable: true
+ type: array
required:
+ - communication_type_id
- name
type: object
- new_cause_data:
+ new_communications_group_data:
properties:
type:
enum:
- - causes
+ - communications_groups
type: string
attributes:
- $ref: '#/components/schemas/new_cause_data_attributes'
+ $ref: '#/components/schemas/new_communications_group_data_attributes'
required:
- attributes
- type
type: object
- update_cause_data_attributes:
+ update_communications_group_data_attributes_communication_group_conditions_inner:
+ properties:
+ id:
+ description: ID of the condition
+ nullable: true
+ type: string
+ property_type:
+ description: Property type
+ enum:
+ - service
+ - severity
+ - functionality
+ - group
+ - incident_type
+ type: string
+ service_ids:
+ description: Array of service IDs
+ items:
+ type: string
+ nullable: true
+ type: array
+ severity_ids:
+ description: Array of severity IDs
+ items:
+ type: string
+ nullable: true
+ type: array
+ functionality_ids:
+ description: Array of functionality IDs
+ items:
+ type: string
+ nullable: true
+ type: array
+ group_ids:
+ description: Array of group IDs
+ items:
+ type: string
+ nullable: true
+ type: array
+ incident_type_ids:
+ description: Array of incident type IDs
+ items:
+ type: string
+ nullable: true
+ type: array
+ type: object
+ update_communications_group_data_attributes_communication_external_group_members_inner:
+ properties:
+ id:
+ description: ID of the external group member
+ nullable: true
+ type: string
+ name:
+ description: Name of the external member
+ type: string
+ email:
+ description: Email of the external member
+ type: string
+ phone_number:
+ description: Phone number of the external member
+ type: string
+ type: object
+ update_communications_group_data_attributes:
additionalProperties: false
properties:
name:
- description: The name of the cause
+ description: The name of the communications group
type: string
description:
- description: The description of the cause
+ description: The description of the communications group
nullable: true
type: string
- position:
- description: Position of the cause
+ communication_type_id:
+ description: The communication type ID
+ type: string
+ is_private:
+ description: Whether the group is private
nullable: true
- type: integer
+ type: boolean
+ condition_type:
+ description: Condition type
+ enum:
+ - any
+ - all
+ nullable: true
+ type: string
+ sms_channel:
+ description: SMS channel enabled
+ nullable: true
+ type: boolean
+ email_channel:
+ description: Email channel enabled
+ nullable: true
+ type: boolean
+ member_ids:
+ description: Array of member user IDs
+ items:
+ type: integer
+ nullable: true
+ type: array
+ slack_channel_ids:
+ description: Array of Slack channel IDs
+ items:
+ type: string
+ nullable: true
+ type: array
+ communication_group_conditions:
+ description: Group conditions attributes
+ items:
+ $ref: '#/components/schemas/update_communications_group_data_attributes_communication_group_conditions_inner'
+ nullable: true
+ type: array
+ communication_external_group_members:
+ description: External group members attributes
+ items:
+ $ref: '#/components/schemas/update_communications_group_data_attributes_communication_external_group_members_inner'
+ nullable: true
+ type: array
type: object
- update_cause_data:
+ update_communications_group_data:
properties:
type:
enum:
- - causes
+ - communications_groups
type: string
attributes:
- $ref: '#/components/schemas/update_cause_data_attributes'
+ $ref: '#/components/schemas/update_communications_group_data_attributes'
required:
- attributes
- type
type: object
- cause_response_data:
+ communications_group_communication_external_group_members_inner:
properties:
id:
- description: Unique ID of the cause
+ description: ID of the external group member
+ type: string
+ name:
+ description: Name of the external member
+ type: string
+ email:
+ description: Email of the external member
+ type: string
+ phone_number:
+ description: Phone number of the external member
+ type: string
+ type: object
+ communications_group_response_data:
+ properties:
+ id:
+ description: Unique ID of the communications group
type: string
type:
enum:
- - causes
+ - communications_groups
type: string
attributes:
allOf:
- - $ref: '#/components/schemas/cause'
+ - $ref: '#/components/schemas/communications_group'
type: object
required:
- attributes
@@ -53431,9 +45569,6 @@ components:
label:
description: The name of the custom_field
type: string
- slug:
- description: The slug of the custom_field
- type: string
description:
description: The description of the custom_field
nullable: true
@@ -53510,10 +45645,6 @@ components:
name:
description: The name of the custom form.
type: string
- slug:
- description: The custom form slug. Add this to form_field.shown or form_field.required
- to associate form fields with custom forms.
- type: string
description:
nullable: true
type: string
@@ -53544,10 +45675,6 @@ components:
name:
description: The name of the custom form.
type: string
- slug:
- description: The custom form slug. Add this to form_field.shown or form_field.required
- to associate form fields with custom forms.
- type: string
description:
nullable: true
type: string
@@ -53618,6 +45745,8 @@ components:
- not_exists
- contains
- not_contains
+ - assigned
+ - unassigned
type: string
key:
type: string
@@ -53636,6 +45765,26 @@ components:
$ref: '#/components/schemas/new_dashboard_panel_data_attributes_params_datasets_inner_filter_inner_rules_inner'
type: array
type: object
+ new_dashboard_panel_data_attributes_params_datasets_inner_group_by_oneOf:
+ nullable: true
+ properties:
+ key:
+ enum:
+ - custom_field
+ - incident_role
+ - alert_field
+ type: string
+ value:
+ type: string
+ required:
+ - key
+ - value
+ type: object
+ new_dashboard_panel_data_attributes_params_datasets_inner_group_by:
+ oneOf:
+ - nullable: true
+ type: string
+ - $ref: '#/components/schemas/new_dashboard_panel_data_attributes_params_datasets_inner_group_by_oneOf'
new_dashboard_panel_data_attributes_params_datasets_inner_aggregate:
nullable: true
properties:
@@ -53670,8 +45819,7 @@ components:
$ref: '#/components/schemas/new_dashboard_panel_data_attributes_params_datasets_inner_filter_inner'
type: array
group_by:
- nullable: true
- type: string
+ $ref: '#/components/schemas/new_dashboard_panel_data_attributes_params_datasets_inner_group_by'
aggregate:
$ref: '#/components/schemas/new_dashboard_panel_data_attributes_params_datasets_inner_aggregate'
type: object
@@ -53923,6 +46071,245 @@ components:
- id
- type
type: object
+ edge_connector_data_attributes:
+ properties:
+ name:
+ description: Connector name
+ type: string
+ description:
+ description: Connector description
+ nullable: true
+ type: string
+ status:
+ description: Connector status
+ enum:
+ - active
+ - paused
+ type: string
+ subscriptions:
+ description: Array of event types to subscribe to
+ items:
+ type: string
+ type: array
+ last_poll_at:
+ description: Last time connector polled
+ format: date-time
+ nullable: true
+ type: string
+ online:
+ description: Whether connector is currently online
+ type: boolean
+ deliveries_count:
+ description: Total number of deliveries
+ type: integer
+ deliveries_queued_count:
+ description: Number of queued deliveries
+ type: integer
+ deliveries_running_count:
+ description: Number of running deliveries
+ type: integer
+ deliveries_completed_count:
+ description: Number of completed deliveries
+ type: integer
+ deliveries_failed_count:
+ description: Number of failed deliveries
+ type: integer
+ created_at:
+ format: date-time
+ type: string
+ updated_at:
+ format: date-time
+ type: string
+ required:
+ - name
+ - status
+ type: object
+ edge_connector_data:
+ properties:
+ type:
+ enum:
+ - edge_connectors
+ type: string
+ id:
+ format: uuid
+ type: string
+ attributes:
+ $ref: '#/components/schemas/edge_connector_data_attributes'
+ required:
+ - attributes
+ - id
+ - type
+ type: object
+ new_edge_connector_edge_connector:
+ properties:
+ name:
+ description: Connector name
+ type: string
+ description:
+ description: Connector description
+ nullable: true
+ type: string
+ status:
+ description: Connector status
+ enum:
+ - active
+ - paused
+ type: string
+ subscriptions:
+ description: Array of event types to subscribe to
+ items:
+ type: string
+ type: array
+ required:
+ - name
+ type: object
+ edge_connector_action_data_attributes_parameters_inner:
+ properties:
+ name:
+ type: string
+ type:
+ enum:
+ - string
+ - number
+ - boolean
+ type: string
+ required:
+ type: boolean
+ description:
+ nullable: true
+ type: string
+ default:
+ description: Default value (any type)
+ nullable: true
+ type: string
+ options:
+ items:
+ type: string
+ nullable: true
+ type: array
+ type: object
+ edge_connector_action_data_attributes:
+ properties:
+ name:
+ description: Action name
+ type: string
+ slug:
+ description: Action slug
+ type: string
+ action_type:
+ description: Action type
+ enum:
+ - script
+ - http
+ type: string
+ icon:
+ description: Action icon
+ enum:
+ - bolt
+ - bolt-slash
+ - cog
+ - command-line
+ - code-bracket
+ - server
+ - server-stack
+ - play
+ - arrow-path
+ - wrench-screwdriver
+ - cube
+ - rocket-launch
+ nullable: true
+ type: string
+ description:
+ description: Action description
+ nullable: true
+ type: string
+ timeout:
+ description: Timeout in seconds
+ nullable: true
+ type: integer
+ parameters:
+ description: Parameter definitions
+ items:
+ $ref: '#/components/schemas/edge_connector_action_data_attributes_parameters_inner'
+ nullable: true
+ type: array
+ last_executed_at:
+ format: date-time
+ nullable: true
+ type: string
+ created_at:
+ format: date-time
+ type: string
+ updated_at:
+ format: date-time
+ type: string
+ required:
+ - action_type
+ - name
+ type: object
+ edge_connector_action_data:
+ properties:
+ type:
+ enum:
+ - edge_connector_actions
+ type: string
+ id:
+ format: uuid
+ type: string
+ attributes:
+ $ref: '#/components/schemas/edge_connector_action_data_attributes'
+ required:
+ - attributes
+ - id
+ - type
+ type: object
+ new_edge_connector_action_action_metadata:
+ properties:
+ description:
+ nullable: true
+ type: string
+ timeout:
+ nullable: true
+ type: integer
+ icon:
+ enum:
+ - bolt
+ - bolt-slash
+ - cog
+ - command-line
+ - code-bracket
+ - server
+ - server-stack
+ - play
+ - arrow-path
+ - wrench-screwdriver
+ - cube
+ - rocket-launch
+ nullable: true
+ type: string
+ parameters:
+ items:
+ $ref: '#/components/schemas/edge_connector_action_data_attributes_parameters_inner'
+ nullable: true
+ type: array
+ type: object
+ new_edge_connector_action_action:
+ properties:
+ name:
+ description: Action name
+ type: string
+ action_type:
+ description: Action type
+ enum:
+ - script
+ - http
+ type: string
+ metadata:
+ $ref: '#/components/schemas/new_edge_connector_action_action_metadata'
+ required:
+ - action_type
+ - name
+ type: object
new_environment_data_attributes_slack_channels_inner:
properties:
id:
@@ -53983,6 +46370,11 @@ components:
$ref: '#/components/schemas/new_environment_data_attributes_slack_aliases_inner'
nullable: true
type: array
+ properties:
+ description: Array of property values for this environment.
+ items:
+ $ref: '#/components/schemas/new_cause_data_attributes_properties_inner'
+ type: array
required:
- name
type: object
@@ -54034,6 +46426,11 @@ components:
$ref: '#/components/schemas/new_environment_data_attributes_slack_aliases_inner'
nullable: true
type: array
+ properties:
+ description: Array of property values for this environment.
+ items:
+ $ref: '#/components/schemas/new_cause_data_attributes_properties_inner'
+ type: array
type: object
update_environment_data:
properties:
@@ -54086,6 +46483,311 @@ components:
properties:
time_zone:
description: Time zone for business hours
+ enum:
+ - International Date Line West
+ - Etc/GMT+12
+ - American Samoa
+ - Pacific/Pago_Pago
+ - Midway Island
+ - Pacific/Midway
+ - Hawaii
+ - Pacific/Honolulu
+ - Alaska
+ - America/Juneau
+ - Pacific Time (US & Canada)
+ - America/Los_Angeles
+ - Tijuana
+ - America/Tijuana
+ - Arizona
+ - America/Phoenix
+ - Mazatlan
+ - America/Mazatlan
+ - Mountain Time (US & Canada)
+ - America/Denver
+ - Central America
+ - America/Guatemala
+ - Central Time (US & Canada)
+ - America/Chicago
+ - Chihuahua
+ - America/Chihuahua
+ - Guadalajara
+ - America/Mexico_City
+ - Mexico City
+ - America/Mexico_City
+ - Monterrey
+ - America/Monterrey
+ - Saskatchewan
+ - America/Regina
+ - Bogota
+ - America/Bogota
+ - Eastern Time (US & Canada)
+ - America/New_York
+ - Indiana (East)
+ - America/Indiana/Indianapolis
+ - Lima
+ - America/Lima
+ - Quito
+ - America/Lima
+ - Atlantic Time (Canada)
+ - America/Halifax
+ - Caracas
+ - America/Caracas
+ - Georgetown
+ - America/Guyana
+ - La Paz
+ - America/La_Paz
+ - Puerto Rico
+ - America/Puerto_Rico
+ - Santiago
+ - America/Santiago
+ - Newfoundland
+ - America/St_Johns
+ - Asuncion
+ - America/Asuncion
+ - Brasilia
+ - America/Sao_Paulo
+ - Buenos Aires
+ - America/Argentina/Buenos_Aires
+ - Montevideo
+ - America/Montevideo
+ - Greenland
+ - America/Nuuk
+ - Mid-Atlantic
+ - Atlantic/South_Georgia
+ - Azores
+ - Atlantic/Azores
+ - Cape Verde Is.
+ - Atlantic/Cape_Verde
+ - Edinburgh
+ - Europe/London
+ - Lisbon
+ - Europe/Lisbon
+ - London
+ - Europe/London
+ - Monrovia
+ - Africa/Monrovia
+ - UTC
+ - Etc/UTC
+ - Amsterdam
+ - Europe/Amsterdam
+ - Belgrade
+ - Europe/Belgrade
+ - Berlin
+ - Europe/Berlin
+ - Bern
+ - Europe/Zurich
+ - Bratislava
+ - Europe/Bratislava
+ - Brussels
+ - Europe/Brussels
+ - Budapest
+ - Europe/Budapest
+ - Casablanca
+ - Africa/Casablanca
+ - Copenhagen
+ - Europe/Copenhagen
+ - Dublin
+ - Europe/Dublin
+ - Ljubljana
+ - Europe/Ljubljana
+ - Madrid
+ - Europe/Madrid
+ - Paris
+ - Europe/Paris
+ - Prague
+ - Europe/Prague
+ - Rome
+ - Europe/Rome
+ - Sarajevo
+ - Europe/Sarajevo
+ - Skopje
+ - Europe/Skopje
+ - Stockholm
+ - Europe/Stockholm
+ - Vienna
+ - Europe/Vienna
+ - Warsaw
+ - Europe/Warsaw
+ - West Central Africa
+ - Africa/Algiers
+ - Zagreb
+ - Europe/Zagreb
+ - Zurich
+ - Europe/Zurich
+ - Athens
+ - Europe/Athens
+ - Bucharest
+ - Europe/Bucharest
+ - Cairo
+ - Africa/Cairo
+ - Harare
+ - Africa/Harare
+ - Helsinki
+ - Europe/Helsinki
+ - Jerusalem
+ - Asia/Jerusalem
+ - Kaliningrad
+ - Europe/Kaliningrad
+ - Kyiv
+ - Europe/Kiev
+ - Pretoria
+ - Africa/Johannesburg
+ - Riga
+ - Europe/Riga
+ - Sofia
+ - Europe/Sofia
+ - Tallinn
+ - Europe/Tallinn
+ - Vilnius
+ - Europe/Vilnius
+ - Baghdad
+ - Asia/Baghdad
+ - Istanbul
+ - Europe/Istanbul
+ - Kuwait
+ - Asia/Kuwait
+ - Minsk
+ - Europe/Minsk
+ - Moscow
+ - Europe/Moscow
+ - Nairobi
+ - Africa/Nairobi
+ - Riyadh
+ - Asia/Riyadh
+ - St. Petersburg
+ - Europe/Moscow
+ - Volgograd
+ - Europe/Volgograd
+ - Tehran
+ - Asia/Tehran
+ - Abu Dhabi
+ - Asia/Muscat
+ - Baku
+ - Asia/Baku
+ - Muscat
+ - Asia/Muscat
+ - Samara
+ - Europe/Samara
+ - Tbilisi
+ - Asia/Tbilisi
+ - Yerevan
+ - Asia/Yerevan
+ - Kabul
+ - Asia/Kabul
+ - Almaty
+ - Asia/Almaty
+ - Astana
+ - Asia/Almaty
+ - Ekaterinburg
+ - Asia/Yekaterinburg
+ - Islamabad
+ - Asia/Karachi
+ - Karachi
+ - Asia/Karachi
+ - Tashkent
+ - Asia/Tashkent
+ - Chennai
+ - Asia/Kolkata
+ - Kolkata
+ - Asia/Kolkata
+ - Mumbai
+ - Asia/Kolkata
+ - New Delhi
+ - Asia/Kolkata
+ - Sri Jayawardenepura
+ - Asia/Colombo
+ - Kathmandu
+ - Asia/Kathmandu
+ - Dhaka
+ - Asia/Dhaka
+ - Urumqi
+ - Asia/Urumqi
+ - Rangoon
+ - Asia/Rangoon
+ - Bangkok
+ - Asia/Bangkok
+ - Hanoi
+ - Asia/Bangkok
+ - Jakarta
+ - Asia/Jakarta
+ - Krasnoyarsk
+ - Asia/Krasnoyarsk
+ - Novosibirsk
+ - Asia/Novosibirsk
+ - Beijing
+ - Asia/Shanghai
+ - Chongqing
+ - Asia/Chongqing
+ - Hong Kong
+ - Asia/Hong_Kong
+ - Irkutsk
+ - Asia/Irkutsk
+ - Kuala Lumpur
+ - Asia/Kuala_Lumpur
+ - Perth
+ - Australia/Perth
+ - Singapore
+ - Asia/Singapore
+ - Taipei
+ - Asia/Taipei
+ - Ulaanbaatar
+ - Asia/Ulaanbaatar
+ - Osaka
+ - Asia/Tokyo
+ - Sapporo
+ - Asia/Tokyo
+ - Seoul
+ - Asia/Seoul
+ - Tokyo
+ - Asia/Tokyo
+ - Yakutsk
+ - Asia/Yakutsk
+ - Adelaide
+ - Australia/Adelaide
+ - Darwin
+ - Australia/Darwin
+ - Brisbane
+ - Australia/Brisbane
+ - Canberra
+ - Australia/Canberra
+ - Guam
+ - Pacific/Guam
+ - Hobart
+ - Australia/Hobart
+ - Melbourne
+ - Australia/Melbourne
+ - Port Moresby
+ - Pacific/Port_Moresby
+ - Sydney
+ - Australia/Sydney
+ - Vladivostok
+ - Asia/Vladivostok
+ - Magadan
+ - Asia/Magadan
+ - New Caledonia
+ - Pacific/Noumea
+ - Solomon Is.
+ - Pacific/Guadalcanal
+ - Srednekolymsk
+ - Asia/Srednekolymsk
+ - Auckland
+ - Pacific/Auckland
+ - Fiji
+ - Pacific/Fiji
+ - Kamchatka
+ - Asia/Kamchatka
+ - Marshall Is.
+ - Pacific/Majuro
+ - Wellington
+ - Pacific/Auckland
+ - Chatham Is.
+ - Pacific/Chatham
+ - Nuku'alofa
+ - Pacific/Tongatapu
+ - Samoa
+ - Pacific/Apia
+ - Tokelau Is.
+ - Pacific/Fakaofo
nullable: true
type: string
days:
@@ -54213,7 +46915,7 @@ components:
- id
- type
type: object
- new_escalation_policy_path_data_attributes_rules_inner_anyOf:
+ new_escalation_policy_path_data_attributes_rules_inner_oneOf:
properties:
rule_type:
description: The type of the escalation path rule
@@ -54224,13 +46926,12 @@ components:
description: Alert urgency ids for which this escalation path should be
used
items:
- description: TODO default missing array inner type to string
type: string
type: array
required:
- rule_type
- urgency_ids
- new_escalation_policy_path_data_attributes_rules_inner_anyOf_1:
+ new_escalation_policy_path_data_attributes_rules_inner_oneOf_1:
properties:
rule_type:
description: The type of the escalation path rule
@@ -54243,7 +46944,7 @@ components:
required:
- rule_type
- within_working_hour
- new_escalation_policy_path_data_attributes_rules_inner_anyOf_2:
+ new_escalation_policy_path_data_attributes_rules_inner_oneOf_2:
properties:
rule_type:
description: The type of the escalation path rule
@@ -54260,90 +46961,484 @@ components:
- is_not
- contains
- does_not_contain
+ - is_one_of
+ - is_not_one_of
+ - is_set
+ - is_not_set
type: string
value:
description: Value with which JSON path value should be matched
+ nullable: true
type: string
+ values:
+ description: Values to match against (for is_one_of / is_not_one_of operators)
+ items:
+ type: string
+ type: array
required:
- json_path
- operator
- rule_type
- - value
- new_escalation_policy_path_data_attributes_rules_inner:
- anyOf:
- - $ref: '#/components/schemas/new_escalation_policy_path_data_attributes_rules_inner_anyOf'
- - $ref: '#/components/schemas/new_escalation_policy_path_data_attributes_rules_inner_anyOf_1'
- - $ref: '#/components/schemas/new_escalation_policy_path_data_attributes_rules_inner_anyOf_2'
- type: object
- new_escalation_policy_path_data_attributes:
- additionalProperties: false
+ new_escalation_policy_path_data_attributes_rules_inner_oneOf_3:
properties:
- name:
- description: The name of the escalation path
+ rule_type:
+ description: The type of the escalation path rule
+ enum:
+ - field
type: string
- notification_type:
- default: audible
- description: Notification rule type to be used
+ fieldable_type:
+ description: "The type of the fieldable (e.g., AlertField)"
+ type: string
+ fieldable_id:
+ description: The ID of the alert field
+ type: string
+ operator:
+ description: How the alert field value should be matched
enum:
- - audible
- - quiet
+ - is
+ - is_not
+ - is_one_of
+ - is_not_one_of
+ - contains
+ - does_not_contain
+ - is_empty
+ - is_not_empty
+ - contains_key
+ - does_not_contain_key
+ - starts_with
+ - does_not_start_with
+ - matches
+ - does_not_match
type: string
- default:
- description: Whether this escalation path is the default path
- nullable: true
- type: boolean
- match_mode:
- default: match-all-rules
- description: How path rules are matched.
+ values:
+ description: Values to match against
+ items:
+ type: string
+ type: array
+ required:
+ - fieldable_id
+ - fieldable_type
+ - operator
+ - rule_type
+ new_escalation_policy_path_data_attributes_rules_inner_oneOf_4:
+ properties:
+ rule_type:
+ description: The type of the escalation path rule
enum:
- - match-all-rules
- - match-any-rule
+ - service
type: string
- position:
- description: The position of this path in the paths for this EP.
- type: integer
- repeat:
- description: Whether this path should be repeated until someone acknowledges
- the alert
- nullable: true
+ service_ids:
+ description: Service ids for which this escalation path should be used
+ items:
+ type: string
+ type: array
+ required:
+ - rule_type
+ - service_ids
+ new_escalation_policy_path_data_attributes_rules_inner_oneOf_5_time_blocks_inner:
+ properties:
+ monday:
+ default: false
type: boolean
- repeat_count:
- description: The number of times this path will be executed until someone
- acknowledges the alert
+ tuesday:
+ default: false
+ type: boolean
+ wednesday:
+ default: false
+ type: boolean
+ thursday:
+ default: false
+ type: boolean
+ friday:
+ default: false
+ type: boolean
+ saturday:
+ default: false
+ type: boolean
+ sunday:
+ default: false
+ type: boolean
+ start_time:
+ description: Formatted as HH:MM
+ type: string
+ end_time:
+ description: Formatted as HH:MM
+ type: string
+ all_day:
+ default: false
+ type: boolean
+ position:
nullable: true
type: integer
- initial_delay:
- description: Initial delay for escalation path in minutes. Maximum 1 week
- (10080).
- type: integer
- rules:
- description: Escalation path conditions
- items:
- $ref: '#/components/schemas/new_escalation_policy_path_data_attributes_rules_inner'
+ type: object
+ new_escalation_policy_path_data_attributes_rules_inner_oneOf_5:
+ properties:
+ rule_type:
+ description: The type of the escalation path rule
+ enum:
+ - deferral_window
+ type: string
+ time_zone:
+ description: Time zone for the deferral window
+ enum:
+ - International Date Line West
+ - Etc/GMT+12
+ - American Samoa
+ - Pacific/Pago_Pago
+ - Midway Island
+ - Pacific/Midway
+ - Hawaii
+ - Pacific/Honolulu
+ - Alaska
+ - America/Juneau
+ - Pacific Time (US & Canada)
+ - America/Los_Angeles
+ - Tijuana
+ - America/Tijuana
+ - Arizona
+ - America/Phoenix
+ - Mazatlan
+ - America/Mazatlan
+ - Mountain Time (US & Canada)
+ - America/Denver
+ - Central America
+ - America/Guatemala
+ - Central Time (US & Canada)
+ - America/Chicago
+ - Chihuahua
+ - America/Chihuahua
+ - Guadalajara
+ - America/Mexico_City
+ - Mexico City
+ - America/Mexico_City
+ - Monterrey
+ - America/Monterrey
+ - Saskatchewan
+ - America/Regina
+ - Bogota
+ - America/Bogota
+ - Eastern Time (US & Canada)
+ - America/New_York
+ - Indiana (East)
+ - America/Indiana/Indianapolis
+ - Lima
+ - America/Lima
+ - Quito
+ - America/Lima
+ - Atlantic Time (Canada)
+ - America/Halifax
+ - Caracas
+ - America/Caracas
+ - Georgetown
+ - America/Guyana
+ - La Paz
+ - America/La_Paz
+ - Puerto Rico
+ - America/Puerto_Rico
+ - Santiago
+ - America/Santiago
+ - Newfoundland
+ - America/St_Johns
+ - Asuncion
+ - America/Asuncion
+ - Brasilia
+ - America/Sao_Paulo
+ - Buenos Aires
+ - America/Argentina/Buenos_Aires
+ - Montevideo
+ - America/Montevideo
+ - Greenland
+ - America/Nuuk
+ - Mid-Atlantic
+ - Atlantic/South_Georgia
+ - Azores
+ - Atlantic/Azores
+ - Cape Verde Is.
+ - Atlantic/Cape_Verde
+ - Edinburgh
+ - Europe/London
+ - Lisbon
+ - Europe/Lisbon
+ - London
+ - Europe/London
+ - Monrovia
+ - Africa/Monrovia
+ - UTC
+ - Etc/UTC
+ - Amsterdam
+ - Europe/Amsterdam
+ - Belgrade
+ - Europe/Belgrade
+ - Berlin
+ - Europe/Berlin
+ - Bern
+ - Europe/Zurich
+ - Bratislava
+ - Europe/Bratislava
+ - Brussels
+ - Europe/Brussels
+ - Budapest
+ - Europe/Budapest
+ - Casablanca
+ - Africa/Casablanca
+ - Copenhagen
+ - Europe/Copenhagen
+ - Dublin
+ - Europe/Dublin
+ - Ljubljana
+ - Europe/Ljubljana
+ - Madrid
+ - Europe/Madrid
+ - Paris
+ - Europe/Paris
+ - Prague
+ - Europe/Prague
+ - Rome
+ - Europe/Rome
+ - Sarajevo
+ - Europe/Sarajevo
+ - Skopje
+ - Europe/Skopje
+ - Stockholm
+ - Europe/Stockholm
+ - Vienna
+ - Europe/Vienna
+ - Warsaw
+ - Europe/Warsaw
+ - West Central Africa
+ - Africa/Algiers
+ - Zagreb
+ - Europe/Zagreb
+ - Zurich
+ - Europe/Zurich
+ - Athens
+ - Europe/Athens
+ - Bucharest
+ - Europe/Bucharest
+ - Cairo
+ - Africa/Cairo
+ - Harare
+ - Africa/Harare
+ - Helsinki
+ - Europe/Helsinki
+ - Jerusalem
+ - Asia/Jerusalem
+ - Kaliningrad
+ - Europe/Kaliningrad
+ - Kyiv
+ - Europe/Kiev
+ - Pretoria
+ - Africa/Johannesburg
+ - Riga
+ - Europe/Riga
+ - Sofia
+ - Europe/Sofia
+ - Tallinn
+ - Europe/Tallinn
+ - Vilnius
+ - Europe/Vilnius
+ - Baghdad
+ - Asia/Baghdad
+ - Istanbul
+ - Europe/Istanbul
+ - Kuwait
+ - Asia/Kuwait
+ - Minsk
+ - Europe/Minsk
+ - Moscow
+ - Europe/Moscow
+ - Nairobi
+ - Africa/Nairobi
+ - Riyadh
+ - Asia/Riyadh
+ - St. Petersburg
+ - Europe/Moscow
+ - Volgograd
+ - Europe/Volgograd
+ - Tehran
+ - Asia/Tehran
+ - Abu Dhabi
+ - Asia/Muscat
+ - Baku
+ - Asia/Baku
+ - Muscat
+ - Asia/Muscat
+ - Samara
+ - Europe/Samara
+ - Tbilisi
+ - Asia/Tbilisi
+ - Yerevan
+ - Asia/Yerevan
+ - Kabul
+ - Asia/Kabul
+ - Almaty
+ - Asia/Almaty
+ - Astana
+ - Asia/Almaty
+ - Ekaterinburg
+ - Asia/Yekaterinburg
+ - Islamabad
+ - Asia/Karachi
+ - Karachi
+ - Asia/Karachi
+ - Tashkent
+ - Asia/Tashkent
+ - Chennai
+ - Asia/Kolkata
+ - Kolkata
+ - Asia/Kolkata
+ - Mumbai
+ - Asia/Kolkata
+ - New Delhi
+ - Asia/Kolkata
+ - Sri Jayawardenepura
+ - Asia/Colombo
+ - Kathmandu
+ - Asia/Kathmandu
+ - Dhaka
+ - Asia/Dhaka
+ - Urumqi
+ - Asia/Urumqi
+ - Rangoon
+ - Asia/Rangoon
+ - Bangkok
+ - Asia/Bangkok
+ - Hanoi
+ - Asia/Bangkok
+ - Jakarta
+ - Asia/Jakarta
+ - Krasnoyarsk
+ - Asia/Krasnoyarsk
+ - Novosibirsk
+ - Asia/Novosibirsk
+ - Beijing
+ - Asia/Shanghai
+ - Chongqing
+ - Asia/Chongqing
+ - Hong Kong
+ - Asia/Hong_Kong
+ - Irkutsk
+ - Asia/Irkutsk
+ - Kuala Lumpur
+ - Asia/Kuala_Lumpur
+ - Perth
+ - Australia/Perth
+ - Singapore
+ - Asia/Singapore
+ - Taipei
+ - Asia/Taipei
+ - Ulaanbaatar
+ - Asia/Ulaanbaatar
+ - Osaka
+ - Asia/Tokyo
+ - Sapporo
+ - Asia/Tokyo
+ - Seoul
+ - Asia/Seoul
+ - Tokyo
+ - Asia/Tokyo
+ - Yakutsk
+ - Asia/Yakutsk
+ - Adelaide
+ - Australia/Adelaide
+ - Darwin
+ - Australia/Darwin
+ - Brisbane
+ - Australia/Brisbane
+ - Canberra
+ - Australia/Canberra
+ - Guam
+ - Pacific/Guam
+ - Hobart
+ - Australia/Hobart
+ - Melbourne
+ - Australia/Melbourne
+ - Port Moresby
+ - Pacific/Port_Moresby
+ - Sydney
+ - Australia/Sydney
+ - Vladivostok
+ - Asia/Vladivostok
+ - Magadan
+ - Asia/Magadan
+ - New Caledonia
+ - Pacific/Noumea
+ - Solomon Is.
+ - Pacific/Guadalcanal
+ - Srednekolymsk
+ - Asia/Srednekolymsk
+ - Auckland
+ - Pacific/Auckland
+ - Fiji
+ - Pacific/Fiji
+ - Kamchatka
+ - Asia/Kamchatka
+ - Marshall Is.
+ - Pacific/Majuro
+ - Wellington
+ - Pacific/Auckland
+ - Chatham Is.
+ - Pacific/Chatham
+ - Nuku'alofa
+ - Pacific/Tongatapu
+ - Samoa
+ - Pacific/Apia
+ - Tokelau Is.
+ - Pacific/Fakaofo
+ type: string
+ time_blocks:
+ description: Time windows during which alerts are deferred
+ items:
+ $ref: '#/components/schemas/new_escalation_policy_path_data_attributes_rules_inner_oneOf_5_time_blocks_inner'
type: array
required:
- - name
+ - rule_type
+ - time_blocks
+ - time_zone
+ new_escalation_policy_path_data_attributes_rules_inner:
+ oneOf:
+ - $ref: '#/components/schemas/new_escalation_policy_path_data_attributes_rules_inner_oneOf'
+ - $ref: '#/components/schemas/new_escalation_policy_path_data_attributes_rules_inner_oneOf_1'
+ - $ref: '#/components/schemas/new_escalation_policy_path_data_attributes_rules_inner_oneOf_2'
+ - $ref: '#/components/schemas/new_escalation_policy_path_data_attributes_rules_inner_oneOf_3'
+ - $ref: '#/components/schemas/new_escalation_policy_path_data_attributes_rules_inner_oneOf_4'
+ - $ref: '#/components/schemas/new_escalation_policy_path_data_attributes_rules_inner_oneOf_5'
type: object
- new_escalation_policy_path_data:
+ new_escalation_policy_path_data_attributes_time_restrictions_inner:
properties:
- type:
+ start_day:
enum:
- - escalation_paths
+ - monday
+ - tuesday
+ - wednesday
+ - thursday
+ - friday
+ - saturday
+ - sunday
+ type: string
+ start_time:
+ description: Formatted as HH:MM
+ type: string
+ end_day:
+ enum:
+ - monday
+ - tuesday
+ - wednesday
+ - thursday
+ - friday
+ - saturday
+ - sunday
+ type: string
+ end_time:
+ description: Formatted as HH:MM
type: string
- attributes:
- $ref: '#/components/schemas/new_escalation_policy_path_data_attributes'
required:
- - attributes
- - type
- type: object
- update_escalation_policy_path_data_attributes_rules_inner:
- anyOf:
- - $ref: '#/components/schemas/new_escalation_policy_path_data_attributes_rules_inner_anyOf'
- - $ref: '#/components/schemas/new_escalation_policy_path_data_attributes_rules_inner_anyOf_1'
- - $ref: '#/components/schemas/new_escalation_policy_path_data_attributes_rules_inner_anyOf_2'
- nullable: true
+ - end_day
+ - end_time
+ - start_day
+ - start_time
type: object
- update_escalation_policy_path_data_attributes:
+ new_escalation_policy_path_data_attributes:
additionalProperties: false
properties:
name:
@@ -54351,11 +47446,31 @@ components:
type: string
notification_type:
default: audible
- description: Position of the escalation policy level
+ description: Notification rule type to be used
enum:
- audible
- quiet
type: string
+ path_type:
+ default: escalation
+ description: The type of escalation path to create
+ enum:
+ - escalation
+ - deferral
+ type: string
+ after_deferral_behavior:
+ description: What happens after a deferral path finishes. Required for deferral
+ paths.
+ enum:
+ - re_evaluate
+ - execute_path
+ nullable: true
+ type: string
+ after_deferral_path_id:
+ description: The escalation path to execute after this deferral path when
+ after_deferral_behavior is execute_path.
+ nullable: true
+ type: string
default:
description: Whether this escalation path is the default path
nullable: true
@@ -54387,43 +47502,768 @@ components:
rules:
description: Escalation path conditions
items:
- $ref: '#/components/schemas/update_escalation_policy_path_data_attributes_rules_inner'
+ $ref: '#/components/schemas/new_escalation_policy_path_data_attributes_rules_inner'
+ type: array
+ time_restriction_time_zone:
+ description: Time zone used for time restrictions.
+ enum:
+ - International Date Line West
+ - Etc/GMT+12
+ - American Samoa
+ - Pacific/Pago_Pago
+ - Midway Island
+ - Pacific/Midway
+ - Hawaii
+ - Pacific/Honolulu
+ - Alaska
+ - America/Juneau
+ - Pacific Time (US & Canada)
+ - America/Los_Angeles
+ - Tijuana
+ - America/Tijuana
+ - Arizona
+ - America/Phoenix
+ - Mazatlan
+ - America/Mazatlan
+ - Mountain Time (US & Canada)
+ - America/Denver
+ - Central America
+ - America/Guatemala
+ - Central Time (US & Canada)
+ - America/Chicago
+ - Chihuahua
+ - America/Chihuahua
+ - Guadalajara
+ - America/Mexico_City
+ - Mexico City
+ - America/Mexico_City
+ - Monterrey
+ - America/Monterrey
+ - Saskatchewan
+ - America/Regina
+ - Bogota
+ - America/Bogota
+ - Eastern Time (US & Canada)
+ - America/New_York
+ - Indiana (East)
+ - America/Indiana/Indianapolis
+ - Lima
+ - America/Lima
+ - Quito
+ - America/Lima
+ - Atlantic Time (Canada)
+ - America/Halifax
+ - Caracas
+ - America/Caracas
+ - Georgetown
+ - America/Guyana
+ - La Paz
+ - America/La_Paz
+ - Puerto Rico
+ - America/Puerto_Rico
+ - Santiago
+ - America/Santiago
+ - Newfoundland
+ - America/St_Johns
+ - Asuncion
+ - America/Asuncion
+ - Brasilia
+ - America/Sao_Paulo
+ - Buenos Aires
+ - America/Argentina/Buenos_Aires
+ - Montevideo
+ - America/Montevideo
+ - Greenland
+ - America/Nuuk
+ - Mid-Atlantic
+ - Atlantic/South_Georgia
+ - Azores
+ - Atlantic/Azores
+ - Cape Verde Is.
+ - Atlantic/Cape_Verde
+ - Edinburgh
+ - Europe/London
+ - Lisbon
+ - Europe/Lisbon
+ - London
+ - Europe/London
+ - Monrovia
+ - Africa/Monrovia
+ - UTC
+ - Etc/UTC
+ - Amsterdam
+ - Europe/Amsterdam
+ - Belgrade
+ - Europe/Belgrade
+ - Berlin
+ - Europe/Berlin
+ - Bern
+ - Europe/Zurich
+ - Bratislava
+ - Europe/Bratislava
+ - Brussels
+ - Europe/Brussels
+ - Budapest
+ - Europe/Budapest
+ - Casablanca
+ - Africa/Casablanca
+ - Copenhagen
+ - Europe/Copenhagen
+ - Dublin
+ - Europe/Dublin
+ - Ljubljana
+ - Europe/Ljubljana
+ - Madrid
+ - Europe/Madrid
+ - Paris
+ - Europe/Paris
+ - Prague
+ - Europe/Prague
+ - Rome
+ - Europe/Rome
+ - Sarajevo
+ - Europe/Sarajevo
+ - Skopje
+ - Europe/Skopje
+ - Stockholm
+ - Europe/Stockholm
+ - Vienna
+ - Europe/Vienna
+ - Warsaw
+ - Europe/Warsaw
+ - West Central Africa
+ - Africa/Algiers
+ - Zagreb
+ - Europe/Zagreb
+ - Zurich
+ - Europe/Zurich
+ - Athens
+ - Europe/Athens
+ - Bucharest
+ - Europe/Bucharest
+ - Cairo
+ - Africa/Cairo
+ - Harare
+ - Africa/Harare
+ - Helsinki
+ - Europe/Helsinki
+ - Jerusalem
+ - Asia/Jerusalem
+ - Kaliningrad
+ - Europe/Kaliningrad
+ - Kyiv
+ - Europe/Kiev
+ - Pretoria
+ - Africa/Johannesburg
+ - Riga
+ - Europe/Riga
+ - Sofia
+ - Europe/Sofia
+ - Tallinn
+ - Europe/Tallinn
+ - Vilnius
+ - Europe/Vilnius
+ - Baghdad
+ - Asia/Baghdad
+ - Istanbul
+ - Europe/Istanbul
+ - Kuwait
+ - Asia/Kuwait
+ - Minsk
+ - Europe/Minsk
+ - Moscow
+ - Europe/Moscow
+ - Nairobi
+ - Africa/Nairobi
+ - Riyadh
+ - Asia/Riyadh
+ - St. Petersburg
+ - Europe/Moscow
+ - Volgograd
+ - Europe/Volgograd
+ - Tehran
+ - Asia/Tehran
+ - Abu Dhabi
+ - Asia/Muscat
+ - Baku
+ - Asia/Baku
+ - Muscat
+ - Asia/Muscat
+ - Samara
+ - Europe/Samara
+ - Tbilisi
+ - Asia/Tbilisi
+ - Yerevan
+ - Asia/Yerevan
+ - Kabul
+ - Asia/Kabul
+ - Almaty
+ - Asia/Almaty
+ - Astana
+ - Asia/Almaty
+ - Ekaterinburg
+ - Asia/Yekaterinburg
+ - Islamabad
+ - Asia/Karachi
+ - Karachi
+ - Asia/Karachi
+ - Tashkent
+ - Asia/Tashkent
+ - Chennai
+ - Asia/Kolkata
+ - Kolkata
+ - Asia/Kolkata
+ - Mumbai
+ - Asia/Kolkata
+ - New Delhi
+ - Asia/Kolkata
+ - Sri Jayawardenepura
+ - Asia/Colombo
+ - Kathmandu
+ - Asia/Kathmandu
+ - Dhaka
+ - Asia/Dhaka
+ - Urumqi
+ - Asia/Urumqi
+ - Rangoon
+ - Asia/Rangoon
+ - Bangkok
+ - Asia/Bangkok
+ - Hanoi
+ - Asia/Bangkok
+ - Jakarta
+ - Asia/Jakarta
+ - Krasnoyarsk
+ - Asia/Krasnoyarsk
+ - Novosibirsk
+ - Asia/Novosibirsk
+ - Beijing
+ - Asia/Shanghai
+ - Chongqing
+ - Asia/Chongqing
+ - Hong Kong
+ - Asia/Hong_Kong
+ - Irkutsk
+ - Asia/Irkutsk
+ - Kuala Lumpur
+ - Asia/Kuala_Lumpur
+ - Perth
+ - Australia/Perth
+ - Singapore
+ - Asia/Singapore
+ - Taipei
+ - Asia/Taipei
+ - Ulaanbaatar
+ - Asia/Ulaanbaatar
+ - Osaka
+ - Asia/Tokyo
+ - Sapporo
+ - Asia/Tokyo
+ - Seoul
+ - Asia/Seoul
+ - Tokyo
+ - Asia/Tokyo
+ - Yakutsk
+ - Asia/Yakutsk
+ - Adelaide
+ - Australia/Adelaide
+ - Darwin
+ - Australia/Darwin
+ - Brisbane
+ - Australia/Brisbane
+ - Canberra
+ - Australia/Canberra
+ - Guam
+ - Pacific/Guam
+ - Hobart
+ - Australia/Hobart
+ - Melbourne
+ - Australia/Melbourne
+ - Port Moresby
+ - Pacific/Port_Moresby
+ - Sydney
+ - Australia/Sydney
+ - Vladivostok
+ - Asia/Vladivostok
+ - Magadan
+ - Asia/Magadan
+ - New Caledonia
+ - Pacific/Noumea
+ - Solomon Is.
+ - Pacific/Guadalcanal
+ - Srednekolymsk
+ - Asia/Srednekolymsk
+ - Auckland
+ - Pacific/Auckland
+ - Fiji
+ - Pacific/Fiji
+ - Kamchatka
+ - Asia/Kamchatka
+ - Marshall Is.
+ - Pacific/Majuro
+ - Wellington
+ - Pacific/Auckland
+ - Chatham Is.
+ - Pacific/Chatham
+ - Nuku'alofa
+ - Pacific/Tongatapu
+ - Samoa
+ - Pacific/Apia
+ - Tokelau Is.
+ - Pacific/Fakaofo
+ nullable: true
+ type: string
+ time_restrictions:
+ description: "If time restrictions are set, alerts will follow this path\
+ \ when they arrive within the specified time ranges and meet the rules."
+ items:
+ $ref: '#/components/schemas/new_escalation_policy_path_data_attributes_time_restrictions_inner'
type: array
+ required:
+ - name
type: object
- update_escalation_policy_path_data:
+ new_escalation_policy_path_data:
properties:
type:
enum:
- escalation_paths
type: string
attributes:
- $ref: '#/components/schemas/update_escalation_policy_path_data_attributes'
+ $ref: '#/components/schemas/new_escalation_policy_path_data_attributes'
required:
- attributes
- type
type: object
- escalation_policy_path_rules_inner_anyOf:
+ update_escalation_policy_path_data_attributes_rules_inner:
+ nullable: true
+ oneOf:
+ - $ref: '#/components/schemas/new_escalation_policy_path_data_attributes_rules_inner_oneOf'
+ - $ref: '#/components/schemas/new_escalation_policy_path_data_attributes_rules_inner_oneOf_1'
+ - $ref: '#/components/schemas/new_escalation_policy_path_data_attributes_rules_inner_oneOf_2'
+ - $ref: '#/components/schemas/new_escalation_policy_path_data_attributes_rules_inner_oneOf_3'
+ - $ref: '#/components/schemas/new_escalation_policy_path_data_attributes_rules_inner_oneOf_4'
+ - $ref: '#/components/schemas/new_escalation_policy_path_data_attributes_rules_inner_oneOf_5'
+ type: object
+ update_escalation_policy_path_data_attributes_time_restrictions_inner:
properties:
- rule_type:
- description: The type of the escalation path rule
+ start_day:
enum:
- - alert_urgency
+ - monday
+ - tuesday
+ - wednesday
+ - thursday
+ - friday
+ - saturday
+ - sunday
type: string
- urgency_ids:
- description: Alert urgency ids for which this escalation path should be
- used
+ start_time:
+ description: Formatted as HH:MM
+ type: string
+ end_day:
+ enum:
+ - monday
+ - tuesday
+ - wednesday
+ - thursday
+ - friday
+ - saturday
+ - sunday
+ type: string
+ end_time:
+ description: Formatted as HH:MM
+ type: string
+ type: object
+ update_escalation_policy_path_data_attributes:
+ additionalProperties: false
+ properties:
+ name:
+ description: The name of the escalation path
+ type: string
+ notification_type:
+ default: audible
+ description: Position of the escalation policy level
+ enum:
+ - audible
+ - quiet
+ type: string
+ path_type:
+ description: The type of escalation path. Cannot be changed after creation.
+ enum:
+ - escalation
+ - deferral
+ type: string
+ after_deferral_behavior:
+ description: What happens after a deferral path finishes.
+ enum:
+ - re_evaluate
+ - execute_path
+ nullable: true
+ type: string
+ after_deferral_path_id:
+ description: The escalation path to execute after this deferral path when
+ after_deferral_behavior is execute_path.
+ nullable: true
+ type: string
+ default:
+ description: Whether this escalation path is the default path
+ nullable: true
+ type: boolean
+ match_mode:
+ default: match-all-rules
+ description: How path rules are matched.
+ enum:
+ - match-all-rules
+ - match-any-rule
+ type: string
+ position:
+ description: The position of this path in the paths for this EP.
+ type: integer
+ repeat:
+ description: Whether this path should be repeated until someone acknowledges
+ the alert
+ nullable: true
+ type: boolean
+ repeat_count:
+ description: The number of times this path will be executed until someone
+ acknowledges the alert
+ nullable: true
+ type: integer
+ initial_delay:
+ description: Initial delay for escalation path in minutes. Maximum 1 week
+ (10080).
+ type: integer
+ rules:
+ description: Escalation path conditions
items:
- type: string
+ $ref: '#/components/schemas/update_escalation_policy_path_data_attributes_rules_inner'
+ type: array
+ time_restriction_time_zone:
+ description: Time zone used for time restrictions.
+ enum:
+ - International Date Line West
+ - Etc/GMT+12
+ - American Samoa
+ - Pacific/Pago_Pago
+ - Midway Island
+ - Pacific/Midway
+ - Hawaii
+ - Pacific/Honolulu
+ - Alaska
+ - America/Juneau
+ - Pacific Time (US & Canada)
+ - America/Los_Angeles
+ - Tijuana
+ - America/Tijuana
+ - Arizona
+ - America/Phoenix
+ - Mazatlan
+ - America/Mazatlan
+ - Mountain Time (US & Canada)
+ - America/Denver
+ - Central America
+ - America/Guatemala
+ - Central Time (US & Canada)
+ - America/Chicago
+ - Chihuahua
+ - America/Chihuahua
+ - Guadalajara
+ - America/Mexico_City
+ - Mexico City
+ - America/Mexico_City
+ - Monterrey
+ - America/Monterrey
+ - Saskatchewan
+ - America/Regina
+ - Bogota
+ - America/Bogota
+ - Eastern Time (US & Canada)
+ - America/New_York
+ - Indiana (East)
+ - America/Indiana/Indianapolis
+ - Lima
+ - America/Lima
+ - Quito
+ - America/Lima
+ - Atlantic Time (Canada)
+ - America/Halifax
+ - Caracas
+ - America/Caracas
+ - Georgetown
+ - America/Guyana
+ - La Paz
+ - America/La_Paz
+ - Puerto Rico
+ - America/Puerto_Rico
+ - Santiago
+ - America/Santiago
+ - Newfoundland
+ - America/St_Johns
+ - Asuncion
+ - America/Asuncion
+ - Brasilia
+ - America/Sao_Paulo
+ - Buenos Aires
+ - America/Argentina/Buenos_Aires
+ - Montevideo
+ - America/Montevideo
+ - Greenland
+ - America/Nuuk
+ - Mid-Atlantic
+ - Atlantic/South_Georgia
+ - Azores
+ - Atlantic/Azores
+ - Cape Verde Is.
+ - Atlantic/Cape_Verde
+ - Edinburgh
+ - Europe/London
+ - Lisbon
+ - Europe/Lisbon
+ - London
+ - Europe/London
+ - Monrovia
+ - Africa/Monrovia
+ - UTC
+ - Etc/UTC
+ - Amsterdam
+ - Europe/Amsterdam
+ - Belgrade
+ - Europe/Belgrade
+ - Berlin
+ - Europe/Berlin
+ - Bern
+ - Europe/Zurich
+ - Bratislava
+ - Europe/Bratislava
+ - Brussels
+ - Europe/Brussels
+ - Budapest
+ - Europe/Budapest
+ - Casablanca
+ - Africa/Casablanca
+ - Copenhagen
+ - Europe/Copenhagen
+ - Dublin
+ - Europe/Dublin
+ - Ljubljana
+ - Europe/Ljubljana
+ - Madrid
+ - Europe/Madrid
+ - Paris
+ - Europe/Paris
+ - Prague
+ - Europe/Prague
+ - Rome
+ - Europe/Rome
+ - Sarajevo
+ - Europe/Sarajevo
+ - Skopje
+ - Europe/Skopje
+ - Stockholm
+ - Europe/Stockholm
+ - Vienna
+ - Europe/Vienna
+ - Warsaw
+ - Europe/Warsaw
+ - West Central Africa
+ - Africa/Algiers
+ - Zagreb
+ - Europe/Zagreb
+ - Zurich
+ - Europe/Zurich
+ - Athens
+ - Europe/Athens
+ - Bucharest
+ - Europe/Bucharest
+ - Cairo
+ - Africa/Cairo
+ - Harare
+ - Africa/Harare
+ - Helsinki
+ - Europe/Helsinki
+ - Jerusalem
+ - Asia/Jerusalem
+ - Kaliningrad
+ - Europe/Kaliningrad
+ - Kyiv
+ - Europe/Kiev
+ - Pretoria
+ - Africa/Johannesburg
+ - Riga
+ - Europe/Riga
+ - Sofia
+ - Europe/Sofia
+ - Tallinn
+ - Europe/Tallinn
+ - Vilnius
+ - Europe/Vilnius
+ - Baghdad
+ - Asia/Baghdad
+ - Istanbul
+ - Europe/Istanbul
+ - Kuwait
+ - Asia/Kuwait
+ - Minsk
+ - Europe/Minsk
+ - Moscow
+ - Europe/Moscow
+ - Nairobi
+ - Africa/Nairobi
+ - Riyadh
+ - Asia/Riyadh
+ - St. Petersburg
+ - Europe/Moscow
+ - Volgograd
+ - Europe/Volgograd
+ - Tehran
+ - Asia/Tehran
+ - Abu Dhabi
+ - Asia/Muscat
+ - Baku
+ - Asia/Baku
+ - Muscat
+ - Asia/Muscat
+ - Samara
+ - Europe/Samara
+ - Tbilisi
+ - Asia/Tbilisi
+ - Yerevan
+ - Asia/Yerevan
+ - Kabul
+ - Asia/Kabul
+ - Almaty
+ - Asia/Almaty
+ - Astana
+ - Asia/Almaty
+ - Ekaterinburg
+ - Asia/Yekaterinburg
+ - Islamabad
+ - Asia/Karachi
+ - Karachi
+ - Asia/Karachi
+ - Tashkent
+ - Asia/Tashkent
+ - Chennai
+ - Asia/Kolkata
+ - Kolkata
+ - Asia/Kolkata
+ - Mumbai
+ - Asia/Kolkata
+ - New Delhi
+ - Asia/Kolkata
+ - Sri Jayawardenepura
+ - Asia/Colombo
+ - Kathmandu
+ - Asia/Kathmandu
+ - Dhaka
+ - Asia/Dhaka
+ - Urumqi
+ - Asia/Urumqi
+ - Rangoon
+ - Asia/Rangoon
+ - Bangkok
+ - Asia/Bangkok
+ - Hanoi
+ - Asia/Bangkok
+ - Jakarta
+ - Asia/Jakarta
+ - Krasnoyarsk
+ - Asia/Krasnoyarsk
+ - Novosibirsk
+ - Asia/Novosibirsk
+ - Beijing
+ - Asia/Shanghai
+ - Chongqing
+ - Asia/Chongqing
+ - Hong Kong
+ - Asia/Hong_Kong
+ - Irkutsk
+ - Asia/Irkutsk
+ - Kuala Lumpur
+ - Asia/Kuala_Lumpur
+ - Perth
+ - Australia/Perth
+ - Singapore
+ - Asia/Singapore
+ - Taipei
+ - Asia/Taipei
+ - Ulaanbaatar
+ - Asia/Ulaanbaatar
+ - Osaka
+ - Asia/Tokyo
+ - Sapporo
+ - Asia/Tokyo
+ - Seoul
+ - Asia/Seoul
+ - Tokyo
+ - Asia/Tokyo
+ - Yakutsk
+ - Asia/Yakutsk
+ - Adelaide
+ - Australia/Adelaide
+ - Darwin
+ - Australia/Darwin
+ - Brisbane
+ - Australia/Brisbane
+ - Canberra
+ - Australia/Canberra
+ - Guam
+ - Pacific/Guam
+ - Hobart
+ - Australia/Hobart
+ - Melbourne
+ - Australia/Melbourne
+ - Port Moresby
+ - Pacific/Port_Moresby
+ - Sydney
+ - Australia/Sydney
+ - Vladivostok
+ - Asia/Vladivostok
+ - Magadan
+ - Asia/Magadan
+ - New Caledonia
+ - Pacific/Noumea
+ - Solomon Is.
+ - Pacific/Guadalcanal
+ - Srednekolymsk
+ - Asia/Srednekolymsk
+ - Auckland
+ - Pacific/Auckland
+ - Fiji
+ - Pacific/Fiji
+ - Kamchatka
+ - Asia/Kamchatka
+ - Marshall Is.
+ - Pacific/Majuro
+ - Wellington
+ - Pacific/Auckland
+ - Chatham Is.
+ - Pacific/Chatham
+ - Nuku'alofa
+ - Pacific/Tongatapu
+ - Samoa
+ - Pacific/Apia
+ - Tokelau Is.
+ - Pacific/Fakaofo
+ nullable: true
+ type: string
+ time_restrictions:
+ description: "If time restrictions are set, alerts will follow this path\
+ \ when they arrive within the specified time ranges and meet the rules."
+ items:
+ $ref: '#/components/schemas/update_escalation_policy_path_data_attributes_time_restrictions_inner'
type: array
+ type: object
+ update_escalation_policy_path_data:
+ properties:
+ type:
+ enum:
+ - escalation_paths
+ type: string
+ attributes:
+ $ref: '#/components/schemas/update_escalation_policy_path_data_attributes'
required:
- - rule_type
- - urgency_ids
- escalation_policy_path_rules_inner:
- anyOf:
- - $ref: '#/components/schemas/escalation_policy_path_rules_inner_anyOf'
- - $ref: '#/components/schemas/new_escalation_policy_path_data_attributes_rules_inner_anyOf_1'
- - $ref: '#/components/schemas/new_escalation_policy_path_data_attributes_rules_inner_anyOf_2'
- nullable: true
+ - attributes
+ - type
type: object
escalation_policy_path_response_data:
properties:
@@ -54488,12 +48328,13 @@ components:
additionalProperties: false
properties:
delay:
- description: Delay before notification targets will be alerted.
+ description: Delay before notifying targets in the next Escalation Level.
type: integer
position:
description: Position of the escalation policy level
type: integer
paging_strategy_configuration_strategy:
+ default: default
enum:
- default
- random
@@ -54502,6 +48343,7 @@ components:
nullable: true
type: string
paging_strategy_configuration_schedule_strategy:
+ default: on_call_only
enum:
- on_call_only
- everyone
@@ -54566,7 +48408,7 @@ components:
additionalProperties: false
properties:
delay:
- description: Delay before notification targets will be alerted.
+ description: Delay before notifying targets in the next Escalation Level.
type: integer
position:
description: Position of the escalation policy level
@@ -54578,6 +48420,7 @@ components:
nullable: true
type: string
paging_strategy_configuration_strategy:
+ default: default
enum:
- default
- random
@@ -54586,6 +48429,7 @@ components:
nullable: true
type: string
paging_strategy_configuration_schedule_strategy:
+ default: on_call_only
enum:
- on_call_only
- everyone
@@ -54646,15 +48490,15 @@ components:
description: The ID of the form field
type: string
value:
- description: The value of the form_field_option
+ description: The value of the form field option
type: string
color:
- description: The hex color of the form_field_option
+ description: The hex color of the form field option
type: string
default:
type: boolean
position:
- description: The position of the form_field_option
+ description: The position of the form field option
type: integer
required:
- form_field_id
@@ -54676,15 +48520,15 @@ components:
additionalProperties: false
properties:
value:
- description: The value of the form_field_option
+ description: The value of the form field option
type: string
color:
- description: The hex color of the form_field_option
+ description: The hex color of the form field option
type: string
default:
type: boolean
position:
- description: The position of the form_field_option
+ description: The position of the form field option
type: integer
type: object
update_form_field_option_data:
@@ -54702,7 +48546,7 @@ components:
form_field_option_response_data:
properties:
id:
- description: Unique ID of the form_field_option
+ description: Unique ID of the form field option
type: string
type:
enum:
@@ -54735,6 +48579,7 @@ components:
description: The condition comparison.
enum:
- equal
+ - not_equal
- is_set
- is_not_set
type: string
@@ -54781,6 +48626,7 @@ components:
description: The condition comparison.
enum:
- equal
+ - not_equal
- is_set
- is_not_set
type: string
@@ -54849,6 +48695,9 @@ components:
- and
- or
type: string
+ non_editable:
+ description: Whether the field is read-only and cannot be edited by users.
+ type: boolean
required:
- form
- form_set_id
@@ -54894,6 +48743,9 @@ components:
- and
- or
type: string
+ non_editable:
+ description: Whether the field is read-only and cannot be edited by users.
+ type: boolean
type: object
update_form_field_placement_data:
properties:
@@ -55067,6 +48919,7 @@ components:
- mitigated_at
- resolved_at
- closed_at
+ - custom_sub_status
- manual_starting_datetime_field
type: string
input_kind:
@@ -55092,6 +48945,9 @@ components:
- functionality
- user
- catalog_entity
+ - environment
+ - cause
+ - incident_type
type: string
value_kind_catalog_id:
description: The ID of the catalog used when value_kind is `catalog_entity`
@@ -55141,6 +48997,11 @@ components:
description: The default values.
type: string
type: array
+ auto_set_by_catalog_property_id:
+ description: Catalog property ID to auto-set this form field. Only reference-kind
+ catalog properties are supported.
+ nullable: true
+ type: string
required:
- kind
- name
@@ -55191,6 +49052,7 @@ components:
- mitigated_at
- resolved_at
- closed_at
+ - custom_sub_status
- manual_starting_datetime_field
type: string
input_kind:
@@ -55216,6 +49078,9 @@ components:
- functionality
- user
- catalog_entity
+ - environment
+ - cause
+ - incident_type
type: string
value_kind_catalog_id:
description: The ID of the catalog used when value_kind is `catalog_entity`
@@ -55265,6 +49130,11 @@ components:
description: The default values.
type: string
type: array
+ auto_set_by_catalog_property_id:
+ description: Catalog property ID to auto-set this form field. Only reference-kind
+ catalog properties are supported.
+ nullable: true
+ type: string
type: object
update_form_field_data:
properties:
@@ -55560,18 +49430,22 @@ components:
type: string
nullable: true
type: array
- owners_group_ids:
+ owner_group_ids:
description: Owner Teams associated with this functionality
items:
type: string
nullable: true
type: array
- owners_user_ids:
+ owner_user_ids:
description: Owner Users associated with this functionality
items:
type: integer
nullable: true
type: array
+ escalation_policy_id:
+ description: The escalation policy id of the functionality
+ nullable: true
+ type: string
slack_channels:
description: Slack Channels associated with this functionality
items:
@@ -55584,6 +49458,11 @@ components:
$ref: '#/components/schemas/new_environment_data_attributes_slack_aliases_inner'
nullable: true
type: array
+ properties:
+ description: Array of property values for this functionality.
+ items:
+ $ref: '#/components/schemas/new_cause_data_attributes_properties_inner'
+ type: array
required:
- name
type: object
@@ -55668,18 +49547,22 @@ components:
type: string
nullable: true
type: array
- owners_group_ids:
+ owner_group_ids:
description: Owner Teams associated with this functionality
items:
type: string
nullable: true
type: array
- owners_user_ids:
+ owner_user_ids:
description: Owner Users associated with this functionality
items:
type: integer
nullable: true
type: array
+ escalation_policy_id:
+ description: The escalation policy id of the functionality
+ nullable: true
+ type: string
slack_channels:
description: Slack Channels associated with this functionality
items:
@@ -55692,6 +49575,11 @@ components:
$ref: '#/components/schemas/new_environment_data_attributes_slack_aliases_inner'
nullable: true
type: array
+ properties:
+ description: Array of property values for this functionality.
+ items:
+ $ref: '#/components/schemas/new_cause_data_attributes_properties_inner'
+ type: array
type: object
update_functionality_data:
properties:
@@ -55762,6 +49650,22 @@ components:
name:
type: string
type: object
+ create_coda_page_task_params_doc:
+ description: The Coda doc object with id and name
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ type: object
+ create_github_issue_task_params_issue_type:
+ description: The issue type
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ type: object
create_incident_postmortem_task_params_template:
description: Retrospective template to use
nullable: true
@@ -55827,6 +49731,13 @@ components:
name:
type: string
type: object
+ create_microsoft_teams_chat_task_params_members_inner:
+ properties:
+ email:
+ type: string
+ name:
+ type: string
+ type: object
create_notion_page_task_params_parent_page:
description: The parent page id and display name
properties:
@@ -55835,6 +49746,22 @@ components:
name:
type: string
type: object
+ update_confluence_page_task_params_template:
+ description: The Confluence template to use
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ type: object
+ update_datadog_notebook_task_params_template:
+ description: The Datadog notebook template to use
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ type: object
create_service_now_incident_task_params_completion:
description: The completion id and display name
properties:
@@ -55876,15 +49803,32 @@ components:
name:
type: string
type: object
- genius_create_openai_chat_completion_task_params_model:
- description: "The OpenAI model. eg: gpt-4o-mini"
+ update_github_issue_task_params_repository:
+ description: The repository (used for loading labels and issue types)
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ type: object
+ update_linear_issue_task_params_state:
+ description: The state id and display name
+ nullable: true
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ type: object
+ create_openai_chat_completion_task_params_model:
+ description: "The OpenAI model. eg: gpt-5-nano"
properties:
id:
type: string
name:
type: string
type: object
- genius_create_watsonx_chat_completion_task_params_model:
+ create_watsonx_chat_completion_task_params_model:
description: "The WatsonX model. eg: ibm/granite-3-b8b-instruct"
properties:
id:
@@ -55892,6 +49836,30 @@ components:
name:
type: string
type: object
+ create_google_gemini_chat_completion_task_params_model:
+ description: "The Gemini model. eg: gemini-2.0-flash"
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ type: object
+ create_mistral_chat_completion_task_params_model:
+ description: "The Mistral model. eg: mistral-large-latest"
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ type: object
+ create_anthropic_chat_completion_task_params_model:
+ description: "The Anthropic model. eg: claude-3-5-sonnet-20241022"
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ type: object
new_workflow_task_data_attributes_task_params:
oneOf:
- $ref: '#/components/schemas/add_action_item_task_params'
@@ -55933,6 +49901,7 @@ components:
- $ref: '#/components/schemas/create_google_meeting_task_params'
- $ref: '#/components/schemas/create_go_to_meeting_task_params'
- $ref: '#/components/schemas/create_incident_task_params'
+ - $ref: '#/components/schemas/create_sub_incident_task_params'
- $ref: '#/components/schemas/create_incident_postmortem_task_params'
- $ref: '#/components/schemas/create_jira_issue_task_params'
- $ref: '#/components/schemas/create_jira_subtask_task_params'
@@ -55941,14 +49910,22 @@ components:
- $ref: '#/components/schemas/create_linear_issue_comment_task_params'
- $ref: '#/components/schemas/create_microsoft_teams_meeting_task_params'
- $ref: '#/components/schemas/create_microsoft_teams_channel_task_params'
+ - $ref: '#/components/schemas/create_microsoft_teams_chat_task_params'
- $ref: '#/components/schemas/add_microsoft_teams_tab_task_params'
+ - $ref: '#/components/schemas/add_microsoft_teams_chat_tab_task_params'
- $ref: '#/components/schemas/archive_microsoft_teams_channels_task_params'
- $ref: '#/components/schemas/rename_microsoft_teams_channel_task_params'
- $ref: '#/components/schemas/invite_to_microsoft_teams_channel_task_params'
- $ref: '#/components/schemas/create_notion_page_task_params'
- $ref: '#/components/schemas/send_microsoft_teams_message_task_params'
+ - $ref: '#/components/schemas/send_microsoft_teams_chat_message_task_params'
- $ref: '#/components/schemas/send_microsoft_teams_blocks_task_params'
- $ref: '#/components/schemas/update_notion_page_task_params'
+ - $ref: '#/components/schemas/update_quip_page_task_params'
+ - $ref: '#/components/schemas/update_confluence_page_task_params'
+ - $ref: '#/components/schemas/update_sharepoint_page_task_params'
+ - $ref: '#/components/schemas/update_dropbox_paper_page_task_params'
+ - $ref: '#/components/schemas/update_datadog_notebook_task_params'
- $ref: '#/components/schemas/create_service_now_incident_task_params'
- $ref: '#/components/schemas/create_shortcut_story_task_params'
- $ref: '#/components/schemas/create_shortcut_task_task_params'
@@ -55971,6 +49948,8 @@ components:
- $ref: '#/components/schemas/invite_to_slack_channel_victor_ops_task_params'
- $ref: '#/components/schemas/page_opsgenie_on_call_responders_task_params'
- $ref: '#/components/schemas/create_opsgenie_alert_task_params'
+ - $ref: '#/components/schemas/create_jsmops_alert_task_params'
+ - $ref: '#/components/schemas/page_jsmops_on_call_responders_task_params'
- $ref: '#/components/schemas/update_opsgenie_alert_task_params'
- $ref: '#/components/schemas/update_opsgenie_incident_task_params'
- $ref: '#/components/schemas/page_rootly_on_call_responders_task_params'
@@ -56015,8 +49994,11 @@ components:
- $ref: '#/components/schemas/update_attached_alerts_task_params'
- $ref: '#/components/schemas/trigger_workflow_task_params'
- $ref: '#/components/schemas/send_slack_blocks_task_params'
- - $ref: '#/components/schemas/genius_create_openai_chat_completion_task_params'
- - $ref: '#/components/schemas/genius_create_watsonx_chat_completion_task_params'
+ - $ref: '#/components/schemas/create_openai_chat_completion_task_params'
+ - $ref: '#/components/schemas/create_watsonx_chat_completion_task_params'
+ - $ref: '#/components/schemas/create_google_gemini_chat_completion_task_params'
+ - $ref: '#/components/schemas/create_mistral_chat_completion_task_params'
+ - $ref: '#/components/schemas/create_anthropic_chat_completion_task_params'
new_workflow_task_data_attributes:
additionalProperties: false
properties:
@@ -56091,6 +50073,7 @@ components:
- $ref: '#/components/schemas/create_google_meeting_task_params'
- $ref: '#/components/schemas/create_go_to_meeting_task_params'
- $ref: '#/components/schemas/create_incident_task_params'
+ - $ref: '#/components/schemas/create_sub_incident_task_params'
- $ref: '#/components/schemas/create_incident_postmortem_task_params'
- $ref: '#/components/schemas/create_jira_issue_task_params'
- $ref: '#/components/schemas/create_jira_subtask_task_params'
@@ -56099,14 +50082,22 @@ components:
- $ref: '#/components/schemas/create_linear_issue_comment_task_params'
- $ref: '#/components/schemas/create_microsoft_teams_meeting_task_params'
- $ref: '#/components/schemas/create_microsoft_teams_channel_task_params'
+ - $ref: '#/components/schemas/create_microsoft_teams_chat_task_params'
- $ref: '#/components/schemas/add_microsoft_teams_tab_task_params'
+ - $ref: '#/components/schemas/add_microsoft_teams_chat_tab_task_params'
- $ref: '#/components/schemas/archive_microsoft_teams_channels_task_params'
- $ref: '#/components/schemas/rename_microsoft_teams_channel_task_params'
- $ref: '#/components/schemas/invite_to_microsoft_teams_channel_task_params'
- $ref: '#/components/schemas/create_notion_page_task_params'
- $ref: '#/components/schemas/send_microsoft_teams_message_task_params'
+ - $ref: '#/components/schemas/send_microsoft_teams_chat_message_task_params'
- $ref: '#/components/schemas/send_microsoft_teams_blocks_task_params'
- $ref: '#/components/schemas/update_notion_page_task_params'
+ - $ref: '#/components/schemas/update_quip_page_task_params'
+ - $ref: '#/components/schemas/update_confluence_page_task_params'
+ - $ref: '#/components/schemas/update_sharepoint_page_task_params'
+ - $ref: '#/components/schemas/update_dropbox_paper_page_task_params'
+ - $ref: '#/components/schemas/update_datadog_notebook_task_params'
- $ref: '#/components/schemas/create_service_now_incident_task_params'
- $ref: '#/components/schemas/create_shortcut_story_task_params'
- $ref: '#/components/schemas/create_shortcut_task_task_params'
@@ -56129,6 +50120,8 @@ components:
- $ref: '#/components/schemas/invite_to_slack_channel_victor_ops_task_params'
- $ref: '#/components/schemas/page_opsgenie_on_call_responders_task_params'
- $ref: '#/components/schemas/create_opsgenie_alert_task_params'
+ - $ref: '#/components/schemas/create_jsmops_alert_task_params'
+ - $ref: '#/components/schemas/page_jsmops_on_call_responders_task_params'
- $ref: '#/components/schemas/update_opsgenie_alert_task_params'
- $ref: '#/components/schemas/update_opsgenie_incident_task_params'
- $ref: '#/components/schemas/page_rootly_on_call_responders_task_params'
@@ -56173,8 +50166,11 @@ components:
- $ref: '#/components/schemas/update_attached_alerts_task_params'
- $ref: '#/components/schemas/trigger_workflow_task_params'
- $ref: '#/components/schemas/send_slack_blocks_task_params'
- - $ref: '#/components/schemas/genius_create_openai_chat_completion_task_params'
- - $ref: '#/components/schemas/genius_create_watsonx_chat_completion_task_params'
+ - $ref: '#/components/schemas/create_openai_chat_completion_task_params'
+ - $ref: '#/components/schemas/create_watsonx_chat_completion_task_params'
+ - $ref: '#/components/schemas/create_google_gemini_chat_completion_task_params'
+ - $ref: '#/components/schemas/create_mistral_chat_completion_task_params'
+ - $ref: '#/components/schemas/create_anthropic_chat_completion_task_params'
update_workflow_task_data_attributes:
additionalProperties: false
properties:
@@ -56238,6 +50234,7 @@ components:
description: The trigger condition
enum:
- IS
+ - IS NOT
- ANY
- CONTAINS
- CONTAINS_ALL
@@ -56280,6 +50277,7 @@ components:
description: The trigger condition
enum:
- IS
+ - IS NOT
- ANY
- CONTAINS
- CONTAINS_ALL
@@ -56343,6 +50341,7 @@ components:
description: The trigger condition
enum:
- IS
+ - IS NOT
- ANY
- CONTAINS
- CONTAINS_ALL
@@ -56388,6 +50387,21 @@ components:
description: The selected user id for select and multi_select kinds
type: integer
type: array
+ selected_cause_ids:
+ items:
+ description: The selected causes for select and multi_select kinds
+ type: string
+ type: array
+ selected_environment_ids:
+ items:
+ description: The selected environments for select and multi_select kinds
+ type: string
+ type: array
+ selected_incident_type_ids:
+ items:
+ description: The selected incident types for select and multi_select kinds
+ type: string
+ type: array
required:
- form_field_id
- incident_condition
@@ -56412,6 +50426,7 @@ components:
description: The trigger condition
enum:
- IS
+ - IS NOT
- ANY
- CONTAINS
- CONTAINS_ALL
@@ -56457,6 +50472,21 @@ components:
description: The selected user id for select and multi_select kinds
type: integer
type: array
+ selected_cause_ids:
+ items:
+ description: The selected causes for select and multi_select kinds
+ type: string
+ type: array
+ selected_environment_ids:
+ items:
+ description: The selected environments for select and multi_select kinds
+ type: string
+ type: array
+ selected_incident_type_ids:
+ items:
+ description: The selected incident types for select and multi_select kinds
+ type: string
+ type: array
type: object
update_workflow_form_field_condition_data:
properties:
@@ -56760,9 +50790,6 @@ components:
name:
description: The title of the workflow
type: string
- slug:
- description: The slug of the workflow
- type: string
description:
description: The description of the workflow
nullable: true
@@ -56885,15 +50912,75 @@ components:
- attributes
- type
type: object
+ alert_trigger_params_alert_field_conditions_inner:
+ properties:
+ alert_field_id:
+ type: string
+ condition_type:
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
+ type: string
+ values:
+ items:
+ type: string
+ type: array
+ required:
+ - alert_field_id
+ - condition_type
+ type: object
+ alert_trigger_params_alert_payload_conditions_conditions_inner:
+ properties:
+ query:
+ type: string
+ operator:
+ enum:
+ - IS
+ - IS NOT
+ - ANY
+ - CONTAINS
+ - CONTAINS_ALL
+ - CONTAINS_NONE
+ - NONE
+ - SET
+ - UNSET
+ type: string
+ values:
+ items:
+ type: string
+ type: array
+ use_regexp:
+ type: boolean
+ required:
+ - operator
+ - query
+ type: object
+ alert_trigger_params_alert_payload_conditions:
+ properties:
+ logic:
+ enum:
+ - ALL
+ - ANY
+ - NONE
+ type: string
+ conditions:
+ items:
+ $ref: '#/components/schemas/alert_trigger_params_alert_payload_conditions_conditions_inner'
+ type: array
+ type: object
update_workflow_data_attributes:
additionalProperties: false
properties:
name:
description: The title of the workflow
type: string
- slug:
- description: The slug of the workflow
- type: string
description:
description: The description of the workflow
nullable: true
@@ -57011,18 +51098,42 @@ components:
- id
- type
type: object
- new_live_call_router_data_attributes_escalation_policy_trigger_params:
+ new_live_call_router_data_attributes_paging_targets_inner:
nullable: false
+ properties:
+ id:
+ description: The ID of paging target
+ type: string
+ type:
+ description: The type of the paging target. Please contact support if you
+ encounter issues using `functionality` as a target type.
+ enum:
+ - service
+ - team
+ - escalation_policy
+ - functionality
+ type: string
+ alert_urgency_id:
+ description: This is used in escalation paths to determine who to page
+ type: string
+ required:
+ - alert_urgency_id
+ - id
+ - type
+ type: object
+ new_live_call_router_data_attributes_escalation_policy_trigger_params:
properties:
id:
description: The ID of notification target
type: string
type:
- description: The type of the notification target
+ description: The type of the notification target. Please contact support
+ if you encounter issues using `functionality` as a target type.
enum:
- service
- group
- escalation_policy
+ - functionality
type: string
required:
- id
@@ -57046,17 +51157,21 @@ components:
country_code:
description: The country code of the live_call_router
enum:
- - US
- - GB
- - NZ
- - CA
- AU
+ - CA
+ - DE
+ - NL
+ - NZ
+ - SE
+ - GB
+ - US
type: string
phone_type:
description: The phone type of the live_call_router
enum:
- local
- toll_free
+ - mobile
type: string
phone_number:
description: "You can select a phone number using [generate_phone_number](#//api/v1/live_call_routers/generate_phone_number)\
@@ -57070,6 +51185,14 @@ components:
type: string
waiting_music_url:
description: The waiting music URL of the live_call_router
+ enum:
+ - https://storage.rootly.com/twilio/voicemail/ClockworkWaltz.mp3
+ - https://storage.rootly.com/twilio/voicemail/ith_brahms-116-4.mp3
+ - https://storage.rootly.com/twilio/voicemail/Mellotroniac_-_Flight_Of_Young_Hearts_Flute.mp3
+ - https://storage.rootly.com/twilio/voicemail/BusyStrings.mp3
+ - https://storage.rootly.com/twilio/voicemail/oldDog_-_endless_goodbye_%28instr.%29.mp3
+ - https://storage.rootly.com/twilio/voicemail/MARKOVICHAMP-Borghestral.mp3
+ - https://storage.rootly.com/twilio/voicemail/ith_chopin-15-2.mp3
type: string
sent_to_voicemail_delay:
description: The delay (seconds) after which the caller in redirected to
@@ -57087,15 +51210,31 @@ components:
alert_urgency_id:
description: This is used in escalation paths to determine who to page
type: string
+ calling_tree_enabled:
+ description: "Whether the live call router is configured as a phone tree,\
+ \ requiring callers to press a key before being connected"
+ type: boolean
+ calling_tree_prompt:
+ description: "The audio instructions callers will hear when they call this\
+ \ number, prompting them to select from available options to route their\
+ \ call"
+ type: string
+ paging_targets:
+ description: Paging targets that callers can select from when this live
+ call router is configured as a phone tree.
+ items:
+ $ref: '#/components/schemas/new_live_call_router_data_attributes_paging_targets_inner'
+ type: array
escalation_policy_trigger_params:
$ref: '#/components/schemas/new_live_call_router_data_attributes_escalation_policy_trigger_params'
required:
- country_code
- - escalation_policy_trigger_params
- kind
- name
+ - paging_targets
- phone_number
- phone_type
+ - voicemail_greeting
type: object
new_live_call_router_data:
properties:
@@ -57110,17 +51249,18 @@ components:
- type
type: object
update_live_call_router_data_attributes_escalation_policy_trigger_params:
- nullable: true
properties:
id:
description: The ID of notification target
type: string
type:
- description: The type of the notification target
+ description: The type of the notification target. Please contact support
+ if you encounter issues using `Functionality` as a target type.
enum:
- Service
- Group
- EscalationPolicy
+ - Functionality
type: string
required:
- id
@@ -57144,17 +51284,21 @@ components:
country_code:
description: The country code of the live_call_router
enum:
- - US
- - GB
- - NZ
- - CA
- AU
+ - CA
+ - DE
+ - NL
+ - NZ
+ - SE
+ - GB
+ - US
type: string
phone_type:
description: The phone type of the live_call_router
enum:
- local
- toll_free
+ - mobile
type: string
voicemail_greeting:
description: The voicemail greeting of the live_call_router
@@ -57164,6 +51308,14 @@ components:
type: string
waiting_music_url:
description: The waiting music URL of the live_call_router
+ enum:
+ - https://storage.rootly.com/twilio/voicemail/ClockworkWaltz.mp3
+ - https://storage.rootly.com/twilio/voicemail/ith_brahms-116-4.mp3
+ - https://storage.rootly.com/twilio/voicemail/Mellotroniac_-_Flight_Of_Young_Hearts_Flute.mp3
+ - https://storage.rootly.com/twilio/voicemail/BusyStrings.mp3
+ - https://storage.rootly.com/twilio/voicemail/oldDog_-_endless_goodbye_%28instr.%29.mp3
+ - https://storage.rootly.com/twilio/voicemail/MARKOVICHAMP-Borghestral.mp3
+ - https://storage.rootly.com/twilio/voicemail/ith_chopin-15-2.mp3
type: string
sent_to_voicemail_delay:
description: The delay (seconds) after which the caller in redirected to
@@ -57181,6 +51333,21 @@ components:
alert_urgency_id:
description: This is used in escalation paths to determine who to page
type: string
+ calling_tree_enabled:
+ description: "Whether the live call router is configured as a phone tree,\
+ \ requiring callers to press a key before being connected"
+ type: boolean
+ calling_tree_prompt:
+ description: "The audio instructions callers will hear when they call this\
+ \ number, prompting them to select from available options to route their\
+ \ call"
+ type: string
+ paging_targets:
+ description: Paging targets that callers can select from when this live
+ call router is configured as a phone tree.
+ items:
+ $ref: '#/components/schemas/new_live_call_router_data_attributes_paging_targets_inner'
+ type: array
escalation_policy_trigger_params:
$ref: '#/components/schemas/update_live_call_router_data_attributes_escalation_policy_trigger_params'
type: object
@@ -57227,6 +51394,10 @@ components:
alert_summary:
description: Summary of alerts triggered when heartbeat expires.
type: string
+ alert_description:
+ description: Description of alerts triggered when heartbeat expires.
+ nullable: true
+ type: string
alert_urgency_id:
description: Urgency of alerts triggered when heartbeat expires.
nullable: true
@@ -57235,18 +51406,21 @@ components:
type: integer
interval_unit:
enum:
- - seconds
- minutes
- hours
+ - days
type: string
notification_target_id:
type: string
notification_target_type:
+ description: The type of the notification target. Please contact support
+ if you encounter issues using `Functionality` as a target type.
enum:
- User
- Group
- Service
- EscalationPolicy
+ - Functionality
type: string
enabled:
description: Whether to trigger alerts when heartbeat is expired.
@@ -57284,6 +51458,10 @@ components:
alert_summary:
description: Summary of alerts triggered when heartbeat expires.
type: string
+ alert_description:
+ description: Description of alerts triggered when heartbeat expires.
+ nullable: true
+ type: string
alert_urgency_id:
description: Urgency of alerts triggered when heartbeat expires.
nullable: true
@@ -57292,18 +51470,21 @@ components:
type: integer
interval_unit:
enum:
- - seconds
- minutes
- hours
+ - days
type: string
notification_target_id:
type: string
notification_target_type:
+ description: The type of the notification target. Please contact support
+ if you encounter issues using `Functionality` as a target type.
enum:
- User
- Group
- Service
- EscalationPolicy
+ - Functionality
type: string
enabled:
description: Whether to trigger alerts when heartbeat is expired.
@@ -57387,6 +51568,10 @@ components:
description: The Jira issue ID.
nullable: true
type: string
+ jira_issue_key:
+ description: The Jira issue key.
+ nullable: true
+ type: string
jira_issue_url:
description: The Jira issue URL.
nullable: true
@@ -57455,6 +51640,10 @@ components:
description: The Jira issue ID.
nullable: true
type: string
+ jira_issue_key:
+ description: The Jira issue key.
+ nullable: true
+ type: string
jira_issue_url:
description: The Jira issue URL.
nullable: true
@@ -57913,6 +52102,21 @@ components:
description: The selected users for select and multi_select kinds
type: integer
type: array
+ selected_environment_ids:
+ items:
+ description: The selected environments for select and multi_select kinds
+ type: string
+ type: array
+ selected_cause_ids:
+ items:
+ description: The selected causes for select and multi_select kinds
+ type: string
+ type: array
+ selected_incident_type_ids:
+ items:
+ description: The selected incident types for select and multi_select kinds
+ type: string
+ type: array
required:
- form_field_id
- incident_id
@@ -57968,6 +52172,21 @@ components:
description: The selected users for select and multi_select kinds
type: integer
type: array
+ selected_environment_ids:
+ items:
+ description: The selected environments for select and multi_select kinds
+ type: string
+ type: array
+ selected_cause_ids:
+ items:
+ description: The selected causes for select and multi_select kinds
+ type: string
+ type: array
+ selected_incident_type_ids:
+ items:
+ description: The selected incident types for select and multi_select kinds
+ type: string
+ type: array
type: object
update_incident_form_field_selection_data:
properties:
@@ -58231,9 +52450,6 @@ components:
name:
description: The incident permission set name.
type: string
- slug:
- description: The incident permission set slug.
- type: string
description:
description: The incident permission set description.
nullable: true
@@ -58277,9 +52493,6 @@ components:
name:
description: The incident permission set name.
type: string
- slug:
- description: The incident permission set slug.
- type: string
description:
description: The incident permission set description.
nullable: true
@@ -58388,7 +52601,7 @@ components:
description: Show action items (follow-ups) in the incident retrospective
type: boolean
cause_ids:
- description: The Cause ID's to attach to the incident retrospective
+ description: The Cause IDs to attach to the incident retrospective
items:
type: string
nullable: true
@@ -58680,7 +52893,6 @@ components:
- resolved
- scheduled
- in_progress
- - verifying
- completed
type: string
notify_subscribers:
@@ -58727,7 +52939,6 @@ components:
- resolved
- scheduled
- in_progress
- - verifying
- completed
type: string
notify_subscribers:
@@ -58808,6 +53019,11 @@ components:
$ref: '#/components/schemas/new_environment_data_attributes_slack_aliases_inner'
nullable: true
type: array
+ properties:
+ description: Array of property values for this incident type.
+ items:
+ $ref: '#/components/schemas/new_cause_data_attributes_properties_inner'
+ type: array
required:
- name
type: object
@@ -58859,6 +53075,11 @@ components:
$ref: '#/components/schemas/new_environment_data_attributes_slack_aliases_inner'
nullable: true
type: array
+ properties:
+ description: Array of property values for this incident type.
+ items:
+ $ref: '#/components/schemas/new_cause_data_attributes_properties_inner'
+ type: array
type: object
update_incident_type_data:
properties:
@@ -58909,6 +53130,7 @@ components:
- normal_sub
- backfilled
- scheduled
+ - scheduled_sub
nullable: true
type: string
parent_incident_id:
@@ -58938,38 +53160,56 @@ components:
description: The Severity ID to attach to the incident
nullable: true
type: string
+ public_title:
+ description: The public title of the incident
+ nullable: true
+ type: string
+ alert_ids:
+ description: The Alert IDs to attach to the incident
+ items:
+ type: string
+ nullable: true
+ type: array
environment_ids:
- description: The Environment ID's to attach to the incident
+ description: The Environment IDs to attach to the incident
items:
type: string
nullable: true
type: array
incident_type_ids:
- description: The Incident Type ID's to attach to the incident
+ description: The Incident Type IDs to attach to the incident
items:
type: string
nullable: true
type: array
service_ids:
- description: The Service ID's to attach to the incident
+ description: The Service IDs to attach to the incident
items:
type: string
nullable: true
type: array
functionality_ids:
- description: The Functionality ID's to attach to the incident
+ description: The Functionality IDs to attach to the incident
items:
type: string
nullable: true
type: array
group_ids:
- description: The Team ID's to attach to the incident
+ description: The Team IDs to attach to the incident
items:
type: string
nullable: true
type: array
cause_ids:
- description: The Cause ID's to attach to the incident
+ description: The Cause IDs to attach to the incident
+ items:
+ type: string
+ nullable: true
+ type: array
+ muted_service_ids:
+ description: "The Service IDs to mute alerts for during maintenance. Alerts\
+ \ for these services will still be triggered and attached to the incident,\
+ \ but won't page responders."
items:
type: string
nullable: true
@@ -58983,6 +53223,38 @@ components:
description: Slack channel name
nullable: true
type: string
+ slack_channel_id:
+ description: Slack channel id
+ nullable: true
+ type: string
+ slack_channel_url:
+ description: Slack channel url
+ nullable: true
+ type: string
+ slack_channel_archived:
+ description: Whether the Slack channel is archived
+ nullable: true
+ type: boolean
+ google_drive_parent_id:
+ description: Google Drive parent folder ID
+ nullable: true
+ type: string
+ google_drive_url:
+ description: Google Drive URL
+ nullable: true
+ type: string
+ jira_issue_key:
+ description: Jira issue key
+ nullable: true
+ type: string
+ jira_issue_id:
+ description: Jira issue ID
+ nullable: true
+ type: string
+ jira_issue_url:
+ description: Jira issue URL
+ nullable: true
+ type: string
notify_emails:
description: Emails you want to notify
items:
@@ -59039,6 +53311,10 @@ components:
description: Date of resolution
nullable: true
type: string
+ closed_at:
+ description: Date of closure
+ nullable: true
+ type: string
cancelled_at:
description: Date of cancellation
nullable: true
@@ -59075,6 +53351,7 @@ components:
- normal_sub
- backfilled
- scheduled
+ - scheduled_sub
nullable: true
type: string
parent_incident_id:
@@ -59115,38 +53392,56 @@ components:
description: The Severity ID to attach to the incident
nullable: true
type: string
+ public_title:
+ description: The public title of the incident
+ nullable: true
+ type: string
+ alert_ids:
+ description: The Alert IDs to attach to the incident
+ items:
+ type: string
+ nullable: true
+ type: array
environment_ids:
- description: The Environment ID's to attach to the incident
+ description: The Environment IDs to attach to the incident
items:
type: string
nullable: true
type: array
incident_type_ids:
- description: The Incident Type ID's to attach to the incident
+ description: The Incident Type IDs to attach to the incident
items:
type: string
nullable: true
type: array
service_ids:
- description: The Service ID's to attach to the incident
+ description: The Service IDs to attach to the incident
items:
type: string
nullable: true
type: array
functionality_ids:
- description: The Functionality ID's to attach to the incident
+ description: The Functionality IDs to attach to the incident
+ items:
+ type: string
+ nullable: true
+ type: array
+ muted_service_ids:
+ description: "The Service IDs to mute alerts for during maintenance. Alerts\
+ \ for these services will still be triggered and attached to the incident,\
+ \ but won't page responders."
items:
type: string
nullable: true
type: array
group_ids:
- description: The Team ID's to attach to the incident
+ description: The Team IDs to attach to the incident
items:
type: string
nullable: true
type: array
cause_ids:
- description: The Cause ID's to attach to the incident
+ description: The Cause IDs to attach to the incident
items:
type: string
nullable: true
@@ -59168,6 +53463,30 @@ components:
description: Slack channel url
nullable: true
type: string
+ slack_channel_archived:
+ description: Whether the Slack channel is archived
+ nullable: true
+ type: boolean
+ google_drive_parent_id:
+ description: Google Drive parent folder ID
+ nullable: true
+ type: string
+ google_drive_url:
+ description: Google Drive URL
+ nullable: true
+ type: string
+ jira_issue_key:
+ description: Jira issue key
+ nullable: true
+ type: string
+ jira_issue_id:
+ description: Jira issue ID
+ nullable: true
+ type: string
+ jira_issue_url:
+ description: Jira issue URL
+ nullable: true
+ type: string
scheduled_for:
description: Date of when the maintenance begins
nullable: true
@@ -59200,10 +53519,26 @@ components:
description: Date of resolution
nullable: true
type: string
+ closed_at:
+ description: Date of closure
+ nullable: true
+ type: string
cancelled_at:
description: Date of cancellation
nullable: true
type: string
+ mitigation_message:
+ description: How was the incident mitigated?
+ nullable: true
+ type: string
+ resolution_message:
+ description: How was the incident resolved?
+ nullable: true
+ type: string
+ cancellation_message:
+ description: Why was the incident cancelled?
+ nullable: true
+ type: string
type: object
update_incident_data:
properties:
@@ -59431,6 +53766,19 @@ components:
- attributes
- type
type: object
+ incident_zoom_meeting_global_dial_in_numbers_inner:
+ properties:
+ country:
+ type: string
+ country_name:
+ type: string
+ city:
+ type: string
+ number:
+ type: string
+ type:
+ type: string
+ type: object
incident_response_data:
properties:
id:
@@ -59467,6 +53815,103 @@ components:
- id
- type
type: object
+ meeting_recording_list_data_inner:
+ properties:
+ id:
+ description: Unique UUID of the meeting recording
+ type: string
+ type:
+ enum:
+ - meeting_recordings
+ type: string
+ attributes:
+ allOf:
+ - $ref: '#/components/schemas/meeting_recording'
+ type: object
+ required:
+ - attributes
+ - id
+ - type
+ type: object
+ new_on_call_pay_report_data_attributes:
+ additionalProperties: false
+ properties:
+ start_date:
+ description: The start date for the report period.
+ format: date
+ type: string
+ end_date:
+ description: The end date for the report period.
+ format: date
+ type: string
+ schedule_ids:
+ description: List of schedule UUIDs to scope the report.
+ items:
+ type: string
+ type: array
+ required:
+ - end_date
+ - start_date
+ type: object
+ new_on_call_pay_report_data:
+ properties:
+ type:
+ enum:
+ - on_call_pay_reports
+ type: string
+ attributes:
+ $ref: '#/components/schemas/new_on_call_pay_report_data_attributes'
+ required:
+ - attributes
+ - type
+ type: object
+ update_on_call_pay_report_data_attributes:
+ additionalProperties: false
+ properties:
+ start_date:
+ description: The start date for the report period.
+ format: date
+ type: string
+ end_date:
+ description: The end date for the report period.
+ format: date
+ type: string
+ schedule_ids:
+ description: List of schedule UUIDs to scope the report.
+ items:
+ type: string
+ type: array
+ type: object
+ update_on_call_pay_report_data:
+ properties:
+ type:
+ enum:
+ - on_call_pay_reports
+ type: string
+ attributes:
+ $ref: '#/components/schemas/update_on_call_pay_report_data_attributes'
+ required:
+ - attributes
+ - type
+ type: object
+ on_call_pay_report_response_data:
+ properties:
+ id:
+ description: Unique ID of the on_call_pay_report
+ type: string
+ type:
+ enum:
+ - on_call_pay_reports
+ type: string
+ attributes:
+ allOf:
+ - $ref: '#/components/schemas/on_call_pay_report'
+ type: object
+ required:
+ - attributes
+ - id
+ - type
+ type: object
new_on_call_shadow_data_attributes:
additionalProperties: false
properties:
@@ -59597,9 +54042,6 @@ components:
name:
description: The role name.
type: string
- slug:
- description: The role slug.
- type: string
system_role:
description: The kind of role (user and custom type roles are only editable)
items:
@@ -59607,13 +54049,57 @@ components:
- admin
- user
- custom
+ - observer
- no_access
type: string
type: array
+ alert_fields_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ alert_groups_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ alert_routing_rules_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ on_call_readiness_report_permissions:
+ items:
+ enum:
+ - read
+ type: string
+ type: array
+ on_call_roles_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
alert_sources_permissions:
items:
enum:
- create
+ - read
- update
- delete
type: string
@@ -59633,6 +54119,7 @@ components:
- create
- update
- read
+ - delete
type: string
type: array
api_keys_permissions:
@@ -59758,7 +54245,6 @@ components:
type: array
required:
- name
- - system_role
type: object
new_on_call_role_data:
properties:
@@ -59778,9 +54264,6 @@ components:
name:
description: The role name.
type: string
- slug:
- description: The role slug.
- type: string
system_role:
description: The kind of role (user and custom type roles are only editable)
items:
@@ -59788,6 +54271,7 @@ components:
- admin
- user
- custom
+ - observer
- no_access
type: string
type: array
@@ -59795,6 +54279,7 @@ components:
items:
enum:
- create
+ - read
- update
- delete
type: string
@@ -59808,12 +54293,55 @@ components:
- delete
type: string
type: array
+ alert_fields_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ alert_groups_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ alert_routing_rules_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ on_call_readiness_report_permissions:
+ items:
+ enum:
+ - read
+ type: string
+ type: array
+ on_call_roles_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
alerts_permissions:
items:
enum:
- create
- update
- read
+ - delete
type: string
type: array
api_keys_permissions:
@@ -60149,37 +54677,37 @@ components:
nullable: true
type: string
severity_ids:
- description: The Severity ID's to attach to the incident
+ description: The Severity IDs to attach to the incident
items:
type: string
nullable: true
type: array
environment_ids:
- description: The Environment ID's to attach to the incident
+ description: The Environment IDs to attach to the incident
items:
type: string
nullable: true
type: array
service_ids:
- description: The Service ID's to attach to the incident
+ description: The Service IDs to attach to the incident
items:
type: string
nullable: true
type: array
functionality_ids:
- description: The Functionality ID's to attach to the incident
+ description: The Functionality IDs to attach to the incident
items:
type: string
nullable: true
type: array
group_ids:
- description: The Team ID's to attach to the incident
+ description: The Team IDs to attach to the incident
items:
type: string
nullable: true
type: array
incident_type_ids:
- description: The Incident Type ID's to attach to the incident
+ description: The Incident Type IDs to attach to the incident
items:
type: string
nullable: true
@@ -60214,37 +54742,37 @@ components:
nullable: true
type: string
severity_ids:
- description: The Severity ID's to attach to the incident
+ description: The Severity IDs to attach to the incident
items:
type: string
nullable: true
type: array
environment_ids:
- description: The Environment ID's to attach to the incident
+ description: The Environment IDs to attach to the incident
items:
type: string
nullable: true
type: array
service_ids:
- description: The Service ID's to attach to the incident
+ description: The Service IDs to attach to the incident
items:
type: string
nullable: true
type: array
functionality_ids:
- description: The Functionality ID's to attach to the incident
+ description: The Functionality IDs to attach to the incident
items:
type: string
nullable: true
type: array
group_ids:
- description: The Team ID's to attach to the incident
+ description: The Team IDs to attach to the incident
items:
type: string
nullable: true
type: array
incident_type_ids:
- description: The Incident Type ID's to attach to the incident
+ description: The Incident Type IDs to attach to the incident
items:
type: string
nullable: true
@@ -60291,7 +54819,9 @@ components:
nullable: true
type: boolean
content:
- description: The postmortem template. Liquid syntax is supported
+ description: "The postmortem template. Supports TipTap blocks (followup\
+ \ and timeline components), Liquid syntax, and HTML. Will be sanitized\
+ \ and applied to both content and content_html fields."
type: string
format:
default: html
@@ -60302,7 +54832,6 @@ components:
nullable: true
type: string
required:
- - content
- name
type: object
new_post_mortem_template_data:
@@ -60328,7 +54857,9 @@ components:
nullable: true
type: boolean
content:
- description: The postmortem template. Liquid syntax is supported
+ description: "The postmortem template. Supports TipTap blocks (followup\
+ \ and timeline components), Liquid syntax, and HTML. Will be sanitized\
+ \ and applied to both content and content_html fields."
type: string
format:
default: html
@@ -60351,6 +54882,37 @@ components:
- attributes
- type
type: object
+ tiptap_block_schema_followup_component:
+ description: Followup component block
+ properties:
+ html:
+ description: "HTML representation: "
+ example:
+ type: string
+ data_sort:
+ default: due_date
+ description: "Sort order for followups. Valid values: due_date, status,\
+ \ priority"
+ enum:
+ - due_date
+ - status
+ - priority
+ type: string
+ required:
+ - html
+ type: object
+ tiptap_block_schema_timeline_component:
+ description: Timeline component block
+ properties:
+ html:
+ description: "HTML representation: "
+ example:
+ type: string
+ required:
+ - html
+ type: object
post_mortem_template_response_data:
properties:
id:
@@ -60369,6 +54931,19 @@ components:
- id
- type
type: object
+ new_pulse_data_attributes_labels_inner:
+ nullable: true
+ properties:
+ key:
+ description: Key of the tag
+ type: string
+ value:
+ description: Value of the tag
+ type: string
+ required:
+ - key
+ - value
+ type: object
new_pulse_data_attributes_refs_inner:
nullable: true
properties:
@@ -60393,13 +54968,13 @@ components:
description: The summary of the pulse
type: string
service_ids:
- description: The Service ID's to attach to the pulse
+ description: The Service IDs to attach to the pulse
items:
type: string
nullable: true
type: array
environment_ids:
- description: The Environment ID's to attach to the pulse
+ description: The Environment IDs to attach to the pulse
items:
type: string
nullable: true
@@ -60420,7 +54995,7 @@ components:
type: string
labels:
items:
- $ref: '#/components/schemas/new_alert_data_attributes_labels_inner'
+ $ref: '#/components/schemas/new_pulse_data_attributes_labels_inner'
type: array
refs:
items:
@@ -60456,13 +55031,13 @@ components:
description: The summary of the pulse
type: string
service_ids:
- description: The Service ID's to attach to the pulse
+ description: The Service IDs to attach to the pulse
items:
type: string
nullable: true
type: array
environment_ids:
- description: The Environment ID's to attach to the pulse
+ description: The Environment IDs to attach to the pulse
items:
type: string
nullable: true
@@ -60483,7 +55058,7 @@ components:
type: string
labels:
items:
- $ref: '#/components/schemas/new_alert_data_attributes_labels_inner'
+ $ref: '#/components/schemas/new_pulse_data_attributes_labels_inner'
type: array
refs:
items:
@@ -60528,19 +55103,19 @@ components:
additionalProperties: false
properties:
severity_ids:
- description: The Severity ID's to attach to the retrospective configuration
+ description: The Severity IDs to attach to the retrospective configuration
items:
type: string
nullable: true
type: array
group_ids:
- description: The Team ID's to attach to the retrospective configuration
+ description: The Team IDs to attach to the retrospective configuration
items:
type: string
nullable: true
type: array
incident_type_ids:
- description: The Incident Type ID's to attach to the retrospective configuration
+ description: The Incident Type IDs to attach to the retrospective configuration
items:
type: string
nullable: true
@@ -60598,7 +55173,7 @@ components:
additionalProperties: false
properties:
severity_ids:
- description: Severity ID's for retrospective process matching criteria
+ description: Severity IDs for retrospective process matching criteria
items:
type: string
type: array
@@ -60609,7 +55184,7 @@ components:
additionalProperties: false
properties:
group_ids:
- description: Team ID's for retrospective process matching criteria
+ description: Team IDs for retrospective process matching criteria
items:
type: string
type: array
@@ -60620,7 +55195,7 @@ components:
additionalProperties: false
properties:
incident_type_ids:
- description: Incident type ID's for retrospective process matching criteria
+ description: Incident type IDs for retrospective process matching criteria
items:
type: string
type: array
@@ -60833,9 +55408,6 @@ components:
name:
description: The role name.
type: string
- slug:
- description: The role slug.
- type: string
incident_permission_set_id:
description: Associated incident permissions set.
nullable: true
@@ -61071,6 +55643,70 @@ components:
- delete
type: string
type: array
+ catalogs_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ sub_statuses_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ edge_connector_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ slas_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ paging_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ incident_communication_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ - send
+ type: string
+ type: array
+ communication_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
required:
- name
type: object
@@ -61092,13 +55728,16 @@ components:
name:
description: The role name.
type: string
- slug:
- description: The role slug.
- type: string
incident_permission_set_id:
description: Associated incident permissions set.
nullable: true
type: string
+ is_deletable:
+ description: Whether the role can be deleted.
+ type: boolean
+ is_editable:
+ description: Whether the role can be edited.
+ type: boolean
api_keys_permissions:
items:
enum:
@@ -61315,6 +55954,70 @@ components:
- delete
type: string
type: array
+ catalogs_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ sub_statuses_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ edge_connector_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ slas_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ paging_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
+ incident_communication_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ - send
+ type: string
+ type: array
+ communication_permissions:
+ items:
+ enum:
+ - create
+ - read
+ - update
+ - delete
+ type: string
+ type: array
type: object
update_role_data:
properties:
@@ -61609,6 +56312,24 @@ components:
- $ref: '#/components/schemas/new_schedule_rotation_data_attributes_schedule_rotationable_attributes_oneOf_2'
- $ref: '#/components/schemas/new_schedule_rotation_data_attributes_schedule_rotationable_attributes_oneOf_3'
type: object
+ new_schedule_rotation_data_attributes_schedule_rotation_members_inner:
+ properties:
+ member_type:
+ description: Type of member
+ enum:
+ - User
+ - Schedule
+ type: string
+ member_id:
+ description: ID of the member
+ type: string
+ position:
+ description: Position of the member in rotation
+ type: integer
+ required:
+ - member_id
+ - member_type
+ type: object
new_schedule_rotation_data_attributes:
additionalProperties: false
properties:
@@ -61665,79 +56386,117 @@ components:
type: string
schedule_rotationable_attributes:
$ref: '#/components/schemas/new_schedule_rotation_data_attributes_schedule_rotationable_attributes'
- required:
- - name
- - schedule_rotationable_attributes
- - schedule_rotationable_type
- type: object
- new_schedule_rotation_data:
- properties:
- type:
- enum:
- - schedule_rotations
- type: string
- attributes:
- $ref: '#/components/schemas/new_schedule_rotation_data_attributes'
- required:
- - attributes
- - type
- type: object
- update_schedule_rotation_data_attributes:
- additionalProperties: false
- properties:
- name:
- description: The name of the schedule rotation
+ start_time:
+ description: RFC3339 date-time when rotation starts. Shifts will only be
+ created after this time.
+ format: date-time
+ nullable: true
+ type: string
+ end_time:
+ description: RFC3339 date-time when rotation ends. Shifts will only be created
+ before this time.
+ format: date-time
+ nullable: true
+ type: string
+ schedule_rotation_members:
+ description: You can only add schedule rotation members if your account
+ has schedule nesting feature enabled
+ items:
+ $ref: '#/components/schemas/new_schedule_rotation_data_attributes_schedule_rotation_members_inner'
+ nullable: true
+ type: array
+ required:
+ - name
+ - schedule_rotationable_attributes
+ - schedule_rotationable_type
+ type: object
+ new_schedule_rotation_data:
+ properties:
+ type:
+ enum:
+ - schedule_rotations
+ type: string
+ attributes:
+ $ref: '#/components/schemas/new_schedule_rotation_data_attributes'
+ required:
+ - attributes
+ - type
+ type: object
+ update_schedule_rotation_data_attributes:
+ additionalProperties: false
+ properties:
+ name:
+ description: The name of the schedule rotation
+ type: string
+ position:
+ description: Position of the schedule rotation
+ type: integer
+ schedule_rotationable_type:
+ description: Schedule rotation type
+ enum:
+ - ScheduleDailyRotation
+ - ScheduleWeeklyRotation
+ - ScheduleBiweeklyRotation
+ - ScheduleMonthlyRotation
+ - ScheduleCustomRotation
+ type: string
+ active_all_week:
+ default: true
+ description: Schedule rotation active all week?
+ type: boolean
+ active_days:
+ items:
+ description: Schedule rotation active days
+ enum:
+ - S
+ - M
+ - T
+ - W
+ - R
+ - F
+ - U
+ type: string
+ type: array
+ active_time_type:
+ items:
+ default: all_day
+ description: Schedule rotation active time type
+ enum:
+ - all_day
+ - same_time
+ - custom
+ type: string
+ type: array
+ active_time_attributes:
+ description: Schedule rotation's active times
+ items:
+ $ref: '#/components/schemas/new_schedule_rotation_data_attributes_active_time_attributes_inner'
+ type: array
+ time_zone:
+ default: Etc/UTC
+ description: A valid IANA time zone name.
+ type: string
+ schedule_rotationable_attributes:
+ $ref: '#/components/schemas/new_schedule_rotation_data_attributes_schedule_rotationable_attributes'
+ start_time:
+ description: RFC3339 date-time when rotation starts. Shifts will only be
+ created after this time.
+ format: date-time
+ nullable: true
type: string
- position:
- description: Position of the schedule rotation
- type: integer
- schedule_rotationable_type:
- description: Schedule rotation type
- enum:
- - ScheduleDailyRotation
- - ScheduleWeeklyRotation
- - ScheduleBiweeklyRotation
- - ScheduleMonthlyRotation
- - ScheduleCustomRotation
+ end_time:
+ description: RFC3339 date-time when rotation ends. Shifts will only be created
+ before this time.
+ format: date-time
+ nullable: true
type: string
- active_all_week:
- default: true
- description: Schedule rotation active all week?
- type: boolean
- active_days:
- items:
- description: Schedule rotation active days
- enum:
- - S
- - M
- - T
- - W
- - R
- - F
- - U
- type: string
- type: array
- active_time_type:
- items:
- default: all_day
- description: Schedule rotation active time type
- enum:
- - all_day
- - same_time
- - custom
- type: string
- type: array
- active_time_attributes:
- description: Schedule rotation's active times
+ schedule_rotation_members:
+ description: You can only update schedule rotation members if your account
+ has schedule nesting feature enabled
items:
- $ref: '#/components/schemas/new_schedule_rotation_data_attributes_active_time_attributes_inner'
+ $ref: '#/components/schemas/new_schedule_rotation_data_attributes_schedule_rotation_members_inner'
+ nullable: true
type: array
- time_zone:
- default: Etc/UTC
- description: A valid IANA time zone name.
- type: string
- schedule_rotationable_attributes:
- $ref: '#/components/schemas/new_schedule_rotation_data_attributes_schedule_rotationable_attributes'
required:
- schedule_rotationable_type
type: object
@@ -61772,6 +56531,16 @@ components:
- type
type: object
new_schedule_data_attributes_slack_user_group:
+ properties:
+ id:
+ description: Slack user group ID
+ type: string
+ name:
+ description: Slack user group name
+ type: string
+ type: object
+ new_schedule_data_attributes_slack_channel:
+ nullable: true
properties:
id:
description: Slack channel ID
@@ -61796,6 +56565,8 @@ components:
type: boolean
slack_user_group:
$ref: '#/components/schemas/new_schedule_data_attributes_slack_user_group'
+ slack_channel:
+ $ref: '#/components/schemas/new_schedule_data_attributes_slack_channel'
owner_group_ids:
description: Owning teams.
items:
@@ -61803,10 +56574,18 @@ components:
type: array
owner_user_id:
description: ID of the owner of the schedule
- nullable: true
type: integer
+ shift_start_notifications_enabled:
+ description: Whether shift-start notifications are enabled
+ nullable: true
+ type: boolean
+ shift_update_notifications_enabled:
+ description: Whether shift-update notifications are enabled
+ nullable: true
+ type: boolean
required:
- name
+ - owner_user_id
type: object
new_schedule_data:
properties:
@@ -61836,6 +56615,8 @@ components:
type: boolean
slack_user_group:
$ref: '#/components/schemas/new_schedule_data_attributes_slack_user_group'
+ slack_channel:
+ $ref: '#/components/schemas/new_schedule_data_attributes_slack_channel'
owner_group_ids:
description: Owning teams.
items:
@@ -61845,6 +56626,14 @@ components:
description: ID of the owner of the schedule
nullable: true
type: integer
+ shift_start_notifications_enabled:
+ description: Whether shift-start notifications are enabled
+ nullable: true
+ type: boolean
+ shift_update_notifications_enabled:
+ description: Whether shift-update notifications are enabled
+ nullable: true
+ type: boolean
type: object
update_schedule_data:
properties:
@@ -61861,6 +56650,17 @@ components:
schedule_slack_user_group:
description: Synced slack group of the schedule
nullable: true
+ properties:
+ id:
+ description: Slack user group ID
+ type: string
+ name:
+ description: Slack user group name
+ type: string
+ type: object
+ schedule_slack_channel:
+ description: Synced slack channel of the schedule
+ nullable: true
properties:
id:
description: Slack channel ID
@@ -62006,6 +56806,32 @@ components:
- id
- type
type: object
+ new_service_data_attributes_alert_broadcast_channel:
+ description: Slack channel to broadcast alerts to
+ nullable: true
+ properties:
+ id:
+ description: Slack channel ID
+ type: string
+ name:
+ description: Slack channel name
+ type: string
+ required:
+ - id
+ type: object
+ new_service_data_attributes_incident_broadcast_channel:
+ description: Slack channel to broadcast incidents to
+ nullable: true
+ properties:
+ id:
+ description: Slack channel ID
+ type: string
+ name:
+ description: Slack channel name
+ type: string
+ required:
+ - id
+ type: object
new_service_data_attributes:
additionalProperties: false
properties:
@@ -62107,18 +56933,23 @@ components:
type: string
nullable: true
type: array
- owners_group_ids:
+ owner_group_ids:
description: Owner Teams associated with this service
items:
type: string
nullable: true
type: array
- owners_user_ids:
+ owner_user_ids:
description: Owner Users associated with this service
items:
type: integer
nullable: true
type: array
+ kubernetes_deployment_name:
+ description: "The Kubernetes deployment name associated to this service.\
+ \ eg: namespace/deployment-name"
+ nullable: true
+ type: string
alerts_email_enabled:
description: Enable alerts through email
nullable: true
@@ -62127,6 +56958,10 @@ components:
description: The alert urgency id of the service
nullable: true
type: string
+ escalation_policy_id:
+ description: The escalation policy id of the service
+ nullable: true
+ type: string
slack_channels:
description: Slack Channels associated with this service
items:
@@ -62139,6 +56974,23 @@ components:
$ref: '#/components/schemas/new_environment_data_attributes_slack_aliases_inner'
nullable: true
type: array
+ alert_broadcast_enabled:
+ description: Enable alerts to be broadcasted to a specific channel
+ nullable: true
+ type: boolean
+ alert_broadcast_channel:
+ $ref: '#/components/schemas/new_service_data_attributes_alert_broadcast_channel'
+ incident_broadcast_enabled:
+ description: Enable incidents to be broadcasted to a specific channel
+ nullable: true
+ type: boolean
+ incident_broadcast_channel:
+ $ref: '#/components/schemas/new_service_data_attributes_incident_broadcast_channel'
+ properties:
+ description: Array of property values for this service.
+ items:
+ $ref: '#/components/schemas/new_cause_data_attributes_properties_inner'
+ type: array
required:
- name
type: object
@@ -62238,13 +57090,13 @@ components:
type: string
nullable: true
type: array
- owners_group_ids:
+ owner_group_ids:
description: Owner Teams associated with this service
items:
type: string
nullable: true
type: array
- owners_user_ids:
+ owner_user_ids:
description: Owner Users associated with this service
items:
type: integer
@@ -62258,6 +57110,15 @@ components:
description: The alert urgency id of the service
nullable: true
type: string
+ escalation_policy_id:
+ description: The escalation policy id of the service
+ nullable: true
+ type: string
+ kubernetes_deployment_name:
+ description: "The Kubernetes deployment name associated to this service.\
+ \ eg: namespace/deployment-name"
+ nullable: true
+ type: string
slack_channels:
description: Slack Channels associated with this service
items:
@@ -62270,6 +57131,23 @@ components:
$ref: '#/components/schemas/new_environment_data_attributes_slack_aliases_inner'
nullable: true
type: array
+ alert_broadcast_enabled:
+ description: Enable alerts to be broadcasted to a specific channel
+ nullable: true
+ type: boolean
+ alert_broadcast_channel:
+ $ref: '#/components/schemas/new_service_data_attributes_alert_broadcast_channel'
+ incident_broadcast_enabled:
+ description: Enable incidents to be broadcasted to a specific channel
+ nullable: true
+ type: boolean
+ incident_broadcast_channel:
+ $ref: '#/components/schemas/new_service_data_attributes_incident_broadcast_channel'
+ properties:
+ description: Array of property values for this service.
+ items:
+ $ref: '#/components/schemas/new_cause_data_attributes_properties_inner'
+ type: array
type: object
update_service_data:
properties:
@@ -62283,6 +57161,28 @@ components:
- attributes
- type
type: object
+ service_alert_broadcast_channel:
+ description: Slack channel to broadcast alerts to
+ nullable: true
+ properties:
+ id:
+ description: Slack channel ID
+ type: string
+ name:
+ description: Slack channel name
+ type: string
+ type: object
+ service_incident_broadcast_channel:
+ description: Slack channel to broadcast incidents to
+ nullable: true
+ properties:
+ id:
+ description: Slack channel ID
+ type: string
+ name:
+ description: Slack channel name
+ type: string
+ type: object
service_response_data:
properties:
id:
@@ -62448,11 +57348,57 @@ components:
allOf:
- $ref: '#/components/schemas/shift'
type: object
+ relationships:
+ $ref: '#/components/schemas/shift_relationships'
required:
- attributes
- id
- type
type: object
+ shift_relationships_shift_override_data:
+ nullable: true
+ properties:
+ id:
+ type: string
+ type:
+ enum:
+ - shift_overrides
+ type: string
+ type: object
+ shift_relationships_shift_override:
+ properties:
+ data:
+ $ref: '#/components/schemas/shift_relationships_shift_override_data'
+ type: object
+ shift_relationships_user_data:
+ nullable: true
+ properties:
+ id:
+ type: string
+ type:
+ enum:
+ - users
+ type: string
+ type: object
+ shift_relationships_user:
+ properties:
+ data:
+ $ref: '#/components/schemas/shift_relationships_user_data'
+ type: object
+ shift_relationships_assignee_data:
+ nullable: true
+ properties:
+ id:
+ type: string
+ type:
+ type: string
+ type: object
+ shift_relationships_assignee:
+ description: Assignee can be either a User or Schedule
+ properties:
+ data:
+ $ref: '#/components/schemas/shift_relationships_assignee_data'
+ type: object
new_status_page_template_data_attributes:
additionalProperties: false
properties:
@@ -62461,6 +57407,10 @@ components:
title:
description: Title of the template
type: string
+ update_title:
+ description: Title that will be used for the status page update
+ nullable: true
+ type: string
body:
description: Description of the event the template will populate
type: string
@@ -62473,7 +57423,6 @@ components:
- resolved
- scheduled
- in_progress
- - verifying
- completed
nullable: true
type: string
@@ -62517,6 +57466,10 @@ components:
title:
description: Title of the template
type: string
+ update_title:
+ description: Title that will be used for the status page update
+ nullable: true
+ type: string
body:
description: Description of the event the template will populate
type: string
@@ -62529,7 +57482,6 @@ components:
- resolved
- scheduled
- in_progress
- - verifying
- completed
nullable: true
type: string
@@ -62644,8 +57596,6 @@ components:
- 30
- 60
- 90
- - 180
- - 360
nullable: true
type: integer
success_message:
@@ -62656,15 +57606,67 @@ components:
description: Message showing when at least one component is not operational
nullable: true
type: string
+ authentication_method:
+ default: none
+ description: Authentication method
+ enum:
+ - none
+ - password
+ - saml
+ nullable: true
+ type: string
authentication_enabled:
default: false
- description: Enable authentication
+ deprecated: true
+ description: Enable authentication (deprecated - use authentication_method
+ instead)
nullable: true
type: boolean
authentication_password:
description: Authentication password
nullable: true
type: string
+ saml_idp_sso_service_url:
+ description: SAML IdP SSO service URL
+ nullable: true
+ type: string
+ saml_idp_slo_service_url:
+ description: SAML IdP SLO service URL
+ nullable: true
+ type: string
+ saml_idp_cert:
+ description: SAML IdP certificate
+ nullable: true
+ type: string
+ saml_name_identifier_format:
+ description: SAML name identifier format
+ enum:
+ - urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress
+ - urn:oasis:names:tc:SAML:2.0:nameid-format:persistent
+ - urn:oasis:names:tc:SAML:2.0:nameid-format:transient
+ - urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified
+ nullable: true
+ type: string
+ section_order:
+ default:
+ - maintenance
+ - system_status
+ - incidents
+ description: Order of sections on the status page
+ items:
+ enum:
+ - maintenance
+ - system_status
+ - incidents
+ type: string
+ nullable: true
+ type: array
+ external_domain_names:
+ description: External domain names attached to the status page
+ items:
+ type: string
+ nullable: true
+ type: array
website_url:
description: Website URL
nullable: true
@@ -62760,8 +57762,6 @@ components:
- 30
- 60
- 90
- - 180
- - 360
nullable: true
type: integer
success_message:
@@ -62772,15 +57772,63 @@ components:
description: Message showing when at least one component is not operational
nullable: true
type: string
+ authentication_method:
+ default: none
+ description: Authentication method
+ enum:
+ - none
+ - password
+ - saml
+ nullable: true
+ type: string
authentication_enabled:
default: false
- description: Enable authentication
+ deprecated: true
+ description: Enable authentication (deprecated - use authentication_method
+ instead)
nullable: true
type: boolean
authentication_password:
description: Authentication password
nullable: true
type: string
+ saml_idp_sso_service_url:
+ description: SAML IdP SSO service URL
+ nullable: true
+ type: string
+ saml_idp_slo_service_url:
+ description: SAML IdP SLO service URL
+ nullable: true
+ type: string
+ saml_idp_cert:
+ description: SAML IdP certificate
+ nullable: true
+ type: string
+ saml_name_identifier_format:
+ description: SAML name identifier format
+ enum:
+ - urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress
+ - urn:oasis:names:tc:SAML:2.0:nameid-format:persistent
+ - urn:oasis:names:tc:SAML:2.0:nameid-format:transient
+ - urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified
+ nullable: true
+ type: string
+ section_order:
+ description: Order of sections on the status page
+ items:
+ enum:
+ - maintenance
+ - system_status
+ - incidents
+ type: string
+ nullable: true
+ type: array
+ external_domain_names:
+ description: External domain names attached to the status page
+ items:
+ type: string
+ nullable: true
+ type: array
website_url:
description: Website URL
nullable: true
@@ -62948,6 +57996,27 @@ components:
$ref: '#/components/schemas/new_environment_data_attributes_slack_aliases_inner'
nullable: true
type: array
+ alert_broadcast_enabled:
+ description: Enable alerts to be broadcasted to a specific channel
+ nullable: true
+ type: boolean
+ alert_broadcast_channel:
+ $ref: '#/components/schemas/new_service_data_attributes_alert_broadcast_channel'
+ incident_broadcast_enabled:
+ description: Enable incidents to be broadcasted to a specific channel
+ nullable: true
+ type: boolean
+ incident_broadcast_channel:
+ $ref: '#/components/schemas/new_service_data_attributes_incident_broadcast_channel'
+ auto_add_members_when_attached:
+ description: Auto add members to incident channel when team is attached
+ nullable: true
+ type: boolean
+ properties:
+ description: Array of property values for this team.
+ items:
+ $ref: '#/components/schemas/new_cause_data_attributes_properties_inner'
+ type: array
required:
- name
type: object
@@ -63056,6 +58125,27 @@ components:
$ref: '#/components/schemas/new_environment_data_attributes_slack_aliases_inner'
nullable: true
type: array
+ alert_broadcast_enabled:
+ description: Enable alerts to be broadcasted to a specific channel
+ nullable: true
+ type: boolean
+ alert_broadcast_channel:
+ $ref: '#/components/schemas/new_service_data_attributes_alert_broadcast_channel'
+ incident_broadcast_enabled:
+ description: Enable incidents to be broadcasted to a specific channel
+ nullable: true
+ type: boolean
+ incident_broadcast_channel:
+ $ref: '#/components/schemas/new_service_data_attributes_incident_broadcast_channel'
+ auto_add_members_when_attached:
+ description: Auto add members to incident channel when team is attached
+ nullable: true
+ type: boolean
+ properties:
+ description: Array of property values for this team.
+ items:
+ $ref: '#/components/schemas/new_cause_data_attributes_properties_inner'
+ type: array
type: object
update_team_data:
properties:
@@ -63123,6 +58213,7 @@ components:
- call
- device
- non_critical_device
+ - slack
type: string
nullable: false
type: array
@@ -63177,6 +58268,7 @@ components:
- call
- device
- non_critical_device
+ - slack
type: string
nullable: false
type: array
@@ -63211,6 +58303,122 @@ components:
- id
- type
type: object
+ new_user_phone_number_data_attributes:
+ additionalProperties: false
+ properties:
+ phone:
+ description: Phone number in international format
+ type: string
+ required:
+ - phone
+ type: object
+ new_user_phone_number_data:
+ properties:
+ type:
+ enum:
+ - user_phone_numbers
+ type: string
+ attributes:
+ $ref: '#/components/schemas/new_user_phone_number_data_attributes'
+ required:
+ - attributes
+ - type
+ type: object
+ update_user_phone_number_data_attributes:
+ additionalProperties: false
+ properties:
+ phone:
+ description: Phone number in international format
+ type: string
+ type: object
+ update_user_phone_number_data:
+ properties:
+ type:
+ enum:
+ - user_phone_numbers
+ type: string
+ attributes:
+ $ref: '#/components/schemas/update_user_phone_number_data_attributes'
+ required:
+ - attributes
+ - type
+ type: object
+ user_phone_number_response_data:
+ properties:
+ id:
+ description: Unique ID of the phone number
+ type: string
+ type:
+ enum:
+ - user_phone_numbers
+ type: string
+ attributes:
+ allOf:
+ - $ref: '#/components/schemas/user_phone_number'
+ type: object
+ required:
+ - attributes
+ - id
+ - type
+ type: object
+ new_user_email_address_data_attributes:
+ additionalProperties: false
+ properties:
+ email:
+ description: Email address
+ type: string
+ required:
+ - email
+ type: object
+ new_user_email_address_data:
+ properties:
+ type:
+ enum:
+ - user_email_addresses
+ type: string
+ attributes:
+ $ref: '#/components/schemas/new_user_email_address_data_attributes'
+ required:
+ - attributes
+ - type
+ type: object
+ update_user_email_address_data_attributes:
+ additionalProperties: false
+ properties:
+ email:
+ description: Email address
+ type: string
+ type: object
+ update_user_email_address_data:
+ properties:
+ type:
+ enum:
+ - user_email_addresses
+ type: string
+ attributes:
+ $ref: '#/components/schemas/update_user_email_address_data_attributes'
+ required:
+ - attributes
+ - type
+ type: object
+ user_email_address_response_data:
+ properties:
+ id:
+ description: Unique ID of the email address
+ type: string
+ type:
+ enum:
+ - user_email_addresses
+ type: string
+ attributes:
+ allOf:
+ - $ref: '#/components/schemas/user_email_address'
+ type: object
+ required:
+ - attributes
+ - id
+ - type
+ type: object
role_relationship_data:
nullable: true
properties:
@@ -63345,6 +58553,7 @@ components:
- genius_workflow_run.completed
- genius_workflow_run.failed
- genius_workflow_run.canceled
+ - audit_log.created
type: string
type: array
enabled:
@@ -63403,6 +58612,7 @@ components:
- genius_workflow_run.completed
- genius_workflow_run.failed
- genius_workflow_run.canceled
+ - audit_log.created
type: string
type: array
enabled:
@@ -63438,13 +58648,29 @@ components:
- id
- type
type: object
+ status_response_data:
+ properties:
+ id:
+ description: Unique ID of the status
+ type: string
+ type:
+ enum:
+ - statuses
+ type: string
+ attributes:
+ allOf:
+ - $ref: '#/components/schemas/status'
+ type: object
+ required:
+ - attributes
+ - id
+ - type
+ type: object
new_sub_status_data_attributes:
additionalProperties: false
properties:
name:
type: string
- slug:
- type: string
description:
nullable: true
type: string
@@ -63477,8 +58703,6 @@ components:
properties:
name:
type: string
- slug:
- type: string
description:
nullable: true
type: string
@@ -63707,6 +58931,401 @@ components:
- id
- type
type: object
+ new_sla_data_attributes_conditions_inner:
+ properties:
+ conditionable_type:
+ description: The type of condition
+ enum:
+ - SLAs::BuiltInFieldCondition
+ - SLAs::CustomFieldCondition
+ type: string
+ property:
+ description: "The property to evaluate (for built-in field conditions).\
+ \ When the team has custom lifecycle statuses enabled, use 'sub_status'\
+ \ (with sub-status IDs as values); otherwise use 'status' (with parent\
+ \ status names). Sending the wrong one will return a validation error."
+ enum:
+ - severity
+ - environment
+ - service
+ - functionality
+ - incident_type
+ - group
+ - cause
+ - sub_status
+ - incident_role
+ - status
+ - kind
+ - visibility
+ - summary
+ - started_at
+ - detected_at
+ - acknowledged_at
+ - mitigated_at
+ - resolved_at
+ nullable: true
+ type: string
+ operator:
+ description: The comparison operator
+ type: string
+ values:
+ description: The values to compare against
+ items:
+ type: string
+ nullable: true
+ type: array
+ form_field_id:
+ description: The ID of the form field (for custom field conditions)
+ format: uuid
+ nullable: true
+ type: string
+ position:
+ description: The position of the condition for ordering
+ type: integer
+ required:
+ - conditionable_type
+ - operator
+ type: object
+ new_sla_data_attributes_notification_configurations_inner:
+ properties:
+ offset_type:
+ description: When to send the notification relative to the deadline
+ enum:
+ - before_due
+ - when_due
+ - after_due
+ type: string
+ offset_days:
+ description: Number of days before or after the deadline. Must be 0 for
+ when_due.
+ type: integer
+ required:
+ - offset_days
+ - offset_type
+ type: object
+ new_sla_data_attributes:
+ additionalProperties: false
+ properties:
+ name:
+ description: The name of the SLA
+ type: string
+ description:
+ description: A description of the SLA
+ nullable: true
+ type: string
+ position:
+ description: Position of the SLA for ordering
+ nullable: true
+ type: integer
+ condition_match_type:
+ description: Whether all or any conditions must match
+ enum:
+ - ALL
+ - ANY
+ type: string
+ manager_role_id:
+ description: The ID of the incident role responsible for this SLA. Must
+ provide either manager_role_id or manager_user_id.
+ format: uuid
+ nullable: true
+ type: string
+ manager_user_id:
+ description: The ID of the user responsible for this SLA. Must provide either
+ manager_role_id or manager_user_id.
+ nullable: true
+ type: integer
+ assignment_deadline_days:
+ description: Number of days for the assignment deadline
+ enum:
+ - 1
+ - 2
+ - 3
+ - 4
+ - 5
+ - 6
+ - 7
+ - 14
+ - 21
+ - 30
+ type: integer
+ assignment_deadline_parent_status:
+ description: The incident parent status that triggers the assignment deadline
+ enum:
+ - in_triage
+ - started
+ - mitigated
+ - resolved
+ - closed
+ - cancelled
+ type: string
+ assignment_deadline_sub_status_id:
+ description: Sub-status for the assignment deadline. Required when custom
+ lifecycle statuses are enabled on the team.
+ format: uuid
+ nullable: true
+ type: string
+ assignment_skip_weekends:
+ description: Whether to skip weekends when calculating the assignment deadline
+ type: boolean
+ completion_deadline_days:
+ description: Number of days for the completion deadline
+ enum:
+ - 1
+ - 2
+ - 3
+ - 4
+ - 5
+ - 6
+ - 7
+ - 14
+ - 21
+ - 30
+ type: integer
+ completion_deadline_parent_status:
+ description: The incident parent status that triggers the completion deadline
+ enum:
+ - in_triage
+ - started
+ - mitigated
+ - resolved
+ - closed
+ - cancelled
+ type: string
+ completion_deadline_sub_status_id:
+ description: Sub-status for the completion deadline. Required when custom
+ lifecycle statuses are enabled on the team.
+ format: uuid
+ nullable: true
+ type: string
+ completion_skip_weekends:
+ description: Whether to skip weekends when calculating the completion deadline
+ type: boolean
+ conditions:
+ description: Conditions that determine which incidents this SLA applies
+ to. Maximum 20.
+ items:
+ $ref: '#/components/schemas/new_sla_data_attributes_conditions_inner'
+ type: array
+ notification_configurations:
+ description: Notification timing configurations. Maximum 20.
+ items:
+ $ref: '#/components/schemas/new_sla_data_attributes_notification_configurations_inner'
+ type: array
+ required:
+ - assignment_deadline_days
+ - assignment_deadline_parent_status
+ - completion_deadline_days
+ - completion_deadline_parent_status
+ - name
+ type: object
+ new_sla_data:
+ properties:
+ type:
+ enum:
+ - slas
+ type: string
+ attributes:
+ $ref: '#/components/schemas/new_sla_data_attributes'
+ required:
+ - attributes
+ - type
+ type: object
+ update_sla_data_attributes:
+ additionalProperties: false
+ properties:
+ name:
+ description: The name of the SLA
+ type: string
+ description:
+ description: A description of the SLA
+ nullable: true
+ type: string
+ position:
+ description: Position of the SLA for ordering
+ nullable: true
+ type: integer
+ condition_match_type:
+ description: Whether all or any conditions must match
+ enum:
+ - ALL
+ - ANY
+ type: string
+ manager_role_id:
+ description: The ID of the incident role responsible for this SLA. Exactly
+ one of `manager_role_id` or `manager_user_id` must be provided.
+ format: uuid
+ nullable: true
+ type: string
+ manager_user_id:
+ description: The ID of the user responsible for this SLA. Exactly one of
+ `manager_role_id` or `manager_user_id` must be provided.
+ nullable: true
+ type: integer
+ assignment_deadline_days:
+ description: Number of days for the assignment deadline
+ enum:
+ - 1
+ - 2
+ - 3
+ - 4
+ - 5
+ - 6
+ - 7
+ - 14
+ - 21
+ - 30
+ type: integer
+ assignment_deadline_parent_status:
+ description: The incident parent status that triggers the assignment deadline
+ enum:
+ - in_triage
+ - started
+ - mitigated
+ - resolved
+ - closed
+ - cancelled
+ type: string
+ assignment_deadline_sub_status_id:
+ description: Sub-status for the assignment deadline. Required when custom
+ lifecycle statuses are enabled on the team.
+ format: uuid
+ nullable: true
+ type: string
+ assignment_skip_weekends:
+ description: Whether to skip weekends when calculating the assignment deadline
+ type: boolean
+ completion_deadline_days:
+ description: Number of days for the completion deadline
+ enum:
+ - 1
+ - 2
+ - 3
+ - 4
+ - 5
+ - 6
+ - 7
+ - 14
+ - 21
+ - 30
+ type: integer
+ completion_deadline_parent_status:
+ description: The incident parent status that triggers the completion deadline
+ enum:
+ - in_triage
+ - started
+ - mitigated
+ - resolved
+ - closed
+ - cancelled
+ type: string
+ completion_deadline_sub_status_id:
+ description: Sub-status for the completion deadline. Required when custom
+ lifecycle statuses are enabled on the team.
+ format: uuid
+ nullable: true
+ type: string
+ completion_skip_weekends:
+ description: Whether to skip weekends when calculating the completion deadline
+ type: boolean
+ conditions:
+ description: Conditions that determine which incidents this SLA applies
+ to. Replaces all existing conditions.
+ items:
+ $ref: '#/components/schemas/new_sla_data_attributes_conditions_inner'
+ type: array
+ notification_configurations:
+ description: Notification timing configurations. Replaces all existing configurations.
+ items:
+ $ref: '#/components/schemas/new_sla_data_attributes_notification_configurations_inner'
+ type: array
+ type: object
+ update_sla_data:
+ properties:
+ type:
+ enum:
+ - slas
+ type: string
+ attributes:
+ $ref: '#/components/schemas/update_sla_data_attributes'
+ required:
+ - attributes
+ - type
+ type: object
+ sla_conditions_inner:
+ properties:
+ id:
+ description: Unique ID of the condition
+ format: uuid
+ type: string
+ position:
+ description: The position of the condition
+ type: integer
+ conditionable_type:
+ description: The type of condition
+ enum:
+ - SLAs::BuiltInFieldCondition
+ - SLAs::CustomFieldCondition
+ type: string
+ property:
+ description: The property to evaluate (for built-in field conditions)
+ nullable: true
+ type: string
+ operator:
+ description: The comparison operator
+ type: string
+ values:
+ description: The values to compare against
+ items:
+ type: string
+ nullable: true
+ type: array
+ form_field_id:
+ description: The ID of the form field (for custom field conditions)
+ format: uuid
+ nullable: true
+ type: string
+ type: object
+ sla_notification_configurations_inner:
+ properties:
+ id:
+ description: Unique ID of the notification configuration
+ format: uuid
+ type: string
+ offset_type:
+ description: When to send the notification relative to the deadline
+ enum:
+ - before_due
+ - when_due
+ - after_due
+ type: string
+ offset_days:
+ description: Number of days offset from the deadline
+ type: integer
+ created_at:
+ description: Date of creation
+ type: string
+ updated_at:
+ description: Date of last update
+ type: string
+ type: object
+ sla_response_data:
+ properties:
+ id:
+ description: Unique ID of the SLA
+ type: string
+ type:
+ enum:
+ - slas
+ type: string
+ attributes:
+ allOf:
+ - $ref: '#/components/schemas/sla'
+ type: object
+ required:
+ - attributes
+ - id
+ - type
+ type: object
securitySchemes:
bearer_auth:
scheme: bearer
diff --git a/build.gradle b/build.gradle
index c2b09f3b..678afdae 100644
--- a/build.gradle
+++ b/build.gradle
@@ -113,7 +113,7 @@ dependencies {
implementation 'com.google.code.gson:gson:2.9.1'
implementation 'io.gsonfire:gson-fire:1.9.0'
implementation 'jakarta.ws.rs:jakarta.ws.rs-api:2.1.6'
- implementation 'org.openapitools:jackson-databind-nullable:0.2.6'
+ implementation 'org.openapitools:jackson-databind-nullable:0.2.10'
implementation group: 'org.apache.commons', name: 'commons-lang3', version: '3.17.0'
implementation "jakarta.annotation:jakarta.annotation-api:$jakarta_annotation_version"
testImplementation 'org.junit.jupiter:junit-jupiter-api:5.10.3'
diff --git a/build.sbt b/build.sbt
index 93e9a205..a0370a59 100644
--- a/build.sbt
+++ b/build.sbt
@@ -15,7 +15,7 @@ lazy val root = (project in file(".")).
"com.google.code.gson" % "gson" % "2.9.1",
"org.apache.commons" % "commons-lang3" % "3.17.0",
"jakarta.ws.rs" % "jakarta.ws.rs-api" % "2.1.6",
- "org.openapitools" % "jackson-databind-nullable" % "0.2.6",
+ "org.openapitools" % "jackson-databind-nullable" % "0.2.10",
"io.gsonfire" % "gson-fire" % "1.9.0" % "compile",
"jakarta.annotation" % "jakarta.annotation-api" % "1.3.5" % "compile",
"com.google.code.findbugs" % "jsr305" % "3.0.2" % "compile",
diff --git a/docs/ActionItemTriggerParams.md b/docs/ActionItemTriggerParams.md
index 2a18a7c0..a1c04f7c 100644
--- a/docs/ActionItemTriggerParams.md
+++ b/docs/ActionItemTriggerParams.md
@@ -64,6 +64,7 @@
| NORMAL_SUB | "normal_sub" |
| BACKFILLED | "backfilled" |
| SCHEDULED | "scheduled" |
+| SCHEDULED_SUB | "scheduled_sub" |
@@ -100,6 +101,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -115,6 +117,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -130,6 +133,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -145,6 +149,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -160,6 +165,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -175,6 +181,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -190,6 +197,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -205,6 +213,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -220,6 +229,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -235,6 +245,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -250,6 +261,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -337,6 +349,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -361,6 +374,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -387,6 +401,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -412,6 +427,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
diff --git a/docs/AddMicrosoftTeamsChatTabTaskParams.md b/docs/AddMicrosoftTeamsChatTabTaskParams.md
new file mode 100644
index 00000000..bfddec88
--- /dev/null
+++ b/docs/AddMicrosoftTeamsChatTabTaskParams.md
@@ -0,0 +1,24 @@
+
+
+# AddMicrosoftTeamsChatTabTaskParams
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**taskType** | [**TaskTypeEnum**](#TaskTypeEnum) | | [optional] |
+|**chat** | [**AddActionItemTaskParamsPostToSlackChannelsInner**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | |
+|**title** | **String** | The tab title | |
+|**link** | **String** | The tab link | |
+
+
+
+## Enum: TaskTypeEnum
+
+| Name | Value |
+|---- | -----|
+| ADD_MICROSOFT_TEAMS_CHAT_TAB | "add_microsoft_teams_chat_tab" |
+
+
+
diff --git a/docs/Alert.md b/docs/Alert.md
index 7c9d31aa..aeb37a3f 100644
--- a/docs/Alert.md
+++ b/docs/Alert.md
@@ -7,6 +7,7 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
+|**shortId** | **String** | Human-readable short identifier for the alert | |
|**noise** | [**NoiseEnum**](#NoiseEnum) | Whether the alert is marked as noise | [optional] |
|**source** | [**SourceEnum**](#SourceEnum) | The source of the alert | |
|**status** | [**StatusEnum**](#StatusEnum) | The status of the alert | [optional] |
@@ -15,14 +16,20 @@
|**services** | [**List<Service>**](Service.md) | Services attached to the alert | [optional] |
|**groups** | [**List<Team>**](Team.md) | Groups attached to the alert | [optional] |
|**environments** | [**List<Environment>**](Environment.md) | Environments attached to the alert | [optional] |
-|**serviceIds** | **List<String>** | The Service ID's to attach to the alert. If your organization has On-Call enabled and your notification target is a Service. This field will be automatically set for you. | [optional] |
-|**groupIds** | **List<String>** | The Group ID's to attach to the alert. If your organization has On-Call enabled and your notification target is a Group. This field will be automatically set for you. | [optional] |
-|**environmentIds** | **List<String>** | The Environment ID's to attach to the alert | [optional] |
+|**serviceIds** | **List<String>** | The Service IDs to attach to the alert. If your organization has On-Call enabled and your notification target is a Service. This field will be automatically set for you. | [optional] |
+|**groupIds** | **List<String>** | The Group IDs to attach to the alert. If your organization has On-Call enabled and your notification target is a Group. This field will be automatically set for you. | [optional] |
+|**environmentIds** | **List<String>** | The Environment IDs to attach to the alert | [optional] |
|**externalId** | **String** | External ID | [optional] |
|**externalUrl** | **String** | External Url | [optional] |
|**alertUrgencyId** | **String** | The ID of the alert urgency | [optional] |
+|**groupLeaderAlertId** | **String** | The ID of the group leader alert | [optional] |
+|**isGroupLeaderAlert** | **Boolean** | Whether the alert is a group leader alert | [optional] |
|**labels** | [**List<NewAlertDataAttributesLabelsInner>**](NewAlertDataAttributesLabelsInner.md) | | [optional] |
|**data** | **Object** | Additional data | [optional] |
+|**deduplicationKey** | **String** | Alerts sharing the same deduplication key are treated as a single alert. | [optional] |
+|**alertFieldValuesAttributes** | [**List<NewAlertDataAttributesAlertFieldValuesAttributesInner>**](NewAlertDataAttributesAlertFieldValuesAttributesInner.md) | Custom alert field values to create with the alert | [optional] |
+|**startedAt** | **OffsetDateTime** | When the alert started | [optional] |
+|**endedAt** | **OffsetDateTime** | When the alert ended | [optional] |
|**createdAt** | **String** | Date of creation | |
|**updatedAt** | **String** | Date of last update | |
@@ -44,16 +51,19 @@
| ROOTLY | "rootly" |
| MANUAL | "manual" |
| API | "api" |
+| HEARTBEAT | "heartbeat" |
| WEB | "web" |
| SLACK | "slack" |
| EMAIL | "email" |
| WORKFLOW | "workflow" |
| LIVE_CALL_ROUTING | "live_call_routing" |
+| MOBILE | "mobile" |
| PAGERDUTY | "pagerduty" |
| OPSGENIE | "opsgenie" |
| VICTOROPS | "victorops" |
| PAGERTREE | "pagertree" |
| DATADOG | "datadog" |
+| DYNATRACE | "dynatrace" |
| NOBL9 | "nobl9" |
| ZENDESK | "zendesk" |
| ASANA | "asana" |
@@ -69,6 +79,7 @@
| GOOGLE_CLOUD | "google_cloud" |
| GENERIC_WEBHOOK | "generic_webhook" |
| CLOUD_WATCH | "cloud_watch" |
+| AWS_SNS | "aws_sns" |
| AZURE | "azure" |
| SPLUNK | "splunk" |
| CHRONOSPHERE | "chronosphere" |
@@ -93,6 +104,7 @@
| TRIGGERED | "triggered" |
| ACKNOWLEDGED | "acknowledged" |
| RESOLVED | "resolved" |
+| DEFERRED | "deferred" |
diff --git a/docs/AlertEvent.md b/docs/AlertEvent.md
index 9cb828e8..717ba72d 100644
--- a/docs/AlertEvent.md
+++ b/docs/AlertEvent.md
@@ -32,6 +32,7 @@
| NOTE | "note" |
| NOISE | "noise" |
| MAINTENANCE | "maintenance" |
+| DEFERRAL | "deferral" |
@@ -40,11 +41,14 @@
| Name | Value |
|---- | -----|
| CREATED | "created" |
+| ESCALATION_POLICY_PAGED | "escalation_policy_paged" |
+| IGNORED_ALERT_REQUEST | "ignored_alert_request" |
| EMAILED | "emailed" |
| SLACKED | "slacked" |
| CALLED | "called" |
| TEXTED | "texted" |
| NOTIFIED | "notified" |
+| SKIPPED | "skipped" |
| OPENED | "opened" |
| RETRIGGERED | "retriggered" |
| ANSWERED | "answered" |
@@ -55,12 +59,14 @@
| ATTACHED | "attached" |
| SNOOZED | "snoozed" |
| TRIGGERED | "triggered" |
+| OPEN | "open" |
| UPDATED | "updated" |
| ADDED | "added" |
| REMOVED | "removed" |
| MARKED | "marked" |
| NOT_MARKED | "not_marked" |
| MUTED | "muted" |
+| DEFERRED | "deferred" |
diff --git a/docs/AlertEventList.md b/docs/AlertEventList.md
index c5979439..c79317b1 100644
--- a/docs/AlertEventList.md
+++ b/docs/AlertEventList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<AlertEventResponseData>**](AlertEventResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/AlertEventsApi.md b/docs/AlertEventsApi.md
index 2f320b36..d0f619a8 100644
--- a/docs/AlertEventsApi.md
+++ b/docs/AlertEventsApi.md
@@ -87,7 +87,7 @@ public class Example {
Delete alert event
-Deletes a specific alert event
+Deletes a specific alert event. Only alert events with kind 'note' (user-created notes) can be deleted. System-generated events are immutable to maintain audit trail integrity.
### Example
```java
@@ -299,7 +299,7 @@ public class Example {
Update alert event
-Updates a specific alert event
+Updates a specific alert event. Only alert events with kind 'note' (user-created notes) can be updated. System-generated events are immutable to maintain audit trail integrity.
### Example
```java
diff --git a/docs/AlertField.md b/docs/AlertField.md
new file mode 100644
index 00000000..1d0d3bc2
--- /dev/null
+++ b/docs/AlertField.md
@@ -0,0 +1,17 @@
+
+
+# AlertField
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**slug** | **String** | The slug of the alert field | [optional] |
+|**name** | **String** | The name of the alert field | |
+|**kind** | **String** | The kind of alert field | |
+|**createdAt** | **String** | Date of creation | |
+|**updatedAt** | **String** | Date of last update | |
+
+
+
diff --git a/docs/AlertFieldList.md b/docs/AlertFieldList.md
new file mode 100644
index 00000000..92ffc36b
--- /dev/null
+++ b/docs/AlertFieldList.md
@@ -0,0 +1,15 @@
+
+
+# AlertFieldList
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<AlertFieldListDataInner>**](AlertFieldListDataInner.md) | | |
+|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
+
+
+
diff --git a/docs/AlertFieldListDataInner.md b/docs/AlertFieldListDataInner.md
new file mode 100644
index 00000000..fcca2b69
--- /dev/null
+++ b/docs/AlertFieldListDataInner.md
@@ -0,0 +1,23 @@
+
+
+# AlertFieldListDataInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | The ID of the alert field | |
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**AlertField**](AlertField.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| ALERT_FIELDS | "alert_fields" |
+
+
+
diff --git a/docs/AlertFieldResponse.md b/docs/AlertFieldResponse.md
new file mode 100644
index 00000000..344efc8c
--- /dev/null
+++ b/docs/AlertFieldResponse.md
@@ -0,0 +1,13 @@
+
+
+# AlertFieldResponse
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**AlertFieldResponseData**](AlertFieldResponseData.md) | | |
+
+
+
diff --git a/docs/AlertFieldResponseData.md b/docs/AlertFieldResponseData.md
new file mode 100644
index 00000000..74d5918a
--- /dev/null
+++ b/docs/AlertFieldResponseData.md
@@ -0,0 +1,23 @@
+
+
+# AlertFieldResponseData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | The ID of the alert field | [optional] |
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**AlertField**](AlertField.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| ALERT_FIELDS | "alert_fields" |
+
+
+
diff --git a/docs/AlertFieldsApi.md b/docs/AlertFieldsApi.md
new file mode 100644
index 00000000..4de6f96e
--- /dev/null
+++ b/docs/AlertFieldsApi.md
@@ -0,0 +1,376 @@
+# AlertFieldsApi
+
+All URIs are relative to *https://api.rootly.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createAlertField**](AlertFieldsApi.md#createAlertField) | **POST** /v1/alert_fields | Creates an alert field |
+| [**deleteAlertField**](AlertFieldsApi.md#deleteAlertField) | **DELETE** /v1/alert_fields/{id} | Delete an alert field |
+| [**getAlertField**](AlertFieldsApi.md#getAlertField) | **GET** /v1/alert_fields/{id} | Retrieves an alert field |
+| [**listAlertFields**](AlertFieldsApi.md#listAlertFields) | **GET** /v1/alert_fields | List alert fields |
+| [**updateAlertField**](AlertFieldsApi.md#updateAlertField) | **PUT** /v1/alert_fields/{id} | Update an alert field |
+
+
+
+# **createAlertField**
+> AlertFieldResponse createAlertField(newAlertField)
+
+Creates an alert field
+
+Creates a new alert field from provided data
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.AlertFieldsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ AlertFieldsApi apiInstance = new AlertFieldsApi(defaultClient);
+ NewAlertField newAlertField = new NewAlertField(); // NewAlertField |
+ try {
+ AlertFieldResponse result = apiInstance.createAlertField(newAlertField);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling AlertFieldsApi#createAlertField");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **newAlertField** | [**NewAlertField**](NewAlertField.md)| | |
+
+### Return type
+
+[**AlertFieldResponse**](AlertFieldResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/vnd.api+json
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | alert field created | - |
+| **422** | invalid request | - |
+| **401** | responds with unauthorized for invalid token | - |
+
+
+# **deleteAlertField**
+> AlertFieldResponse deleteAlertField(id)
+
+Delete an alert field
+
+Delete a specific alert field by id
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.AlertFieldsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ AlertFieldsApi apiInstance = new AlertFieldsApi(defaultClient);
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
+ try {
+ AlertFieldResponse result = apiInstance.deleteAlertField(id);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling AlertFieldsApi#deleteAlertField");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
+
+### Return type
+
+[**AlertFieldResponse**](AlertFieldResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | custom alert field deleted successfully | - |
+| **422** | cannot delete alert field referenced by escalation path field rules | - |
+| **404** | resource not found | - |
+
+
+# **getAlertField**
+> AlertFieldResponse getAlertField(id)
+
+Retrieves an alert field
+
+Retrieves a specific alert field by id
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.AlertFieldsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ AlertFieldsApi apiInstance = new AlertFieldsApi(defaultClient);
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
+ try {
+ AlertFieldResponse result = apiInstance.getAlertField(id);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling AlertFieldsApi#getAlertField");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
+
+### Return type
+
+[**AlertFieldResponse**](AlertFieldResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | alert_field found by slug | - |
+| **404** | resource not found | - |
+
+
+# **listAlertFields**
+> AlertFieldList listAlertFields(include, pageNumber, pageSize, filterSearch, filterName, filterKind, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, sort)
+
+List alert fields
+
+List alert fields
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.AlertFieldsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ AlertFieldsApi apiInstance = new AlertFieldsApi(defaultClient);
+ String include = "include_example"; // String |
+ Integer pageNumber = 56; // Integer |
+ Integer pageSize = 56; // Integer |
+ String filterSearch = "filterSearch_example"; // String |
+ String filterName = "filterName_example"; // String |
+ String filterKind = "filterKind_example"; // String |
+ String filterCreatedAtGt = "filterCreatedAtGt_example"; // String |
+ String filterCreatedAtGte = "filterCreatedAtGte_example"; // String |
+ String filterCreatedAtLt = "filterCreatedAtLt_example"; // String |
+ String filterCreatedAtLte = "filterCreatedAtLte_example"; // String |
+ String sort = "sort_example"; // String |
+ try {
+ AlertFieldList result = apiInstance.listAlertFields(include, pageNumber, pageSize, filterSearch, filterName, filterKind, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, sort);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling AlertFieldsApi#listAlertFields");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **include** | **String**| | [optional] |
+| **pageNumber** | **Integer**| | [optional] |
+| **pageSize** | **Integer**| | [optional] |
+| **filterSearch** | **String**| | [optional] |
+| **filterName** | **String**| | [optional] |
+| **filterKind** | **String**| | [optional] |
+| **filterCreatedAtGt** | **String**| | [optional] |
+| **filterCreatedAtGte** | **String**| | [optional] |
+| **filterCreatedAtLt** | **String**| | [optional] |
+| **filterCreatedAtLte** | **String**| | [optional] |
+| **sort** | **String**| | [optional] |
+
+### Return type
+
+[**AlertFieldList**](AlertFieldList.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | success | - |
+
+
+# **updateAlertField**
+> AlertFieldResponse updateAlertField(id, updateAlertField)
+
+Update an alert field
+
+Update a specific alert field by id
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.AlertFieldsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ AlertFieldsApi apiInstance = new AlertFieldsApi(defaultClient);
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
+ UpdateAlertField updateAlertField = new UpdateAlertField(); // UpdateAlertField |
+ try {
+ AlertFieldResponse result = apiInstance.updateAlertField(id, updateAlertField);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling AlertFieldsApi#updateAlertField");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
+| **updateAlertField** | [**UpdateAlertField**](UpdateAlertField.md)| | |
+
+### Return type
+
+[**AlertFieldResponse**](AlertFieldResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/vnd.api+json
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | alert field updated | - |
+| **404** | resource not found | - |
+
diff --git a/docs/AlertGroup.md b/docs/AlertGroup.md
index 533c2757..9200298a 100644
--- a/docs/AlertGroup.md
+++ b/docs/AlertGroup.md
@@ -9,13 +9,14 @@
|------------ | ------------- | ------------- | -------------|
|**name** | **String** | The name of the alert group | |
|**description** | **String** | The description of the alert group | |
-|**slug** | **String** | The slug of the alert group | |
+|**slug** | **String** | The slug of the alert group | [optional] |
|**conditionType** | **String** | Grouping condition for the alert group | |
|**timeWindow** | **Integer** | Time window for the alert grouping | |
-|**groupByAlertTitle** | **Boolean** | Whether the alerts are grouped by title or not | |
-|**groupByAlertUrgency** | **Boolean** | Whether the alerts are grouped by urgency or not | |
+|**groupByAlertTitle** | **Boolean** | [DEPRECATED] Whether the alerts are grouped by title or not. This field is deprecated. Please use the `conditions` field with advanced alert grouping instead. | [optional] |
+|**groupByAlertUrgency** | **Boolean** | [DEPRECATED] Whether the alerts are grouped by urgency or not. This field is deprecated. Please use the `conditions` field with advanced alert grouping instead. | [optional] |
|**targets** | [**List<NewAlertGroupDataAttributesTargetsInner>**](NewAlertGroupDataAttributesTargetsInner.md) | | [optional] |
-|**attributes** | [**List<NewAlertGroupDataAttributesAttributesInner>**](NewAlertGroupDataAttributesAttributesInner.md) | | [optional] |
+|**attributes** | [**List<NewAlertGroupDataAttributesAttributesInner>**](NewAlertGroupDataAttributesAttributesInner.md) | This field is deprecated. Please use the `conditions` field instead, `attributes` will be removed in the future. | [optional] |
+|**conditions** | [**List<AlertGroupConditionsInner>**](AlertGroupConditionsInner.md) | The conditions for the alert group | [optional] |
|**createdAt** | **String** | Date of creation | |
|**updatedAt** | **String** | Date of last update | |
|**deletedAt** | **String** | Date or deletion | |
diff --git a/docs/AlertGroupConditionsInner.md b/docs/AlertGroupConditionsInner.md
new file mode 100644
index 00000000..1d70c53a
--- /dev/null
+++ b/docs/AlertGroupConditionsInner.md
@@ -0,0 +1,55 @@
+
+
+# AlertGroupConditionsInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**propertyFieldType** | [**PropertyFieldTypeEnum**](#PropertyFieldTypeEnum) | The type of the property field | |
+|**propertyFieldName** | **String** | The name of the property field. If the property field type is selected as 'attribute', then the allowed property field names are 'summary' (for Title), 'description', 'alert_urgency' and 'external_url' (for Alert Source URL). If the property field type is selected as 'payload', then the property field name should be supplied in JSON Path syntax. | [optional] |
+|**propertyFieldConditionType** | [**PropertyFieldConditionTypeEnum**](#PropertyFieldConditionTypeEnum) | The condition type of the property field | |
+|**propertyFieldValue** | **String** | The value of the property field. Can be null if the property field condition type is 'is_one_of' or 'is_not_one_of' | [optional] |
+|**propertyFieldValues** | **List<String>** | The values of the property field. Used if the property field condition type is 'is_one_of' or 'is_not_one_of' except for when property field name is 'alert_urgency' | [optional] |
+|**values** | [**List<AlertGroupConditionsInnerValuesInner>**](AlertGroupConditionsInnerValuesInner.md) | | [optional] |
+|**alertUrgencyIds** | **List<String>** | The Alert Urgency IDs to check in the condition. Only need to be set when the property field type is 'attribute', the property field name is 'alert_urgency' and the property field condition type is 'is_one_of' or 'is_not_one_of' | [optional] |
+|**conditionableType** | [**ConditionableTypeEnum**](#ConditionableTypeEnum) | The type of the conditionable | [optional] |
+|**conditionableId** | **String** | The ID of the conditionable. If conditionable_type is AlertField, this is the ID of the alert field. | [optional] |
+
+
+
+## Enum: PropertyFieldTypeEnum
+
+| Name | Value |
+|---- | -----|
+| ATTRIBUTE | "attribute" |
+| PAYLOAD | "payload" |
+| ALERT_FIELD | "alert_field" |
+
+
+
+## Enum: PropertyFieldConditionTypeEnum
+
+| Name | Value |
+|---- | -----|
+| IS_ONE_OF | "is_one_of" |
+| IS_NOT_ONE_OF | "is_not_one_of" |
+| CONTAINS | "contains" |
+| DOES_NOT_CONTAIN | "does_not_contain" |
+| STARTS_WITH | "starts_with" |
+| ENDS_WITH | "ends_with" |
+| MATCHES_REGEX | "matches_regex" |
+| IS_EMPTY | "is_empty" |
+| MATCHES_EXISTING_ALERT | "matches_existing_alert" |
+
+
+
+## Enum: ConditionableTypeEnum
+
+| Name | Value |
+|---- | -----|
+| ALERT_FIELD | "AlertField" |
+
+
+
diff --git a/docs/AlertGroupConditionsInnerValuesInner.md b/docs/AlertGroupConditionsInnerValuesInner.md
new file mode 100644
index 00000000..bdbd31cf
--- /dev/null
+++ b/docs/AlertGroupConditionsInnerValuesInner.md
@@ -0,0 +1,14 @@
+
+
+# AlertGroupConditionsInnerValuesInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**recordId** | **String** | ID of the Alert Urgency to set. | |
+|**recordType** | **String** | Should be \"AlertUrgency\". | |
+
+
+
diff --git a/docs/AlertGroupsApi.md b/docs/AlertGroupsApi.md
index e2aee261..e67b75b0 100644
--- a/docs/AlertGroupsApi.md
+++ b/docs/AlertGroupsApi.md
@@ -17,7 +17,7 @@ All URIs are relative to *https://api.rootly.com*
Creates an alert group
-Creates a new alert group
+Creates a new alert group. **Note**: For enhanced functionality and future compatibility, consider using the advanced alert grouping with `conditions` field instead of the legacy `group_by_alert_title`, `group_by_alert_urgency`, and `attributes` fields.
### Example
```java
@@ -76,7 +76,7 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **201** | alert group created | - |
+| **201** | alert group created with conditions | - |
| **422** | invalid request | - |
| **401** | responds with unauthorized for invalid token | - |
@@ -108,7 +108,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
AlertGroupsApi apiInstance = new AlertGroupsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
AlertGroupResponse result = apiInstance.deleteAlertGroup(id);
System.out.println(result);
@@ -127,7 +127,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -176,7 +176,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
AlertGroupsApi apiInstance = new AlertGroupsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
AlertGroupResponse result = apiInstance.getAlertGroup(id);
System.out.println(result);
@@ -195,7 +195,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -213,7 +213,7 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **200** | alert group found | - |
+| **200** | alert_group found by slug | - |
| **404** | resource not found | - |
@@ -289,7 +289,7 @@ public class Example {
Update an alert group
-Update a specific alert group by id
+Update a specific alert group by id. **Note**: For enhanced functionality and future compatibility, consider using the advanced alert grouping with `conditions` field instead of the legacy `group_by_alert_title`, `group_by_alert_urgency`, and `attributes` fields.
### Example
```java
@@ -311,7 +311,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
AlertGroupsApi apiInstance = new AlertGroupsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
UpdateAlertGroup updateAlertGroup = new UpdateAlertGroup(); // UpdateAlertGroup |
try {
AlertGroupResponse result = apiInstance.updateAlertGroup(id, updateAlertGroup);
@@ -331,7 +331,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
| **updateAlertGroup** | [**UpdateAlertGroup**](UpdateAlertGroup.md)| | |
### Return type
@@ -350,6 +350,6 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **200** | alert group updated | - |
+| **200** | alert group updated with conditions | - |
| **404** | resource not found | - |
diff --git a/docs/AlertList.md b/docs/AlertList.md
index 67172700..479bbad2 100644
--- a/docs/AlertList.md
+++ b/docs/AlertList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<AlertResponseData>**](AlertResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/AlertResponseData.md b/docs/AlertResponseData.md
index 740deac8..6f955738 100644
--- a/docs/AlertResponseData.md
+++ b/docs/AlertResponseData.md
@@ -21,16 +21,19 @@
| ROOTLY | "rootly" |
| MANUAL | "manual" |
| API | "api" |
+| HEARTBEAT | "heartbeat" |
| WEB | "web" |
| SLACK | "slack" |
| EMAIL | "email" |
| WORKFLOW | "workflow" |
| LIVE_CALL_ROUTING | "live_call_routing" |
+| MOBILE | "mobile" |
| PAGERDUTY | "pagerduty" |
| OPSGENIE | "opsgenie" |
| VICTOROPS | "victorops" |
| PAGERTREE | "pagertree" |
| DATADOG | "datadog" |
+| DYNATRACE | "dynatrace" |
| NOBL9 | "nobl9" |
| ZENDESK | "zendesk" |
| ASANA | "asana" |
@@ -46,6 +49,7 @@
| GOOGLE_CLOUD | "google_cloud" |
| GENERIC_WEBHOOK | "generic_webhook" |
| CLOUD_WATCH | "cloud_watch" |
+| AWS_SNS | "aws_sns" |
| AZURE | "azure" |
| SPLUNK | "splunk" |
| CHRONOSPHERE | "chronosphere" |
diff --git a/docs/AlertRoute.md b/docs/AlertRoute.md
new file mode 100644
index 00000000..4e08606f
--- /dev/null
+++ b/docs/AlertRoute.md
@@ -0,0 +1,17 @@
+
+
+# AlertRoute
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | The name of the alert route | |
+|**enabled** | **Boolean** | Whether the alert route is enabled | [optional] |
+|**alertsSourceIds** | **List<UUID>** | | |
+|**owningTeamIds** | **List<UUID>** | | [optional] |
+|**rules** | [**List<NewAlertRouteDataAttributesRulesInner>**](NewAlertRouteDataAttributesRulesInner.md) | | [optional] |
+
+
+
diff --git a/docs/AlertRouteList.md b/docs/AlertRouteList.md
new file mode 100644
index 00000000..3a0e1f75
--- /dev/null
+++ b/docs/AlertRouteList.md
@@ -0,0 +1,15 @@
+
+
+# AlertRouteList
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<AlertRouteResponseData>**](AlertRouteResponseData.md) | | |
+|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
+
+
+
diff --git a/docs/AlertRouteResponse.md b/docs/AlertRouteResponse.md
new file mode 100644
index 00000000..8362e169
--- /dev/null
+++ b/docs/AlertRouteResponse.md
@@ -0,0 +1,13 @@
+
+
+# AlertRouteResponse
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**AlertRouteResponseData**](AlertRouteResponseData.md) | | |
+
+
+
diff --git a/docs/AlertRouteResponseData.md b/docs/AlertRouteResponseData.md
new file mode 100644
index 00000000..78748f65
--- /dev/null
+++ b/docs/AlertRouteResponseData.md
@@ -0,0 +1,23 @@
+
+
+# AlertRouteResponseData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | Unique ID of the alert route | |
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**AlertRoute**](AlertRoute.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| ALERT_ROUTES | "alert_routes" |
+
+
+
diff --git a/docs/AlertRoutesApi.md b/docs/AlertRoutesApi.md
new file mode 100644
index 00000000..c6745516
--- /dev/null
+++ b/docs/AlertRoutesApi.md
@@ -0,0 +1,441 @@
+# AlertRoutesApi
+
+All URIs are relative to *https://api.rootly.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createAlertRoute**](AlertRoutesApi.md#createAlertRoute) | **POST** /v1/alert_routes | Creates an alert route |
+| [**deleteAlertRoute**](AlertRoutesApi.md#deleteAlertRoute) | **DELETE** /v1/alert_routes/{id} | Delete an alert route |
+| [**getAlertRoute**](AlertRoutesApi.md#getAlertRoute) | **GET** /v1/alert_routes/{id} | Get an alert route |
+| [**listAlertRoutes**](AlertRoutesApi.md#listAlertRoutes) | **GET** /v1/alert_routes | List alert routes |
+| [**patchAlertRoute**](AlertRoutesApi.md#patchAlertRoute) | **PATCH** /v1/alert_routes/{id} | Update an alert route |
+| [**updateAlertRoute**](AlertRoutesApi.md#updateAlertRoute) | **PUT** /v1/alert_routes/{id} | Update an alert route |
+
+
+
+# **createAlertRoute**
+> AlertRouteResponse createAlertRoute(newAlertRoute)
+
+Creates an alert route
+
+Creates a new alert route from provided data. **Note: This endpoint requires access to Advanced Alert Routing. If you're unsure whether you have access to this feature, please contact Rootly customer support.** ## Asynchronous Rule Creation For organizations with large numbers of routing rules, Rootly supports asynchronous rule processing to improve performance. When enabled, rule creation happens in the background. **Important**: When async processing is enabled, the rules list in the API response will not be up-to-date immediately after creation. You should refetch the alert route after a few minutes to get the updated rules. If you experience slow operations when managing alert routes with many rules, contact Rootly customer support to enable asynchronous rule processing for your organization.
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.AlertRoutesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ AlertRoutesApi apiInstance = new AlertRoutesApi(defaultClient);
+ NewAlertRoute newAlertRoute = new NewAlertRoute(); // NewAlertRoute |
+ try {
+ AlertRouteResponse result = apiInstance.createAlertRoute(newAlertRoute);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling AlertRoutesApi#createAlertRoute");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **newAlertRoute** | [**NewAlertRoute**](NewAlertRoute.md)| | |
+
+### Return type
+
+[**AlertRouteResponse**](AlertRouteResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/vnd.api+json
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | unknown attribute filtered out gracefully | - |
+| **422** | create: raises error when multiple fallback rules are present | - |
+| **401** | unauthorized | - |
+
+
+# **deleteAlertRoute**
+> DeleteAlertRoute200Response deleteAlertRoute(id)
+
+Delete an alert route
+
+Delete a specific alert route by id. **Note: This endpoint requires access to Advanced Alert Routing. If you're unsure whether you have access to this feature, please contact Rootly customer support.**
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.AlertRoutesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ AlertRoutesApi apiInstance = new AlertRoutesApi(defaultClient);
+ String id = "id_example"; // String |
+ try {
+ DeleteAlertRoute200Response result = apiInstance.deleteAlertRoute(id);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling AlertRoutesApi#deleteAlertRoute");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| | |
+
+### Return type
+
+[**DeleteAlertRoute200Response**](DeleteAlertRoute200Response.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | alert route deleted | - |
+| **404** | cross-team access denied | - |
+| **422** | destroy failed | - |
+| **401** | unauthorized | - |
+
+
+# **getAlertRoute**
+> AlertRouteResponse getAlertRoute(id)
+
+Get an alert route
+
+Get a specific alert route by id. **Note: This endpoint requires access to Advanced Alert Routing. If you're unsure whether you have access to this feature, please contact Rootly customer support.** ## Optional Parameters - **show_nested_ids** (query parameter): When set to `true`, the response will include IDs for all nested resources (destinations, condition_groups, conditions). This is useful when you need to reference these nested resources for updates or deletions via PATCH requests. Example: `GET /v1/alert_routes/{id}?show_nested_ids=true`
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.AlertRoutesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ AlertRoutesApi apiInstance = new AlertRoutesApi(defaultClient);
+ String id = "id_example"; // String |
+ try {
+ AlertRouteResponse result = apiInstance.getAlertRoute(id);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling AlertRoutesApi#getAlertRoute");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| | |
+
+### Return type
+
+[**AlertRouteResponse**](AlertRouteResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | alert route found | - |
+| **404** | cross-team access denied | - |
+| **401** | unauthorized | - |
+
+
+# **listAlertRoutes**
+> AlertRouteList listAlertRoutes(pageNumber, pageSize, filterSearch, filterName, sort)
+
+List alert routes
+
+List all alert routes for the current team with filtering and pagination. **Note: This endpoint requires access to Advanced Alert Routing. If you're unsure whether you have access to this feature, please contact Rootly customer support.**
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.AlertRoutesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ AlertRoutesApi apiInstance = new AlertRoutesApi(defaultClient);
+ Integer pageNumber = 56; // Integer |
+ Integer pageSize = 56; // Integer |
+ String filterSearch = "filterSearch_example"; // String |
+ String filterName = "filterName_example"; // String |
+ String sort = "sort_example"; // String |
+ try {
+ AlertRouteList result = apiInstance.listAlertRoutes(pageNumber, pageSize, filterSearch, filterName, sort);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling AlertRoutesApi#listAlertRoutes");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **pageNumber** | **Integer**| | [optional] |
+| **pageSize** | **Integer**| | [optional] |
+| **filterSearch** | **String**| | [optional] |
+| **filterName** | **String**| | [optional] |
+| **sort** | **String**| | [optional] |
+
+### Return type
+
+[**AlertRouteList**](AlertRouteList.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | alert routes filtered by search | - |
+| **401** | unauthorized | - |
+
+
+# **patchAlertRoute**
+> AlertRouteResponse patchAlertRoute(id, patchAlertRoute)
+
+Update an alert route
+
+Updates an alert route. **Note: This endpoint requires access to Advanced Alert Routing. If you're unsure whether you have access to this feature, please contact Rootly customer support.**
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.AlertRoutesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ AlertRoutesApi apiInstance = new AlertRoutesApi(defaultClient);
+ String id = "id_example"; // String |
+ PatchAlertRoute patchAlertRoute = new PatchAlertRoute(); // PatchAlertRoute |
+ try {
+ AlertRouteResponse result = apiInstance.patchAlertRoute(id, patchAlertRoute);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling AlertRoutesApi#patchAlertRoute");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| | |
+| **patchAlertRoute** | [**PatchAlertRoute**](PatchAlertRoute.md)| | |
+
+### Return type
+
+[**AlertRouteResponse**](AlertRouteResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/vnd.api+json
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | delete existing rule by id with _destroy | - |
+| **422** | invalid request | - |
+| **401** | unauthorized | - |
+| **404** | cross-team access denied | - |
+
+
+# **updateAlertRoute**
+> AlertRouteResponse updateAlertRoute(id, updateAlertRoute)
+
+Update an alert route
+
+Update a specific alert route by id. **Note: This endpoint requires access to Advanced Alert Routing. If you're unsure whether you have access to this feature, please contact Rootly customer support.** ### Asynchronous Rule Creation For organizations with large numbers of routing rules, Rootly supports asynchronous rule processing to improve performance. When enabled, rule updates happen in the background. **Important**: When async processing is enabled, the rules list in the API response will not be up-to-date immediately after update. You should refetch the alert route after a few minutes to get the updated rules. If you experience slow operations when managing alert routes with many rules, contact Rootly customer support to enable asynchronous rule processing for your organization.
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.AlertRoutesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ AlertRoutesApi apiInstance = new AlertRoutesApi(defaultClient);
+ String id = "id_example"; // String |
+ UpdateAlertRoute updateAlertRoute = new UpdateAlertRoute(); // UpdateAlertRoute |
+ try {
+ AlertRouteResponse result = apiInstance.updateAlertRoute(id, updateAlertRoute);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling AlertRoutesApi#updateAlertRoute");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| | |
+| **updateAlertRoute** | [**UpdateAlertRoute**](UpdateAlertRoute.md)| | |
+
+### Return type
+
+[**AlertRouteResponse**](AlertRouteResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/vnd.api+json
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | update: handles mixed position types correctly | - |
+| **422** | update: raises error when multiple fallback rules are present | - |
+| **404** | cross-team access denied | - |
+
diff --git a/docs/AlertRoutingRule.md b/docs/AlertRoutingRule.md
index 94acd7eb..4bc940db 100644
--- a/docs/AlertRoutingRule.md
+++ b/docs/AlertRoutingRule.md
@@ -10,9 +10,11 @@
|**name** | **String** | The name of the alert routing rule | |
|**enabled** | **Boolean** | Whether the alert routing rule is enabled | |
|**alertsSourceId** | **UUID** | The ID of the alerts source | |
+|**position** | **Integer** | The position of the alert routing rule for ordering evaluation | |
|**conditionType** | [**ConditionTypeEnum**](#ConditionTypeEnum) | The type of condition for the alert routing rule | |
|**conditions** | [**List<AlertRoutingRuleConditionsInner>**](AlertRoutingRuleConditionsInner.md) | The conditions for the alert routing rule | [optional] |
-|**destination** | [**AlertRoutingRuleDestination**](AlertRoutingRuleDestination.md) | | |
+|**destination** | [**AlertRoutingRuleDestination**](AlertRoutingRuleDestination.md) | | [optional] |
+|**conditionGroups** | [**List<AlertRoutingRuleConditionGroupsInner>**](AlertRoutingRuleConditionGroupsInner.md) | The condition groups for the alert routing rule | [optional] |
|**createdAt** | **String** | Date of creation | |
|**updatedAt** | **String** | Date of last update | |
diff --git a/docs/AlertRoutingRuleCondition.md b/docs/AlertRoutingRuleCondition.md
new file mode 100644
index 00000000..552b3f35
--- /dev/null
+++ b/docs/AlertRoutingRuleCondition.md
@@ -0,0 +1,47 @@
+
+
+# AlertRoutingRuleCondition
+
+A condition for alert routing rule
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | Unique ID of the condition | [optional] |
+|**propertyFieldType** | [**PropertyFieldTypeEnum**](#PropertyFieldTypeEnum) | The type of the property field | |
+|**propertyFieldName** | **String** | The name of the property field | |
+|**propertyFieldConditionType** | [**PropertyFieldConditionTypeEnum**](#PropertyFieldConditionTypeEnum) | The condition type of the property field | |
+|**propertyFieldValue** | **String** | The value of the property field | [optional] |
+|**propertyFieldValues** | **List<String>** | The values of the property field | [optional] |
+|**conditionableId** | **UUID** | The ID of the conditionable object | [optional] |
+|**conditionableType** | **String** | The type of the conditionable object | [optional] |
+|**createdAt** | **String** | Date of creation | [optional] |
+|**updatedAt** | **String** | Date of last update | [optional] |
+
+
+
+## Enum: PropertyFieldTypeEnum
+
+| Name | Value |
+|---- | -----|
+| ATTRIBUTE | "attribute" |
+| PAYLOAD | "payload" |
+
+
+
+## Enum: PropertyFieldConditionTypeEnum
+
+| Name | Value |
+|---- | -----|
+| IS_ONE_OF | "is_one_of" |
+| IS_NOT_ONE_OF | "is_not_one_of" |
+| CONTAINS | "contains" |
+| DOES_NOT_CONTAIN | "does_not_contain" |
+| STARTS_WITH | "starts_with" |
+| ENDS_WITH | "ends_with" |
+| MATCHES_REGEX | "matches_regex" |
+| IS_EMPTY | "is_empty" |
+
+
+
diff --git a/docs/AlertRoutingRuleConditionGroup.md b/docs/AlertRoutingRuleConditionGroup.md
new file mode 100644
index 00000000..825bf00f
--- /dev/null
+++ b/docs/AlertRoutingRuleConditionGroup.md
@@ -0,0 +1,18 @@
+
+
+# AlertRoutingRuleConditionGroup
+
+A group of conditions for alert routing rule
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | Unique ID of the condition group | [optional] |
+|**position** | **Integer** | The position of the condition group for ordering | |
+|**conditions** | [**List<AlertRoutingRuleCondition>**](AlertRoutingRuleCondition.md) | The conditions within this group | [optional] |
+|**createdAt** | **String** | Date of creation | [optional] |
+|**updatedAt** | **String** | Date of last update | [optional] |
+
+
+
diff --git a/docs/AlertRoutingRuleConditionGroupsInner.md b/docs/AlertRoutingRuleConditionGroupsInner.md
new file mode 100644
index 00000000..80dc0a49
--- /dev/null
+++ b/docs/AlertRoutingRuleConditionGroupsInner.md
@@ -0,0 +1,17 @@
+
+
+# AlertRoutingRuleConditionGroupsInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | Unique ID of the condition group | [optional] |
+|**position** | **Integer** | The position of the condition group for ordering | |
+|**conditions** | [**List<AlertRoutingRuleConditionGroupsInnerConditionsInner>**](AlertRoutingRuleConditionGroupsInnerConditionsInner.md) | The conditions within this group | [optional] |
+|**createdAt** | **String** | Date of creation | [optional] |
+|**updatedAt** | **String** | Date of last update | [optional] |
+
+
+
diff --git a/docs/AlertRoutingRuleConditionGroupsInnerConditionsInner.md b/docs/AlertRoutingRuleConditionGroupsInnerConditionsInner.md
new file mode 100644
index 00000000..45b00c09
--- /dev/null
+++ b/docs/AlertRoutingRuleConditionGroupsInnerConditionsInner.md
@@ -0,0 +1,46 @@
+
+
+# AlertRoutingRuleConditionGroupsInnerConditionsInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | Unique ID of the condition | [optional] |
+|**propertyFieldType** | [**PropertyFieldTypeEnum**](#PropertyFieldTypeEnum) | The type of the property field | |
+|**propertyFieldName** | **String** | The name of the property field | |
+|**propertyFieldConditionType** | [**PropertyFieldConditionTypeEnum**](#PropertyFieldConditionTypeEnum) | The condition type of the property field | |
+|**propertyFieldValue** | **String** | The value of the property field | [optional] |
+|**propertyFieldValues** | **List<String>** | The values of the property field | [optional] |
+|**conditionableId** | **UUID** | The ID of the conditionable object | [optional] |
+|**conditionableType** | **String** | The type of the conditionable object | [optional] |
+|**createdAt** | **String** | Date of creation | [optional] |
+|**updatedAt** | **String** | Date of last update | [optional] |
+
+
+
+## Enum: PropertyFieldTypeEnum
+
+| Name | Value |
+|---- | -----|
+| ATTRIBUTE | "attribute" |
+| PAYLOAD | "payload" |
+
+
+
+## Enum: PropertyFieldConditionTypeEnum
+
+| Name | Value |
+|---- | -----|
+| IS_ONE_OF | "is_one_of" |
+| IS_NOT_ONE_OF | "is_not_one_of" |
+| CONTAINS | "contains" |
+| DOES_NOT_CONTAIN | "does_not_contain" |
+| STARTS_WITH | "starts_with" |
+| ENDS_WITH | "ends_with" |
+| MATCHES_REGEX | "matches_regex" |
+| IS_EMPTY | "is_empty" |
+
+
+
diff --git a/docs/AlertRoutingRuleDestination.md b/docs/AlertRoutingRuleDestination.md
index 3d2b2ddb..ec71287d 100644
--- a/docs/AlertRoutingRuleDestination.md
+++ b/docs/AlertRoutingRuleDestination.md
@@ -8,7 +8,7 @@ The destinations for the alert routing rule
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
-|**targetType** | [**TargetTypeEnum**](#TargetTypeEnum) | The type of the target | |
+|**targetType** | [**TargetTypeEnum**](#TargetTypeEnum) | The type of the target. Please contact support if you encounter issues using `Functionality` as a target type. | |
|**targetId** | **UUID** | The ID of the target | |
@@ -17,8 +17,9 @@ The destinations for the alert routing rule
| Name | Value |
|---- | -----|
-| GROUP | "Group" |
| SERVICE | "Service" |
+| GROUP | "Group" |
+| FUNCTIONALITY | "Functionality" |
| ESCALATION_POLICY | "EscalationPolicy" |
diff --git a/docs/AlertRoutingRuleList.md b/docs/AlertRoutingRuleList.md
index 70bcab28..4436cf68 100644
--- a/docs/AlertRoutingRuleList.md
+++ b/docs/AlertRoutingRuleList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<AlertRoutingRuleResponseData>**](AlertRoutingRuleResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/AlertRoutingRuleTarget.md b/docs/AlertRoutingRuleTarget.md
new file mode 100644
index 00000000..a45f5db2
--- /dev/null
+++ b/docs/AlertRoutingRuleTarget.md
@@ -0,0 +1,26 @@
+
+
+# AlertRoutingRuleTarget
+
+The destination target for the alert routing rule
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**targetType** | [**TargetTypeEnum**](#TargetTypeEnum) | The type of the target. Please contact support if you encounter issues using `Functionality` as a target type. | |
+|**targetId** | **UUID** | The ID of the target | |
+
+
+
+## Enum: TargetTypeEnum
+
+| Name | Value |
+|---- | -----|
+| SERVICE | "Service" |
+| GROUP | "Group" |
+| FUNCTIONALITY | "Functionality" |
+| ESCALATION_POLICY | "EscalationPolicy" |
+
+
+
diff --git a/docs/AlertRoutingRulesApi.md b/docs/AlertRoutingRulesApi.md
index 133cc919..36c61fe0 100644
--- a/docs/AlertRoutingRulesApi.md
+++ b/docs/AlertRoutingRulesApi.md
@@ -17,7 +17,7 @@ All URIs are relative to *https://api.rootly.com*
Creates an alert routing rule
-Creates a new alert routing rule from provided data
+Creates a new alert routing rule from provided data. **Note: If you are an advanced alert routing user, you should use the Alert Routes endpoint instead of this endpoint. If you don't know whether you are an advanced user, please contact Rootly customer support.**
### Example
```java
@@ -86,7 +86,7 @@ public class Example {
Delete an alert routing rule
-Delete a specific alert routing rule by id
+Delete a specific alert routing rule by id. **Note: If you are an advanced alert routing user, you should use the Alert Routes endpoint instead of this endpoint. If you don't know whether you are an advanced user, please contact Rootly customer support.**
### Example
```java
@@ -108,7 +108,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
AlertRoutingRulesApi apiInstance = new AlertRoutingRulesApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
AlertRoutingRuleResponse result = apiInstance.deleteAlertRoutingRule(id);
System.out.println(result);
@@ -127,7 +127,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -154,7 +154,7 @@ public class Example {
Retrieves an alert routing rule
-Retrieves a specific alert routing rule by id
+Retrieves a specific alert routing rule by id. **Note: If you are an advanced alert routing user, you should use the Alert Routes endpoint instead of this endpoint. If you don't know whether you are an advanced user, please contact Rootly customer support.**
### Example
```java
@@ -176,7 +176,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
AlertRoutingRulesApi apiInstance = new AlertRoutingRulesApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
AlertRoutingRuleResponse result = apiInstance.getAlertRoutingRule(id);
System.out.println(result);
@@ -195,7 +195,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -213,7 +213,7 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **200** | alert routing rule found | - |
+| **200** | alert_routing_rule found by slug | - |
| **404** | resource not found | - |
@@ -222,7 +222,7 @@ public class Example {
List alert routing rules
-List alert routing rules
+List alert routing rules. **Note: If you are an advanced alert routing user, you should use the Alert Routes endpoint instead of this endpoint. If you don't know whether you are an advanced user, please contact Rootly customer support.**
### Example
```java
@@ -307,7 +307,7 @@ public class Example {
Update an alert routing rule
-Update a specific alert routing rule by id
+Update a specific alert routing rule by id. **Note: If you are an advanced alert routing user, you should use the Alert Routes endpoint instead of this endpoint. If you don't know whether you are an advanced user, please contact Rootly customer support.**
### Example
```java
@@ -329,7 +329,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
AlertRoutingRulesApi apiInstance = new AlertRoutingRulesApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
UpdateAlertRoutingRule updateAlertRoutingRule = new UpdateAlertRoutingRule(); // UpdateAlertRoutingRule |
try {
AlertRoutingRuleResponse result = apiInstance.updateAlertRoutingRule(id, updateAlertRoutingRule);
@@ -349,7 +349,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
| **updateAlertRoutingRule** | [**UpdateAlertRoutingRule**](UpdateAlertRoutingRule.md)| | |
### Return type
diff --git a/docs/AlertSourcesApi.md b/docs/AlertSourcesApi.md
index 49de5d83..86d28e0a 100644
--- a/docs/AlertSourcesApi.md
+++ b/docs/AlertSourcesApi.md
@@ -4,16 +4,16 @@ All URIs are relative to *https://api.rootly.com*
| Method | HTTP request | Description |
|------------- | ------------- | -------------|
-| [**createAlertSource**](AlertSourcesApi.md#createAlertSource) | **POST** /v1/alert_sources | Creates an alert source |
-| [**deleteAlertSource**](AlertSourcesApi.md#deleteAlertSource) | **DELETE** /v1/alert_sources/{id} | Delete an alert source |
-| [**getAlertSource**](AlertSourcesApi.md#getAlertSource) | **GET** /v1/alert_sources/{id} | Retrieves an alert source |
-| [**listAlertSources**](AlertSourcesApi.md#listAlertSources) | **GET** /v1/alert_sources | List alert sources |
-| [**updateAlertSource**](AlertSourcesApi.md#updateAlertSource) | **PUT** /v1/alert_sources/{id} | Update an alert source |
+| [**createAlertsSource**](AlertSourcesApi.md#createAlertsSource) | **POST** /v1/alert_sources | Creates an alert source |
+| [**deleteAlertsSource**](AlertSourcesApi.md#deleteAlertsSource) | **DELETE** /v1/alert_sources/{id} | Delete an alert source |
+| [**getAlertsSource**](AlertSourcesApi.md#getAlertsSource) | **GET** /v1/alert_sources/{id} | Retrieves an alert source |
+| [**listAlertsSources**](AlertSourcesApi.md#listAlertsSources) | **GET** /v1/alert_sources | List alert sources |
+| [**updateAlertsSource**](AlertSourcesApi.md#updateAlertsSource) | **PUT** /v1/alert_sources/{id} | Update an alert source |
-
-# **createAlertSource**
-> AlertsSourceResponse createAlertSource(newAlertsSource)
+
+# **createAlertsSource**
+> AlertsSourceResponse createAlertsSource(newAlertsSource)
Creates an alert source
@@ -41,10 +41,10 @@ public class Example {
AlertSourcesApi apiInstance = new AlertSourcesApi(defaultClient);
NewAlertsSource newAlertsSource = new NewAlertsSource(); // NewAlertsSource |
try {
- AlertsSourceResponse result = apiInstance.createAlertSource(newAlertsSource);
+ AlertsSourceResponse result = apiInstance.createAlertsSource(newAlertsSource);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling AlertSourcesApi#createAlertSource");
+ System.err.println("Exception when calling AlertSourcesApi#createAlertsSource");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -80,9 +80,9 @@ public class Example {
| **422** | invalid request | - |
| **401** | responds with unauthorized for invalid token | - |
-
-# **deleteAlertSource**
-> AlertsSourceResponse deleteAlertSource(id)
+
+# **deleteAlertsSource**
+> AlertsSourceResponse deleteAlertsSource(id)
Delete an alert source
@@ -110,10 +110,10 @@ public class Example {
AlertSourcesApi apiInstance = new AlertSourcesApi(defaultClient);
String id = "id_example"; // String |
try {
- AlertsSourceResponse result = apiInstance.deleteAlertSource(id);
+ AlertsSourceResponse result = apiInstance.deleteAlertsSource(id);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling AlertSourcesApi#deleteAlertSource");
+ System.err.println("Exception when calling AlertSourcesApi#deleteAlertsSource");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -148,9 +148,9 @@ public class Example {
| **200** | alert source deleted | - |
| **404** | resource not found | - |
-
-# **getAlertSource**
-> AlertsSourceResponse getAlertSource(id)
+
+# **getAlertsSource**
+> AlertsSourceResponse getAlertsSource(id)
Retrieves an alert source
@@ -178,10 +178,10 @@ public class Example {
AlertSourcesApi apiInstance = new AlertSourcesApi(defaultClient);
String id = "id_example"; // String |
try {
- AlertsSourceResponse result = apiInstance.getAlertSource(id);
+ AlertsSourceResponse result = apiInstance.getAlertsSource(id);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling AlertSourcesApi#getAlertSource");
+ System.err.println("Exception when calling AlertSourcesApi#getAlertsSource");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -216,9 +216,9 @@ public class Example {
| **200** | alert source found | - |
| **404** | resource not found | - |
-
-# **listAlertSources**
-> AlertsSourceList listAlertSources(include, pageNumber, pageSize, filterSearch, filterStatuses, filterSourceTypes, sort)
+
+# **listAlertsSources**
+> AlertsSourceList listAlertsSources(include, pageNumber, pageSize, filterSearch, filterStatuses, filterSourceTypes, filterName, sort)
List alert sources
@@ -250,12 +250,13 @@ public class Example {
String filterSearch = "filterSearch_example"; // String |
String filterStatuses = "filterStatuses_example"; // String |
String filterSourceTypes = "filterSourceTypes_example"; // String |
+ String filterName = "filterName_example"; // String |
String sort = "sort_example"; // String |
try {
- AlertsSourceList result = apiInstance.listAlertSources(include, pageNumber, pageSize, filterSearch, filterStatuses, filterSourceTypes, sort);
+ AlertsSourceList result = apiInstance.listAlertsSources(include, pageNumber, pageSize, filterSearch, filterStatuses, filterSourceTypes, filterName, sort);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling AlertSourcesApi#listAlertSources");
+ System.err.println("Exception when calling AlertSourcesApi#listAlertsSources");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -275,6 +276,7 @@ public class Example {
| **filterSearch** | **String**| | [optional] |
| **filterStatuses** | **String**| | [optional] |
| **filterSourceTypes** | **String**| | [optional] |
+| **filterName** | **String**| | [optional] |
| **sort** | **String**| | [optional] |
### Return type
@@ -295,9 +297,9 @@ public class Example {
|-------------|-------------|------------------|
| **200** | success | - |
-
-# **updateAlertSource**
-> AlertsSourceResponse updateAlertSource(id, updateAlertsSource)
+
+# **updateAlertsSource**
+> AlertsSourceResponse updateAlertsSource(id, updateAlertsSource)
Update an alert source
@@ -326,10 +328,10 @@ public class Example {
String id = "id_example"; // String |
UpdateAlertsSource updateAlertsSource = new UpdateAlertsSource(); // UpdateAlertsSource |
try {
- AlertsSourceResponse result = apiInstance.updateAlertSource(id, updateAlertsSource);
+ AlertsSourceResponse result = apiInstance.updateAlertsSource(id, updateAlertsSource);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling AlertSourcesApi#updateAlertSource");
+ System.err.println("Exception when calling AlertSourcesApi#updateAlertsSource");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
diff --git a/docs/AlertTriggerParams.md b/docs/AlertTriggerParams.md
index 44ad7017..93263622 100644
--- a/docs/AlertTriggerParams.md
+++ b/docs/AlertTriggerParams.md
@@ -19,10 +19,14 @@
|**alertConditionStatusUseRegexp** | **Boolean** | | [optional] |
|**alertStatuses** | **List<String>** | | [optional] |
|**alertLabels** | **List<String>** | | [optional] |
+|**alertConditionUrgency** | [**AlertConditionUrgencyEnum**](#AlertConditionUrgencyEnum) | | [optional] |
+|**alertUrgencyIds** | **List<UUID>** | | [optional] |
|**alertConditionPayload** | [**AlertConditionPayloadEnum**](#AlertConditionPayloadEnum) | | [optional] |
|**alertConditionPayloadUseRegexp** | **Boolean** | | [optional] |
|**alertPayload** | **List<String>** | | [optional] |
|**alertQueryPayload** | **String** | You can use jsonpath syntax. eg: $.incident.teams[*] | [optional] |
+|**alertFieldConditions** | [**List<AlertTriggerParamsAlertFieldConditionsInner>**](AlertTriggerParamsAlertFieldConditionsInner.md) | | [optional] |
+|**alertPayloadConditions** | [**AlertTriggerParamsAlertPayloadConditions**](AlertTriggerParamsAlertPayloadConditions.md) | | [optional] |
@@ -58,6 +62,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -73,6 +78,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -88,6 +94,23 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
+| ANY | "ANY" |
+| CONTAINS | "CONTAINS" |
+| CONTAINS_ALL | "CONTAINS_ALL" |
+| CONTAINS_NONE | "CONTAINS_NONE" |
+| NONE | "NONE" |
+| SET | "SET" |
+| UNSET | "UNSET" |
+
+
+
+## Enum: AlertConditionUrgencyEnum
+
+| Name | Value |
+|---- | -----|
+| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -103,6 +126,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
diff --git a/docs/AlertTriggerParamsAlertFieldConditionsInner.md b/docs/AlertTriggerParamsAlertFieldConditionsInner.md
new file mode 100644
index 00000000..83e4aac8
--- /dev/null
+++ b/docs/AlertTriggerParamsAlertFieldConditionsInner.md
@@ -0,0 +1,31 @@
+
+
+# AlertTriggerParamsAlertFieldConditionsInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**alertFieldId** | **String** | | |
+|**conditionType** | [**ConditionTypeEnum**](#ConditionTypeEnum) | | |
+|**values** | **List<String>** | | [optional] |
+
+
+
+## Enum: ConditionTypeEnum
+
+| Name | Value |
+|---- | -----|
+| IS | "IS" |
+| IS_NOT | "IS NOT" |
+| ANY | "ANY" |
+| CONTAINS | "CONTAINS" |
+| CONTAINS_ALL | "CONTAINS_ALL" |
+| CONTAINS_NONE | "CONTAINS_NONE" |
+| NONE | "NONE" |
+| SET | "SET" |
+| UNSET | "UNSET" |
+
+
+
diff --git a/docs/AlertTriggerParamsAlertPayloadConditions.md b/docs/AlertTriggerParamsAlertPayloadConditions.md
new file mode 100644
index 00000000..573c7ba4
--- /dev/null
+++ b/docs/AlertTriggerParamsAlertPayloadConditions.md
@@ -0,0 +1,24 @@
+
+
+# AlertTriggerParamsAlertPayloadConditions
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**logic** | [**LogicEnum**](#LogicEnum) | | [optional] |
+|**conditions** | [**List<AlertTriggerParamsAlertPayloadConditionsConditionsInner>**](AlertTriggerParamsAlertPayloadConditionsConditionsInner.md) | | [optional] |
+
+
+
+## Enum: LogicEnum
+
+| Name | Value |
+|---- | -----|
+| ALL | "ALL" |
+| ANY | "ANY" |
+| NONE | "NONE" |
+
+
+
diff --git a/docs/AlertTriggerParamsAlertPayloadConditionsConditionsInner.md b/docs/AlertTriggerParamsAlertPayloadConditionsConditionsInner.md
new file mode 100644
index 00000000..8406b750
--- /dev/null
+++ b/docs/AlertTriggerParamsAlertPayloadConditionsConditionsInner.md
@@ -0,0 +1,32 @@
+
+
+# AlertTriggerParamsAlertPayloadConditionsConditionsInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**query** | **String** | | |
+|**operator** | [**OperatorEnum**](#OperatorEnum) | | |
+|**values** | **List<String>** | | [optional] |
+|**useRegexp** | **Boolean** | | [optional] |
+
+
+
+## Enum: OperatorEnum
+
+| Name | Value |
+|---- | -----|
+| IS | "IS" |
+| IS_NOT | "IS NOT" |
+| ANY | "ANY" |
+| CONTAINS | "CONTAINS" |
+| CONTAINS_ALL | "CONTAINS_ALL" |
+| CONTAINS_NONE | "CONTAINS_NONE" |
+| NONE | "NONE" |
+| SET | "SET" |
+| UNSET | "UNSET" |
+
+
+
diff --git a/docs/AlertUrgencyList.md b/docs/AlertUrgencyList.md
index 2b93c510..287647da 100644
--- a/docs/AlertUrgencyList.md
+++ b/docs/AlertUrgencyList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<AlertUrgencyResponseData>**](AlertUrgencyResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/AlertsApi.md b/docs/AlertsApi.md
index d360175d..4d7d965a 100644
--- a/docs/AlertsApi.md
+++ b/docs/AlertsApi.md
@@ -7,10 +7,12 @@ All URIs are relative to *https://api.rootly.com*
| [**acknowledgeAlert**](AlertsApi.md#acknowledgeAlert) | **POST** /v1/alerts/{id}/acknowledge | Acknowledges an alert |
| [**attachAlert**](AlertsApi.md#attachAlert) | **POST** /v1/incidents/{incident_id}/alerts | Attach alerts to an incident |
| [**createAlert**](AlertsApi.md#createAlert) | **POST** /v1/alerts | Creates an alert |
+| [**escalateAlert**](AlertsApi.md#escalateAlert) | **POST** /v1/alerts/{id}/escalate | Escalates an alert |
| [**getAlert**](AlertsApi.md#getAlert) | **GET** /v1/alerts/{id} | Retrieves an alert |
| [**listAlerts**](AlertsApi.md#listAlerts) | **GET** /v1/alerts | List alerts |
| [**listIncidentAlerts**](AlertsApi.md#listIncidentAlerts) | **GET** /v1/incidents/{incident_id}/alerts | List Incident alerts |
| [**resolveAlert**](AlertsApi.md#resolveAlert) | **POST** /v1/alerts/{id}/resolve | Resolves an alert |
+| [**snoozeAlert**](AlertsApi.md#snoozeAlert) | **POST** /v1/alerts/{id}/snooze | Snoozes an alert |
| [**updateAlert**](AlertsApi.md#updateAlert) | **PATCH** /v1/alerts/{id} | Update alert |
@@ -81,6 +83,7 @@ public class Example {
|-------------|-------------|------------------|
| **200** | alert acknowledged | - |
| **404** | resource not found | - |
+| **400** | cannot acknowledge open alert | - |
# **attachAlert**
@@ -221,13 +224,13 @@ public class Example {
| **422** | invalid request | - |
| **401** | resource not found | - |
-
-# **getAlert**
-> AlertResponse getAlert(id)
+
+# **escalateAlert**
+> AlertResponse escalateAlert(id, escalateAlert)
-Retrieves an alert
+Escalates an alert
-Retrieves a specific alert by id
+Escalates a specific alert to the next or specified level in its escalation policy
### Example
```java
@@ -250,11 +253,12 @@ public class Example {
AlertsApi apiInstance = new AlertsApi(defaultClient);
String id = "id_example"; // String |
+ EscalateAlert escalateAlert = new EscalateAlert(); // EscalateAlert |
try {
- AlertResponse result = apiInstance.getAlert(id);
+ AlertResponse result = apiInstance.escalateAlert(id, escalateAlert);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling AlertsApi#getAlert");
+ System.err.println("Exception when calling AlertsApi#escalateAlert");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -269,6 +273,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **id** | **String**| | |
+| **escalateAlert** | [**EscalateAlert**](EscalateAlert.md)| | [optional] |
### Return type
@@ -280,22 +285,24 @@ public class Example {
### HTTP request headers
- - **Content-Type**: Not defined
+ - **Content-Type**: application/vnd.api+json
- **Accept**: application/vnd.api+json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **200** | alert found | - |
-| **404** | resource not found | - |
+| **200** | escalates to different EP defaults to level 1 | - |
+| **422** | escalation_policy_level exceeds max | - |
+| **404** | cannot escalate grouped member alert | - |
+| **400** | malformed escalation_policy_id | - |
-
-# **listAlerts**
-> AlertList listAlerts(include, filterStatus, pageNumber, pageSize)
+
+# **getAlert**
+> AlertResponse getAlert(id, include)
-List alerts
+Retrieves an alert
-List alerts
+Retrieves a specific alert by id
### Example
```java
@@ -317,15 +324,13 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
AlertsApi apiInstance = new AlertsApi(defaultClient);
- String include = "include_example"; // String |
- String filterStatus = "filterStatus_example"; // String |
- Integer pageNumber = 56; // Integer |
- Integer pageSize = 56; // Integer |
+ String id = "id_example"; // String |
+ String include = "environments"; // String | comma separated if needed. eg: environments,services,groups
try {
- AlertList result = apiInstance.listAlerts(include, filterStatus, pageNumber, pageSize);
+ AlertResponse result = apiInstance.getAlert(id, include);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling AlertsApi#listAlerts");
+ System.err.println("Exception when calling AlertsApi#getAlert");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -339,14 +344,12 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **include** | **String**| | [optional] |
-| **filterStatus** | **String**| | [optional] |
-| **pageNumber** | **Integer**| | [optional] |
-| **pageSize** | **Integer**| | [optional] |
+| **id** | **String**| | |
+| **include** | **String**| comma separated if needed. eg: environments,services,groups | [optional] [enum: environments, services, groups, responders, incidents, events, alert_urgency, heartbeat, live_call_router, alert_group, group_leader_alert, group_member_alerts, alert_field_values, alerting_targets, escalation_policies, alert_call_recording, alert_urgency] |
### Return type
-[**AlertList**](AlertList.md)
+[**AlertResponse**](AlertResponse.md)
### Authorization
@@ -360,15 +363,16 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **200** | filter by status | - |
+| **200** | alert found with group_member_alerts included | - |
+| **404** | resource not found | - |
-
-# **listIncidentAlerts**
-> AlertList listIncidentAlerts(incidentId, include, filterSource, filterServices, filterEnvironments, filterGroups, filterLabels, filterStartedAtGt, filterStartedAtGte, filterStartedAtLt, filterStartedAtLte, filterEndedAtGt, filterEndedAtGte, filterEndedAtLt, filterEndedAtLte, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, pageNumber, pageSize)
+
+# **listAlerts**
+> AlertList listAlerts(include, filterStatus, filterSource, filterServices, filterEnvironments, filterGroups, filterLabels, filterStartedAtGt, filterStartedAtGte, filterStartedAtLt, filterStartedAtLte, filterEndedAtGt, filterEndedAtGte, filterEndedAtLt, filterEndedAtLte, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, filterUpdatedAtGt, filterUpdatedAtGte, filterUpdatedAtLt, filterUpdatedAtLte, pageAfter, pageNumber, pageSize)
-List Incident alerts
+List alerts
-List incident alerts
+List alerts
### Example
```java
@@ -390,8 +394,8 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
AlertsApi apiInstance = new AlertsApi(defaultClient);
- String incidentId = "incidentId_example"; // String |
- String include = "include_example"; // String |
+ String include = "environments"; // String | comma separated if needed. eg: environments,services,groups
+ String filterStatus = "filterStatus_example"; // String |
String filterSource = "filterSource_example"; // String |
String filterServices = "filterServices_example"; // String |
String filterEnvironments = "filterEnvironments_example"; // String |
@@ -409,13 +413,18 @@ public class Example {
String filterCreatedAtGte = "filterCreatedAtGte_example"; // String |
String filterCreatedAtLt = "filterCreatedAtLt_example"; // String |
String filterCreatedAtLte = "filterCreatedAtLte_example"; // String |
+ String filterUpdatedAtGt = "filterUpdatedAtGt_example"; // String |
+ String filterUpdatedAtGte = "filterUpdatedAtGte_example"; // String |
+ String filterUpdatedAtLt = "filterUpdatedAtLt_example"; // String |
+ String filterUpdatedAtLte = "filterUpdatedAtLte_example"; // String |
+ String pageAfter = "pageAfter_example"; // String | The cursor to fetch results using cursor pagination. A cursor is provided in meta.next_cursor in the response.
Integer pageNumber = 56; // Integer |
Integer pageSize = 56; // Integer |
try {
- AlertList result = apiInstance.listIncidentAlerts(incidentId, include, filterSource, filterServices, filterEnvironments, filterGroups, filterLabels, filterStartedAtGt, filterStartedAtGte, filterStartedAtLt, filterStartedAtLte, filterEndedAtGt, filterEndedAtGte, filterEndedAtLt, filterEndedAtLte, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, pageNumber, pageSize);
+ AlertList result = apiInstance.listAlerts(include, filterStatus, filterSource, filterServices, filterEnvironments, filterGroups, filterLabels, filterStartedAtGt, filterStartedAtGte, filterStartedAtLt, filterStartedAtLte, filterEndedAtGt, filterEndedAtGte, filterEndedAtLt, filterEndedAtLte, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, filterUpdatedAtGt, filterUpdatedAtGte, filterUpdatedAtLt, filterUpdatedAtLte, pageAfter, pageNumber, pageSize);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling AlertsApi#listIncidentAlerts");
+ System.err.println("Exception when calling AlertsApi#listAlerts");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -429,8 +438,8 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **incidentId** | **String**| | |
-| **include** | **String**| | [optional] |
+| **include** | **String**| comma separated if needed. eg: environments,services,groups | [optional] [enum: environments, services, groups, responders, incidents, events, alert_urgency, heartbeat, live_call_router, alert_group, group_leader_alert, group_member_alerts, alert_field_values, alerting_targets, escalation_policies, alert_call_recording, alert_urgency] |
+| **filterStatus** | **String**| | [optional] |
| **filterSource** | **String**| | [optional] |
| **filterServices** | **String**| | [optional] |
| **filterEnvironments** | **String**| | [optional] |
@@ -448,6 +457,11 @@ public class Example {
| **filterCreatedAtGte** | **String**| | [optional] |
| **filterCreatedAtLt** | **String**| | [optional] |
| **filterCreatedAtLte** | **String**| | [optional] |
+| **filterUpdatedAtGt** | **String**| | [optional] |
+| **filterUpdatedAtGte** | **String**| | [optional] |
+| **filterUpdatedAtLt** | **String**| | [optional] |
+| **filterUpdatedAtLte** | **String**| | [optional] |
+| **pageAfter** | **String**| The cursor to fetch results using cursor pagination. A cursor is provided in meta.next_cursor in the response. | [optional] |
| **pageNumber** | **Integer**| | [optional] |
| **pageSize** | **Integer**| | [optional] |
@@ -459,6 +473,75 @@ public class Example {
[bearer_auth](../README.md#bearer_auth)
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | returns grouping attributes | - |
+
+
+# **listIncidentAlerts**
+> AlertList listIncidentAlerts(incidentId, include)
+
+List Incident alerts
+
+List incident alerts
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.AlertsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ AlertsApi apiInstance = new AlertsApi(defaultClient);
+ String incidentId = "incidentId_example"; // String |
+ String include = "environments"; // String | comma separated if needed. eg: environments,services,groups
+ try {
+ AlertList result = apiInstance.listIncidentAlerts(incidentId, include);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling AlertsApi#listIncidentAlerts");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **incidentId** | **String**| | |
+| **include** | **String**| comma separated if needed. eg: environments,services,groups | [optional] [enum: environments, services, groups, responders, incidents, events, alert_urgency, heartbeat, live_call_router, alert_group, group_leader_alert, group_member_alerts, alert_field_values, alerting_targets, escalation_policies, alert_call_recording, alert_urgency] |
+
+### Return type
+
+[**AlertList**](AlertList.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
### HTTP request headers
- **Content-Type**: Not defined
@@ -536,8 +619,80 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **200** | resolve acknowledged | - |
+| **200** | resolves open alert | - |
+| **404** | resource not found | - |
+
+
+# **snoozeAlert**
+> AlertResponse snoozeAlert(id, snoozeAlert)
+
+Snoozes an alert
+
+Snoozes a specific alert by id, extending the acknowledgment timeout
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.AlertsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ AlertsApi apiInstance = new AlertsApi(defaultClient);
+ String id = "id_example"; // String |
+ SnoozeAlert snoozeAlert = new SnoozeAlert(); // SnoozeAlert |
+ try {
+ AlertResponse result = apiInstance.snoozeAlert(id, snoozeAlert);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling AlertsApi#snoozeAlert");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| | |
+| **snoozeAlert** | [**SnoozeAlert**](SnoozeAlert.md)| | |
+
+### Return type
+
+[**AlertResponse**](AlertResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/vnd.api+json
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | alert snoozed | - |
| **404** | resource not found | - |
+| **400** | invalid delay_minutes | - |
+| **422** | snooze service failure | - |
# **updateAlert**
@@ -606,6 +761,6 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **200** | alert updated | - |
+| **200** | updates one field value and preserves others | - |
| **422** | invalid request | - |
diff --git a/docs/AlertsSource.md b/docs/AlertsSource.md
index a4adcbe8..0123e44e 100644
--- a/docs/AlertsSource.md
+++ b/docs/AlertsSource.md
@@ -7,18 +7,73 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
-|**alertUrgencyId** | **String** | ID for the default alert urgency assigned to this alert source | [optional] |
|**name** | **String** | The name of the alert source | |
-|**sourceType** | **String** | The alert source type | [optional] |
-|**status** | **String** | The current status of the alert source | |
-|**secret** | **String** | A secret key used to authenticate incoming requests to this alerts source | |
-|**webhookEndpoint** | **String** | The URL endpoint of the alert source | [optional] |
-|**email** | **String** | The email address of the alert source | [optional] |
+|**sourceType** | [**SourceTypeEnum**](#SourceTypeEnum) | The alert source type | [optional] |
+|**alertUrgencyId** | **String** | ID for the default alert urgency assigned to this alert source | [optional] |
+|**deduplicateAlertsByKey** | **Boolean** | Toggle alert deduplication using deduplication key. If enabled, deduplication_key_kind and deduplication_key_path are required. | [optional] |
+|**deduplicationKeyKind** | [**DeduplicationKeyKindEnum**](#DeduplicationKeyKindEnum) | Kind of deduplication key. | [optional] |
+|**deduplicationKeyPath** | **String** | Path to deduplication key. This is a JSON Path to extract the deduplication key from the request body. | [optional] |
+|**deduplicationKeyRegexp** | **String** | Regular expression to extract key from value found at key path. | [optional] |
|**ownerGroupIds** | **List<String>** | List of team IDs that will own the alert source | [optional] |
+|**alertTemplateAttributes** | [**NewAlertsSourceDataAttributesAlertTemplateAttributes**](NewAlertsSourceDataAttributesAlertTemplateAttributes.md) | | [optional] |
+|**alertSourceUrgencyRulesAttributes** | [**List<NewAlertsSourceDataAttributesAlertSourceUrgencyRulesAttributesInner>**](NewAlertsSourceDataAttributesAlertSourceUrgencyRulesAttributesInner.md) | List of rules that define the conditions under which the alert urgency will be set automatically based on the alert payload | [optional] |
+|**sourceableAttributes** | [**NewAlertsSourceDataAttributesSourceableAttributes**](NewAlertsSourceDataAttributesSourceableAttributes.md) | | [optional] |
+|**resolutionRuleAttributes** | [**NewAlertsSourceDataAttributesResolutionRuleAttributes**](NewAlertsSourceDataAttributesResolutionRuleAttributes.md) | | [optional] |
+|**alertSourceFieldsAttributes** | [**List<NewAlertsSourceDataAttributesAlertSourceFieldsAttributesInner>**](NewAlertsSourceDataAttributesAlertSourceFieldsAttributesInner.md) | List of alert fields to be added to the alert source. Note: This attribute requires the alert field feature to be enabled on your account. Contact Rootly customer support if you need assistance with this feature. | [optional] |
+|**status** | [**StatusEnum**](#StatusEnum) | The status of the alert source | |
+|**secret** | **String** | The secret used to authenticate non-email alert sources | |
+|**email** | **String** | The email generated for email alert sources | [optional] |
+|**webhookEndpoint** | **String** | The webhook URL generated for non-email alert sources | [optional] |
|**createdAt** | **String** | Date of creation | |
|**updatedAt** | **String** | Date of last update | |
-|**sourceableAttributes** | **Object** | Additional attributes specific to certain alert sources (e.g., generic_webhook), encapsulating source-specific configurations or details | [optional] |
-|**resolutionRuleAttributes** | **Object** | Additional attributes for email alerts source | [optional] |
+
+
+
+## Enum: SourceTypeEnum
+
+| Name | Value |
+|---- | -----|
+| EMAIL | "email" |
+| APP_DYNAMICS | "app_dynamics" |
+| CATCHPOINT | "catchpoint" |
+| DATADOG | "datadog" |
+| DYNATRACE | "dynatrace" |
+| ALERTMANAGER | "alertmanager" |
+| GOOGLE_CLOUD | "google_cloud" |
+| GRAFANA | "grafana" |
+| SENTRY | "sentry" |
+| GENERIC_WEBHOOK | "generic_webhook" |
+| CLOUD_WATCH | "cloud_watch" |
+| AWS_SNS | "aws_sns" |
+| CHECKLY | "checkly" |
+| AZURE | "azure" |
+| NEW_RELIC | "new_relic" |
+| SPLUNK | "splunk" |
+| CHRONOSPHERE | "chronosphere" |
+| APP_OPTICS | "app_optics" |
+| BUG_SNAG | "bug_snag" |
+| HONEYCOMB | "honeycomb" |
+| MONTE_CARLO | "monte_carlo" |
+| NAGIOS | "nagios" |
+| PRTG | "prtg" |
+
+
+
+## Enum: DeduplicationKeyKindEnum
+
+| Name | Value |
+|---- | -----|
+| PAYLOAD | "payload" |
+
+
+
+## Enum: StatusEnum
+
+| Name | Value |
+|---- | -----|
+| CONNECTED | "connected" |
+| SETUP_COMPLETE | "setup_complete" |
+| SETUP_INCOMPLETE | "setup_incomplete" |
diff --git a/docs/AlertsSourceList.md b/docs/AlertsSourceList.md
index 11812cff..978a9af7 100644
--- a/docs/AlertsSourceList.md
+++ b/docs/AlertsSourceList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<AlertsSourceResponseData>**](AlertsSourceResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/ApiKey.md b/docs/ApiKey.md
new file mode 100644
index 00000000..5f9ce7f5
--- /dev/null
+++ b/docs/ApiKey.md
@@ -0,0 +1,32 @@
+
+
+# ApiKey
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | The name of the API key | |
+|**description** | **String** | A description of the API key | [optional] |
+|**kind** | [**KindEnum**](#KindEnum) | The kind of the API key | |
+|**roleId** | **String** | The role ID | [optional] |
+|**onCallRoleId** | **String** | The on-call role ID | [optional] |
+|**createdAt** | **String** | Date of creation | |
+|**updatedAt** | **String** | Date of last update | |
+|**expiresAt** | **String** | Expiration date | [optional] |
+|**lastUsedAt** | **String** | Date of last use | [optional] |
+|**gracePeriodEndsAt** | **String** | Grace period end date | [optional] |
+
+
+
+## Enum: KindEnum
+
+| Name | Value |
+|---- | -----|
+| PERSONAL | "personal" |
+| TEAM | "team" |
+| ORGANIZATION | "organization" |
+
+
+
diff --git a/docs/ApiKeyList.md b/docs/ApiKeyList.md
new file mode 100644
index 00000000..3847164d
--- /dev/null
+++ b/docs/ApiKeyList.md
@@ -0,0 +1,15 @@
+
+
+# ApiKeyList
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<ApiKeyResponseData>**](ApiKeyResponseData.md) | | |
+|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
+
+
+
diff --git a/docs/ApiKeyResponse.md b/docs/ApiKeyResponse.md
new file mode 100644
index 00000000..3c9e8412
--- /dev/null
+++ b/docs/ApiKeyResponse.md
@@ -0,0 +1,13 @@
+
+
+# ApiKeyResponse
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**ApiKeyResponseData**](ApiKeyResponseData.md) | | |
+
+
+
diff --git a/docs/ApiKeyResponseData.md b/docs/ApiKeyResponseData.md
new file mode 100644
index 00000000..4cfe1c59
--- /dev/null
+++ b/docs/ApiKeyResponseData.md
@@ -0,0 +1,23 @@
+
+
+# ApiKeyResponseData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | Unique ID of the API key | |
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**ApiKey**](ApiKey.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| API_KEYS | "api_keys" |
+
+
+
diff --git a/docs/ApiKeyWithTokenResponse.md b/docs/ApiKeyWithTokenResponse.md
new file mode 100644
index 00000000..a5be96d4
--- /dev/null
+++ b/docs/ApiKeyWithTokenResponse.md
@@ -0,0 +1,13 @@
+
+
+# ApiKeyWithTokenResponse
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**ApiKeyWithTokenResponseData**](ApiKeyWithTokenResponseData.md) | | |
+
+
+
diff --git a/docs/ApiKeyWithTokenResponseData.md b/docs/ApiKeyWithTokenResponseData.md
new file mode 100644
index 00000000..6e68b146
--- /dev/null
+++ b/docs/ApiKeyWithTokenResponseData.md
@@ -0,0 +1,23 @@
+
+
+# ApiKeyWithTokenResponseData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | Unique ID of the API key | |
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**ApiKeyWithTokenResponseDataAttributes**](ApiKeyWithTokenResponseDataAttributes.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| API_KEYS | "api_keys" |
+
+
+
diff --git a/docs/ApiKeyWithTokenResponseDataAttributes.md b/docs/ApiKeyWithTokenResponseDataAttributes.md
new file mode 100644
index 00000000..796c1914
--- /dev/null
+++ b/docs/ApiKeyWithTokenResponseDataAttributes.md
@@ -0,0 +1,33 @@
+
+
+# ApiKeyWithTokenResponseDataAttributes
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | The name of the API key | |
+|**description** | **String** | A description of the API key | [optional] |
+|**kind** | [**KindEnum**](#KindEnum) | The kind of the API key | |
+|**roleId** | **String** | The role ID | [optional] |
+|**onCallRoleId** | **String** | The on-call role ID | [optional] |
+|**createdAt** | **String** | Date of creation | |
+|**updatedAt** | **String** | Date of last update | |
+|**expiresAt** | **String** | Expiration date | [optional] |
+|**lastUsedAt** | **String** | Date of last use | [optional] |
+|**gracePeriodEndsAt** | **String** | Grace period end date | [optional] |
+|**token** | **String** | The API key token (only shown once) | |
+
+
+
+## Enum: KindEnum
+
+| Name | Value |
+|---- | -----|
+| PERSONAL | "personal" |
+| TEAM | "team" |
+| ORGANIZATION | "organization" |
+
+
+
diff --git a/docs/ApiKeysApi.md b/docs/ApiKeysApi.md
new file mode 100644
index 00000000..55ed6e94
--- /dev/null
+++ b/docs/ApiKeysApi.md
@@ -0,0 +1,475 @@
+# ApiKeysApi
+
+All URIs are relative to *https://api.rootly.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createApiKey**](ApiKeysApi.md#createApiKey) | **POST** /v1/api_keys | Creates an API key |
+| [**deleteApiKey**](ApiKeysApi.md#deleteApiKey) | **DELETE** /v1/api_keys/{id} | Revoke an API key |
+| [**getApiKey**](ApiKeysApi.md#getApiKey) | **GET** /v1/api_keys/{id} | Retrieves an API key |
+| [**listApiKeys**](ApiKeysApi.md#listApiKeys) | **GET** /v1/api_keys | List API keys |
+| [**rotateApiKey**](ApiKeysApi.md#rotateApiKey) | **POST** /v1/api_keys/{id}/rotate | Rotate an API key |
+| [**updateApiKey**](ApiKeysApi.md#updateApiKey) | **PUT** /v1/api_keys/{id} | Update an API key |
+
+
+
+# **createApiKey**
+> ApiKeyWithTokenResponse createApiKey(newApiKey)
+
+Creates an API key
+
+Creates a new API key and returns it with the plaintext token. **The token is only returned once** — store it securely, as it cannot be retrieved again. **Kinds and required fields:** - `personal` — created for the authenticated user. No additional fields required. - `team` — scoped to a team (group). Requires `group_id`. A service account is automatically created with permissions derived from group membership. - `organization` — organization-wide access. Requires owner or admin role. Optionally set `role_id` and `on_call_role_id` to control the service account's permissions. **Expiration:** All keys require an `expires_at` date set in the future (maximum 5 years). Names must be unique within their kind and scope.
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.ApiKeysApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ ApiKeysApi apiInstance = new ApiKeysApi(defaultClient);
+ NewApiKey newApiKey = new NewApiKey(); // NewApiKey |
+ try {
+ ApiKeyWithTokenResponse result = apiInstance.createApiKey(newApiKey);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling ApiKeysApi#createApiKey");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **newApiKey** | [**NewApiKey**](NewApiKey.md)| | |
+
+### Return type
+
+[**ApiKeyWithTokenResponse**](ApiKeyWithTokenResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/vnd.api+json
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | API key created | - |
+| **422** | invalid request | - |
+| **401** | responds with unauthorized for invalid token | - |
+
+
+# **deleteApiKey**
+> ApiKeyResponse deleteApiKey(id)
+
+Revoke an API key
+
+Revoke an API key. The key is immediately invalidated and can no longer be used for authentication. This action cannot be undone. For `team` and `organization` keys, the associated service account is also deleted. Any active sessions using this key will fail on the next request.
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.ApiKeysApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ ApiKeysApi apiInstance = new ApiKeysApi(defaultClient);
+ UUID id = UUID.randomUUID(); // UUID |
+ try {
+ ApiKeyResponse result = apiInstance.deleteApiKey(id);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling ApiKeysApi#deleteApiKey");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **UUID**| | |
+
+### Return type
+
+[**ApiKeyResponse**](ApiKeyResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | API key revoked | - |
+| **404** | API key not found | - |
+
+
+# **getApiKey**
+> ApiKeyResponse getApiKey(id, include)
+
+Retrieves an API key
+
+Retrieves a specific API key by its UUID. Returns key metadata including name, kind, expiration, last usage timestamp, and the grace period status — the secret token is never included.
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.ApiKeysApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ ApiKeysApi apiInstance = new ApiKeysApi(defaultClient);
+ UUID id = UUID.randomUUID(); // UUID |
+ String include = "include_example"; // String | Comma-separated list of relationships to include (role, on_call_role, created_by, groups)
+ try {
+ ApiKeyResponse result = apiInstance.getApiKey(id, include);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling ApiKeysApi#getApiKey");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **UUID**| | |
+| **include** | **String**| Comma-separated list of relationships to include (role, on_call_role, created_by, groups) | [optional] |
+
+### Return type
+
+[**ApiKeyResponse**](ApiKeyResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | API key found | - |
+| **404** | API key not found | - |
+
+
+# **listApiKeys**
+> ApiKeyList listApiKeys(include, pageNumber, pageSize, filterKind, filterSearch, filterName, filterUserId, filterGroupIds, filterRoleId, filterActive, filterExpired, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, filterExpiresAtGt, filterExpiresAtGte, filterExpiresAtLt, filterExpiresAtLte, filterLastUsedAtGt, filterLastUsedAtGte, filterLastUsedAtLt, filterLastUsedAtLte, sort)
+
+List API keys
+
+List API keys for the current organization. Returns key metadata including name, kind, expiration, and last usage — the secret token value is never included in the response. **API key kinds:** - `personal` — tied to a specific user, inherits that user's permissions. - `team` — scoped to one or more teams (groups), creates a service account with permissions derived from group membership. - `organization` — organization-wide, creates a service account with a configurable role and on-call role. **Automated rotation workflow:** Use `filter[expires_at][lt]` to find keys approaching expiration, then call the rotate endpoint to issue a new token before the old one expires. Combine with `filter[active]=true` to exclude already-expired keys. **Sorting:** Use the `sort` parameter with a field name (e.g., `sort=expires_at`). Prefix with `-` for descending order (e.g., `sort=-created_at`). Allowed fields: `name`, `kind`, `created_at`, `updated_at`, `expires_at`, `last_used_at`.
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.ApiKeysApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ ApiKeysApi apiInstance = new ApiKeysApi(defaultClient);
+ String include = "include_example"; // String | Comma-separated list of relationships to include (role, on_call_role, created_by, groups)
+ Integer pageNumber = 56; // Integer |
+ Integer pageSize = 56; // Integer |
+ String filterKind = "filterKind_example"; // String | Filter by API key kind: personal, team, organization
+ String filterSearch = "filterSearch_example"; // String | Search by name (case-insensitive partial match)
+ String filterName = "filterName_example"; // String | Filter by exact name
+ String filterUserId = "filterUserId_example"; // String | Filter by the user ID that owns the key
+ String filterGroupIds = "filterGroupIds_example"; // String | Filter team keys by group IDs (comma-separated)
+ String filterRoleId = "filterRoleId_example"; // String | Filter by role ID
+ Boolean filterActive = true; // Boolean | When true, return only non-expired keys
+ Boolean filterExpired = true; // Boolean | When true, return only expired keys
+ String filterCreatedAtGt = "filterCreatedAtGt_example"; // String | Created after (ISO 8601)
+ String filterCreatedAtGte = "filterCreatedAtGte_example"; // String | Created at or after (ISO 8601)
+ String filterCreatedAtLt = "filterCreatedAtLt_example"; // String | Created before (ISO 8601)
+ String filterCreatedAtLte = "filterCreatedAtLte_example"; // String | Created at or before (ISO 8601)
+ String filterExpiresAtGt = "filterExpiresAtGt_example"; // String | Expires after (ISO 8601)
+ String filterExpiresAtGte = "filterExpiresAtGte_example"; // String | Expires at or after (ISO 8601)
+ String filterExpiresAtLt = "filterExpiresAtLt_example"; // String | Expires before (ISO 8601). Useful for finding keys approaching expiration.
+ String filterExpiresAtLte = "filterExpiresAtLte_example"; // String | Expires at or before (ISO 8601)
+ String filterLastUsedAtGt = "filterLastUsedAtGt_example"; // String | Last used after (ISO 8601)
+ String filterLastUsedAtGte = "filterLastUsedAtGte_example"; // String | Last used at or after (ISO 8601)
+ String filterLastUsedAtLt = "filterLastUsedAtLt_example"; // String | Last used before (ISO 8601)
+ String filterLastUsedAtLte = "filterLastUsedAtLte_example"; // String | Last used at or before (ISO 8601)
+ String sort = "sort_example"; // String | Sort by field. Prefix with - for descending (e.g., -created_at, expires_at)
+ try {
+ ApiKeyList result = apiInstance.listApiKeys(include, pageNumber, pageSize, filterKind, filterSearch, filterName, filterUserId, filterGroupIds, filterRoleId, filterActive, filterExpired, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, filterExpiresAtGt, filterExpiresAtGte, filterExpiresAtLt, filterExpiresAtLte, filterLastUsedAtGt, filterLastUsedAtGte, filterLastUsedAtLt, filterLastUsedAtLte, sort);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling ApiKeysApi#listApiKeys");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **include** | **String**| Comma-separated list of relationships to include (role, on_call_role, created_by, groups) | [optional] |
+| **pageNumber** | **Integer**| | [optional] |
+| **pageSize** | **Integer**| | [optional] |
+| **filterKind** | **String**| Filter by API key kind: personal, team, organization | [optional] |
+| **filterSearch** | **String**| Search by name (case-insensitive partial match) | [optional] |
+| **filterName** | **String**| Filter by exact name | [optional] |
+| **filterUserId** | **String**| Filter by the user ID that owns the key | [optional] |
+| **filterGroupIds** | **String**| Filter team keys by group IDs (comma-separated) | [optional] |
+| **filterRoleId** | **String**| Filter by role ID | [optional] |
+| **filterActive** | **Boolean**| When true, return only non-expired keys | [optional] |
+| **filterExpired** | **Boolean**| When true, return only expired keys | [optional] |
+| **filterCreatedAtGt** | **String**| Created after (ISO 8601) | [optional] |
+| **filterCreatedAtGte** | **String**| Created at or after (ISO 8601) | [optional] |
+| **filterCreatedAtLt** | **String**| Created before (ISO 8601) | [optional] |
+| **filterCreatedAtLte** | **String**| Created at or before (ISO 8601) | [optional] |
+| **filterExpiresAtGt** | **String**| Expires after (ISO 8601) | [optional] |
+| **filterExpiresAtGte** | **String**| Expires at or after (ISO 8601) | [optional] |
+| **filterExpiresAtLt** | **String**| Expires before (ISO 8601). Useful for finding keys approaching expiration. | [optional] |
+| **filterExpiresAtLte** | **String**| Expires at or before (ISO 8601) | [optional] |
+| **filterLastUsedAtGt** | **String**| Last used after (ISO 8601) | [optional] |
+| **filterLastUsedAtGte** | **String**| Last used at or after (ISO 8601) | [optional] |
+| **filterLastUsedAtLt** | **String**| Last used before (ISO 8601) | [optional] |
+| **filterLastUsedAtLte** | **String**| Last used at or before (ISO 8601) | [optional] |
+| **sort** | **String**| Sort by field. Prefix with - for descending (e.g., -created_at, expires_at) | [optional] |
+
+### Return type
+
+[**ApiKeyList**](ApiKeyList.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | success | - |
+| **401** | responds with unauthorized for invalid token | - |
+
+
+# **rotateApiKey**
+> ApiKeyWithTokenResponse rotateApiKey(id, rotateApiKey)
+
+Rotate an API key
+
+Rotate an API key's token. Issues a new secret token and returns it — **the new token is only shown once**, so store it securely. **Self-only:** You can only rotate the API key that was used to authenticate this request. Attempting to rotate a different key returns `403 Forbidden`. **Grace period:** When enabled for your organization, the previous token remains valid after rotation, giving you time to deploy the new token without downtime. Pass `grace_period_minutes` (integer, 0–1440, default 30) to control how long the old token stays valid. Set to 0 to immediately invalidate the old token. The `grace_period_ends_at` field in the response confirms the exact time the old token will stop working. **Expiration:** Optionally provide a new `expires_at` date (ISO 8601, up to 5 years). Defaults to 90 days from now if omitted. Dates in the past are rejected. **Typical rotation workflow:** 1. Call this endpoint to get a new token (optionally with a custom `grace_period_minutes`). 2. Deploy the new token to your systems. 3. The old token continues working for `grace_period_minutes` (if grace period is enabled). 4. After the grace period, the old token is automatically invalidated.
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.ApiKeysApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ ApiKeysApi apiInstance = new ApiKeysApi(defaultClient);
+ String id = "id_example"; // String |
+ RotateApiKey rotateApiKey = new RotateApiKey(); // RotateApiKey |
+ try {
+ ApiKeyWithTokenResponse result = apiInstance.rotateApiKey(id, rotateApiKey);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling ApiKeysApi#rotateApiKey");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| | |
+| **rotateApiKey** | [**RotateApiKey**](RotateApiKey.md)| | [optional] |
+
+### Return type
+
+[**ApiKeyWithTokenResponse**](ApiKeyWithTokenResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/vnd.api+json
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | API key rotated | - |
+| **404** | API key not found | - |
+
+
+# **updateApiKey**
+> ApiKeyResponse updateApiKey(id, updateApiKey)
+
+Update an API key
+
+Update an API key's mutable attributes: `name`, `description`, and `expires_at`. The key's `kind`, `role_id`, `on_call_role_id`, and token cannot be changed after creation. To issue a new token, use the rotate endpoint. To change the role or kind, revoke the key and create a new one. The new `expires_at` must be in the future and within 5 years.
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.ApiKeysApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ ApiKeysApi apiInstance = new ApiKeysApi(defaultClient);
+ UUID id = UUID.randomUUID(); // UUID |
+ UpdateApiKey updateApiKey = new UpdateApiKey(); // UpdateApiKey |
+ try {
+ ApiKeyResponse result = apiInstance.updateApiKey(id, updateApiKey);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling ApiKeysApi#updateApiKey");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **UUID**| | |
+| **updateApiKey** | [**UpdateApiKey**](UpdateApiKey.md)| | |
+
+### Return type
+
+[**ApiKeyResponse**](ApiKeyResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/vnd.api+json
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | API key updated | - |
+| **404** | API key not found | - |
+
diff --git a/docs/Audit.md b/docs/Audit.md
index 4eab140d..a091525f 100644
--- a/docs/Audit.md
+++ b/docs/Audit.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**event** | **String** | Describes the action that was taken. | |
|**itemType** | [**ItemTypeEnum**](#ItemTypeEnum) | Describes the object in which the action was taken on | [optional] |
+|**itemTypeDisplay** | **String** | Human-friendly display name for the item type | [optional] |
|**_object** | **Object** | The object in which the action was taken on | [optional] |
|**objectChanges** | **Object** | The changes that occurred on the object | [optional] |
|**userId** | **Integer** | The ID of who took action on the object. Together with whodunnit_type can be used to find the user | [optional] |
@@ -22,12 +23,21 @@
| Name | Value |
|---- | -----|
+| ALERT_ROUTE | "AlertRoute" |
+| ALERT_ROUTING_RULE | "AlertRoutingRule" |
+| ALERTS_SOURCE | "Alerts::Source" |
| API_KEY | "ApiKey" |
+| CATALOG | "Catalog" |
+| CATALOG_ENTITY | "CatalogEntity" |
+| CATALOG_ENTITY_PROPERTY | "CatalogEntityProperty" |
+| CATALOG_FIELD | "CatalogField" |
| CAUSE | "Cause" |
| CUSTOM_FIELD | "CustomField" |
| CUSTOM_FIELD_OPTION | "CustomFieldOption" |
| CUSTOM_FORM | "CustomForm" |
| DASHBOARD | "Dashboard" |
+| EDGE_CONNECTOR | "EdgeConnector" |
+| EDGE_CONNECTOR_ACTION | "EdgeConnector::Action" |
| ENVIRONMENT | "Environment" |
| ESCALATION_POLICY | "EscalationPolicy" |
| ESCALATION_POLICY_PATH | "EscalationPolicyPath" |
@@ -38,24 +48,41 @@
| GENIUS_WORKFLOW_GROUP | "GeniusWorkflowGroup" |
| GENIUS_WORKFLOW_RUN | "GeniusWorkflowRun" |
| GROUP | "Group" |
+| GROUP_USER | "GroupUser" |
| HEARTBEAT | "Heartbeat" |
| INCIDENT | "Incident" |
+| LOGIN_ACTIVITY | "LoginActivity" |
| INCIDENT_ACTION_ITEM | "IncidentActionItem" |
| INCIDENT_EVENT | "IncidentEvent" |
| INCIDENT_FORM_FIELD_SELECTION | "IncidentFormFieldSelection" |
| INCIDENT_FORM_FIELD_SELECTION_USER | "IncidentFormFieldSelectionUser" |
+| INCIDENT_PERMISSION_SET | "IncidentPermissionSet" |
| INCIDENT_POST_MORTEM | "IncidentPostMortem" |
| INCIDENT_ROLE_ASSIGNMENT | "IncidentRoleAssignment" |
| INCIDENT_ROLE_TASK | "IncidentRoleTask" |
| INCIDENT_STATUS_PAGE_EVENT | "IncidentStatusPageEvent" |
| INCIDENT_TASK | "IncidentTask" |
| INCIDENT_TYPE | "IncidentType" |
+| INTEGRATIONS_DATADOG_ACCOUNT | "Integrations::DatadogAccount" |
+| INTEGRATIONS_GITHUB_ACCOUNT | "Integrations::GithubAccount" |
+| INTEGRATIONS_GOOGLE_MEET_ACCOUNT | "Integrations::GoogleMeetAccount" |
+| INTEGRATIONS_JIRA_ACCOUNT | "Integrations::JiraAccount" |
+| INTEGRATIONS_MICROSOFT_TEAMS_ACCOUNT | "Integrations::MicrosoftTeamsAccount" |
+| INTEGRATIONS_OPSGENIE_ACCOUNT | "Integrations::OpsgenieAccount" |
+| INTEGRATIONS_PAGERDUTY_ACCOUNT | "Integrations::PagerdutyAccount" |
+| INTEGRATIONS_SERVICE_NOW_ACCOUNT | "Integrations::ServiceNowAccount" |
+| INTEGRATIONS_SLACK_ACCOUNT | "Integrations::SlackAccount" |
+| INTEGRATIONS_STATUS_PAGE_IO_ACCOUNT | "Integrations::StatusPageIoAccount" |
+| INTEGRATIONS_ZENDESK_ACCOUNT | "Integrations::ZendeskAccount" |
+| INTEGRATIONS_ZOOM_ACCOUNT | "Integrations::ZoomAccount" |
| LIVE_CALL_ROUTER | "LiveCallRouter" |
+| MEMBERSHIP | "Membership" |
| ON_CALL_ROLE | "OnCallRole" |
| PLAYBOOK | "Playbook" |
| PLAYBOOK_TASK | "PlaybookTask" |
| ROLE | "Role" |
| SCHEDULE | "Schedule" |
+| SECRET | "Secret" |
| SERVICE | "Service" |
| SEVERITY | "Severity" |
| STATUS_PAGE | "StatusPage" |
diff --git a/docs/AuditsList.md b/docs/AuditsList.md
index 1fc057d6..edfcbae2 100644
--- a/docs/AuditsList.md
+++ b/docs/AuditsList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<AuditsListDataInner>**](AuditsListDataInner.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/AuthorizationList.md b/docs/AuthorizationList.md
index 3633dd66..c89d9c16 100644
--- a/docs/AuthorizationList.md
+++ b/docs/AuthorizationList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<AuthorizationResponseData>**](AuthorizationResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/BuiltinField.md b/docs/BuiltinField.md
new file mode 100644
index 00000000..6af57f40
--- /dev/null
+++ b/docs/BuiltinField.md
@@ -0,0 +1,22 @@
+
+
+# BuiltinField
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**fieldSource** | [**FieldSourceEnum**](#FieldSourceEnum) | | |
+|**fieldKey** | **String** | Key identifying the builtin field | |
+
+
+
+## Enum: FieldSourceEnum
+
+| Name | Value |
+|---- | -----|
+| BUILTIN | "builtin" |
+
+
+
diff --git a/docs/CatalogChecklistTemplate.md b/docs/CatalogChecklistTemplate.md
new file mode 100644
index 00000000..8738e934
--- /dev/null
+++ b/docs/CatalogChecklistTemplate.md
@@ -0,0 +1,45 @@
+
+
+# CatalogChecklistTemplate
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | The name of the checklist template | |
+|**slug** | **String** | The slug of the checklist template | [optional] |
+|**description** | **String** | The description of the checklist template | [optional] |
+|**catalogType** | [**CatalogTypeEnum**](#CatalogTypeEnum) | The catalog type | |
+|**scopeType** | [**ScopeTypeEnum**](#ScopeTypeEnum) | The scope type | |
+|**scopeId** | **String** | The scope ID | |
+|**createdAt** | **String** | Date of creation | |
+|**updatedAt** | **String** | Date of last update | |
+|**fields** | [**List<CatalogChecklistTemplateFieldsInner>**](CatalogChecklistTemplateFieldsInner.md) | Template fields in position order | [optional] |
+|**owners** | [**List<CatalogChecklistTemplateOwnersInner>**](CatalogChecklistTemplateOwnersInner.md) | Template owners | [optional] |
+
+
+
+## Enum: CatalogTypeEnum
+
+| Name | Value |
+|---- | -----|
+| SERVICE | "Service" |
+| FUNCTIONALITY | "Functionality" |
+| ENVIRONMENT | "Environment" |
+| GROUP | "Group" |
+| CAUSE | "Cause" |
+| INCIDENT_TYPE | "IncidentType" |
+| CATALOG | "Catalog" |
+
+
+
+## Enum: ScopeTypeEnum
+
+| Name | Value |
+|---- | -----|
+| TEAM | "Team" |
+| CATALOG | "Catalog" |
+
+
+
diff --git a/docs/CatalogChecklistTemplateFieldsInner.md b/docs/CatalogChecklistTemplateFieldsInner.md
new file mode 100644
index 00000000..62cea492
--- /dev/null
+++ b/docs/CatalogChecklistTemplateFieldsInner.md
@@ -0,0 +1,24 @@
+
+
+# CatalogChecklistTemplateFieldsInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**fieldSource** | [**FieldSourceEnum**](#FieldSourceEnum) | Source of the field | [optional] |
+|**fieldKey** | **String** | Key identifying the field | [optional] |
+|**catalogPropertyId** | **String** | ID of the catalog property for custom fields | [optional] |
+
+
+
+## Enum: FieldSourceEnum
+
+| Name | Value |
+|---- | -----|
+| BUILTIN | "builtin" |
+| CUSTOM | "custom" |
+
+
+
diff --git a/docs/CatalogChecklistTemplateList.md b/docs/CatalogChecklistTemplateList.md
new file mode 100644
index 00000000..d66b6a53
--- /dev/null
+++ b/docs/CatalogChecklistTemplateList.md
@@ -0,0 +1,15 @@
+
+
+# CatalogChecklistTemplateList
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<CatalogChecklistTemplateResponseData>**](CatalogChecklistTemplateResponseData.md) | | |
+|**links** | [**Links**](Links.md) | | [optional] |
+|**meta** | [**Meta**](Meta.md) | | [optional] |
+
+
+
diff --git a/docs/CatalogChecklistTemplateOwnersInner.md b/docs/CatalogChecklistTemplateOwnersInner.md
new file mode 100644
index 00000000..bbc293f9
--- /dev/null
+++ b/docs/CatalogChecklistTemplateOwnersInner.md
@@ -0,0 +1,23 @@
+
+
+# CatalogChecklistTemplateOwnersInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | User ID for user owners, or field key for field owners | [optional] |
+|**type** | [**TypeEnum**](#TypeEnum) | Type of owner | [optional] |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| FIELD | "field" |
+| USER | "user" |
+
+
+
diff --git a/docs/CatalogChecklistTemplateResponse.md b/docs/CatalogChecklistTemplateResponse.md
new file mode 100644
index 00000000..e9311087
--- /dev/null
+++ b/docs/CatalogChecklistTemplateResponse.md
@@ -0,0 +1,13 @@
+
+
+# CatalogChecklistTemplateResponse
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**CatalogChecklistTemplateResponseData**](CatalogChecklistTemplateResponseData.md) | | |
+
+
+
diff --git a/docs/CatalogChecklistTemplateResponseData.md b/docs/CatalogChecklistTemplateResponseData.md
new file mode 100644
index 00000000..a6418664
--- /dev/null
+++ b/docs/CatalogChecklistTemplateResponseData.md
@@ -0,0 +1,23 @@
+
+
+# CatalogChecklistTemplateResponseData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | Unique ID of the checklist template | |
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**CatalogChecklistTemplate**](CatalogChecklistTemplate.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| CATALOG_CHECKLIST_TEMPLATES | "catalog_checklist_templates" |
+
+
+
diff --git a/docs/CatalogChecklistTemplatesApi.md b/docs/CatalogChecklistTemplatesApi.md
new file mode 100644
index 00000000..fad71a9d
--- /dev/null
+++ b/docs/CatalogChecklistTemplatesApi.md
@@ -0,0 +1,445 @@
+# CatalogChecklistTemplatesApi
+
+All URIs are relative to *https://api.rootly.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createCatalogChecklistTemplate**](CatalogChecklistTemplatesApi.md#createCatalogChecklistTemplate) | **POST** /v1/catalog_checklist_templates | Creates a catalog checklist template |
+| [**deleteCatalogChecklistTemplate**](CatalogChecklistTemplatesApi.md#deleteCatalogChecklistTemplate) | **DELETE** /v1/catalog_checklist_templates/{id} | Delete a catalog checklist template |
+| [**getCatalogChecklistTemplate**](CatalogChecklistTemplatesApi.md#getCatalogChecklistTemplate) | **GET** /v1/catalog_checklist_templates/{id} | Retrieves a catalog checklist template |
+| [**listCatalogChecklistTemplates**](CatalogChecklistTemplatesApi.md#listCatalogChecklistTemplates) | **GET** /v1/catalog_checklist_templates | List catalog checklist templates |
+| [**triggerCatalogChecklistTemplate**](CatalogChecklistTemplatesApi.md#triggerCatalogChecklistTemplate) | **POST** /v1/catalog_checklist_templates/{id}/trigger | Trigger an audit for a catalog checklist template |
+| [**updateCatalogChecklistTemplate**](CatalogChecklistTemplatesApi.md#updateCatalogChecklistTemplate) | **PUT** /v1/catalog_checklist_templates/{id} | Update a catalog checklist template |
+
+
+
+# **createCatalogChecklistTemplate**
+> CatalogChecklistTemplateResponse createCatalogChecklistTemplate(newCatalogChecklistTemplate)
+
+Creates a catalog checklist template
+
+Creates a new catalog checklist template
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.CatalogChecklistTemplatesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ CatalogChecklistTemplatesApi apiInstance = new CatalogChecklistTemplatesApi(defaultClient);
+ NewCatalogChecklistTemplate newCatalogChecklistTemplate = new NewCatalogChecklistTemplate(); // NewCatalogChecklistTemplate |
+ try {
+ CatalogChecklistTemplateResponse result = apiInstance.createCatalogChecklistTemplate(newCatalogChecklistTemplate);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling CatalogChecklistTemplatesApi#createCatalogChecklistTemplate");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **newCatalogChecklistTemplate** | [**NewCatalogChecklistTemplate**](NewCatalogChecklistTemplate.md)| | |
+
+### Return type
+
+[**CatalogChecklistTemplateResponse**](CatalogChecklistTemplateResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/vnd.api+json
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | ignores user-provided field_key for custom fields | - |
+| **422** | returns 422 when scope_type is missing for Catalog scope_id | - |
+| **401** | responds with unauthorized for invalid token | - |
+
+
+# **deleteCatalogChecklistTemplate**
+> CatalogChecklistTemplateResponse deleteCatalogChecklistTemplate(id)
+
+Delete a catalog checklist template
+
+Delete a specific catalog checklist template by id
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.CatalogChecklistTemplatesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ CatalogChecklistTemplatesApi apiInstance = new CatalogChecklistTemplatesApi(defaultClient);
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
+ try {
+ CatalogChecklistTemplateResponse result = apiInstance.deleteCatalogChecklistTemplate(id);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling CatalogChecklistTemplatesApi#deleteCatalogChecklistTemplate");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
+
+### Return type
+
+[**CatalogChecklistTemplateResponse**](CatalogChecklistTemplateResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | catalog checklist template deleted | - |
+| **404** | catalog checklist template not found | - |
+
+
+# **getCatalogChecklistTemplate**
+> CatalogChecklistTemplateResponse getCatalogChecklistTemplate(id)
+
+Retrieves a catalog checklist template
+
+Retrieves a specific catalog checklist template by id
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.CatalogChecklistTemplatesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ CatalogChecklistTemplatesApi apiInstance = new CatalogChecklistTemplatesApi(defaultClient);
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
+ try {
+ CatalogChecklistTemplateResponse result = apiInstance.getCatalogChecklistTemplate(id);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling CatalogChecklistTemplatesApi#getCatalogChecklistTemplate");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
+
+### Return type
+
+[**CatalogChecklistTemplateResponse**](CatalogChecklistTemplateResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | catalog checklist template found by slug | - |
+| **404** | resource not found for another team | - |
+
+
+# **listCatalogChecklistTemplates**
+> CatalogChecklistTemplateList listCatalogChecklistTemplates(include, sort, pageNumber, pageSize, filterName, filterSlug, filterCatalogType, filterScopeType, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte)
+
+List catalog checklist templates
+
+List catalog checklist templates
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.CatalogChecklistTemplatesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ CatalogChecklistTemplatesApi apiInstance = new CatalogChecklistTemplatesApi(defaultClient);
+ String include = "template_fields"; // String | comma separated if needed. eg: template_fields,template_owners
+ String sort = "created_at"; // String | comma separated if needed. eg: created_at,updated_at
+ Integer pageNumber = 56; // Integer |
+ Integer pageSize = 56; // Integer |
+ String filterName = "filterName_example"; // String |
+ String filterSlug = "filterSlug_example"; // String |
+ String filterCatalogType = "filterCatalogType_example"; // String |
+ String filterScopeType = "filterScopeType_example"; // String |
+ String filterCreatedAtGt = "filterCreatedAtGt_example"; // String |
+ String filterCreatedAtGte = "filterCreatedAtGte_example"; // String |
+ String filterCreatedAtLt = "filterCreatedAtLt_example"; // String |
+ String filterCreatedAtLte = "filterCreatedAtLte_example"; // String |
+ try {
+ CatalogChecklistTemplateList result = apiInstance.listCatalogChecklistTemplates(include, sort, pageNumber, pageSize, filterName, filterSlug, filterCatalogType, filterScopeType, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling CatalogChecklistTemplatesApi#listCatalogChecklistTemplates");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **include** | **String**| comma separated if needed. eg: template_fields,template_owners | [optional] [enum: template_fields, template_owners] |
+| **sort** | **String**| comma separated if needed. eg: created_at,updated_at | [optional] [enum: created_at, -created_at, updated_at, -updated_at, name, -name] |
+| **pageNumber** | **Integer**| | [optional] |
+| **pageSize** | **Integer**| | [optional] |
+| **filterName** | **String**| | [optional] |
+| **filterSlug** | **String**| | [optional] |
+| **filterCatalogType** | **String**| | [optional] |
+| **filterScopeType** | **String**| | [optional] |
+| **filterCreatedAtGt** | **String**| | [optional] |
+| **filterCreatedAtGte** | **String**| | [optional] |
+| **filterCreatedAtLt** | **String**| | [optional] |
+| **filterCreatedAtLte** | **String**| | [optional] |
+
+### Return type
+
+[**CatalogChecklistTemplateList**](CatalogChecklistTemplateList.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | returns empty list for another team | - |
+
+
+# **triggerCatalogChecklistTemplate**
+> triggerCatalogChecklistTemplate(id)
+
+Trigger an audit for a catalog checklist template
+
+Triggers an audit for all applicable entities of the checklist template
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.CatalogChecklistTemplatesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ CatalogChecklistTemplatesApi apiInstance = new CatalogChecklistTemplatesApi(defaultClient);
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
+ try {
+ apiInstance.triggerCatalogChecklistTemplate(id);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling CatalogChecklistTemplatesApi#triggerCatalogChecklistTemplate");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **202** | audit triggered | - |
+| **404** | resource not found for another team | - |
+
+
+# **updateCatalogChecklistTemplate**
+> CatalogChecklistTemplateResponse updateCatalogChecklistTemplate(id, updateCatalogChecklistTemplate)
+
+Update a catalog checklist template
+
+Update a specific catalog checklist template by id
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.CatalogChecklistTemplatesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ CatalogChecklistTemplatesApi apiInstance = new CatalogChecklistTemplatesApi(defaultClient);
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
+ UpdateCatalogChecklistTemplate updateCatalogChecklistTemplate = new UpdateCatalogChecklistTemplate(); // UpdateCatalogChecklistTemplate |
+ try {
+ CatalogChecklistTemplateResponse result = apiInstance.updateCatalogChecklistTemplate(id, updateCatalogChecklistTemplate);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling CatalogChecklistTemplatesApi#updateCatalogChecklistTemplate");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
+| **updateCatalogChecklistTemplate** | [**UpdateCatalogChecklistTemplate**](UpdateCatalogChecklistTemplate.md)| | |
+
+### Return type
+
+[**CatalogChecklistTemplateResponse**](CatalogChecklistTemplateResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/vnd.api+json
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | ignores user-provided field_key for custom fields on update | - |
+| **422** | rejects duplicate custom fields on update | - |
+
diff --git a/docs/CatalogEntitiesApi.md b/docs/CatalogEntitiesApi.md
index b8b90d46..e8d7d1ab 100644
--- a/docs/CatalogEntitiesApi.md
+++ b/docs/CatalogEntitiesApi.md
@@ -78,8 +78,8 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **201** | catalog_entity created | - |
-| **422** | invalid request | - |
+| **201** | catalog_entity created with fields attribute | - |
+| **422** | rejects entity with invalid catalog_field_id | - |
| **401** | responds with unauthorized for invalid token | - |
@@ -110,7 +110,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
CatalogEntitiesApi apiInstance = new CatalogEntitiesApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
CatalogEntityResponse result = apiInstance.deleteCatalogEntity(id);
System.out.println(result);
@@ -129,7 +129,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -178,7 +178,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
CatalogEntitiesApi apiInstance = new CatalogEntitiesApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
String include = "catalog"; // String | comma separated if needed. eg: catalog,properties
try {
CatalogEntityResponse result = apiInstance.getCatalogEntity(id, include);
@@ -198,7 +198,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
| **include** | **String**| comma separated if needed. eg: catalog,properties | [optional] [enum: catalog, properties] |
### Return type
@@ -217,12 +217,12 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **200** | catalog_entity found | - |
+| **200** | catalog_entity found by slug | - |
| **404** | resource not found | - |
# **listCatalogEntities**
-> CatalogEntityList listCatalogEntities(catalogId, include, sort, pageNumber, pageSize, filterSlug, filterName, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte)
+> CatalogEntityList listCatalogEntities(catalogId, include, sort, pageNumber, pageSize, filterSearch, filterSlug, filterName, filterBackstageId, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte)
List Catalog Entities
@@ -253,14 +253,16 @@ public class Example {
String sort = "created_at"; // String | comma separated if needed. eg: created_at,updated_at
Integer pageNumber = 56; // Integer |
Integer pageSize = 56; // Integer |
+ String filterSearch = "filterSearch_example"; // String |
String filterSlug = "filterSlug_example"; // String |
String filterName = "filterName_example"; // String |
+ String filterBackstageId = "filterBackstageId_example"; // String |
String filterCreatedAtGt = "filterCreatedAtGt_example"; // String |
String filterCreatedAtGte = "filterCreatedAtGte_example"; // String |
String filterCreatedAtLt = "filterCreatedAtLt_example"; // String |
String filterCreatedAtLte = "filterCreatedAtLte_example"; // String |
try {
- CatalogEntityList result = apiInstance.listCatalogEntities(catalogId, include, sort, pageNumber, pageSize, filterSlug, filterName, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte);
+ CatalogEntityList result = apiInstance.listCatalogEntities(catalogId, include, sort, pageNumber, pageSize, filterSearch, filterSlug, filterName, filterBackstageId, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling CatalogEntitiesApi#listCatalogEntities");
@@ -282,8 +284,10 @@ public class Example {
| **sort** | **String**| comma separated if needed. eg: created_at,updated_at | [optional] [enum: created_at, -created_at, updated_at, -updated_at, position, -position] |
| **pageNumber** | **Integer**| | [optional] |
| **pageSize** | **Integer**| | [optional] |
+| **filterSearch** | **String**| | [optional] |
| **filterSlug** | **String**| | [optional] |
| **filterName** | **String**| | [optional] |
+| **filterBackstageId** | **String**| | [optional] |
| **filterCreatedAtGt** | **String**| | [optional] |
| **filterCreatedAtGte** | **String**| | [optional] |
| **filterCreatedAtLt** | **String**| | [optional] |
@@ -335,7 +339,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
CatalogEntitiesApi apiInstance = new CatalogEntitiesApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
UpdateCatalogEntity updateCatalogEntity = new UpdateCatalogEntity(); // UpdateCatalogEntity |
try {
CatalogEntityResponse result = apiInstance.updateCatalogEntity(id, updateCatalogEntity);
@@ -355,7 +359,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
| **updateCatalogEntity** | [**UpdateCatalogEntity**](UpdateCatalogEntity.md)| | |
### Return type
@@ -374,6 +378,6 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **200** | catalog_entity updated | - |
+| **200** | catalog_entity update replaces existing properties | - |
| **404** | resource not found | - |
diff --git a/docs/CatalogEntity.md b/docs/CatalogEntity.md
index 91bff1b9..1175b094 100644
--- a/docs/CatalogEntity.md
+++ b/docs/CatalogEntity.md
@@ -10,8 +10,10 @@
|**name** | **String** | | |
|**description** | **String** | | [optional] |
|**position** | **Integer** | Default position of the item when displayed in a list. | |
+|**backstageId** | **String** | The Backstage entity ID this catalog entity is linked to. | [optional] |
|**createdAt** | **String** | | |
|**updatedAt** | **String** | | |
+|**properties** | [**List<NewCatalogEntityDataAttributesPropertiesInner>**](NewCatalogEntityDataAttributesPropertiesInner.md) | Array of property values for this catalog entity | [optional] |
diff --git a/docs/CatalogEntityChecklist.md b/docs/CatalogEntityChecklist.md
new file mode 100644
index 00000000..d3109fd1
--- /dev/null
+++ b/docs/CatalogEntityChecklist.md
@@ -0,0 +1,48 @@
+
+
+# CatalogEntityChecklist
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**catalogChecklistTemplateId** | **String** | The ID of the checklist template | |
+|**auditableType** | [**AuditableTypeEnum**](#AuditableTypeEnum) | The type of the auditable entity | |
+|**auditableId** | **String** | The ID of the auditable entity | |
+|**status** | [**StatusEnum**](#StatusEnum) | The status of the checklist | |
+|**startedAt** | **String** | When the checklist was started | [optional] |
+|**completedAt** | **String** | When the checklist was completed | [optional] |
+|**completedByUserId** | **String** | The ID of the user who completed the checklist | [optional] |
+|**createdAt** | **String** | Date of creation | |
+|**updatedAt** | **String** | Date of last update | |
+|**checklistFields** | [**List<CatalogEntityChecklistChecklistFieldsInner>**](CatalogEntityChecklistChecklistFieldsInner.md) | Checklist fields | [optional] |
+|**checklistOwners** | [**List<CatalogEntityChecklistChecklistOwnersInner>**](CatalogEntityChecklistChecklistOwnersInner.md) | Checklist owners | [optional] |
+
+
+
+## Enum: AuditableTypeEnum
+
+| Name | Value |
+|---- | -----|
+| SERVICE | "Service" |
+| FUNCTIONALITY | "Functionality" |
+| ENVIRONMENT | "Environment" |
+| GROUP | "Group" |
+| CAUSE | "Cause" |
+| INCIDENT_TYPE | "IncidentType" |
+| CATALOG_ENTITY | "CatalogEntity" |
+
+
+
+## Enum: StatusEnum
+
+| Name | Value |
+|---- | -----|
+| TRIGGERED | "triggered" |
+| IN_PROGRESS | "in_progress" |
+| COMPLETED | "completed" |
+| CANCELLED | "cancelled" |
+
+
+
diff --git a/docs/CatalogEntityChecklistChecklistFieldsInner.md b/docs/CatalogEntityChecklistChecklistFieldsInner.md
new file mode 100644
index 00000000..b19e9a6a
--- /dev/null
+++ b/docs/CatalogEntityChecklistChecklistFieldsInner.md
@@ -0,0 +1,13 @@
+
+
+# CatalogEntityChecklistChecklistFieldsInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**CatalogEntityChecklistChecklistFieldsInnerData**](CatalogEntityChecklistChecklistFieldsInnerData.md) | | [optional] |
+
+
+
diff --git a/docs/CatalogEntityChecklistChecklistFieldsInnerData.md b/docs/CatalogEntityChecklistChecklistFieldsInnerData.md
new file mode 100644
index 00000000..ca7bf157
--- /dev/null
+++ b/docs/CatalogEntityChecklistChecklistFieldsInnerData.md
@@ -0,0 +1,23 @@
+
+
+# CatalogEntityChecklistChecklistFieldsInnerData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | ID of the checklist field | [optional] |
+|**type** | [**TypeEnum**](#TypeEnum) | | [optional] |
+|**attributes** | [**CatalogEntityChecklistChecklistFieldsInnerDataAttributes**](CatalogEntityChecklistChecklistFieldsInnerDataAttributes.md) | | [optional] |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| CATALOG_ENTITY_CHECKLIST_FIELDS | "catalog_entity_checklist_fields" |
+
+
+
diff --git a/docs/CatalogEntityChecklistChecklistFieldsInnerDataAttributes.md b/docs/CatalogEntityChecklistChecklistFieldsInnerDataAttributes.md
new file mode 100644
index 00000000..5359ab86
--- /dev/null
+++ b/docs/CatalogEntityChecklistChecklistFieldsInnerDataAttributes.md
@@ -0,0 +1,21 @@
+
+
+# CatalogEntityChecklistChecklistFieldsInnerDataAttributes
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**catalogEntityChecklistId** | **String** | The ID of the parent checklist | [optional] |
+|**catalogChecklistTemplateFieldId** | **String** | The ID of the template field | [optional] |
+|**fieldKey** | **String** | The field key | [optional] |
+|**checked** | **Boolean** | Whether the field is checked | [optional] |
+|**valueSnapshot** | **Object** | The value snapshot at time of checking | [optional] |
+|**completedByUserId** | **String** | The ID of the user who checked the field | [optional] |
+|**completedAt** | **String** | When the field was checked | [optional] |
+|**createdAt** | **String** | Date of creation | [optional] |
+|**updatedAt** | **String** | Date of last update | [optional] |
+
+
+
diff --git a/docs/CatalogEntityChecklistChecklistOwnersInner.md b/docs/CatalogEntityChecklistChecklistOwnersInner.md
new file mode 100644
index 00000000..3acdda0a
--- /dev/null
+++ b/docs/CatalogEntityChecklistChecklistOwnersInner.md
@@ -0,0 +1,13 @@
+
+
+# CatalogEntityChecklistChecklistOwnersInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**CatalogEntityChecklistChecklistOwnersInnerData**](CatalogEntityChecklistChecklistOwnersInnerData.md) | | [optional] |
+
+
+
diff --git a/docs/CatalogEntityChecklistChecklistOwnersInnerData.md b/docs/CatalogEntityChecklistChecklistOwnersInnerData.md
new file mode 100644
index 00000000..4bd40ebb
--- /dev/null
+++ b/docs/CatalogEntityChecklistChecklistOwnersInnerData.md
@@ -0,0 +1,23 @@
+
+
+# CatalogEntityChecklistChecklistOwnersInnerData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | ID of the checklist owner | [optional] |
+|**type** | [**TypeEnum**](#TypeEnum) | | [optional] |
+|**attributes** | [**CatalogEntityChecklistChecklistOwnersInnerDataAttributes**](CatalogEntityChecklistChecklistOwnersInnerDataAttributes.md) | | [optional] |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| CATALOG_ENTITY_CHECKLIST_OWNERS | "catalog_entity_checklist_owners" |
+
+
+
diff --git a/docs/CatalogEntityChecklistChecklistOwnersInnerDataAttributes.md b/docs/CatalogEntityChecklistChecklistOwnersInnerDataAttributes.md
new file mode 100644
index 00000000..11d9cf4b
--- /dev/null
+++ b/docs/CatalogEntityChecklistChecklistOwnersInnerDataAttributes.md
@@ -0,0 +1,16 @@
+
+
+# CatalogEntityChecklistChecklistOwnersInnerDataAttributes
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**catalogEntityChecklistId** | **String** | The ID of the parent checklist | [optional] |
+|**ownerUserId** | **String** | The ID of the owner user | [optional] |
+|**createdAt** | **String** | Date of creation | [optional] |
+|**updatedAt** | **String** | Date of last update | [optional] |
+
+
+
diff --git a/docs/CatalogEntityChecklistList.md b/docs/CatalogEntityChecklistList.md
new file mode 100644
index 00000000..0e368d72
--- /dev/null
+++ b/docs/CatalogEntityChecklistList.md
@@ -0,0 +1,15 @@
+
+
+# CatalogEntityChecklistList
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<CatalogEntityChecklistResponseData>**](CatalogEntityChecklistResponseData.md) | | |
+|**links** | [**Links**](Links.md) | | [optional] |
+|**meta** | [**Meta**](Meta.md) | | [optional] |
+
+
+
diff --git a/docs/CatalogEntityChecklistResponse.md b/docs/CatalogEntityChecklistResponse.md
new file mode 100644
index 00000000..2df8b92e
--- /dev/null
+++ b/docs/CatalogEntityChecklistResponse.md
@@ -0,0 +1,13 @@
+
+
+# CatalogEntityChecklistResponse
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**CatalogEntityChecklistResponseData**](CatalogEntityChecklistResponseData.md) | | |
+
+
+
diff --git a/docs/CatalogEntityChecklistResponseData.md b/docs/CatalogEntityChecklistResponseData.md
new file mode 100644
index 00000000..d0ca6d5e
--- /dev/null
+++ b/docs/CatalogEntityChecklistResponseData.md
@@ -0,0 +1,23 @@
+
+
+# CatalogEntityChecklistResponseData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | Unique ID of the entity checklist | |
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**CatalogEntityChecklist**](CatalogEntityChecklist.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| CATALOG_ENTITY_CHECKLISTS | "catalog_entity_checklists" |
+
+
+
diff --git a/docs/CatalogEntityChecklistsApi.md b/docs/CatalogEntityChecklistsApi.md
new file mode 100644
index 00000000..816435de
--- /dev/null
+++ b/docs/CatalogEntityChecklistsApi.md
@@ -0,0 +1,163 @@
+# CatalogEntityChecklistsApi
+
+All URIs are relative to *https://api.rootly.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getCatalogEntityChecklist**](CatalogEntityChecklistsApi.md#getCatalogEntityChecklist) | **GET** /v1/catalog_entity_checklists/{id} | Retrieves a catalog entity checklist |
+| [**listCatalogEntityChecklists**](CatalogEntityChecklistsApi.md#listCatalogEntityChecklists) | **GET** /v1/catalog_entity_checklists | List catalog entity checklists |
+
+
+
+# **getCatalogEntityChecklist**
+> CatalogEntityChecklistResponse getCatalogEntityChecklist(id)
+
+Retrieves a catalog entity checklist
+
+Retrieves a specific catalog entity checklist by id
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.CatalogEntityChecklistsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ CatalogEntityChecklistsApi apiInstance = new CatalogEntityChecklistsApi(defaultClient);
+ UUID id = UUID.randomUUID(); // UUID |
+ try {
+ CatalogEntityChecklistResponse result = apiInstance.getCatalogEntityChecklist(id);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling CatalogEntityChecklistsApi#getCatalogEntityChecklist");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **UUID**| | |
+
+### Return type
+
+[**CatalogEntityChecklistResponse**](CatalogEntityChecklistResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | catalog entity checklist found | - |
+| **404** | resource not found for another team | - |
+
+
+# **listCatalogEntityChecklists**
+> CatalogEntityChecklistList listCatalogEntityChecklists(pageNumber, pageSize, filterStatus, filterCatalogChecklistTemplateId, filterAuditableType, filterAuditableId, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte)
+
+List catalog entity checklists
+
+List catalog entity checklists
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.CatalogEntityChecklistsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ CatalogEntityChecklistsApi apiInstance = new CatalogEntityChecklistsApi(defaultClient);
+ Integer pageNumber = 56; // Integer |
+ Integer pageSize = 56; // Integer |
+ String filterStatus = "filterStatus_example"; // String |
+ String filterCatalogChecklistTemplateId = "filterCatalogChecklistTemplateId_example"; // String |
+ String filterAuditableType = "filterAuditableType_example"; // String |
+ String filterAuditableId = "filterAuditableId_example"; // String |
+ String filterCreatedAtGt = "filterCreatedAtGt_example"; // String |
+ String filterCreatedAtGte = "filterCreatedAtGte_example"; // String |
+ String filterCreatedAtLt = "filterCreatedAtLt_example"; // String |
+ String filterCreatedAtLte = "filterCreatedAtLte_example"; // String |
+ try {
+ CatalogEntityChecklistList result = apiInstance.listCatalogEntityChecklists(pageNumber, pageSize, filterStatus, filterCatalogChecklistTemplateId, filterAuditableType, filterAuditableId, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling CatalogEntityChecklistsApi#listCatalogEntityChecklists");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **pageNumber** | **Integer**| | [optional] |
+| **pageSize** | **Integer**| | [optional] |
+| **filterStatus** | **String**| | [optional] |
+| **filterCatalogChecklistTemplateId** | **String**| | [optional] |
+| **filterAuditableType** | **String**| | [optional] |
+| **filterAuditableId** | **String**| | [optional] |
+| **filterCreatedAtGt** | **String**| | [optional] |
+| **filterCreatedAtGte** | **String**| | [optional] |
+| **filterCreatedAtLt** | **String**| | [optional] |
+| **filterCreatedAtLte** | **String**| | [optional] |
+
+### Return type
+
+[**CatalogEntityChecklistList**](CatalogEntityChecklistList.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | returns empty list for another team | - |
+
diff --git a/docs/CatalogEntityList.md b/docs/CatalogEntityList.md
index 1223ce5c..d545d66a 100644
--- a/docs/CatalogEntityList.md
+++ b/docs/CatalogEntityList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<CatalogEntityResponseData>**](CatalogEntityResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/CatalogEntityPropertiesApi.md b/docs/CatalogEntityPropertiesApi.md
index d642d051..aca8d48d 100644
--- a/docs/CatalogEntityPropertiesApi.md
+++ b/docs/CatalogEntityPropertiesApi.md
@@ -17,7 +17,7 @@ All URIs are relative to *https://api.rootly.com*
Creates a Catalog Entity Property
-Creates a new Catalog Entity Property from provided data
+**Deprecated:** This endpoint is deprecated, please use the `fields` attribute on catalog entities or native catalog endpoints (teams, services, functionalities, incident_types, causes, environments) to set field values instead. Creates a new Catalog Entity Property from provided data.
### Example
```java
@@ -88,7 +88,7 @@ public class Example {
Delete a Catalog Entity Property
-Delete a specific Catalog Entity Property by id
+**Deprecated:** This endpoint is deprecated, please use the `fields` attribute on catalog entities or native catalog endpoints (teams, services, functionalities, incident_types, causes, environments) to set field values instead. Delete a specific Catalog Entity Property by id.
### Example
```java
@@ -156,7 +156,7 @@ public class Example {
Retrieves a Catalog Entity Property
-Retrieves a specific Catalog Entity Property by id
+**Deprecated:** This endpoint is deprecated, please use `include=fields` on catalog entities or native catalog endpoints (teams, services, functionalities, incident_types, causes, environments) to retrieve field values instead. Retrieves a specific Catalog Entity Property by id.
### Example
```java
@@ -226,7 +226,7 @@ public class Example {
List catalog properties
-List Catalog Entity Properties
+**Deprecated:** This endpoint is deprecated, please use `include=fields` on catalog entities or native catalog endpoints (teams, services, functionalities, incident_types, causes, environments) to retrieve field values instead. List Catalog Entity Properties.
### Example
```java
@@ -313,7 +313,7 @@ public class Example {
Update a Catalog Entity Property
-Update a specific Catalog Entity Property by id
+**Deprecated:** This endpoint is deprecated, please use the `fields` attribute on catalog entities or native catalog endpoints (teams, services, functionalities, incident_types, causes, environments) to set field values instead. Update a specific Catalog Entity Property by id.
### Example
```java
diff --git a/docs/CatalogEntityProperty.md b/docs/CatalogEntityProperty.md
index 39a6cfd5..5ec3b97d 100644
--- a/docs/CatalogEntityProperty.md
+++ b/docs/CatalogEntityProperty.md
@@ -2,6 +2,7 @@
# CatalogEntityProperty
+**Deprecated:** This endpoint is deprecated, please use `include=fields` on catalog entities or native catalog endpoints (teams, services, functionalities, incident_types, causes, environments) to retrieve field values instead.
## Properties
@@ -22,6 +23,7 @@
|---- | -----|
| TEXT | "text" |
| CATALOG_ENTITY | "catalog_entity" |
+| SLACK | "slack" |
diff --git a/docs/CatalogEntityPropertyList.md b/docs/CatalogEntityPropertyList.md
index 622c169c..e78328be 100644
--- a/docs/CatalogEntityPropertyList.md
+++ b/docs/CatalogEntityPropertyList.md
@@ -2,6 +2,7 @@
# CatalogEntityPropertyList
+**Deprecated:** This endpoint is deprecated, please use `include=fields` on catalog entities or native catalog endpoints (teams, services, functionalities, incident_types, causes, environments) to retrieve field values instead.
## Properties
@@ -9,6 +10,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<CatalogEntityPropertyResponseData>**](CatalogEntityPropertyResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/CatalogEntityPropertyResponse.md b/docs/CatalogEntityPropertyResponse.md
index 31323843..26c07158 100644
--- a/docs/CatalogEntityPropertyResponse.md
+++ b/docs/CatalogEntityPropertyResponse.md
@@ -2,6 +2,7 @@
# CatalogEntityPropertyResponse
+**Deprecated:** This endpoint is deprecated, please use `include=fields` on catalog entities or native catalog endpoints (teams, services, functionalities, incident_types, causes, environments) to retrieve field values instead.
## Properties
diff --git a/docs/CatalogField.md b/docs/CatalogField.md
index 52e1e3a0..273cfac1 100644
--- a/docs/CatalogField.md
+++ b/docs/CatalogField.md
@@ -9,11 +9,13 @@
|------------ | ------------- | ------------- | -------------|
|**catalogId** | **String** | | |
|**name** | **String** | | |
-|**slug** | **String** | | |
+|**slug** | **String** | | [optional] |
|**kind** | [**KindEnum**](#KindEnum) | | |
|**kindCatalogId** | **String** | Restricts values to items of specified catalog. | [optional] |
|**multiple** | **Boolean** | Whether the attribute accepts multiple values. | |
|**position** | **Integer** | Default position of the item when displayed in a list. | |
+|**required** | **Boolean** | Whether the field is required. | [optional] |
+|**catalogType** | [**CatalogTypeEnum**](#CatalogTypeEnum) | The type of catalog the field belongs to. | [optional] |
|**createdAt** | **String** | | |
|**updatedAt** | **String** | | |
@@ -28,3 +30,17 @@
+## Enum: CatalogTypeEnum
+
+| Name | Value |
+|---- | -----|
+| CATALOG | "catalog" |
+| CAUSE | "cause" |
+| ENVIRONMENT | "environment" |
+| FUNCTIONALITY | "functionality" |
+| INCIDENT_TYPE | "incident_type" |
+| SERVICE | "service" |
+| TEAM | "team" |
+
+
+
diff --git a/docs/CatalogFieldList.md b/docs/CatalogFieldList.md
index 93b5082d..e9b7cbca 100644
--- a/docs/CatalogFieldList.md
+++ b/docs/CatalogFieldList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<CatalogFieldResponseData>**](CatalogFieldResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/CatalogFieldResponseData.md b/docs/CatalogFieldResponseData.md
index 8f6f231f..cc8f720d 100644
--- a/docs/CatalogFieldResponseData.md
+++ b/docs/CatalogFieldResponseData.md
@@ -17,7 +17,7 @@
| Name | Value |
|---- | -----|
-| CATALOG_FIELDS | "catalog_fields" |
+| CATALOG_PROPERTIES | "catalog_properties" |
diff --git a/docs/CatalogList.md b/docs/CatalogList.md
index 2a768832..16e590e8 100644
--- a/docs/CatalogList.md
+++ b/docs/CatalogList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<CatalogResponseData>**](CatalogResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/CatalogPropertiesApi.md b/docs/CatalogPropertiesApi.md
new file mode 100644
index 00000000..58e902f7
--- /dev/null
+++ b/docs/CatalogPropertiesApi.md
@@ -0,0 +1,347 @@
+# CatalogPropertiesApi
+
+All URIs are relative to *https://api.rootly.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createCatalogProperty**](CatalogPropertiesApi.md#createCatalogProperty) | **POST** /v1/catalogs/{catalog_id}/properties | Creates a Catalog Property (alias for field) |
+| [**deleteCatalogProperty**](CatalogPropertiesApi.md#deleteCatalogProperty) | **DELETE** /v1/catalog_properties/{id} | Delete a catalog_property |
+| [**getCatalogProperty**](CatalogPropertiesApi.md#getCatalogProperty) | **GET** /v1/catalog_properties/{id} | Retrieves a Catalog Property (alias for field) |
+| [**listCatalogProperties**](CatalogPropertiesApi.md#listCatalogProperties) | **GET** /v1/catalogs/{catalog_id}/properties | List Catalog Properties (alias for fields) |
+| [**updateCatalogProperty**](CatalogPropertiesApi.md#updateCatalogProperty) | **PUT** /v1/catalog_properties/{id} | Update a catalog_property (alias for field) |
+
+
+
+# **createCatalogProperty**
+> createCatalogProperty(catalogId, newCatalogField)
+
+Creates a Catalog Property (alias for field)
+
+Creates a new Catalog Property - returns catalog_properties type
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.CatalogPropertiesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ CatalogPropertiesApi apiInstance = new CatalogPropertiesApi(defaultClient);
+ String catalogId = "catalogId_example"; // String |
+ NewCatalogField newCatalogField = new NewCatalogField(); // NewCatalogField |
+ try {
+ apiInstance.createCatalogProperty(catalogId, newCatalogField);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling CatalogPropertiesApi#createCatalogProperty");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **catalogId** | **String**| | |
+| **newCatalogField** | [**NewCatalogField**](NewCatalogField.md)| | |
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/vnd.api+json
+ - **Accept**: Not defined
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | catalog_property created | - |
+
+
+# **deleteCatalogProperty**
+> deleteCatalogProperty(id)
+
+Delete a catalog_property
+
+Delete a specific catalog_property by id - returns catalog_properties type
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.CatalogPropertiesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ CatalogPropertiesApi apiInstance = new CatalogPropertiesApi(defaultClient);
+ String id = "id_example"; // String |
+ try {
+ apiInstance.deleteCatalogProperty(id);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling CatalogPropertiesApi#deleteCatalogProperty");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| | |
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | catalog_property deleted | - |
+
+
+# **getCatalogProperty**
+> getCatalogProperty(id)
+
+Retrieves a Catalog Property (alias for field)
+
+Retrieves a specific Catalog Property by id - returns catalog_properties type
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.CatalogPropertiesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ CatalogPropertiesApi apiInstance = new CatalogPropertiesApi(defaultClient);
+ String id = "id_example"; // String |
+ try {
+ apiInstance.getCatalogProperty(id);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling CatalogPropertiesApi#getCatalogProperty");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| | |
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | catalog_property found | - |
+
+
+# **listCatalogProperties**
+> listCatalogProperties(catalogId)
+
+List Catalog Properties (alias for fields)
+
+List Catalog Properties - returns catalog_properties type
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.CatalogPropertiesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ CatalogPropertiesApi apiInstance = new CatalogPropertiesApi(defaultClient);
+ String catalogId = "catalogId_example"; // String |
+ try {
+ apiInstance.listCatalogProperties(catalogId);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling CatalogPropertiesApi#listCatalogProperties");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **catalogId** | **String**| | |
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | success with catalog_properties type | - |
+
+
+# **updateCatalogProperty**
+> updateCatalogProperty(id, updateCatalogField)
+
+Update a catalog_property (alias for field)
+
+Update a specific catalog_property by id - returns catalog_properties type
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.CatalogPropertiesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ CatalogPropertiesApi apiInstance = new CatalogPropertiesApi(defaultClient);
+ String id = "id_example"; // String |
+ UpdateCatalogField updateCatalogField = new UpdateCatalogField(); // UpdateCatalogField |
+ try {
+ apiInstance.updateCatalogProperty(id, updateCatalogField);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling CatalogPropertiesApi#updateCatalogProperty");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| | |
+| **updateCatalogField** | [**UpdateCatalogField**](UpdateCatalogField.md)| | |
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/vnd.api+json
+ - **Accept**: Not defined
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | catalog_property updated | - |
+
diff --git a/docs/CatalogProperty.md b/docs/CatalogProperty.md
new file mode 100644
index 00000000..72edacfd
--- /dev/null
+++ b/docs/CatalogProperty.md
@@ -0,0 +1,46 @@
+
+
+# CatalogProperty
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**catalogId** | **String** | | |
+|**name** | **String** | | |
+|**slug** | **String** | | [optional] |
+|**kind** | [**KindEnum**](#KindEnum) | | |
+|**kindCatalogId** | **String** | Restricts values to items of specified catalog. | [optional] |
+|**multiple** | **Boolean** | Whether the attribute accepts multiple values. | |
+|**position** | **Integer** | Default position of the item when displayed in a list. | |
+|**required** | **Boolean** | Whether the property is required. | [optional] |
+|**catalogType** | [**CatalogTypeEnum**](#CatalogTypeEnum) | The type of catalog the property belongs to. | [optional] |
+|**createdAt** | **String** | | |
+|**updatedAt** | **String** | | |
+
+
+
+## Enum: KindEnum
+
+| Name | Value |
+|---- | -----|
+| TEXT | "text" |
+| REFERENCE | "reference" |
+
+
+
+## Enum: CatalogTypeEnum
+
+| Name | Value |
+|---- | -----|
+| CATALOG | "catalog" |
+| CAUSE | "cause" |
+| ENVIRONMENT | "environment" |
+| FUNCTIONALITY | "functionality" |
+| INCIDENT_TYPE | "incident_type" |
+| SERVICE | "service" |
+| TEAM | "team" |
+
+
+
diff --git a/docs/CatalogPropertyList.md b/docs/CatalogPropertyList.md
new file mode 100644
index 00000000..776dda39
--- /dev/null
+++ b/docs/CatalogPropertyList.md
@@ -0,0 +1,15 @@
+
+
+# CatalogPropertyList
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<CatalogPropertyResponseData>**](CatalogPropertyResponseData.md) | | |
+|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
+
+
+
diff --git a/docs/CatalogPropertyResponse.md b/docs/CatalogPropertyResponse.md
new file mode 100644
index 00000000..ff236dc7
--- /dev/null
+++ b/docs/CatalogPropertyResponse.md
@@ -0,0 +1,13 @@
+
+
+# CatalogPropertyResponse
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**CatalogPropertyResponseData**](CatalogPropertyResponseData.md) | | |
+
+
+
diff --git a/docs/CatalogPropertyResponseData.md b/docs/CatalogPropertyResponseData.md
new file mode 100644
index 00000000..136a8761
--- /dev/null
+++ b/docs/CatalogPropertyResponseData.md
@@ -0,0 +1,23 @@
+
+
+# CatalogPropertyResponseData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | Unique ID of the catalog_property | |
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**CatalogProperty**](CatalogProperty.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| CATALOG_PROPERTIES | "catalog_properties" |
+
+
+
diff --git a/docs/CatalogsApi.md b/docs/CatalogsApi.md
index 7e3cf0aa..a16a8f4a 100644
--- a/docs/CatalogsApi.md
+++ b/docs/CatalogsApi.md
@@ -108,7 +108,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
CatalogsApi apiInstance = new CatalogsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
CatalogResponse result = apiInstance.deleteCatalog(id);
System.out.println(result);
@@ -127,7 +127,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -176,7 +176,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
CatalogsApi apiInstance = new CatalogsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
CatalogResponse result = apiInstance.getCatalog(id);
System.out.println(result);
@@ -195,7 +195,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -213,12 +213,12 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **200** | catalog found | - |
+| **200** | catalog found by slug | - |
| **404** | resource not found | - |
# **listCatalogs**
-> CatalogList listCatalogs(include, sort, pageNumber, pageSize, filterSlug, filterName, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte)
+> CatalogList listCatalogs(include, sort, pageNumber, pageSize, filterSearch, filterSlug, filterName, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte)
List catalogs
@@ -248,6 +248,7 @@ public class Example {
String sort = "created_at"; // String | comma separated if needed. eg: created_at,updated_at
Integer pageNumber = 56; // Integer |
Integer pageSize = 56; // Integer |
+ String filterSearch = "filterSearch_example"; // String |
String filterSlug = "filterSlug_example"; // String |
String filterName = "filterName_example"; // String |
String filterCreatedAtGt = "filterCreatedAtGt_example"; // String |
@@ -255,7 +256,7 @@ public class Example {
String filterCreatedAtLt = "filterCreatedAtLt_example"; // String |
String filterCreatedAtLte = "filterCreatedAtLte_example"; // String |
try {
- CatalogList result = apiInstance.listCatalogs(include, sort, pageNumber, pageSize, filterSlug, filterName, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte);
+ CatalogList result = apiInstance.listCatalogs(include, sort, pageNumber, pageSize, filterSearch, filterSlug, filterName, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling CatalogsApi#listCatalogs");
@@ -276,6 +277,7 @@ public class Example {
| **sort** | **String**| comma separated if needed. eg: created_at,updated_at | [optional] [enum: created_at, -created_at, updated_at, -updated_at, position, -position] |
| **pageNumber** | **Integer**| | [optional] |
| **pageSize** | **Integer**| | [optional] |
+| **filterSearch** | **String**| | [optional] |
| **filterSlug** | **String**| | [optional] |
| **filterName** | **String**| | [optional] |
| **filterCreatedAtGt** | **String**| | [optional] |
@@ -329,7 +331,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
CatalogsApi apiInstance = new CatalogsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
UpdateCatalog updateCatalog = new UpdateCatalog(); // UpdateCatalog |
try {
CatalogResponse result = apiInstance.updateCatalog(id, updateCatalog);
@@ -349,7 +351,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
| **updateCatalog** | [**UpdateCatalog**](UpdateCatalog.md)| | |
### Return type
diff --git a/docs/Cause.md b/docs/Cause.md
index 34a3c0fa..128f7d8a 100644
--- a/docs/Cause.md
+++ b/docs/Cause.md
@@ -11,6 +11,7 @@
|**slug** | **String** | The slug of the cause | [optional] |
|**description** | **String** | The description of the cause | [optional] |
|**position** | **Integer** | Position of the cause | [optional] |
+|**properties** | [**List<NewCauseDataAttributesPropertiesInner>**](NewCauseDataAttributesPropertiesInner.md) | Array of property values for this cause. | [optional] |
|**createdAt** | **String** | Date of creation | |
|**updatedAt** | **String** | Date of last update | |
diff --git a/docs/CauseList.md b/docs/CauseList.md
index 9e3517ba..d85887ec 100644
--- a/docs/CauseList.md
+++ b/docs/CauseList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<CauseResponseData>**](CauseResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/CausesApi.md b/docs/CausesApi.md
index 6a075e7a..1ee2dbc3 100644
--- a/docs/CausesApi.md
+++ b/docs/CausesApi.md
@@ -5,8 +5,10 @@ All URIs are relative to *https://api.rootly.com*
| Method | HTTP request | Description |
|------------- | ------------- | -------------|
| [**createCause**](CausesApi.md#createCause) | **POST** /v1/causes | Creates a cause |
+| [**createCauseCatalogProperty**](CausesApi.md#createCauseCatalogProperty) | **POST** /v1/causes/properties | Creates a Catalog Property |
| [**deleteCause**](CausesApi.md#deleteCause) | **DELETE** /v1/causes/{id} | Delete a cause |
| [**getCause**](CausesApi.md#getCause) | **GET** /v1/causes/{id} | Retrieves a cause |
+| [**listCauseCatalogProperties**](CausesApi.md#listCauseCatalogProperties) | **GET** /v1/causes/properties | List Catalog Properties |
| [**listCauses**](CausesApi.md#listCauses) | **GET** /v1/causes | List causes |
| [**updateCause**](CausesApi.md#updateCause) | **PUT** /v1/causes/{id} | Update a cause |
@@ -80,6 +82,75 @@ public class Example {
| **422** | invalid request | - |
| **401** | responds with unauthorized for invalid token | - |
+
+# **createCauseCatalogProperty**
+> CatalogPropertyResponse createCauseCatalogProperty(newCatalogProperty)
+
+Creates a Catalog Property
+
+Creates a new Catalog Property from provided data
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.CausesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ CausesApi apiInstance = new CausesApi(defaultClient);
+ NewCatalogProperty newCatalogProperty = new NewCatalogProperty(); // NewCatalogProperty |
+ try {
+ CatalogPropertyResponse result = apiInstance.createCauseCatalogProperty(newCatalogProperty);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling CausesApi#createCauseCatalogProperty");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **newCatalogProperty** | [**NewCatalogProperty**](NewCatalogProperty.md)| | |
+
+### Return type
+
+[**CatalogPropertyResponse**](CatalogPropertyResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/vnd.api+json
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | catalog_property created ignores wrong catalog_type attribute | - |
+| **422** | exceeds max fields per catalog | - |
+| **401** | responds with unauthorized for invalid token | - |
+
# **deleteCause**
> CauseResponse deleteCause(id)
@@ -108,7 +179,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
CausesApi apiInstance = new CausesApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
CauseResponse result = apiInstance.deleteCause(id);
System.out.println(result);
@@ -127,7 +198,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -176,7 +247,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
CausesApi apiInstance = new CausesApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
CauseResponse result = apiInstance.getCause(id);
System.out.println(result);
@@ -195,7 +266,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -213,9 +284,96 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **200** | cause found | - |
+| **200** | cause found by slug | - |
| **404** | resource not found | - |
+
+# **listCauseCatalogProperties**
+> CatalogPropertyList listCauseCatalogProperties(include, sort, pageNumber, pageSize, filterSlug, filterName, filterKind, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte)
+
+List Catalog Properties
+
+List Cause Catalog Properties
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.CausesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ CausesApi apiInstance = new CausesApi(defaultClient);
+ String include = "catalog"; // String | comma separated if needed. eg: catalog
+ String sort = "created_at"; // String | comma separated if needed. eg: created_at,updated_at
+ Integer pageNumber = 56; // Integer |
+ Integer pageSize = 56; // Integer |
+ String filterSlug = "filterSlug_example"; // String |
+ String filterName = "filterName_example"; // String |
+ String filterKind = "filterKind_example"; // String |
+ String filterCreatedAtGt = "filterCreatedAtGt_example"; // String |
+ String filterCreatedAtGte = "filterCreatedAtGte_example"; // String |
+ String filterCreatedAtLt = "filterCreatedAtLt_example"; // String |
+ String filterCreatedAtLte = "filterCreatedAtLte_example"; // String |
+ try {
+ CatalogPropertyList result = apiInstance.listCauseCatalogProperties(include, sort, pageNumber, pageSize, filterSlug, filterName, filterKind, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling CausesApi#listCauseCatalogProperties");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **include** | **String**| comma separated if needed. eg: catalog | [optional] [enum: catalog] |
+| **sort** | **String**| comma separated if needed. eg: created_at,updated_at | [optional] [enum: created_at, -created_at, updated_at, -updated_at, position, -position] |
+| **pageNumber** | **Integer**| | [optional] |
+| **pageSize** | **Integer**| | [optional] |
+| **filterSlug** | **String**| | [optional] |
+| **filterName** | **String**| | [optional] |
+| **filterKind** | **String**| | [optional] |
+| **filterCreatedAtGt** | **String**| | [optional] |
+| **filterCreatedAtGte** | **String**| | [optional] |
+| **filterCreatedAtLt** | **String**| | [optional] |
+| **filterCreatedAtLte** | **String**| | [optional] |
+
+### Return type
+
+[**CatalogPropertyList**](CatalogPropertyList.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | success | - |
+
# **listCauses**
> CauseList listCauses(include, pageNumber, pageSize, filterSearch, filterSlug, filterName, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte)
@@ -329,7 +487,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
CausesApi apiInstance = new CausesApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
UpdateCause updateCause = new UpdateCause(); // UpdateCause |
try {
CauseResponse result = apiInstance.updateCause(id, updateCause);
@@ -349,7 +507,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
| **updateCause** | [**UpdateCause**](UpdateCause.md)| | |
### Return type
diff --git a/docs/CommunicationsGroup.md b/docs/CommunicationsGroup.md
new file mode 100644
index 00000000..b5dedf2e
--- /dev/null
+++ b/docs/CommunicationsGroup.md
@@ -0,0 +1,35 @@
+
+
+# CommunicationsGroup
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | The name of the communications group | |
+|**slug** | **String** | The slug of the communications group | [optional] |
+|**description** | **String** | The description of the communications group | [optional] |
+|**communicationTypeId** | **String** | The communication type ID | |
+|**isPrivate** | **Boolean** | Whether the group is private | |
+|**conditionType** | [**ConditionTypeEnum**](#ConditionTypeEnum) | Condition type | |
+|**smsChannel** | **Boolean** | SMS channel enabled | |
+|**emailChannel** | **Boolean** | Email channel enabled | |
+|**createdAt** | **String** | Date of creation | |
+|**updatedAt** | **String** | Date of last update | |
+|**communicationGroupConditions** | [**List<NewCommunicationsGroupDataAttributesCommunicationGroupConditionsInner>**](NewCommunicationsGroupDataAttributesCommunicationGroupConditionsInner.md) | Group conditions attributes | [optional] |
+|**memberIds** | **List<Integer>** | Array of member user IDs | [optional] |
+|**slackChannelIds** | **List<String>** | Array of Slack channel IDs | [optional] |
+|**communicationExternalGroupMembers** | [**List<CommunicationsGroupCommunicationExternalGroupMembersInner>**](CommunicationsGroupCommunicationExternalGroupMembersInner.md) | External group members | [optional] |
+
+
+
+## Enum: ConditionTypeEnum
+
+| Name | Value |
+|---- | -----|
+| ANY | "any" |
+| ALL | "all" |
+
+
+
diff --git a/docs/CommunicationsGroupCommunicationExternalGroupMembersInner.md b/docs/CommunicationsGroupCommunicationExternalGroupMembersInner.md
new file mode 100644
index 00000000..9a0d10db
--- /dev/null
+++ b/docs/CommunicationsGroupCommunicationExternalGroupMembersInner.md
@@ -0,0 +1,16 @@
+
+
+# CommunicationsGroupCommunicationExternalGroupMembersInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | ID of the external group member | [optional] |
+|**name** | **String** | Name of the external member | [optional] |
+|**email** | **String** | Email of the external member | [optional] |
+|**phoneNumber** | **String** | Phone number of the external member | [optional] |
+
+
+
diff --git a/docs/CommunicationsGroupResponse.md b/docs/CommunicationsGroupResponse.md
new file mode 100644
index 00000000..ed9766ff
--- /dev/null
+++ b/docs/CommunicationsGroupResponse.md
@@ -0,0 +1,13 @@
+
+
+# CommunicationsGroupResponse
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**CommunicationsGroupResponseData**](CommunicationsGroupResponseData.md) | | |
+
+
+
diff --git a/docs/CommunicationsGroupResponseData.md b/docs/CommunicationsGroupResponseData.md
new file mode 100644
index 00000000..602f63af
--- /dev/null
+++ b/docs/CommunicationsGroupResponseData.md
@@ -0,0 +1,23 @@
+
+
+# CommunicationsGroupResponseData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | Unique ID of the communications group | |
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**CommunicationsGroup**](CommunicationsGroup.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| COMMUNICATIONS_GROUPS | "communications_groups" |
+
+
+
diff --git a/docs/CommunicationsGroupsApi.md b/docs/CommunicationsGroupsApi.md
new file mode 100644
index 00000000..97612a1d
--- /dev/null
+++ b/docs/CommunicationsGroupsApi.md
@@ -0,0 +1,377 @@
+# CommunicationsGroupsApi
+
+All URIs are relative to *https://api.rootly.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createCommunicationsGroup**](CommunicationsGroupsApi.md#createCommunicationsGroup) | **POST** /v1/communications/groups | Creates a communications group |
+| [**deleteCommunicationsGroup**](CommunicationsGroupsApi.md#deleteCommunicationsGroup) | **DELETE** /v1/communications/groups/{id} | Deletes a communications group |
+| [**getCommunicationsGroup**](CommunicationsGroupsApi.md#getCommunicationsGroup) | **GET** /v1/communications/groups/{id} | Shows a communications group |
+| [**listCommunicationsGroups**](CommunicationsGroupsApi.md#listCommunicationsGroups) | **GET** /v1/communications/groups | Lists communications groups |
+| [**updateCommunicationsGroup**](CommunicationsGroupsApi.md#updateCommunicationsGroup) | **PATCH** /v1/communications/groups/{id} | Updates a communications group |
+
+
+
+# **createCommunicationsGroup**
+> CommunicationsGroupResponse createCommunicationsGroup(newCommunicationsGroup)
+
+Creates a communications group
+
+Creates a new communications group from provided data
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.CommunicationsGroupsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ CommunicationsGroupsApi apiInstance = new CommunicationsGroupsApi(defaultClient);
+ NewCommunicationsGroup newCommunicationsGroup = new NewCommunicationsGroup(); // NewCommunicationsGroup |
+ try {
+ CommunicationsGroupResponse result = apiInstance.createCommunicationsGroup(newCommunicationsGroup);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling CommunicationsGroupsApi#createCommunicationsGroup");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **newCommunicationsGroup** | [**NewCommunicationsGroup**](NewCommunicationsGroup.md)| | |
+
+### Return type
+
+[**CommunicationsGroupResponse**](CommunicationsGroupResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/vnd.api+json
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | communications group created | - |
+| **422** | invalid request | - |
+
+
+# **deleteCommunicationsGroup**
+> deleteCommunicationsGroup(id)
+
+Deletes a communications group
+
+Deletes a communications group
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.CommunicationsGroupsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ CommunicationsGroupsApi apiInstance = new CommunicationsGroupsApi(defaultClient);
+ String id = "id_example"; // String | Communications Group ID
+ try {
+ apiInstance.deleteCommunicationsGroup(id);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling CommunicationsGroupsApi#deleteCommunicationsGroup");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| Communications Group ID | |
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | communications group deleted | - |
+| **404** | communications group not found | - |
+
+
+# **getCommunicationsGroup**
+> CommunicationsGroupResponse getCommunicationsGroup(id)
+
+Shows a communications group
+
+Shows details of a communications group
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.CommunicationsGroupsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ CommunicationsGroupsApi apiInstance = new CommunicationsGroupsApi(defaultClient);
+ String id = "id_example"; // String | Communications Group ID
+ try {
+ CommunicationsGroupResponse result = apiInstance.getCommunicationsGroup(id);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling CommunicationsGroupsApi#getCommunicationsGroup");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| Communications Group ID | |
+
+### Return type
+
+[**CommunicationsGroupResponse**](CommunicationsGroupResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | communications group found | - |
+| **404** | communications group not found | - |
+
+
+# **listCommunicationsGroups**
+> CommunicationsGroupsResponse listCommunicationsGroups(pageNumber, pageSize, filterSearch, filterName, filterSlug, filterIsPrivate, filterCommunicationTypeId, filterConditionType, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, sort)
+
+Lists communications groups
+
+Lists communications groups
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.CommunicationsGroupsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ CommunicationsGroupsApi apiInstance = new CommunicationsGroupsApi(defaultClient);
+ Integer pageNumber = 56; // Integer |
+ Integer pageSize = 56; // Integer |
+ String filterSearch = "filterSearch_example"; // String |
+ String filterName = "filterName_example"; // String |
+ String filterSlug = "filterSlug_example"; // String |
+ String filterIsPrivate = "filterIsPrivate_example"; // String |
+ String filterCommunicationTypeId = "filterCommunicationTypeId_example"; // String |
+ String filterConditionType = "filterConditionType_example"; // String |
+ String filterCreatedAtGt = "filterCreatedAtGt_example"; // String |
+ String filterCreatedAtGte = "filterCreatedAtGte_example"; // String |
+ String filterCreatedAtLt = "filterCreatedAtLt_example"; // String |
+ String filterCreatedAtLte = "filterCreatedAtLte_example"; // String |
+ String sort = "sort_example"; // String |
+ try {
+ CommunicationsGroupsResponse result = apiInstance.listCommunicationsGroups(pageNumber, pageSize, filterSearch, filterName, filterSlug, filterIsPrivate, filterCommunicationTypeId, filterConditionType, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, sort);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling CommunicationsGroupsApi#listCommunicationsGroups");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **pageNumber** | **Integer**| | [optional] |
+| **pageSize** | **Integer**| | [optional] |
+| **filterSearch** | **String**| | [optional] |
+| **filterName** | **String**| | [optional] |
+| **filterSlug** | **String**| | [optional] |
+| **filterIsPrivate** | **String**| | [optional] |
+| **filterCommunicationTypeId** | **String**| | [optional] |
+| **filterConditionType** | **String**| | [optional] |
+| **filterCreatedAtGt** | **String**| | [optional] |
+| **filterCreatedAtGte** | **String**| | [optional] |
+| **filterCreatedAtLt** | **String**| | [optional] |
+| **filterCreatedAtLte** | **String**| | [optional] |
+| **sort** | **String**| | [optional] |
+
+### Return type
+
+[**CommunicationsGroupsResponse**](CommunicationsGroupsResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | communications groups found | - |
+
+
+# **updateCommunicationsGroup**
+> CommunicationsGroupResponse updateCommunicationsGroup(id, updateCommunicationsGroup)
+
+Updates a communications group
+
+Updates a communications group
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.CommunicationsGroupsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ CommunicationsGroupsApi apiInstance = new CommunicationsGroupsApi(defaultClient);
+ String id = "id_example"; // String | Communications Group ID
+ UpdateCommunicationsGroup updateCommunicationsGroup = new UpdateCommunicationsGroup(); // UpdateCommunicationsGroup |
+ try {
+ CommunicationsGroupResponse result = apiInstance.updateCommunicationsGroup(id, updateCommunicationsGroup);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling CommunicationsGroupsApi#updateCommunicationsGroup");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| Communications Group ID | |
+| **updateCommunicationsGroup** | [**UpdateCommunicationsGroup**](UpdateCommunicationsGroup.md)| | |
+
+### Return type
+
+[**CommunicationsGroupResponse**](CommunicationsGroupResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/vnd.api+json
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | communications group updated | - |
+| **422** | invalid request | - |
+
diff --git a/docs/CommunicationsGroupsResponse.md b/docs/CommunicationsGroupsResponse.md
new file mode 100644
index 00000000..81dd8dda
--- /dev/null
+++ b/docs/CommunicationsGroupsResponse.md
@@ -0,0 +1,15 @@
+
+
+# CommunicationsGroupsResponse
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<CommunicationsGroupResponseData>**](CommunicationsGroupResponseData.md) | | |
+|**links** | [**Links**](Links.md) | | [optional] |
+|**meta** | [**Meta**](Meta.md) | | [optional] |
+
+
+
diff --git a/docs/CommunicationsStage.md b/docs/CommunicationsStage.md
new file mode 100644
index 00000000..3f045bb2
--- /dev/null
+++ b/docs/CommunicationsStage.md
@@ -0,0 +1,18 @@
+
+
+# CommunicationsStage
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | The name of the communications stage | |
+|**slug** | **String** | The slug of the communications stage | [optional] |
+|**description** | **String** | The description of the communications stage | [optional] |
+|**position** | **Integer** | Position of the communications stage | |
+|**createdAt** | **String** | Date of creation | |
+|**updatedAt** | **String** | Date of last update | |
+
+
+
diff --git a/docs/CommunicationsStageResponse.md b/docs/CommunicationsStageResponse.md
new file mode 100644
index 00000000..9de0253c
--- /dev/null
+++ b/docs/CommunicationsStageResponse.md
@@ -0,0 +1,13 @@
+
+
+# CommunicationsStageResponse
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**CommunicationsStageResponseData**](CommunicationsStageResponseData.md) | | |
+
+
+
diff --git a/docs/CommunicationsStageResponseData.md b/docs/CommunicationsStageResponseData.md
new file mode 100644
index 00000000..4203165a
--- /dev/null
+++ b/docs/CommunicationsStageResponseData.md
@@ -0,0 +1,23 @@
+
+
+# CommunicationsStageResponseData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | Unique ID of the communications stage | |
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**CommunicationsStage**](CommunicationsStage.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| COMMUNICATIONS_STAGES | "communications_stages" |
+
+
+
diff --git a/docs/CommunicationsStagesApi.md b/docs/CommunicationsStagesApi.md
new file mode 100644
index 00000000..8bd2ce97
--- /dev/null
+++ b/docs/CommunicationsStagesApi.md
@@ -0,0 +1,372 @@
+# CommunicationsStagesApi
+
+All URIs are relative to *https://api.rootly.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createCommunicationsStage**](CommunicationsStagesApi.md#createCommunicationsStage) | **POST** /v1/communications/stages | Creates a communications stage |
+| [**deleteCommunicationsStage**](CommunicationsStagesApi.md#deleteCommunicationsStage) | **DELETE** /v1/communications/stages/{id} | Deletes a communications stage |
+| [**getCommunicationsStage**](CommunicationsStagesApi.md#getCommunicationsStage) | **GET** /v1/communications/stages/{id} | Shows a communications stage |
+| [**listCommunicationsStages**](CommunicationsStagesApi.md#listCommunicationsStages) | **GET** /v1/communications/stages | Lists communications stages |
+| [**updateCommunicationsStage**](CommunicationsStagesApi.md#updateCommunicationsStage) | **PATCH** /v1/communications/stages/{id} | Updates a communications stage |
+
+
+
+# **createCommunicationsStage**
+> CommunicationsStageResponse createCommunicationsStage(newCommunicationsStage)
+
+Creates a communications stage
+
+Creates a new communications stage from provided data
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.CommunicationsStagesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ CommunicationsStagesApi apiInstance = new CommunicationsStagesApi(defaultClient);
+ NewCommunicationsStage newCommunicationsStage = new NewCommunicationsStage(); // NewCommunicationsStage |
+ try {
+ CommunicationsStageResponse result = apiInstance.createCommunicationsStage(newCommunicationsStage);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling CommunicationsStagesApi#createCommunicationsStage");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **newCommunicationsStage** | [**NewCommunicationsStage**](NewCommunicationsStage.md)| | |
+
+### Return type
+
+[**CommunicationsStageResponse**](CommunicationsStageResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/vnd.api+json
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | communications stage created | - |
+| **422** | invalid request | - |
+| **401** | unauthorized | - |
+
+
+# **deleteCommunicationsStage**
+> deleteCommunicationsStage(id)
+
+Deletes a communications stage
+
+Deletes a communications stage
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.CommunicationsStagesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ CommunicationsStagesApi apiInstance = new CommunicationsStagesApi(defaultClient);
+ String id = "id_example"; // String | Communications Stage ID
+ try {
+ apiInstance.deleteCommunicationsStage(id);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling CommunicationsStagesApi#deleteCommunicationsStage");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| Communications Stage ID | |
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | communications stage deleted | - |
+| **404** | communications stage not found | - |
+
+
+# **getCommunicationsStage**
+> CommunicationsStageResponse getCommunicationsStage(id)
+
+Shows a communications stage
+
+Shows details of a communications stage
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.CommunicationsStagesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ CommunicationsStagesApi apiInstance = new CommunicationsStagesApi(defaultClient);
+ String id = "id_example"; // String | Communications Stage ID
+ try {
+ CommunicationsStageResponse result = apiInstance.getCommunicationsStage(id);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling CommunicationsStagesApi#getCommunicationsStage");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| Communications Stage ID | |
+
+### Return type
+
+[**CommunicationsStageResponse**](CommunicationsStageResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | communications stage found | - |
+| **404** | resource not found | - |
+
+
+# **listCommunicationsStages**
+> CommunicationsStagesResponse listCommunicationsStages(pageNumber, pageSize, filterSearch, filterName, filterSlug, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, sort)
+
+Lists communications stages
+
+Lists communications stages
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.CommunicationsStagesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ CommunicationsStagesApi apiInstance = new CommunicationsStagesApi(defaultClient);
+ Integer pageNumber = 56; // Integer |
+ Integer pageSize = 56; // Integer |
+ String filterSearch = "filterSearch_example"; // String |
+ String filterName = "filterName_example"; // String |
+ String filterSlug = "filterSlug_example"; // String |
+ String filterCreatedAtGt = "filterCreatedAtGt_example"; // String |
+ String filterCreatedAtGte = "filterCreatedAtGte_example"; // String |
+ String filterCreatedAtLt = "filterCreatedAtLt_example"; // String |
+ String filterCreatedAtLte = "filterCreatedAtLte_example"; // String |
+ String sort = "sort_example"; // String |
+ try {
+ CommunicationsStagesResponse result = apiInstance.listCommunicationsStages(pageNumber, pageSize, filterSearch, filterName, filterSlug, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, sort);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling CommunicationsStagesApi#listCommunicationsStages");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **pageNumber** | **Integer**| | [optional] |
+| **pageSize** | **Integer**| | [optional] |
+| **filterSearch** | **String**| | [optional] |
+| **filterName** | **String**| | [optional] |
+| **filterSlug** | **String**| | [optional] |
+| **filterCreatedAtGt** | **String**| | [optional] |
+| **filterCreatedAtGte** | **String**| | [optional] |
+| **filterCreatedAtLt** | **String**| | [optional] |
+| **filterCreatedAtLte** | **String**| | [optional] |
+| **sort** | **String**| | [optional] |
+
+### Return type
+
+[**CommunicationsStagesResponse**](CommunicationsStagesResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | communications stages found | - |
+
+
+# **updateCommunicationsStage**
+> CommunicationsStageResponse updateCommunicationsStage(id, updateCommunicationsStage)
+
+Updates a communications stage
+
+Updates a communications stage
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.CommunicationsStagesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ CommunicationsStagesApi apiInstance = new CommunicationsStagesApi(defaultClient);
+ String id = "id_example"; // String | Communications Stage ID
+ UpdateCommunicationsStage updateCommunicationsStage = new UpdateCommunicationsStage(); // UpdateCommunicationsStage |
+ try {
+ CommunicationsStageResponse result = apiInstance.updateCommunicationsStage(id, updateCommunicationsStage);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling CommunicationsStagesApi#updateCommunicationsStage");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| Communications Stage ID | |
+| **updateCommunicationsStage** | [**UpdateCommunicationsStage**](UpdateCommunicationsStage.md)| | |
+
+### Return type
+
+[**CommunicationsStageResponse**](CommunicationsStageResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/vnd.api+json
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | communications stage updated | - |
+| **422** | invalid request | - |
+
diff --git a/docs/CommunicationsStagesResponse.md b/docs/CommunicationsStagesResponse.md
new file mode 100644
index 00000000..9909a4e9
--- /dev/null
+++ b/docs/CommunicationsStagesResponse.md
@@ -0,0 +1,15 @@
+
+
+# CommunicationsStagesResponse
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<CommunicationsStageResponseData>**](CommunicationsStageResponseData.md) | | |
+|**links** | [**Links**](Links.md) | | [optional] |
+|**meta** | [**Meta**](Meta.md) | | [optional] |
+
+
+
diff --git a/docs/CommunicationsTemplate.md b/docs/CommunicationsTemplate.md
new file mode 100644
index 00000000..b1c43343
--- /dev/null
+++ b/docs/CommunicationsTemplate.md
@@ -0,0 +1,21 @@
+
+
+# CommunicationsTemplate
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | The name of the communications template | |
+|**slug** | **String** | The slug of the communications template | [optional] |
+|**description** | **String** | The description of the communications template | [optional] |
+|**position** | **Integer** | Position of the communications template | |
+|**createdAt** | **String** | Date of creation | |
+|**updatedAt** | **String** | Date of last update | |
+|**communicationTypeId** | **String** | The communication type ID | [optional] |
+|**communicationTemplateStages** | [**List<CommunicationsTemplateCommunicationTemplateStagesInner>**](CommunicationsTemplateCommunicationTemplateStagesInner.md) | Communication template stages | [optional] |
+|**communicationType** | [**CommunicationsTemplateCommunicationType**](CommunicationsTemplateCommunicationType.md) | | [optional] |
+
+
+
diff --git a/docs/CommunicationsTemplateCommunicationTemplateStagesInner.md b/docs/CommunicationsTemplateCommunicationTemplateStagesInner.md
new file mode 100644
index 00000000..1bcead95
--- /dev/null
+++ b/docs/CommunicationsTemplateCommunicationTemplateStagesInner.md
@@ -0,0 +1,13 @@
+
+
+# CommunicationsTemplateCommunicationTemplateStagesInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**CommunicationsTemplateCommunicationTemplateStagesInnerData**](CommunicationsTemplateCommunicationTemplateStagesInnerData.md) | | [optional] |
+
+
+
diff --git a/docs/CommunicationsTemplateCommunicationTemplateStagesInnerData.md b/docs/CommunicationsTemplateCommunicationTemplateStagesInnerData.md
new file mode 100644
index 00000000..5336392f
--- /dev/null
+++ b/docs/CommunicationsTemplateCommunicationTemplateStagesInnerData.md
@@ -0,0 +1,23 @@
+
+
+# CommunicationsTemplateCommunicationTemplateStagesInnerData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | ID of the communication template stage | [optional] |
+|**type** | [**TypeEnum**](#TypeEnum) | | [optional] |
+|**attributes** | [**CommunicationsTemplateCommunicationTemplateStagesInnerDataAttributes**](CommunicationsTemplateCommunicationTemplateStagesInnerDataAttributes.md) | | [optional] |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| COMMUNICATIONS_TEMPLATE_STAGES | "communications_template_stages" |
+
+
+
diff --git a/docs/CommunicationsTemplateCommunicationTemplateStagesInnerDataAttributes.md b/docs/CommunicationsTemplateCommunicationTemplateStagesInnerDataAttributes.md
new file mode 100644
index 00000000..b2ed441e
--- /dev/null
+++ b/docs/CommunicationsTemplateCommunicationTemplateStagesInnerDataAttributes.md
@@ -0,0 +1,20 @@
+
+
+# CommunicationsTemplateCommunicationTemplateStagesInnerDataAttributes
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**emailBody** | **String** | Email body for the stage | [optional] |
+|**emailSubject** | **String** | Email subject for the stage | [optional] |
+|**slackContent** | **String** | Slack content for the stage | [optional] |
+|**smsContent** | **String** | SMS content for the stage | [optional] |
+|**createdAt** | **String** | Date of creation | [optional] |
+|**updatedAt** | **String** | Date of last update | [optional] |
+|**communicationStage** | [**CommunicationsTemplateCommunicationTemplateStagesInnerDataAttributesCommunicationStage**](CommunicationsTemplateCommunicationTemplateStagesInnerDataAttributesCommunicationStage.md) | | [optional] |
+|**communicationTemplate** | [**CommunicationsTemplateCommunicationTemplateStagesInnerDataAttributesCommunicationTemplate**](CommunicationsTemplateCommunicationTemplateStagesInnerDataAttributesCommunicationTemplate.md) | | [optional] |
+
+
+
diff --git a/docs/CommunicationsTemplateCommunicationTemplateStagesInnerDataAttributesCommunicationStage.md b/docs/CommunicationsTemplateCommunicationTemplateStagesInnerDataAttributesCommunicationStage.md
new file mode 100644
index 00000000..30c59c04
--- /dev/null
+++ b/docs/CommunicationsTemplateCommunicationTemplateStagesInnerDataAttributesCommunicationStage.md
@@ -0,0 +1,14 @@
+
+
+# CommunicationsTemplateCommunicationTemplateStagesInnerDataAttributesCommunicationStage
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | The communication stage ID | [optional] |
+|**name** | **String** | The communication stage name | [optional] |
+
+
+
diff --git a/docs/CommunicationsTemplateCommunicationTemplateStagesInnerDataAttributesCommunicationTemplate.md b/docs/CommunicationsTemplateCommunicationTemplateStagesInnerDataAttributesCommunicationTemplate.md
new file mode 100644
index 00000000..1ccaaa32
--- /dev/null
+++ b/docs/CommunicationsTemplateCommunicationTemplateStagesInnerDataAttributesCommunicationTemplate.md
@@ -0,0 +1,14 @@
+
+
+# CommunicationsTemplateCommunicationTemplateStagesInnerDataAttributesCommunicationTemplate
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | The communication template ID | [optional] |
+|**name** | **String** | The communication template name | [optional] |
+
+
+
diff --git a/docs/CommunicationsTemplateCommunicationType.md b/docs/CommunicationsTemplateCommunicationType.md
new file mode 100644
index 00000000..8dceefe8
--- /dev/null
+++ b/docs/CommunicationsTemplateCommunicationType.md
@@ -0,0 +1,14 @@
+
+
+# CommunicationsTemplateCommunicationType
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | ID of the communication type | [optional] |
+|**name** | **String** | Name of the communication type | [optional] |
+
+
+
diff --git a/docs/CommunicationsTemplateResponse.md b/docs/CommunicationsTemplateResponse.md
new file mode 100644
index 00000000..d7b9032d
--- /dev/null
+++ b/docs/CommunicationsTemplateResponse.md
@@ -0,0 +1,13 @@
+
+
+# CommunicationsTemplateResponse
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**CommunicationsTemplateResponseData**](CommunicationsTemplateResponseData.md) | | |
+
+
+
diff --git a/docs/CommunicationsTemplateResponseData.md b/docs/CommunicationsTemplateResponseData.md
new file mode 100644
index 00000000..5bae24c0
--- /dev/null
+++ b/docs/CommunicationsTemplateResponseData.md
@@ -0,0 +1,23 @@
+
+
+# CommunicationsTemplateResponseData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | Unique ID of the communications template | |
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**CommunicationsTemplate**](CommunicationsTemplate.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| COMMUNICATIONS_TEMPLATES | "communications_templates" |
+
+
+
diff --git a/docs/CommunicationsTemplatesApi.md b/docs/CommunicationsTemplatesApi.md
new file mode 100644
index 00000000..58bda5e4
--- /dev/null
+++ b/docs/CommunicationsTemplatesApi.md
@@ -0,0 +1,373 @@
+# CommunicationsTemplatesApi
+
+All URIs are relative to *https://api.rootly.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createCommunicationsTemplate**](CommunicationsTemplatesApi.md#createCommunicationsTemplate) | **POST** /v1/communications/templates | Creates a communications template |
+| [**deleteCommunicationsTemplate**](CommunicationsTemplatesApi.md#deleteCommunicationsTemplate) | **DELETE** /v1/communications/templates/{id} | Deletes a communications template |
+| [**getCommunicationsTemplate**](CommunicationsTemplatesApi.md#getCommunicationsTemplate) | **GET** /v1/communications/templates/{id} | Shows a communications template |
+| [**listCommunicationsTemplates**](CommunicationsTemplatesApi.md#listCommunicationsTemplates) | **GET** /v1/communications/templates | Lists communications templates |
+| [**updateCommunicationsTemplate**](CommunicationsTemplatesApi.md#updateCommunicationsTemplate) | **PATCH** /v1/communications/templates/{id} | Updates a communications template |
+
+
+
+# **createCommunicationsTemplate**
+> CommunicationsTemplateResponse createCommunicationsTemplate(newCommunicationsTemplate)
+
+Creates a communications template
+
+Creates a new communications template from provided data
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.CommunicationsTemplatesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ CommunicationsTemplatesApi apiInstance = new CommunicationsTemplatesApi(defaultClient);
+ NewCommunicationsTemplate newCommunicationsTemplate = new NewCommunicationsTemplate(); // NewCommunicationsTemplate |
+ try {
+ CommunicationsTemplateResponse result = apiInstance.createCommunicationsTemplate(newCommunicationsTemplate);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling CommunicationsTemplatesApi#createCommunicationsTemplate");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **newCommunicationsTemplate** | [**NewCommunicationsTemplate**](NewCommunicationsTemplate.md)| | |
+
+### Return type
+
+[**CommunicationsTemplateResponse**](CommunicationsTemplateResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/vnd.api+json
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | communications template created | - |
+| **422** | invalid request | - |
+
+
+# **deleteCommunicationsTemplate**
+> deleteCommunicationsTemplate(id)
+
+Deletes a communications template
+
+Deletes a communications template
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.CommunicationsTemplatesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ CommunicationsTemplatesApi apiInstance = new CommunicationsTemplatesApi(defaultClient);
+ String id = "id_example"; // String | Communications Template ID
+ try {
+ apiInstance.deleteCommunicationsTemplate(id);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling CommunicationsTemplatesApi#deleteCommunicationsTemplate");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| Communications Template ID | |
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | communications template deleted | - |
+| **404** | communications template not found | - |
+
+
+# **getCommunicationsTemplate**
+> CommunicationsTemplateResponse getCommunicationsTemplate(id)
+
+Shows a communications template
+
+Shows details of a communications template
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.CommunicationsTemplatesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ CommunicationsTemplatesApi apiInstance = new CommunicationsTemplatesApi(defaultClient);
+ String id = "id_example"; // String | Communications Template ID
+ try {
+ CommunicationsTemplateResponse result = apiInstance.getCommunicationsTemplate(id);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling CommunicationsTemplatesApi#getCommunicationsTemplate");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| Communications Template ID | |
+
+### Return type
+
+[**CommunicationsTemplateResponse**](CommunicationsTemplateResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | communications template found | - |
+| **404** | communications template not found | - |
+
+
+# **listCommunicationsTemplates**
+> CommunicationsTemplatesResponse listCommunicationsTemplates(pageNumber, pageSize, filterSearch, filterName, filterSlug, filterCommunicationTypeId, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, sort)
+
+Lists communications templates
+
+Lists communications templates
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.CommunicationsTemplatesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ CommunicationsTemplatesApi apiInstance = new CommunicationsTemplatesApi(defaultClient);
+ Integer pageNumber = 56; // Integer |
+ Integer pageSize = 56; // Integer |
+ String filterSearch = "filterSearch_example"; // String |
+ String filterName = "filterName_example"; // String |
+ String filterSlug = "filterSlug_example"; // String |
+ String filterCommunicationTypeId = "filterCommunicationTypeId_example"; // String |
+ String filterCreatedAtGt = "filterCreatedAtGt_example"; // String |
+ String filterCreatedAtGte = "filterCreatedAtGte_example"; // String |
+ String filterCreatedAtLt = "filterCreatedAtLt_example"; // String |
+ String filterCreatedAtLte = "filterCreatedAtLte_example"; // String |
+ String sort = "sort_example"; // String |
+ try {
+ CommunicationsTemplatesResponse result = apiInstance.listCommunicationsTemplates(pageNumber, pageSize, filterSearch, filterName, filterSlug, filterCommunicationTypeId, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, sort);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling CommunicationsTemplatesApi#listCommunicationsTemplates");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **pageNumber** | **Integer**| | [optional] |
+| **pageSize** | **Integer**| | [optional] |
+| **filterSearch** | **String**| | [optional] |
+| **filterName** | **String**| | [optional] |
+| **filterSlug** | **String**| | [optional] |
+| **filterCommunicationTypeId** | **String**| | [optional] |
+| **filterCreatedAtGt** | **String**| | [optional] |
+| **filterCreatedAtGte** | **String**| | [optional] |
+| **filterCreatedAtLt** | **String**| | [optional] |
+| **filterCreatedAtLte** | **String**| | [optional] |
+| **sort** | **String**| | [optional] |
+
+### Return type
+
+[**CommunicationsTemplatesResponse**](CommunicationsTemplatesResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | communications templates found | - |
+
+
+# **updateCommunicationsTemplate**
+> CommunicationsTemplateResponse updateCommunicationsTemplate(id, updateCommunicationsTemplate)
+
+Updates a communications template
+
+Updates a communications template
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.CommunicationsTemplatesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ CommunicationsTemplatesApi apiInstance = new CommunicationsTemplatesApi(defaultClient);
+ String id = "id_example"; // String | Communications Template ID
+ UpdateCommunicationsTemplate updateCommunicationsTemplate = new UpdateCommunicationsTemplate(); // UpdateCommunicationsTemplate |
+ try {
+ CommunicationsTemplateResponse result = apiInstance.updateCommunicationsTemplate(id, updateCommunicationsTemplate);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling CommunicationsTemplatesApi#updateCommunicationsTemplate");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| Communications Template ID | |
+| **updateCommunicationsTemplate** | [**UpdateCommunicationsTemplate**](UpdateCommunicationsTemplate.md)| | |
+
+### Return type
+
+[**CommunicationsTemplateResponse**](CommunicationsTemplateResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/vnd.api+json
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | communications template updated | - |
+| **422** | invalid request | - |
+
diff --git a/docs/CommunicationsTemplatesResponse.md b/docs/CommunicationsTemplatesResponse.md
new file mode 100644
index 00000000..47ce805a
--- /dev/null
+++ b/docs/CommunicationsTemplatesResponse.md
@@ -0,0 +1,15 @@
+
+
+# CommunicationsTemplatesResponse
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<CommunicationsTemplateResponseData>**](CommunicationsTemplateResponseData.md) | | |
+|**links** | [**Links**](Links.md) | | [optional] |
+|**meta** | [**Meta**](Meta.md) | | [optional] |
+
+
+
diff --git a/docs/CommunicationsType.md b/docs/CommunicationsType.md
new file mode 100644
index 00000000..8aa1063b
--- /dev/null
+++ b/docs/CommunicationsType.md
@@ -0,0 +1,19 @@
+
+
+# CommunicationsType
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | The name of the communications type | |
+|**slug** | **String** | The slug of the communications type | [optional] |
+|**description** | **String** | The description of the communications type | [optional] |
+|**color** | **String** | The color of the communications type | |
+|**position** | **Integer** | Position of the communications type | |
+|**createdAt** | **String** | Date of creation | |
+|**updatedAt** | **String** | Date of last update | |
+
+
+
diff --git a/docs/CommunicationsTypeResponse.md b/docs/CommunicationsTypeResponse.md
new file mode 100644
index 00000000..1acdfc2d
--- /dev/null
+++ b/docs/CommunicationsTypeResponse.md
@@ -0,0 +1,13 @@
+
+
+# CommunicationsTypeResponse
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**CommunicationsTypeResponseData**](CommunicationsTypeResponseData.md) | | |
+
+
+
diff --git a/docs/CommunicationsTypeResponseData.md b/docs/CommunicationsTypeResponseData.md
new file mode 100644
index 00000000..b042b175
--- /dev/null
+++ b/docs/CommunicationsTypeResponseData.md
@@ -0,0 +1,23 @@
+
+
+# CommunicationsTypeResponseData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | Unique ID of the communications type | |
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**CommunicationsType**](CommunicationsType.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| COMMUNICATIONS_TYPES | "communications_types" |
+
+
+
diff --git a/docs/CommunicationsTypesApi.md b/docs/CommunicationsTypesApi.md
new file mode 100644
index 00000000..5a4201d2
--- /dev/null
+++ b/docs/CommunicationsTypesApi.md
@@ -0,0 +1,371 @@
+# CommunicationsTypesApi
+
+All URIs are relative to *https://api.rootly.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createCommunicationsType**](CommunicationsTypesApi.md#createCommunicationsType) | **POST** /v1/communications/types | Creates a communications type |
+| [**deleteCommunicationsType**](CommunicationsTypesApi.md#deleteCommunicationsType) | **DELETE** /v1/communications/types/{id} | Deletes a communications type |
+| [**getCommunicationsType**](CommunicationsTypesApi.md#getCommunicationsType) | **GET** /v1/communications/types/{id} | Shows a communications type |
+| [**listCommunicationsTypes**](CommunicationsTypesApi.md#listCommunicationsTypes) | **GET** /v1/communications/types | Lists communications types |
+| [**updateCommunicationsType**](CommunicationsTypesApi.md#updateCommunicationsType) | **PATCH** /v1/communications/types/{id} | Updates a communications type |
+
+
+
+# **createCommunicationsType**
+> CommunicationsTypeResponse createCommunicationsType(newCommunicationsType)
+
+Creates a communications type
+
+Creates a new communications type from provided data
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.CommunicationsTypesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ CommunicationsTypesApi apiInstance = new CommunicationsTypesApi(defaultClient);
+ NewCommunicationsType newCommunicationsType = new NewCommunicationsType(); // NewCommunicationsType |
+ try {
+ CommunicationsTypeResponse result = apiInstance.createCommunicationsType(newCommunicationsType);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling CommunicationsTypesApi#createCommunicationsType");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **newCommunicationsType** | [**NewCommunicationsType**](NewCommunicationsType.md)| | |
+
+### Return type
+
+[**CommunicationsTypeResponse**](CommunicationsTypeResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/vnd.api+json
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | communications type created | - |
+| **422** | invalid request | - |
+
+
+# **deleteCommunicationsType**
+> deleteCommunicationsType(id)
+
+Deletes a communications type
+
+Deletes a communications type
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.CommunicationsTypesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ CommunicationsTypesApi apiInstance = new CommunicationsTypesApi(defaultClient);
+ String id = "id_example"; // String | Communications Type ID
+ try {
+ apiInstance.deleteCommunicationsType(id);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling CommunicationsTypesApi#deleteCommunicationsType");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| Communications Type ID | |
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | communications type deleted | - |
+| **404** | communications type not found | - |
+
+
+# **getCommunicationsType**
+> CommunicationsTypeResponse getCommunicationsType(id)
+
+Shows a communications type
+
+Shows details of a communications type
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.CommunicationsTypesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ CommunicationsTypesApi apiInstance = new CommunicationsTypesApi(defaultClient);
+ String id = "id_example"; // String | Communications Type ID
+ try {
+ CommunicationsTypeResponse result = apiInstance.getCommunicationsType(id);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling CommunicationsTypesApi#getCommunicationsType");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| Communications Type ID | |
+
+### Return type
+
+[**CommunicationsTypeResponse**](CommunicationsTypeResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | communications type found | - |
+| **404** | communications type not found | - |
+
+
+# **listCommunicationsTypes**
+> CommunicationsTypesResponse listCommunicationsTypes(pageNumber, pageSize, filterSearch, filterName, filterSlug, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, sort)
+
+Lists communications types
+
+Lists communications types
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.CommunicationsTypesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ CommunicationsTypesApi apiInstance = new CommunicationsTypesApi(defaultClient);
+ Integer pageNumber = 56; // Integer |
+ Integer pageSize = 56; // Integer |
+ String filterSearch = "filterSearch_example"; // String |
+ String filterName = "filterName_example"; // String |
+ String filterSlug = "filterSlug_example"; // String |
+ String filterCreatedAtGt = "filterCreatedAtGt_example"; // String |
+ String filterCreatedAtGte = "filterCreatedAtGte_example"; // String |
+ String filterCreatedAtLt = "filterCreatedAtLt_example"; // String |
+ String filterCreatedAtLte = "filterCreatedAtLte_example"; // String |
+ String sort = "sort_example"; // String |
+ try {
+ CommunicationsTypesResponse result = apiInstance.listCommunicationsTypes(pageNumber, pageSize, filterSearch, filterName, filterSlug, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, sort);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling CommunicationsTypesApi#listCommunicationsTypes");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **pageNumber** | **Integer**| | [optional] |
+| **pageSize** | **Integer**| | [optional] |
+| **filterSearch** | **String**| | [optional] |
+| **filterName** | **String**| | [optional] |
+| **filterSlug** | **String**| | [optional] |
+| **filterCreatedAtGt** | **String**| | [optional] |
+| **filterCreatedAtGte** | **String**| | [optional] |
+| **filterCreatedAtLt** | **String**| | [optional] |
+| **filterCreatedAtLte** | **String**| | [optional] |
+| **sort** | **String**| | [optional] |
+
+### Return type
+
+[**CommunicationsTypesResponse**](CommunicationsTypesResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | communications types found | - |
+
+
+# **updateCommunicationsType**
+> CommunicationsTypeResponse updateCommunicationsType(id, updateCommunicationsType)
+
+Updates a communications type
+
+Updates a communications type
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.CommunicationsTypesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ CommunicationsTypesApi apiInstance = new CommunicationsTypesApi(defaultClient);
+ String id = "id_example"; // String | Communications Type ID
+ UpdateCommunicationsType updateCommunicationsType = new UpdateCommunicationsType(); // UpdateCommunicationsType |
+ try {
+ CommunicationsTypeResponse result = apiInstance.updateCommunicationsType(id, updateCommunicationsType);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling CommunicationsTypesApi#updateCommunicationsType");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| Communications Type ID | |
+| **updateCommunicationsType** | [**UpdateCommunicationsType**](UpdateCommunicationsType.md)| | |
+
+### Return type
+
+[**CommunicationsTypeResponse**](CommunicationsTypeResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/vnd.api+json
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | communications type updated | - |
+| **422** | invalid request | - |
+
diff --git a/docs/CommunicationsTypesResponse.md b/docs/CommunicationsTypesResponse.md
new file mode 100644
index 00000000..3b0d046a
--- /dev/null
+++ b/docs/CommunicationsTypesResponse.md
@@ -0,0 +1,15 @@
+
+
+# CommunicationsTypesResponse
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<CommunicationsTypeResponseData>**](CommunicationsTypeResponseData.md) | | |
+|**links** | [**Links**](Links.md) | | [optional] |
+|**meta** | [**Meta**](Meta.md) | | [optional] |
+
+
+
diff --git a/docs/CreateAnthropicChatCompletionTaskParams.md b/docs/CreateAnthropicChatCompletionTaskParams.md
new file mode 100644
index 00000000..e80fc823
--- /dev/null
+++ b/docs/CreateAnthropicChatCompletionTaskParams.md
@@ -0,0 +1,24 @@
+
+
+# CreateAnthropicChatCompletionTaskParams
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**taskType** | [**TaskTypeEnum**](#TaskTypeEnum) | | [optional] |
+|**model** | [**CreateAnthropicChatCompletionTaskParamsModel**](CreateAnthropicChatCompletionTaskParamsModel.md) | | |
+|**systemPrompt** | **String** | The system prompt to send to Anthropic (optional) | [optional] |
+|**prompt** | **String** | The prompt to send to Anthropic | |
+
+
+
+## Enum: TaskTypeEnum
+
+| Name | Value |
+|---- | -----|
+| CREATE_ANTHROPIC_CHAT_COMPLETION_TASK | "create_anthropic_chat_completion_task" |
+
+
+
diff --git a/docs/CreateAnthropicChatCompletionTaskParamsModel.md b/docs/CreateAnthropicChatCompletionTaskParamsModel.md
new file mode 100644
index 00000000..08ba7c6e
--- /dev/null
+++ b/docs/CreateAnthropicChatCompletionTaskParamsModel.md
@@ -0,0 +1,15 @@
+
+
+# CreateAnthropicChatCompletionTaskParamsModel
+
+The Anthropic model. eg: claude-3-5-sonnet-20241022
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | | [optional] |
+|**name** | **String** | | [optional] |
+
+
+
diff --git a/docs/CreateCodaPageTaskParams.md b/docs/CreateCodaPageTaskParams.md
index 44012581..e0b92f4a 100644
--- a/docs/CreateCodaPageTaskParams.md
+++ b/docs/CreateCodaPageTaskParams.md
@@ -15,6 +15,7 @@
|**content** | **String** | The Coda page content | [optional] |
|**template** | [**CreateCodaPageTaskParamsTemplate**](CreateCodaPageTaskParamsTemplate.md) | | [optional] |
|**folderId** | **String** | The Coda folder id | [optional] |
+|**doc** | [**CreateCodaPageTaskParamsDoc**](CreateCodaPageTaskParamsDoc.md) | | [optional] |
diff --git a/docs/CreateCodaPageTaskParamsDoc.md b/docs/CreateCodaPageTaskParamsDoc.md
new file mode 100644
index 00000000..3afc7c0b
--- /dev/null
+++ b/docs/CreateCodaPageTaskParamsDoc.md
@@ -0,0 +1,15 @@
+
+
+# CreateCodaPageTaskParamsDoc
+
+The Coda doc object with id and name
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | | [optional] |
+|**name** | **String** | | [optional] |
+
+
+
diff --git a/docs/CreateEdgeConnectorActionRequest.md b/docs/CreateEdgeConnectorActionRequest.md
new file mode 100644
index 00000000..9c47a018
--- /dev/null
+++ b/docs/CreateEdgeConnectorActionRequest.md
@@ -0,0 +1,13 @@
+
+
+# CreateEdgeConnectorActionRequest
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**action** | [**CreateEdgeConnectorActionRequestAction**](CreateEdgeConnectorActionRequestAction.md) | | [optional] |
+
+
+
diff --git a/docs/CreateEdgeConnectorActionRequestAction.md b/docs/CreateEdgeConnectorActionRequestAction.md
new file mode 100644
index 00000000..d8802ed2
--- /dev/null
+++ b/docs/CreateEdgeConnectorActionRequestAction.md
@@ -0,0 +1,24 @@
+
+
+# CreateEdgeConnectorActionRequestAction
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | Action name | |
+|**actionType** | [**ActionTypeEnum**](#ActionTypeEnum) | Action type | |
+|**metadata** | [**CreateEdgeConnectorActionRequestActionMetadata**](CreateEdgeConnectorActionRequestActionMetadata.md) | | [optional] |
+
+
+
+## Enum: ActionTypeEnum
+
+| Name | Value |
+|---- | -----|
+| SCRIPT | "script" |
+| HTTP | "http" |
+
+
+
diff --git a/docs/CreateEdgeConnectorActionRequestActionMetadata.md b/docs/CreateEdgeConnectorActionRequestActionMetadata.md
new file mode 100644
index 00000000..71618afb
--- /dev/null
+++ b/docs/CreateEdgeConnectorActionRequestActionMetadata.md
@@ -0,0 +1,15 @@
+
+
+# CreateEdgeConnectorActionRequestActionMetadata
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**description** | **String** | | [optional] |
+|**timeout** | **Integer** | | [optional] |
+|**parameters** | [**List<CreateEdgeConnectorActionRequestActionMetadataParametersInner>**](CreateEdgeConnectorActionRequestActionMetadataParametersInner.md) | | [optional] |
+
+
+
diff --git a/docs/CreateEdgeConnectorActionRequestActionMetadataParametersInner.md b/docs/CreateEdgeConnectorActionRequestActionMetadataParametersInner.md
new file mode 100644
index 00000000..e19dbea2
--- /dev/null
+++ b/docs/CreateEdgeConnectorActionRequestActionMetadataParametersInner.md
@@ -0,0 +1,27 @@
+
+
+# CreateEdgeConnectorActionRequestActionMetadataParametersInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | | [optional] |
+|**type** | [**TypeEnum**](#TypeEnum) | | [optional] |
+|**required** | **Boolean** | | [optional] |
+|**description** | **String** | | [optional] |
+|**options** | **List<String>** | | [optional] |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| STRING | "string" |
+| NUMBER | "number" |
+| BOOLEAN | "boolean" |
+
+
+
diff --git a/docs/CreateEdgeConnectorRequest.md b/docs/CreateEdgeConnectorRequest.md
new file mode 100644
index 00000000..d0628cca
--- /dev/null
+++ b/docs/CreateEdgeConnectorRequest.md
@@ -0,0 +1,13 @@
+
+
+# CreateEdgeConnectorRequest
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**CreateEdgeConnectorRequestData**](CreateEdgeConnectorRequestData.md) | | |
+
+
+
diff --git a/docs/CreateEdgeConnectorRequestData.md b/docs/CreateEdgeConnectorRequestData.md
new file mode 100644
index 00000000..d1eabf25
--- /dev/null
+++ b/docs/CreateEdgeConnectorRequestData.md
@@ -0,0 +1,22 @@
+
+
+# CreateEdgeConnectorRequestData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**CreateEdgeConnectorRequestDataAttributes**](CreateEdgeConnectorRequestDataAttributes.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| EDGE_CONNECTORS | "edge_connectors" |
+
+
+
diff --git a/docs/CreateEdgeConnectorRequestDataAttributes.md b/docs/CreateEdgeConnectorRequestDataAttributes.md
new file mode 100644
index 00000000..123a9a45
--- /dev/null
+++ b/docs/CreateEdgeConnectorRequestDataAttributes.md
@@ -0,0 +1,25 @@
+
+
+# CreateEdgeConnectorRequestDataAttributes
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | Connector name | |
+|**description** | **String** | Connector description | [optional] |
+|**status** | [**StatusEnum**](#StatusEnum) | Connector status | [optional] |
+|**subscriptions** | **List<String>** | Array of event types to subscribe to | [optional] |
+
+
+
+## Enum: StatusEnum
+
+| Name | Value |
+|---- | -----|
+| ACTIVE | "active" |
+| PAUSED | "paused" |
+
+
+
diff --git a/docs/CreateGithubIssueTaskParams.md b/docs/CreateGithubIssueTaskParams.md
index 745a4582..ae741ab4 100644
--- a/docs/CreateGithubIssueTaskParams.md
+++ b/docs/CreateGithubIssueTaskParams.md
@@ -11,6 +11,9 @@
|**title** | **String** | The issue title | |
|**body** | **String** | The issue body | [optional] |
|**repository** | [**AddActionItemTaskParamsPostToSlackChannelsInner**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | |
+|**labels** | [**List<AddActionItemTaskParamsPostToSlackChannelsInner>**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | The issue labels | [optional] |
+|**issueType** | [**CreateGithubIssueTaskParamsIssueType**](CreateGithubIssueTaskParamsIssueType.md) | | [optional] |
+|**parentIssueNumber** | **String** | The parent issue number for sub-issue linking | [optional] |
diff --git a/docs/CreateGithubIssueTaskParamsIssueType.md b/docs/CreateGithubIssueTaskParamsIssueType.md
new file mode 100644
index 00000000..f5fc5d5d
--- /dev/null
+++ b/docs/CreateGithubIssueTaskParamsIssueType.md
@@ -0,0 +1,15 @@
+
+
+# CreateGithubIssueTaskParamsIssueType
+
+The issue type
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | | [optional] |
+|**name** | **String** | | [optional] |
+
+
+
diff --git a/docs/CreateGoogleGeminiChatCompletionTaskParams.md b/docs/CreateGoogleGeminiChatCompletionTaskParams.md
new file mode 100644
index 00000000..d8008f9d
--- /dev/null
+++ b/docs/CreateGoogleGeminiChatCompletionTaskParams.md
@@ -0,0 +1,24 @@
+
+
+# CreateGoogleGeminiChatCompletionTaskParams
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**taskType** | [**TaskTypeEnum**](#TaskTypeEnum) | | [optional] |
+|**model** | [**CreateGoogleGeminiChatCompletionTaskParamsModel**](CreateGoogleGeminiChatCompletionTaskParamsModel.md) | | |
+|**systemPrompt** | **String** | The system prompt to send to Gemini (optional) | [optional] |
+|**prompt** | **String** | The prompt to send to Gemini | |
+
+
+
+## Enum: TaskTypeEnum
+
+| Name | Value |
+|---- | -----|
+| CREATE_GOOGLE_GEMINI_CHAT_COMPLETION_TASK | "create_google_gemini_chat_completion_task" |
+
+
+
diff --git a/docs/CreateGoogleGeminiChatCompletionTaskParamsModel.md b/docs/CreateGoogleGeminiChatCompletionTaskParamsModel.md
new file mode 100644
index 00000000..9a50ff68
--- /dev/null
+++ b/docs/CreateGoogleGeminiChatCompletionTaskParamsModel.md
@@ -0,0 +1,15 @@
+
+
+# CreateGoogleGeminiChatCompletionTaskParamsModel
+
+The Gemini model. eg: gemini-2.0-flash
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | | [optional] |
+|**name** | **String** | | [optional] |
+
+
+
diff --git a/docs/CreateGoogleMeetingTaskParams.md b/docs/CreateGoogleMeetingTaskParams.md
index 9d5f8fef..bf121a11 100644
--- a/docs/CreateGoogleMeetingTaskParams.md
+++ b/docs/CreateGoogleMeetingTaskParams.md
@@ -12,6 +12,7 @@
|**description** | **String** | [DEPRECATED] The meeting description | |
|**conferenceSolutionKey** | [**ConferenceSolutionKeyEnum**](#ConferenceSolutionKeyEnum) | [DEPRECATED] Sets the video conference type attached to the meeting | [optional] |
|**recordMeeting** | **Boolean** | Rootly AI will record the meeting and automatically generate a transcript and summary from your meeting | [optional] |
+|**recordingMode** | [**RecordingModeEnum**](#RecordingModeEnum) | The video layout for the bot's recording (e.g. speaker_view, gallery_view, gallery_view_v2, audio_only) | [optional] |
|**postToIncidentTimeline** | **Boolean** | | [optional] |
|**postToSlackChannels** | [**List<AddActionItemTaskParamsPostToSlackChannelsInner>**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | [optional] |
@@ -36,3 +37,14 @@
+## Enum: RecordingModeEnum
+
+| Name | Value |
+|---- | -----|
+| SPEAKER_VIEW | "speaker_view" |
+| GALLERY_VIEW | "gallery_view" |
+| GALLERY_VIEW_V2 | "gallery_view_v2" |
+| AUDIO_ONLY | "audio_only" |
+
+
+
diff --git a/docs/CreateIncidentTaskParams.md b/docs/CreateIncidentTaskParams.md
index 879cd6c1..558e8b8d 100644
--- a/docs/CreateIncidentTaskParams.md
+++ b/docs/CreateIncidentTaskParams.md
@@ -12,12 +12,12 @@
|**summary** | **String** | The incident summary | [optional] |
|**severityId** | **String** | | [optional] |
|**incidentTypeIds** | **List<String>** | | [optional] |
-|**serviceIds** | **List<String>** | | [optional] |
-|**functionalityIds** | **List<String>** | | [optional] |
+|**serviceIds** | **List<String>** | Array of service UUIDs | [optional] |
+|**functionalityIds** | **List<String>** | Array of functionality UUIDs | [optional] |
|**environmentIds** | **List<String>** | | [optional] |
-|**groupIds** | **List<String>** | | [optional] |
+|**groupIds** | **List<String>** | Array of group/team UUIDs | [optional] |
|**_private** | **Boolean** | | [optional] |
-|**customFieldsMapping** | **String** | Custom field mappings. Can contain liquid markup and need to be valid JSON | [optional] |
+|**customFieldsMapping** | **String** | Custom field mappings. Can contain liquid markup and need to be valid JSON. Use 'services', 'functionalities', or 'groups' keys with arrays of names/slugs for name/slug lookup | [optional] |
diff --git a/docs/CreateJsmopsAlertTaskParams.md b/docs/CreateJsmopsAlertTaskParams.md
new file mode 100644
index 00000000..7f99d120
--- /dev/null
+++ b/docs/CreateJsmopsAlertTaskParams.md
@@ -0,0 +1,43 @@
+
+
+# CreateJsmopsAlertTaskParams
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**taskType** | [**TaskTypeEnum**](#TaskTypeEnum) | | [optional] |
+|**message** | **String** | Message of the alert | |
+|**description** | **String** | Description field of the alert that is generally used to provide a detailed information about the alert | [optional] |
+|**teams** | [**List<AddActionItemTaskParamsPostToSlackChannelsInner>**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | [optional] |
+|**users** | [**List<AddActionItemTaskParamsPostToSlackChannelsInner>**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | [optional] |
+|**schedules** | [**List<AddActionItemTaskParamsPostToSlackChannelsInner>**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | [optional] |
+|**escalations** | [**List<AddActionItemTaskParamsPostToSlackChannelsInner>**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | [optional] |
+|**priority** | [**PriorityEnum**](#PriorityEnum) | | [optional] |
+|**details** | **String** | Details payload. Can contain liquid markup and need to be valid JSON | [optional] |
+
+
+
+## Enum: TaskTypeEnum
+
+| Name | Value |
+|---- | -----|
+| CREATE_JSMOPS_ALERT | "create_jsmops_alert" |
+
+
+
+## Enum: PriorityEnum
+
+| Name | Value |
+|---- | -----|
+| P3 | "P3" |
+| P1 | "P1" |
+| P2 | "P2" |
+| P32 | "P3" |
+| P4 | "P4" |
+| P5 | "P5" |
+| AUTO | "auto" |
+
+
+
diff --git a/docs/CreateMicrosoftTeamsChatTaskParams.md b/docs/CreateMicrosoftTeamsChatTaskParams.md
new file mode 100644
index 00000000..cab6a4d0
--- /dev/null
+++ b/docs/CreateMicrosoftTeamsChatTaskParams.md
@@ -0,0 +1,33 @@
+
+
+# CreateMicrosoftTeamsChatTaskParams
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**taskType** | [**TaskTypeEnum**](#TaskTypeEnum) | | [optional] |
+|**topic** | **String** | Chat topic (only for group chats) | [optional] |
+|**chatType** | [**ChatTypeEnum**](#ChatTypeEnum) | Type of chat to create | [optional] |
+|**members** | [**List<CreateMicrosoftTeamsChatTaskParamsMembersInner>**](CreateMicrosoftTeamsChatTaskParamsMembersInner.md) | Array of members to include in the chat | |
+
+
+
+## Enum: TaskTypeEnum
+
+| Name | Value |
+|---- | -----|
+| CREATE_MICROSOFT_TEAMS_CHAT | "create_microsoft_teams_chat" |
+
+
+
+## Enum: ChatTypeEnum
+
+| Name | Value |
+|---- | -----|
+| GROUP | "group" |
+| ONE_ON_ONE | "oneOnOne" |
+
+
+
diff --git a/docs/CreateMicrosoftTeamsChatTaskParamsMembersInner.md b/docs/CreateMicrosoftTeamsChatTaskParamsMembersInner.md
new file mode 100644
index 00000000..4f383147
--- /dev/null
+++ b/docs/CreateMicrosoftTeamsChatTaskParamsMembersInner.md
@@ -0,0 +1,14 @@
+
+
+# CreateMicrosoftTeamsChatTaskParamsMembersInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**email** | **String** | | [optional] |
+|**name** | **String** | | [optional] |
+
+
+
diff --git a/docs/CreateMicrosoftTeamsMeetingTaskParams.md b/docs/CreateMicrosoftTeamsMeetingTaskParams.md
index 5c9d00ee..8153bd0f 100644
--- a/docs/CreateMicrosoftTeamsMeetingTaskParams.md
+++ b/docs/CreateMicrosoftTeamsMeetingTaskParams.md
@@ -11,6 +11,7 @@
|**name** | **String** | The meeting name | |
|**subject** | **String** | The meeting subject | |
|**recordMeeting** | **Boolean** | Rootly AI will record the meeting and automatically generate a transcript and summary from your meeting | [optional] |
+|**recordingMode** | [**RecordingModeEnum**](#RecordingModeEnum) | The video layout for the bot's recording (e.g. speaker_view, gallery_view, gallery_view_v2, audio_only) | [optional] |
|**postToIncidentTimeline** | **Boolean** | | [optional] |
|**postToSlackChannels** | [**List<AddActionItemTaskParamsPostToSlackChannelsInner>**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | [optional] |
@@ -24,3 +25,14 @@
+## Enum: RecordingModeEnum
+
+| Name | Value |
+|---- | -----|
+| SPEAKER_VIEW | "speaker_view" |
+| GALLERY_VIEW | "gallery_view" |
+| GALLERY_VIEW_V2 | "gallery_view_v2" |
+| AUDIO_ONLY | "audio_only" |
+
+
+
diff --git a/docs/CreateMistralChatCompletionTaskParams.md b/docs/CreateMistralChatCompletionTaskParams.md
new file mode 100644
index 00000000..7ba015d8
--- /dev/null
+++ b/docs/CreateMistralChatCompletionTaskParams.md
@@ -0,0 +1,27 @@
+
+
+# CreateMistralChatCompletionTaskParams
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**taskType** | [**TaskTypeEnum**](#TaskTypeEnum) | | [optional] |
+|**model** | [**CreateMistralChatCompletionTaskParamsModel**](CreateMistralChatCompletionTaskParamsModel.md) | | |
+|**systemPrompt** | **String** | The system prompt to send to Mistral (optional) | [optional] |
+|**prompt** | **String** | The prompt to send to Mistral | |
+|**temperature** | **BigDecimal** | Sampling temperature (0.0-1.5). Higher values make output more random. | [optional] |
+|**maxTokens** | **Integer** | Maximum number of tokens to generate | [optional] |
+|**topP** | **BigDecimal** | Nucleus sampling parameter (0.0-1.0) | [optional] |
+
+
+
+## Enum: TaskTypeEnum
+
+| Name | Value |
+|---- | -----|
+| CREATE_MISTRAL_CHAT_COMPLETION_TASK | "create_mistral_chat_completion_task" |
+
+
+
diff --git a/docs/CreateMistralChatCompletionTaskParamsModel.md b/docs/CreateMistralChatCompletionTaskParamsModel.md
new file mode 100644
index 00000000..9cf60b59
--- /dev/null
+++ b/docs/CreateMistralChatCompletionTaskParamsModel.md
@@ -0,0 +1,15 @@
+
+
+# CreateMistralChatCompletionTaskParamsModel
+
+The Mistral model. eg: mistral-large-latest
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | | [optional] |
+|**name** | **String** | | [optional] |
+
+
+
diff --git a/docs/CreateNotionPageTaskParams.md b/docs/CreateNotionPageTaskParams.md
index 93c726dd..706416ff 100644
--- a/docs/CreateNotionPageTaskParams.md
+++ b/docs/CreateNotionPageTaskParams.md
@@ -11,6 +11,7 @@
|**title** | **String** | The Notion page title | |
|**parentPage** | [**CreateNotionPageTaskParamsParentPage**](CreateNotionPageTaskParamsParentPage.md) | | |
|**postMortemTemplateId** | **String** | Retrospective template to use when creating page task, if desired | [optional] |
+|**content** | **String** | Custom page content with liquid templating support. When provided, only this content will be rendered (no default sections) | [optional] |
|**markPostMortemAsPublished** | **Boolean** | | [optional] |
|**showTimelineAsTable** | **Boolean** | | [optional] |
|**showActionItemsAsTable** | **Boolean** | | [optional] |
diff --git a/docs/CreateOpenaiChatCompletionTaskParams.md b/docs/CreateOpenaiChatCompletionTaskParams.md
new file mode 100644
index 00000000..7f219337
--- /dev/null
+++ b/docs/CreateOpenaiChatCompletionTaskParams.md
@@ -0,0 +1,50 @@
+
+
+# CreateOpenaiChatCompletionTaskParams
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**taskType** | [**TaskTypeEnum**](#TaskTypeEnum) | | [optional] |
+|**model** | [**CreateOpenaiChatCompletionTaskParamsModel**](CreateOpenaiChatCompletionTaskParamsModel.md) | | |
+|**systemPrompt** | **String** | The system prompt to send to OpenAI (optional) | [optional] |
+|**prompt** | **String** | The prompt to send to OpenAI | |
+|**temperature** | **BigDecimal** | Controls randomness in the response. Higher values make output more random | [optional] |
+|**maxTokens** | **Integer** | Maximum number of tokens to generate in the response | [optional] |
+|**topP** | **BigDecimal** | Controls diversity via nucleus sampling. Lower values make output more focused | [optional] |
+|**reasoningEffort** | [**ReasoningEffortEnum**](#ReasoningEffortEnum) | Constrains effort on reasoning for GPT-5 and o-series models | [optional] |
+|**reasoningSummary** | [**ReasoningSummaryEnum**](#ReasoningSummaryEnum) | Summary of the reasoning performed by the model for GPT-5 and o-series models | [optional] |
+
+
+
+## Enum: TaskTypeEnum
+
+| Name | Value |
+|---- | -----|
+| OPENAI_CHAT_COMPLETION | "openai_chat_completion" |
+
+
+
+## Enum: ReasoningEffortEnum
+
+| Name | Value |
+|---- | -----|
+| MINIMAL | "minimal" |
+| LOW | "low" |
+| MEDIUM | "medium" |
+| HIGH | "high" |
+
+
+
+## Enum: ReasoningSummaryEnum
+
+| Name | Value |
+|---- | -----|
+| AUTO | "auto" |
+| CONCISE | "concise" |
+| DETAILED | "detailed" |
+
+
+
diff --git a/docs/CreateOpenaiChatCompletionTaskParamsModel.md b/docs/CreateOpenaiChatCompletionTaskParamsModel.md
new file mode 100644
index 00000000..342d3110
--- /dev/null
+++ b/docs/CreateOpenaiChatCompletionTaskParamsModel.md
@@ -0,0 +1,15 @@
+
+
+# CreateOpenaiChatCompletionTaskParamsModel
+
+The OpenAI model. eg: gpt-5-nano
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | | [optional] |
+|**name** | **String** | | [optional] |
+
+
+
diff --git a/docs/CreateOutlookEventTaskParams.md b/docs/CreateOutlookEventTaskParams.md
index 863c4949..fde371af 100644
--- a/docs/CreateOutlookEventTaskParams.md
+++ b/docs/CreateOutlookEventTaskParams.md
@@ -17,6 +17,7 @@
|**summary** | **String** | The event summary | |
|**description** | **String** | The event description | |
|**excludeWeekends** | **Boolean** | | [optional] |
+|**enableOnlineMeeting** | **Boolean** | Enable Microsoft Teams online meeting | [optional] |
|**postToIncidentTimeline** | **Boolean** | | [optional] |
|**postToSlackChannels** | [**List<AddActionItemTaskParamsPostToSlackChannelsInner>**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | [optional] |
diff --git a/docs/CreateSubIncidentTaskParams.md b/docs/CreateSubIncidentTaskParams.md
new file mode 100644
index 00000000..c4377282
--- /dev/null
+++ b/docs/CreateSubIncidentTaskParams.md
@@ -0,0 +1,23 @@
+
+
+# CreateSubIncidentTaskParams
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**taskType** | [**TaskTypeEnum**](#TaskTypeEnum) | | [optional] |
+|**title** | **String** | The sub incident title | |
+|**summary** | **String** | The sub incident summary | [optional] |
+
+
+
+## Enum: TaskTypeEnum
+
+| Name | Value |
+|---- | -----|
+| CREATE_SUB_INCIDENT | "create_sub_incident" |
+
+
+
diff --git a/docs/CreateWatsonxChatCompletionTaskParams.md b/docs/CreateWatsonxChatCompletionTaskParams.md
new file mode 100644
index 00000000..99f4b5e2
--- /dev/null
+++ b/docs/CreateWatsonxChatCompletionTaskParams.md
@@ -0,0 +1,25 @@
+
+
+# CreateWatsonxChatCompletionTaskParams
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**taskType** | [**TaskTypeEnum**](#TaskTypeEnum) | | [optional] |
+|**model** | [**CreateWatsonxChatCompletionTaskParamsModel**](CreateWatsonxChatCompletionTaskParamsModel.md) | | |
+|**systemPrompt** | **String** | The system prompt to send to WatsonX (optional) | [optional] |
+|**prompt** | **String** | The prompt to send to WatsonX | |
+|**projectId** | **String** | | |
+
+
+
+## Enum: TaskTypeEnum
+
+| Name | Value |
+|---- | -----|
+| CREATE_WATSONX_CHAT_COMPLETION_TASK | "create_watsonx_chat_completion_task" |
+
+
+
diff --git a/docs/CreateWatsonxChatCompletionTaskParamsModel.md b/docs/CreateWatsonxChatCompletionTaskParamsModel.md
new file mode 100644
index 00000000..9d0f63fe
--- /dev/null
+++ b/docs/CreateWatsonxChatCompletionTaskParamsModel.md
@@ -0,0 +1,15 @@
+
+
+# CreateWatsonxChatCompletionTaskParamsModel
+
+The WatsonX model. eg: ibm/granite-3-b8b-instruct
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | | [optional] |
+|**name** | **String** | | [optional] |
+
+
+
diff --git a/docs/CreateWebexMeetingTaskParams.md b/docs/CreateWebexMeetingTaskParams.md
index c3c8d8c2..4493a6b0 100644
--- a/docs/CreateWebexMeetingTaskParams.md
+++ b/docs/CreateWebexMeetingTaskParams.md
@@ -11,6 +11,7 @@
|**topic** | **String** | The meeting topic | |
|**password** | **String** | The meeting password | [optional] |
|**recordMeeting** | **Boolean** | Rootly AI will record the meeting and automatically generate a transcript and summary from your meeting | [optional] |
+|**recordingMode** | [**RecordingModeEnum**](#RecordingModeEnum) | The video layout for the bot's recording (e.g. speaker_view, gallery_view, gallery_view_v2, audio_only) | [optional] |
|**postToIncidentTimeline** | **Boolean** | | [optional] |
|**postToSlackChannels** | [**List<AddActionItemTaskParamsPostToSlackChannelsInner>**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | [optional] |
@@ -24,3 +25,14 @@
+## Enum: RecordingModeEnum
+
+| Name | Value |
+|---- | -----|
+| SPEAKER_VIEW | "speaker_view" |
+| GALLERY_VIEW | "gallery_view" |
+| GALLERY_VIEW_V2 | "gallery_view_v2" |
+| AUDIO_ONLY | "audio_only" |
+
+
+
diff --git a/docs/CreateZoomMeetingTaskParams.md b/docs/CreateZoomMeetingTaskParams.md
index 74067e5b..caec50b5 100644
--- a/docs/CreateZoomMeetingTaskParams.md
+++ b/docs/CreateZoomMeetingTaskParams.md
@@ -14,6 +14,7 @@
|**alternativeHosts** | **List<String>** | | [optional] |
|**autoRecording** | [**AutoRecordingEnum**](#AutoRecordingEnum) | | [optional] |
|**recordMeeting** | **Boolean** | Rootly AI will record the meeting and automatically generate a transcript and summary from your meeting | [optional] |
+|**recordingMode** | [**RecordingModeEnum**](#RecordingModeEnum) | The video layout for the bot's recording (e.g. speaker_view, gallery_view, gallery_view_v2, audio_only) | [optional] |
|**postToIncidentTimeline** | **Boolean** | | [optional] |
|**postToSlackChannels** | [**List<AddActionItemTaskParamsPostToSlackChannelsInner>**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | [optional] |
@@ -37,3 +38,14 @@
+## Enum: RecordingModeEnum
+
+| Name | Value |
+|---- | -----|
+| SPEAKER_VIEW | "speaker_view" |
+| GALLERY_VIEW | "gallery_view" |
+| GALLERY_VIEW_V2 | "gallery_view_v2" |
+| AUDIO_ONLY | "audio_only" |
+
+
+
diff --git a/docs/CustomField.md b/docs/CustomField.md
index cf44714b..7427948e 100644
--- a/docs/CustomField.md
+++ b/docs/CustomField.md
@@ -7,46 +7,17 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
-|**label** | **String** | The name of the custom_field | |
-|**kind** | **String** | The kind of the custom_field | [optional] |
-|**enabled** | **Boolean** | Whether the custom_field is enabled | [optional] |
-|**slug** | **String** | The slug of the custom_field | |
-|**description** | **String** | The description of the custom_field | [optional] |
-|**shown** | [**List<ShownEnum>**](#List<ShownEnum>) | | |
-|**required** | [**List<RequiredEnum>**](#List<RequiredEnum>) | | |
-|**_default** | **String** | The default value for text field kinds | [optional] |
-|**position** | **Integer** | The position of the custom_field | |
-|**createdAt** | **String** | Date of creation | |
-|**updatedAt** | **String** | Date of last update | |
+|**fieldSource** | [**FieldSourceEnum**](#FieldSourceEnum) | | |
+|**catalogPropertyId** | **String** | ID of the catalog property | |
+|**fieldKey** | **String** | Ignored for custom fields (auto-derived from catalog property) | [optional] |
-## Enum: List<ShownEnum>
+## Enum: FieldSourceEnum
| Name | Value |
|---- | -----|
-| INCIDENT_FORM | "incident_form" |
-| INCIDENT_MITIGATION_FORM | "incident_mitigation_form" |
-| INCIDENT_RESOLUTION_FORM | "incident_resolution_form" |
-| INCIDENT_POST_MORTEM_FORM | "incident_post_mortem_form" |
-| INCIDENT_SLACK_FORM | "incident_slack_form" |
-| INCIDENT_MITIGATION_SLACK_FORM | "incident_mitigation_slack_form" |
-| INCIDENT_RESOLUTION_SLACK_FORM | "incident_resolution_slack_form" |
-| INCIDENT_POST_MORTEM | "incident_post_mortem" |
-
-
-
-## Enum: List<RequiredEnum>
-
-| Name | Value |
-|---- | -----|
-| INCIDENT_FORM | "incident_form" |
-| INCIDENT_MITIGATION_FORM | "incident_mitigation_form" |
-| INCIDENT_RESOLUTION_FORM | "incident_resolution_form" |
-| INCIDENT_POST_MORTEM_FORM | "incident_post_mortem_form" |
-| INCIDENT_SLACK_FORM | "incident_slack_form" |
-| INCIDENT_MITIGATION_SLACK_FORM | "incident_mitigation_slack_form" |
-| INCIDENT_RESOLUTION_SLACK_FORM | "incident_resolution_slack_form" |
+| CUSTOM | "custom" |
diff --git a/docs/CustomFieldList.md b/docs/CustomFieldList.md
index e5ee7a08..9f668e38 100644
--- a/docs/CustomFieldList.md
+++ b/docs/CustomFieldList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<CustomFieldResponseData>**](CustomFieldResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/CustomFieldOptionList.md b/docs/CustomFieldOptionList.md
index 69824e87..faa2d59a 100644
--- a/docs/CustomFieldOptionList.md
+++ b/docs/CustomFieldOptionList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<CustomFieldOptionResponseData>**](CustomFieldOptionResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/CustomForm.md b/docs/CustomForm.md
index 86356f70..61663856 100644
--- a/docs/CustomForm.md
+++ b/docs/CustomForm.md
@@ -8,7 +8,7 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**name** | **String** | The name of the custom form. | |
-|**slug** | **String** | The custom form slug. Add this to form_field.shown or form_field.required to associate form fields with custom forms. | |
+|**slug** | **String** | The custom form slug. Add this to form_field.shown or form_field.required to associate form fields with custom forms. | [optional] |
|**description** | **String** | | [optional] |
|**enabled** | **Boolean** | | |
|**command** | **String** | The Slack command used to trigger this form. | |
diff --git a/docs/CustomFormList.md b/docs/CustomFormList.md
index 24abb6f1..16da6772 100644
--- a/docs/CustomFormList.md
+++ b/docs/CustomFormList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<CustomFormResponseData>**](CustomFormResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/CustomFormsApi.md b/docs/CustomFormsApi.md
index ceace400..9b38e0e2 100644
--- a/docs/CustomFormsApi.md
+++ b/docs/CustomFormsApi.md
@@ -108,7 +108,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
CustomFormsApi apiInstance = new CustomFormsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
CustomFormResponse result = apiInstance.deleteCustomForm(id);
System.out.println(result);
@@ -127,7 +127,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -145,7 +145,7 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **200** | custom_form deleted | - |
+| **200** | custom_form found by slug | - |
| **404** | resource not found | - |
@@ -176,7 +176,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
CustomFormsApi apiInstance = new CustomFormsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
CustomFormResponse result = apiInstance.getCustomForm(id);
System.out.println(result);
@@ -195,7 +195,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -332,7 +332,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
CustomFormsApi apiInstance = new CustomFormsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
UpdateCustomForm updateCustomForm = new UpdateCustomForm(); // UpdateCustomForm |
try {
CustomFormResponse result = apiInstance.updateCustomForm(id, updateCustomForm);
@@ -352,7 +352,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
| **updateCustomForm** | [**UpdateCustomForm**](UpdateCustomForm.md)| | |
### Return type
diff --git a/docs/DashboardList.md b/docs/DashboardList.md
index eaca87a8..8660691a 100644
--- a/docs/DashboardList.md
+++ b/docs/DashboardList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<DashboardResponseData>**](DashboardResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/DashboardPanelList.md b/docs/DashboardPanelList.md
index 5228036e..aefc0b73 100644
--- a/docs/DashboardPanelList.md
+++ b/docs/DashboardPanelList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<DashboardPanelResponseData>**](DashboardPanelResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/DashboardsApi.md b/docs/DashboardsApi.md
index 62a8ae03..216c7051 100644
--- a/docs/DashboardsApi.md
+++ b/docs/DashboardsApi.md
@@ -110,7 +110,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
DashboardsApi apiInstance = new DashboardsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
DashboardResponse result = apiInstance.deleteDashboard(id);
System.out.println(result);
@@ -129,7 +129,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -178,7 +178,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
DashboardsApi apiInstance = new DashboardsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
DashboardResponse result = apiInstance.duplicateDashboard(id);
System.out.println(result);
@@ -197,7 +197,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -246,7 +246,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
DashboardsApi apiInstance = new DashboardsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
String include = "panels"; // String | comma separated if needed. eg: panels
try {
DashboardResponse result = apiInstance.getDashboard(id, include);
@@ -266,7 +266,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
| **include** | **String**| comma separated if needed. eg: panels | [optional] [enum: panels] |
### Return type
@@ -285,7 +285,7 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **200** | dashboard found | - |
+| **200** | dashboard found by slug | - |
| **404** | resource not found | - |
@@ -387,7 +387,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
DashboardsApi apiInstance = new DashboardsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
DashboardResponse result = apiInstance.setDefaultDashboard(id);
System.out.println(result);
@@ -406,7 +406,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -424,7 +424,7 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **200** | dashboard created | - |
+| **200** | dashboard found by slug | - |
| **401** | responds with unauthorized for invalid token | - |
@@ -455,7 +455,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
DashboardsApi apiInstance = new DashboardsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
UpdateDashboard updateDashboard = new UpdateDashboard(); // UpdateDashboard |
try {
DashboardResponse result = apiInstance.updateDashboard(id, updateDashboard);
@@ -475,7 +475,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
| **updateDashboard** | [**UpdateDashboard**](UpdateDashboard.md)| | |
### Return type
diff --git a/docs/DeleteAlertRoute200Response.md b/docs/DeleteAlertRoute200Response.md
new file mode 100644
index 00000000..3e44642a
--- /dev/null
+++ b/docs/DeleteAlertRoute200Response.md
@@ -0,0 +1,13 @@
+
+
+# DeleteAlertRoute200Response
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**DeleteAlertRoute200ResponseData**](DeleteAlertRoute200ResponseData.md) | | [optional] |
+
+
+
diff --git a/docs/DeleteAlertRoute200ResponseData.md b/docs/DeleteAlertRoute200ResponseData.md
new file mode 100644
index 00000000..300e003a
--- /dev/null
+++ b/docs/DeleteAlertRoute200ResponseData.md
@@ -0,0 +1,15 @@
+
+
+# DeleteAlertRoute200ResponseData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | | [optional] |
+|**type** | **String** | | [optional] |
+|**attributes** | [**DeleteAlertRoute200ResponseDataAttributes**](DeleteAlertRoute200ResponseDataAttributes.md) | | [optional] |
+
+
+
diff --git a/docs/DeleteAlertRoute200ResponseDataAttributes.md b/docs/DeleteAlertRoute200ResponseDataAttributes.md
new file mode 100644
index 00000000..c40eff46
--- /dev/null
+++ b/docs/DeleteAlertRoute200ResponseDataAttributes.md
@@ -0,0 +1,13 @@
+
+
+# DeleteAlertRoute200ResponseDataAttributes
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**deleted** | **Boolean** | | [optional] |
+
+
+
diff --git a/docs/EdgeConnector.md b/docs/EdgeConnector.md
new file mode 100644
index 00000000..90dd308e
--- /dev/null
+++ b/docs/EdgeConnector.md
@@ -0,0 +1,13 @@
+
+
+# EdgeConnector
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**EdgeConnectorData**](EdgeConnectorData.md) | | |
+
+
+
diff --git a/docs/EdgeConnectorAction.md b/docs/EdgeConnectorAction.md
new file mode 100644
index 00000000..45782d24
--- /dev/null
+++ b/docs/EdgeConnectorAction.md
@@ -0,0 +1,13 @@
+
+
+# EdgeConnectorAction
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**EdgeConnectorActionData**](EdgeConnectorActionData.md) | | |
+
+
+
diff --git a/docs/EdgeConnectorActionData.md b/docs/EdgeConnectorActionData.md
new file mode 100644
index 00000000..51c7e381
--- /dev/null
+++ b/docs/EdgeConnectorActionData.md
@@ -0,0 +1,23 @@
+
+
+# EdgeConnectorActionData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**id** | **UUID** | | |
+|**attributes** | [**EdgeConnectorActionDataAttributes**](EdgeConnectorActionDataAttributes.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| EDGE_CONNECTOR_ACTIONS | "edge_connector_actions" |
+
+
+
diff --git a/docs/EdgeConnectorActionDataAttributes.md b/docs/EdgeConnectorActionDataAttributes.md
new file mode 100644
index 00000000..d1bde491
--- /dev/null
+++ b/docs/EdgeConnectorActionDataAttributes.md
@@ -0,0 +1,50 @@
+
+
+# EdgeConnectorActionDataAttributes
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | Action name | |
+|**slug** | **String** | Action slug | [optional] |
+|**actionType** | [**ActionTypeEnum**](#ActionTypeEnum) | Action type | |
+|**icon** | [**IconEnum**](#IconEnum) | Action icon | [optional] |
+|**description** | **String** | Action description | [optional] |
+|**timeout** | **Integer** | Timeout in seconds | [optional] |
+|**parameters** | [**List<EdgeConnectorActionDataAttributesParametersInner>**](EdgeConnectorActionDataAttributesParametersInner.md) | Parameter definitions | [optional] |
+|**lastExecutedAt** | **OffsetDateTime** | | [optional] |
+|**createdAt** | **OffsetDateTime** | | [optional] |
+|**updatedAt** | **OffsetDateTime** | | [optional] |
+
+
+
+## Enum: ActionTypeEnum
+
+| Name | Value |
+|---- | -----|
+| SCRIPT | "script" |
+| HTTP | "http" |
+
+
+
+## Enum: IconEnum
+
+| Name | Value |
+|---- | -----|
+| BOLT | "bolt" |
+| BOLT_SLASH | "bolt-slash" |
+| COG | "cog" |
+| COMMAND_LINE | "command-line" |
+| CODE_BRACKET | "code-bracket" |
+| SERVER | "server" |
+| SERVER_STACK | "server-stack" |
+| PLAY | "play" |
+| ARROW_PATH | "arrow-path" |
+| WRENCH_SCREWDRIVER | "wrench-screwdriver" |
+| CUBE | "cube" |
+| ROCKET_LAUNCH | "rocket-launch" |
+
+
+
diff --git a/docs/EdgeConnectorActionDataAttributesParametersInner.md b/docs/EdgeConnectorActionDataAttributesParametersInner.md
new file mode 100644
index 00000000..0aaff13f
--- /dev/null
+++ b/docs/EdgeConnectorActionDataAttributesParametersInner.md
@@ -0,0 +1,28 @@
+
+
+# EdgeConnectorActionDataAttributesParametersInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | | [optional] |
+|**type** | [**TypeEnum**](#TypeEnum) | | [optional] |
+|**required** | **Boolean** | | [optional] |
+|**description** | **String** | | [optional] |
+|**_default** | **String** | Default value (any type) | [optional] |
+|**options** | **List<String>** | | [optional] |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| STRING | "string" |
+| NUMBER | "number" |
+| BOOLEAN | "boolean" |
+
+
+
diff --git a/docs/EdgeConnectorActionsApi.md b/docs/EdgeConnectorActionsApi.md
new file mode 100644
index 00000000..34687dba
--- /dev/null
+++ b/docs/EdgeConnectorActionsApi.md
@@ -0,0 +1,346 @@
+# EdgeConnectorActionsApi
+
+All URIs are relative to *https://api.rootly.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createEdgeConnectorAction**](EdgeConnectorActionsApi.md#createEdgeConnectorAction) | **POST** /v1/edge_connectors/{edge_connector_id}/actions | Create edge connector action |
+| [**deleteEdgeConnectorAction**](EdgeConnectorActionsApi.md#deleteEdgeConnectorAction) | **DELETE** /v1/edge_connectors/{edge_connector_id}/actions/{id} | Delete edge connector action |
+| [**getEdgeConnectorAction**](EdgeConnectorActionsApi.md#getEdgeConnectorAction) | **GET** /v1/edge_connectors/{edge_connector_id}/actions/{id} | Show edge connector action |
+| [**listEdgeConnectorActions**](EdgeConnectorActionsApi.md#listEdgeConnectorActions) | **GET** /v1/edge_connectors/{edge_connector_id}/actions | List edge connector actions |
+| [**updateEdgeConnectorAction**](EdgeConnectorActionsApi.md#updateEdgeConnectorAction) | **PATCH** /v1/edge_connectors/{edge_connector_id}/actions/{id} | Update edge connector action |
+
+
+
+# **createEdgeConnectorAction**
+> createEdgeConnectorAction(edgeConnectorId, createEdgeConnectorActionRequest)
+
+Create edge connector action
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.EdgeConnectorActionsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ EdgeConnectorActionsApi apiInstance = new EdgeConnectorActionsApi(defaultClient);
+ String edgeConnectorId = "edgeConnectorId_example"; // String | Edge connector ID
+ CreateEdgeConnectorActionRequest createEdgeConnectorActionRequest = new CreateEdgeConnectorActionRequest(); // CreateEdgeConnectorActionRequest |
+ try {
+ apiInstance.createEdgeConnectorAction(edgeConnectorId, createEdgeConnectorActionRequest);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling EdgeConnectorActionsApi#createEdgeConnectorAction");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **edgeConnectorId** | **String**| Edge connector ID | |
+| **createEdgeConnectorActionRequest** | [**CreateEdgeConnectorActionRequest**](CreateEdgeConnectorActionRequest.md)| | [optional] |
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/vnd.api+json
+ - **Accept**: Not defined
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Action created | - |
+| **422** | Invalid parameters | - |
+
+
+# **deleteEdgeConnectorAction**
+> deleteEdgeConnectorAction(edgeConnectorId, id)
+
+Delete edge connector action
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.EdgeConnectorActionsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ EdgeConnectorActionsApi apiInstance = new EdgeConnectorActionsApi(defaultClient);
+ String edgeConnectorId = "edgeConnectorId_example"; // String | Edge connector ID
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
+ try {
+ apiInstance.deleteEdgeConnectorAction(edgeConnectorId, id);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling EdgeConnectorActionsApi#deleteEdgeConnectorAction");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **edgeConnectorId** | **String**| Edge connector ID | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Action deleted | - |
+
+
+# **getEdgeConnectorAction**
+> getEdgeConnectorAction(edgeConnectorId, id)
+
+Show edge connector action
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.EdgeConnectorActionsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ EdgeConnectorActionsApi apiInstance = new EdgeConnectorActionsApi(defaultClient);
+ String edgeConnectorId = "edgeConnectorId_example"; // String | Edge connector ID
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
+ try {
+ apiInstance.getEdgeConnectorAction(edgeConnectorId, id);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling EdgeConnectorActionsApi#getEdgeConnectorAction");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **edgeConnectorId** | **String**| Edge connector ID | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Returns action details | - |
+| **404** | Action not found | - |
+
+
+# **listEdgeConnectorActions**
+> listEdgeConnectorActions(edgeConnectorId)
+
+List edge connector actions
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.EdgeConnectorActionsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ EdgeConnectorActionsApi apiInstance = new EdgeConnectorActionsApi(defaultClient);
+ String edgeConnectorId = "edgeConnectorId_example"; // String | Edge connector ID
+ try {
+ apiInstance.listEdgeConnectorActions(edgeConnectorId);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling EdgeConnectorActionsApi#listEdgeConnectorActions");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **edgeConnectorId** | **String**| Edge connector ID | |
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Returns list of actions | - |
+| **404** | Edge connector not found | - |
+
+
+# **updateEdgeConnectorAction**
+> updateEdgeConnectorAction(edgeConnectorId, id, updateEdgeConnectorActionRequest)
+
+Update edge connector action
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.EdgeConnectorActionsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ EdgeConnectorActionsApi apiInstance = new EdgeConnectorActionsApi(defaultClient);
+ String edgeConnectorId = "edgeConnectorId_example"; // String | Edge connector ID
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
+ UpdateEdgeConnectorActionRequest updateEdgeConnectorActionRequest = new UpdateEdgeConnectorActionRequest(); // UpdateEdgeConnectorActionRequest |
+ try {
+ apiInstance.updateEdgeConnectorAction(edgeConnectorId, id, updateEdgeConnectorActionRequest);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling EdgeConnectorActionsApi#updateEdgeConnectorAction");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **edgeConnectorId** | **String**| Edge connector ID | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
+| **updateEdgeConnectorActionRequest** | [**UpdateEdgeConnectorActionRequest**](UpdateEdgeConnectorActionRequest.md)| | [optional] |
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/vnd.api+json
+ - **Accept**: Not defined
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Action updated | - |
+
diff --git a/docs/EdgeConnectorData.md b/docs/EdgeConnectorData.md
new file mode 100644
index 00000000..682d39f3
--- /dev/null
+++ b/docs/EdgeConnectorData.md
@@ -0,0 +1,23 @@
+
+
+# EdgeConnectorData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**id** | **UUID** | | |
+|**attributes** | [**EdgeConnectorDataAttributes**](EdgeConnectorDataAttributes.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| EDGE_CONNECTORS | "edge_connectors" |
+
+
+
diff --git a/docs/EdgeConnectorDataAttributes.md b/docs/EdgeConnectorDataAttributes.md
new file mode 100644
index 00000000..79c83996
--- /dev/null
+++ b/docs/EdgeConnectorDataAttributes.md
@@ -0,0 +1,34 @@
+
+
+# EdgeConnectorDataAttributes
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | Connector name | |
+|**description** | **String** | Connector description | [optional] |
+|**status** | [**StatusEnum**](#StatusEnum) | Connector status | |
+|**subscriptions** | **List<String>** | Array of event types to subscribe to | [optional] |
+|**lastPollAt** | **OffsetDateTime** | Last time connector polled | [optional] |
+|**online** | **Boolean** | Whether connector is currently online | [optional] |
+|**deliveriesCount** | **Integer** | Total number of deliveries | [optional] |
+|**deliveriesQueuedCount** | **Integer** | Number of queued deliveries | [optional] |
+|**deliveriesRunningCount** | **Integer** | Number of running deliveries | [optional] |
+|**deliveriesCompletedCount** | **Integer** | Number of completed deliveries | [optional] |
+|**deliveriesFailedCount** | **Integer** | Number of failed deliveries | [optional] |
+|**createdAt** | **OffsetDateTime** | | [optional] |
+|**updatedAt** | **OffsetDateTime** | | [optional] |
+
+
+
+## Enum: StatusEnum
+
+| Name | Value |
+|---- | -----|
+| ACTIVE | "active" |
+| PAUSED | "paused" |
+
+
+
diff --git a/docs/EdgeConnectorsApi.md b/docs/EdgeConnectorsApi.md
new file mode 100644
index 00000000..d2096fed
--- /dev/null
+++ b/docs/EdgeConnectorsApi.md
@@ -0,0 +1,344 @@
+# EdgeConnectorsApi
+
+All URIs are relative to *https://api.rootly.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createEdgeConnector**](EdgeConnectorsApi.md#createEdgeConnector) | **POST** /v1/edge_connectors | Create edge connector |
+| [**deleteEdgeConnector**](EdgeConnectorsApi.md#deleteEdgeConnector) | **DELETE** /v1/edge_connectors/{id} | Delete edge connector |
+| [**getEdgeConnector**](EdgeConnectorsApi.md#getEdgeConnector) | **GET** /v1/edge_connectors/{id} | Show edge connector |
+| [**listEdgeConnectors**](EdgeConnectorsApi.md#listEdgeConnectors) | **GET** /v1/edge_connectors | List edge connectors |
+| [**updateEdgeConnector**](EdgeConnectorsApi.md#updateEdgeConnector) | **PATCH** /v1/edge_connectors/{id} | Update edge connector |
+
+
+
+# **createEdgeConnector**
+> createEdgeConnector(createEdgeConnectorRequest)
+
+Create edge connector
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.EdgeConnectorsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ EdgeConnectorsApi apiInstance = new EdgeConnectorsApi(defaultClient);
+ CreateEdgeConnectorRequest createEdgeConnectorRequest = new CreateEdgeConnectorRequest(); // CreateEdgeConnectorRequest |
+ try {
+ apiInstance.createEdgeConnector(createEdgeConnectorRequest);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling EdgeConnectorsApi#createEdgeConnector");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createEdgeConnectorRequest** | [**CreateEdgeConnectorRequest**](CreateEdgeConnectorRequest.md)| | [optional] |
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/vnd.api+json
+ - **Accept**: Not defined
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Edge connector created | - |
+| **422** | Invalid parameters | - |
+
+
+# **deleteEdgeConnector**
+> deleteEdgeConnector(id)
+
+Delete edge connector
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.EdgeConnectorsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ EdgeConnectorsApi apiInstance = new EdgeConnectorsApi(defaultClient);
+ String id = "id_example"; // String | Edge connector ID
+ try {
+ apiInstance.deleteEdgeConnector(id);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling EdgeConnectorsApi#deleteEdgeConnector");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| Edge connector ID | |
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Edge connector deleted | - |
+
+
+# **getEdgeConnector**
+> getEdgeConnector(id)
+
+Show edge connector
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.EdgeConnectorsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ EdgeConnectorsApi apiInstance = new EdgeConnectorsApi(defaultClient);
+ String id = "id_example"; // String | Edge connector ID
+ try {
+ apiInstance.getEdgeConnector(id);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling EdgeConnectorsApi#getEdgeConnector");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| Edge connector ID | |
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Returns edge connector details | - |
+| **404** | Edge connector not found | - |
+
+
+# **listEdgeConnectors**
+> listEdgeConnectors(page, perPage, status, name)
+
+List edge connectors
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.EdgeConnectorsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ EdgeConnectorsApi apiInstance = new EdgeConnectorsApi(defaultClient);
+ Integer page = 56; // Integer |
+ Integer perPage = 56; // Integer |
+ String status = "status_example"; // String | Filter by status (active/paused)
+ String name = "name_example"; // String | Filter by name (partial match)
+ try {
+ apiInstance.listEdgeConnectors(page, perPage, status, name);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling EdgeConnectorsApi#listEdgeConnectors");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **page** | **Integer**| | [optional] |
+| **perPage** | **Integer**| | [optional] |
+| **status** | **String**| Filter by status (active/paused) | [optional] |
+| **name** | **String**| Filter by name (partial match) | [optional] |
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Filters by status | - |
+
+
+# **updateEdgeConnector**
+> updateEdgeConnector(id, updateEdgeConnectorRequest)
+
+Update edge connector
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.EdgeConnectorsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ EdgeConnectorsApi apiInstance = new EdgeConnectorsApi(defaultClient);
+ String id = "id_example"; // String | Edge connector ID
+ UpdateEdgeConnectorRequest updateEdgeConnectorRequest = new UpdateEdgeConnectorRequest(); // UpdateEdgeConnectorRequest |
+ try {
+ apiInstance.updateEdgeConnector(id, updateEdgeConnectorRequest);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling EdgeConnectorsApi#updateEdgeConnector");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| Edge connector ID | |
+| **updateEdgeConnectorRequest** | [**UpdateEdgeConnectorRequest**](UpdateEdgeConnectorRequest.md)| | [optional] |
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/vnd.api+json
+ - **Accept**: Not defined
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Edge connector updated | - |
+| **422** | Invalid parameters | - |
+
diff --git a/docs/Environment.md b/docs/Environment.md
index 92e523c4..5ceb90bd 100644
--- a/docs/Environment.md
+++ b/docs/Environment.md
@@ -15,6 +15,7 @@
|**position** | **Integer** | Position of the environment | [optional] |
|**slackChannels** | [**List<NewEnvironmentDataAttributesSlackChannelsInner>**](NewEnvironmentDataAttributesSlackChannelsInner.md) | Slack Channels associated with this environment | [optional] |
|**slackAliases** | [**List<NewEnvironmentDataAttributesSlackAliasesInner>**](NewEnvironmentDataAttributesSlackAliasesInner.md) | Slack Aliases associated with this environment | [optional] |
+|**properties** | [**List<NewCauseDataAttributesPropertiesInner>**](NewCauseDataAttributesPropertiesInner.md) | Array of property values for this environment. | [optional] |
|**createdAt** | **String** | Date of creation | |
|**updatedAt** | **String** | Date of last update | |
diff --git a/docs/EnvironmentList.md b/docs/EnvironmentList.md
index d18b7677..32b43e94 100644
--- a/docs/EnvironmentList.md
+++ b/docs/EnvironmentList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<EnvironmentResponseData>**](EnvironmentResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/EnvironmentsApi.md b/docs/EnvironmentsApi.md
index 00de2dce..114614c1 100644
--- a/docs/EnvironmentsApi.md
+++ b/docs/EnvironmentsApi.md
@@ -5,8 +5,10 @@ All URIs are relative to *https://api.rootly.com*
| Method | HTTP request | Description |
|------------- | ------------- | -------------|
| [**createEnvironment**](EnvironmentsApi.md#createEnvironment) | **POST** /v1/environments | Creates an environment |
+| [**createEnvironmentCatalogProperty**](EnvironmentsApi.md#createEnvironmentCatalogProperty) | **POST** /v1/environments/properties | Creates a Catalog Property |
| [**deleteEnvironment**](EnvironmentsApi.md#deleteEnvironment) | **DELETE** /v1/environments/{id} | Delete an environment |
| [**getEnvironment**](EnvironmentsApi.md#getEnvironment) | **GET** /v1/environments/{id} | Retrieves an environment |
+| [**listEnvironmentCatalogProperties**](EnvironmentsApi.md#listEnvironmentCatalogProperties) | **GET** /v1/environments/properties | List Catalog Properties |
| [**listEnvironments**](EnvironmentsApi.md#listEnvironments) | **GET** /v1/environments | List environments |
| [**updateEnvironment**](EnvironmentsApi.md#updateEnvironment) | **PUT** /v1/environments/{id} | Update an environment |
@@ -80,6 +82,75 @@ public class Example {
| **422** | invalid request | - |
| **401** | responds with unauthorized for invalid token | - |
+
+# **createEnvironmentCatalogProperty**
+> CatalogPropertyResponse createEnvironmentCatalogProperty(newCatalogProperty)
+
+Creates a Catalog Property
+
+Creates a new Catalog Property from provided data
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.EnvironmentsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ EnvironmentsApi apiInstance = new EnvironmentsApi(defaultClient);
+ NewCatalogProperty newCatalogProperty = new NewCatalogProperty(); // NewCatalogProperty |
+ try {
+ CatalogPropertyResponse result = apiInstance.createEnvironmentCatalogProperty(newCatalogProperty);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling EnvironmentsApi#createEnvironmentCatalogProperty");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **newCatalogProperty** | [**NewCatalogProperty**](NewCatalogProperty.md)| | |
+
+### Return type
+
+[**CatalogPropertyResponse**](CatalogPropertyResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/vnd.api+json
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | catalog_property created ignores wrong catalog_type attribute | - |
+| **422** | exceeds max fields per catalog | - |
+| **401** | responds with unauthorized for invalid token | - |
+
# **deleteEnvironment**
> EnvironmentResponse deleteEnvironment(id)
@@ -108,7 +179,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
EnvironmentsApi apiInstance = new EnvironmentsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
EnvironmentResponse result = apiInstance.deleteEnvironment(id);
System.out.println(result);
@@ -127,7 +198,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -176,7 +247,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
EnvironmentsApi apiInstance = new EnvironmentsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
EnvironmentResponse result = apiInstance.getEnvironment(id);
System.out.println(result);
@@ -195,7 +266,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -213,9 +284,96 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **200** | environment found | - |
+| **200** | environment found by slug | - |
| **404** | resource not found | - |
+
+# **listEnvironmentCatalogProperties**
+> CatalogPropertyList listEnvironmentCatalogProperties(include, sort, pageNumber, pageSize, filterSlug, filterName, filterKind, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte)
+
+List Catalog Properties
+
+List Environment Catalog Properties
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.EnvironmentsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ EnvironmentsApi apiInstance = new EnvironmentsApi(defaultClient);
+ String include = "catalog"; // String | comma separated if needed. eg: catalog
+ String sort = "created_at"; // String | comma separated if needed. eg: created_at,updated_at
+ Integer pageNumber = 56; // Integer |
+ Integer pageSize = 56; // Integer |
+ String filterSlug = "filterSlug_example"; // String |
+ String filterName = "filterName_example"; // String |
+ String filterKind = "filterKind_example"; // String |
+ String filterCreatedAtGt = "filterCreatedAtGt_example"; // String |
+ String filterCreatedAtGte = "filterCreatedAtGte_example"; // String |
+ String filterCreatedAtLt = "filterCreatedAtLt_example"; // String |
+ String filterCreatedAtLte = "filterCreatedAtLte_example"; // String |
+ try {
+ CatalogPropertyList result = apiInstance.listEnvironmentCatalogProperties(include, sort, pageNumber, pageSize, filterSlug, filterName, filterKind, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling EnvironmentsApi#listEnvironmentCatalogProperties");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **include** | **String**| comma separated if needed. eg: catalog | [optional] [enum: catalog] |
+| **sort** | **String**| comma separated if needed. eg: created_at,updated_at | [optional] [enum: created_at, -created_at, updated_at, -updated_at, position, -position] |
+| **pageNumber** | **Integer**| | [optional] |
+| **pageSize** | **Integer**| | [optional] |
+| **filterSlug** | **String**| | [optional] |
+| **filterName** | **String**| | [optional] |
+| **filterKind** | **String**| | [optional] |
+| **filterCreatedAtGt** | **String**| | [optional] |
+| **filterCreatedAtGte** | **String**| | [optional] |
+| **filterCreatedAtLt** | **String**| | [optional] |
+| **filterCreatedAtLte** | **String**| | [optional] |
+
+### Return type
+
+[**CatalogPropertyList**](CatalogPropertyList.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | success | - |
+
# **listEnvironments**
> EnvironmentList listEnvironments(include, pageNumber, pageSize, filterSearch, filterSlug, filterName, filterColor, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, sort)
@@ -333,7 +491,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
EnvironmentsApi apiInstance = new EnvironmentsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
UpdateEnvironment updateEnvironment = new UpdateEnvironment(); // UpdateEnvironment |
try {
EnvironmentResponse result = apiInstance.updateEnvironment(id, updateEnvironment);
@@ -353,7 +511,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
| **updateEnvironment** | [**UpdateEnvironment**](UpdateEnvironment.md)| | |
### Return type
diff --git a/docs/EscalateAlert.md b/docs/EscalateAlert.md
new file mode 100644
index 00000000..a852156c
--- /dev/null
+++ b/docs/EscalateAlert.md
@@ -0,0 +1,13 @@
+
+
+# EscalateAlert
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**EscalateAlertData**](EscalateAlertData.md) | | [optional] |
+
+
+
diff --git a/docs/EscalateAlertData.md b/docs/EscalateAlertData.md
new file mode 100644
index 00000000..b823a796
--- /dev/null
+++ b/docs/EscalateAlertData.md
@@ -0,0 +1,22 @@
+
+
+# EscalateAlertData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | [**TypeEnum**](#TypeEnum) | | [optional] |
+|**attributes** | [**EscalateAlertDataAttributes**](EscalateAlertDataAttributes.md) | | [optional] |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| ALERTS | "alerts" |
+
+
+
diff --git a/docs/EscalateAlertDataAttributes.md b/docs/EscalateAlertDataAttributes.md
new file mode 100644
index 00000000..09cd42bf
--- /dev/null
+++ b/docs/EscalateAlertDataAttributes.md
@@ -0,0 +1,14 @@
+
+
+# EscalateAlertDataAttributes
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**escalationPolicyId** | **String** | The ID of the escalation policy to escalate to. If omitted, uses the alert's current escalation policy from metadata. Required for resolved alerts whose metadata may have been cleared. | [optional] |
+|**escalationPolicyLevel** | **Integer** | The escalation policy level to escalate to. If omitted, defaults to the next level (same EP) or level 1 (different EP). | [optional] |
+
+
+
diff --git a/docs/EscalationPoliciesApi.md b/docs/EscalationPoliciesApi.md
index d56f0f56..e7ab0fb9 100644
--- a/docs/EscalationPoliciesApi.md
+++ b/docs/EscalationPoliciesApi.md
@@ -220,7 +220,7 @@ public class Example {
# **listEscalationPolicies**
-> EscalationPolicyList listEscalationPolicies(include, filterSearch, filterName, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, pageNumber, pageSize)
+> EscalationPolicyList listEscalationPolicies(include, filterSearch, filterName, filterTeamIds, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, pageNumber, pageSize)
List escalation policies
@@ -249,6 +249,7 @@ public class Example {
String include = "escalation_policy_levels"; // String | comma separated if needed. eg: escalation_policy_levels,escalation_policy_paths
String filterSearch = "filterSearch_example"; // String |
String filterName = "filterName_example"; // String |
+ String filterTeamIds = "filterTeamIds_example"; // String | Filter escalation policies by associated team IDs. Comma-separate multiple values.
String filterCreatedAtGt = "filterCreatedAtGt_example"; // String |
String filterCreatedAtGte = "filterCreatedAtGte_example"; // String |
String filterCreatedAtLt = "filterCreatedAtLt_example"; // String |
@@ -256,7 +257,7 @@ public class Example {
Integer pageNumber = 56; // Integer |
Integer pageSize = 56; // Integer |
try {
- EscalationPolicyList result = apiInstance.listEscalationPolicies(include, filterSearch, filterName, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, pageNumber, pageSize);
+ EscalationPolicyList result = apiInstance.listEscalationPolicies(include, filterSearch, filterName, filterTeamIds, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, pageNumber, pageSize);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling EscalationPoliciesApi#listEscalationPolicies");
@@ -276,6 +277,7 @@ public class Example {
| **include** | **String**| comma separated if needed. eg: escalation_policy_levels,escalation_policy_paths | [optional] [enum: escalation_policy_levels, escalation_policy_paths, groups, services] |
| **filterSearch** | **String**| | [optional] |
| **filterName** | **String**| | [optional] |
+| **filterTeamIds** | **String**| Filter escalation policies by associated team IDs. Comma-separate multiple values. | [optional] |
| **filterCreatedAtGt** | **String**| | [optional] |
| **filterCreatedAtGte** | **String**| | [optional] |
| **filterCreatedAtLt** | **String**| | [optional] |
diff --git a/docs/EscalationPolicyLevel.md b/docs/EscalationPolicyLevel.md
index 5a0ec066..ad3df1c4 100644
--- a/docs/EscalationPolicyLevel.md
+++ b/docs/EscalationPolicyLevel.md
@@ -11,7 +11,7 @@
|**escalationPolicyPathId** | **String** | The ID of the dynamic escalation policy path the level will belong to. If nothing is specified it will add the level to your default path. | [optional] |
|**pagingStrategyConfigurationStrategy** | [**PagingStrategyConfigurationStrategyEnum**](#PagingStrategyConfigurationStrategyEnum) | | [optional] |
|**pagingStrategyConfigurationScheduleStrategy** | [**PagingStrategyConfigurationScheduleStrategyEnum**](#PagingStrategyConfigurationScheduleStrategyEnum) | | [optional] |
-|**delay** | **Integer** | Delay before notification targets will be alerted. | |
+|**delay** | **Integer** | Delay before notifying targets in the next Escalation Level. | |
|**position** | **Integer** | Position of the escalation policy level | |
|**createdAt** | **String** | Date of creation | [optional] |
|**updatedAt** | **String** | Date of last update | [optional] |
diff --git a/docs/EscalationPolicyLevelList.md b/docs/EscalationPolicyLevelList.md
index af62dbd1..8bda6a99 100644
--- a/docs/EscalationPolicyLevelList.md
+++ b/docs/EscalationPolicyLevelList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<EscalationPolicyLevelListDataInner>**](EscalationPolicyLevelListDataInner.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/EscalationPolicyList.md b/docs/EscalationPolicyList.md
index 90a1471c..e7f91240 100644
--- a/docs/EscalationPolicyList.md
+++ b/docs/EscalationPolicyList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<EscalationPolicyResponseData>**](EscalationPolicyResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/EscalationPolicyPath.md b/docs/EscalationPolicyPath.md
index aa91376a..4e0b1d1e 100644
--- a/docs/EscalationPolicyPath.md
+++ b/docs/EscalationPolicyPath.md
@@ -10,7 +10,10 @@
|**name** | **String** | The name of the escalation path | |
|**_default** | **Boolean** | Whether this escalation path is the default path | |
|**notificationType** | **String** | Notification rule type | |
+|**pathType** | [**PathTypeEnum**](#PathTypeEnum) | The type of escalation path | [optional] |
|**escalationPolicyId** | **String** | The ID of the escalation policy | |
+|**afterDeferralBehavior** | [**AfterDeferralBehaviorEnum**](#AfterDeferralBehaviorEnum) | What happens after a deferral path finishes | [optional] |
+|**afterDeferralPathId** | **String** | The escalation path to execute after this deferral path when after_deferral_behavior is execute_path | [optional] |
|**matchMode** | [**MatchModeEnum**](#MatchModeEnum) | How path rules are matched. | [optional] |
|**position** | **Integer** | The position of this path in the paths for this EP. | [optional] |
|**repeat** | **Boolean** | Whether this path should be repeated until someone acknowledges the alert | |
@@ -18,7 +21,27 @@
|**initialDelay** | **Integer** | Initial delay for escalation path in minutes. Maximum 1 week (10080). | [optional] |
|**createdAt** | **String** | Date of creation | [optional] |
|**updatedAt** | **String** | Date of last update | [optional] |
-|**rules** | [**List<EscalationPolicyPathRulesInner>**](EscalationPolicyPathRulesInner.md) | Escalation path rules | [optional] |
+|**rules** | [**List<UpdateEscalationPolicyPathDataAttributesRulesInner>**](UpdateEscalationPolicyPathDataAttributesRulesInner.md) | Escalation path rules | [optional] |
+|**timeRestrictionTimeZone** | [**TimeRestrictionTimeZoneEnum**](#TimeRestrictionTimeZoneEnum) | Time zone used for time restrictions. | [optional] |
+|**timeRestrictions** | [**List<UpdateEscalationPolicyPathDataAttributesTimeRestrictionsInner>**](UpdateEscalationPolicyPathDataAttributesTimeRestrictionsInner.md) | If time restrictions are set, alerts will follow this path when they arrive within the specified time ranges and meet the rules. | [optional] |
+
+
+
+## Enum: PathTypeEnum
+
+| Name | Value |
+|---- | -----|
+| ESCALATION | "escalation" |
+| DEFERRAL | "deferral" |
+
+
+
+## Enum: AfterDeferralBehaviorEnum
+
+| Name | Value |
+|---- | -----|
+| RE_EVALUATE | "re_evaluate" |
+| EXECUTE_PATH | "execute_path" |
@@ -31,3 +54,314 @@
+## Enum: TimeRestrictionTimeZoneEnum
+
+| Name | Value |
+|---- | -----|
+| INTERNATIONAL_DATE_LINE_WEST | "International Date Line West" |
+| ETC_GMT_12 | "Etc/GMT+12" |
+| AMERICAN_SAMOA | "American Samoa" |
+| PACIFIC_PAGO_PAGO | "Pacific/Pago_Pago" |
+| MIDWAY_ISLAND | "Midway Island" |
+| PACIFIC_MIDWAY | "Pacific/Midway" |
+| HAWAII | "Hawaii" |
+| PACIFIC_HONOLULU | "Pacific/Honolulu" |
+| ALASKA | "Alaska" |
+| AMERICA_JUNEAU | "America/Juneau" |
+| PACIFIC_TIME_US_CANADA_ | "Pacific Time (US & Canada)" |
+| AMERICA_LOS_ANGELES | "America/Los_Angeles" |
+| TIJUANA | "Tijuana" |
+| AMERICA_TIJUANA | "America/Tijuana" |
+| ARIZONA | "Arizona" |
+| AMERICA_PHOENIX | "America/Phoenix" |
+| MAZATLAN | "Mazatlan" |
+| AMERICA_MAZATLAN | "America/Mazatlan" |
+| MOUNTAIN_TIME_US_CANADA_ | "Mountain Time (US & Canada)" |
+| AMERICA_DENVER | "America/Denver" |
+| CENTRAL_AMERICA | "Central America" |
+| AMERICA_GUATEMALA | "America/Guatemala" |
+| CENTRAL_TIME_US_CANADA_ | "Central Time (US & Canada)" |
+| AMERICA_CHICAGO | "America/Chicago" |
+| CHIHUAHUA | "Chihuahua" |
+| AMERICA_CHIHUAHUA | "America/Chihuahua" |
+| GUADALAJARA | "Guadalajara" |
+| AMERICA_MEXICO_CITY | "America/Mexico_City" |
+| MEXICO_CITY | "Mexico City" |
+| AMERICA_MEXICO_CITY2 | "America/Mexico_City" |
+| MONTERREY | "Monterrey" |
+| AMERICA_MONTERREY | "America/Monterrey" |
+| SASKATCHEWAN | "Saskatchewan" |
+| AMERICA_REGINA | "America/Regina" |
+| BOGOTA | "Bogota" |
+| AMERICA_BOGOTA | "America/Bogota" |
+| EASTERN_TIME_US_CANADA_ | "Eastern Time (US & Canada)" |
+| AMERICA_NEW_YORK | "America/New_York" |
+| INDIANA_EAST_ | "Indiana (East)" |
+| AMERICA_INDIANA_INDIANAPOLIS | "America/Indiana/Indianapolis" |
+| LIMA | "Lima" |
+| AMERICA_LIMA | "America/Lima" |
+| QUITO | "Quito" |
+| AMERICA_LIMA2 | "America/Lima" |
+| ATLANTIC_TIME_CANADA_ | "Atlantic Time (Canada)" |
+| AMERICA_HALIFAX | "America/Halifax" |
+| CARACAS | "Caracas" |
+| AMERICA_CARACAS | "America/Caracas" |
+| GEORGETOWN | "Georgetown" |
+| AMERICA_GUYANA | "America/Guyana" |
+| LA_PAZ | "La Paz" |
+| AMERICA_LA_PAZ | "America/La_Paz" |
+| PUERTO_RICO | "Puerto Rico" |
+| AMERICA_PUERTO_RICO | "America/Puerto_Rico" |
+| SANTIAGO | "Santiago" |
+| AMERICA_SANTIAGO | "America/Santiago" |
+| NEWFOUNDLAND | "Newfoundland" |
+| AMERICA_ST_JOHNS | "America/St_Johns" |
+| ASUNCION | "Asuncion" |
+| AMERICA_ASUNCION | "America/Asuncion" |
+| BRASILIA | "Brasilia" |
+| AMERICA_SAO_PAULO | "America/Sao_Paulo" |
+| BUENOS_AIRES | "Buenos Aires" |
+| AMERICA_ARGENTINA_BUENOS_AIRES | "America/Argentina/Buenos_Aires" |
+| MONTEVIDEO | "Montevideo" |
+| AMERICA_MONTEVIDEO | "America/Montevideo" |
+| GREENLAND | "Greenland" |
+| AMERICA_NUUK | "America/Nuuk" |
+| MID_ATLANTIC | "Mid-Atlantic" |
+| ATLANTIC_SOUTH_GEORGIA | "Atlantic/South_Georgia" |
+| AZORES | "Azores" |
+| ATLANTIC_AZORES | "Atlantic/Azores" |
+| CAPE_VERDE_IS_ | "Cape Verde Is." |
+| ATLANTIC_CAPE_VERDE | "Atlantic/Cape_Verde" |
+| EDINBURGH | "Edinburgh" |
+| EUROPE_LONDON | "Europe/London" |
+| LISBON | "Lisbon" |
+| EUROPE_LISBON | "Europe/Lisbon" |
+| LONDON | "London" |
+| EUROPE_LONDON2 | "Europe/London" |
+| MONROVIA | "Monrovia" |
+| AFRICA_MONROVIA | "Africa/Monrovia" |
+| UTC | "UTC" |
+| ETC_UTC | "Etc/UTC" |
+| AMSTERDAM | "Amsterdam" |
+| EUROPE_AMSTERDAM | "Europe/Amsterdam" |
+| BELGRADE | "Belgrade" |
+| EUROPE_BELGRADE | "Europe/Belgrade" |
+| BERLIN | "Berlin" |
+| EUROPE_BERLIN | "Europe/Berlin" |
+| BERN | "Bern" |
+| EUROPE_ZURICH | "Europe/Zurich" |
+| BRATISLAVA | "Bratislava" |
+| EUROPE_BRATISLAVA | "Europe/Bratislava" |
+| BRUSSELS | "Brussels" |
+| EUROPE_BRUSSELS | "Europe/Brussels" |
+| BUDAPEST | "Budapest" |
+| EUROPE_BUDAPEST | "Europe/Budapest" |
+| CASABLANCA | "Casablanca" |
+| AFRICA_CASABLANCA | "Africa/Casablanca" |
+| COPENHAGEN | "Copenhagen" |
+| EUROPE_COPENHAGEN | "Europe/Copenhagen" |
+| DUBLIN | "Dublin" |
+| EUROPE_DUBLIN | "Europe/Dublin" |
+| LJUBLJANA | "Ljubljana" |
+| EUROPE_LJUBLJANA | "Europe/Ljubljana" |
+| MADRID | "Madrid" |
+| EUROPE_MADRID | "Europe/Madrid" |
+| PARIS | "Paris" |
+| EUROPE_PARIS | "Europe/Paris" |
+| PRAGUE | "Prague" |
+| EUROPE_PRAGUE | "Europe/Prague" |
+| ROME | "Rome" |
+| EUROPE_ROME | "Europe/Rome" |
+| SARAJEVO | "Sarajevo" |
+| EUROPE_SARAJEVO | "Europe/Sarajevo" |
+| SKOPJE | "Skopje" |
+| EUROPE_SKOPJE | "Europe/Skopje" |
+| STOCKHOLM | "Stockholm" |
+| EUROPE_STOCKHOLM | "Europe/Stockholm" |
+| VIENNA | "Vienna" |
+| EUROPE_VIENNA | "Europe/Vienna" |
+| WARSAW | "Warsaw" |
+| EUROPE_WARSAW | "Europe/Warsaw" |
+| WEST_CENTRAL_AFRICA | "West Central Africa" |
+| AFRICA_ALGIERS | "Africa/Algiers" |
+| ZAGREB | "Zagreb" |
+| EUROPE_ZAGREB | "Europe/Zagreb" |
+| ZURICH | "Zurich" |
+| EUROPE_ZURICH2 | "Europe/Zurich" |
+| ATHENS | "Athens" |
+| EUROPE_ATHENS | "Europe/Athens" |
+| BUCHAREST | "Bucharest" |
+| EUROPE_BUCHAREST | "Europe/Bucharest" |
+| CAIRO | "Cairo" |
+| AFRICA_CAIRO | "Africa/Cairo" |
+| HARARE | "Harare" |
+| AFRICA_HARARE | "Africa/Harare" |
+| HELSINKI | "Helsinki" |
+| EUROPE_HELSINKI | "Europe/Helsinki" |
+| JERUSALEM | "Jerusalem" |
+| ASIA_JERUSALEM | "Asia/Jerusalem" |
+| KALININGRAD | "Kaliningrad" |
+| EUROPE_KALININGRAD | "Europe/Kaliningrad" |
+| KYIV | "Kyiv" |
+| EUROPE_KIEV | "Europe/Kiev" |
+| PRETORIA | "Pretoria" |
+| AFRICA_JOHANNESBURG | "Africa/Johannesburg" |
+| RIGA | "Riga" |
+| EUROPE_RIGA | "Europe/Riga" |
+| SOFIA | "Sofia" |
+| EUROPE_SOFIA | "Europe/Sofia" |
+| TALLINN | "Tallinn" |
+| EUROPE_TALLINN | "Europe/Tallinn" |
+| VILNIUS | "Vilnius" |
+| EUROPE_VILNIUS | "Europe/Vilnius" |
+| BAGHDAD | "Baghdad" |
+| ASIA_BAGHDAD | "Asia/Baghdad" |
+| ISTANBUL | "Istanbul" |
+| EUROPE_ISTANBUL | "Europe/Istanbul" |
+| KUWAIT | "Kuwait" |
+| ASIA_KUWAIT | "Asia/Kuwait" |
+| MINSK | "Minsk" |
+| EUROPE_MINSK | "Europe/Minsk" |
+| MOSCOW | "Moscow" |
+| EUROPE_MOSCOW | "Europe/Moscow" |
+| NAIROBI | "Nairobi" |
+| AFRICA_NAIROBI | "Africa/Nairobi" |
+| RIYADH | "Riyadh" |
+| ASIA_RIYADH | "Asia/Riyadh" |
+| ST_PETERSBURG | "St. Petersburg" |
+| EUROPE_MOSCOW2 | "Europe/Moscow" |
+| VOLGOGRAD | "Volgograd" |
+| EUROPE_VOLGOGRAD | "Europe/Volgograd" |
+| TEHRAN | "Tehran" |
+| ASIA_TEHRAN | "Asia/Tehran" |
+| ABU_DHABI | "Abu Dhabi" |
+| ASIA_MUSCAT | "Asia/Muscat" |
+| BAKU | "Baku" |
+| ASIA_BAKU | "Asia/Baku" |
+| MUSCAT | "Muscat" |
+| ASIA_MUSCAT2 | "Asia/Muscat" |
+| SAMARA | "Samara" |
+| EUROPE_SAMARA | "Europe/Samara" |
+| TBILISI | "Tbilisi" |
+| ASIA_TBILISI | "Asia/Tbilisi" |
+| YEREVAN | "Yerevan" |
+| ASIA_YEREVAN | "Asia/Yerevan" |
+| KABUL | "Kabul" |
+| ASIA_KABUL | "Asia/Kabul" |
+| ALMATY | "Almaty" |
+| ASIA_ALMATY | "Asia/Almaty" |
+| ASTANA | "Astana" |
+| ASIA_ALMATY2 | "Asia/Almaty" |
+| EKATERINBURG | "Ekaterinburg" |
+| ASIA_YEKATERINBURG | "Asia/Yekaterinburg" |
+| ISLAMABAD | "Islamabad" |
+| ASIA_KARACHI | "Asia/Karachi" |
+| KARACHI | "Karachi" |
+| ASIA_KARACHI2 | "Asia/Karachi" |
+| TASHKENT | "Tashkent" |
+| ASIA_TASHKENT | "Asia/Tashkent" |
+| CHENNAI | "Chennai" |
+| ASIA_KOLKATA | "Asia/Kolkata" |
+| KOLKATA | "Kolkata" |
+| ASIA_KOLKATA2 | "Asia/Kolkata" |
+| MUMBAI | "Mumbai" |
+| ASIA_KOLKATA3 | "Asia/Kolkata" |
+| NEW_DELHI | "New Delhi" |
+| ASIA_KOLKATA4 | "Asia/Kolkata" |
+| SRI_JAYAWARDENEPURA | "Sri Jayawardenepura" |
+| ASIA_COLOMBO | "Asia/Colombo" |
+| KATHMANDU | "Kathmandu" |
+| ASIA_KATHMANDU | "Asia/Kathmandu" |
+| DHAKA | "Dhaka" |
+| ASIA_DHAKA | "Asia/Dhaka" |
+| URUMQI | "Urumqi" |
+| ASIA_URUMQI | "Asia/Urumqi" |
+| RANGOON | "Rangoon" |
+| ASIA_RANGOON | "Asia/Rangoon" |
+| BANGKOK | "Bangkok" |
+| ASIA_BANGKOK | "Asia/Bangkok" |
+| HANOI | "Hanoi" |
+| ASIA_BANGKOK2 | "Asia/Bangkok" |
+| JAKARTA | "Jakarta" |
+| ASIA_JAKARTA | "Asia/Jakarta" |
+| KRASNOYARSK | "Krasnoyarsk" |
+| ASIA_KRASNOYARSK | "Asia/Krasnoyarsk" |
+| NOVOSIBIRSK | "Novosibirsk" |
+| ASIA_NOVOSIBIRSK | "Asia/Novosibirsk" |
+| BEIJING | "Beijing" |
+| ASIA_SHANGHAI | "Asia/Shanghai" |
+| CHONGQING | "Chongqing" |
+| ASIA_CHONGQING | "Asia/Chongqing" |
+| HONG_KONG | "Hong Kong" |
+| ASIA_HONG_KONG | "Asia/Hong_Kong" |
+| IRKUTSK | "Irkutsk" |
+| ASIA_IRKUTSK | "Asia/Irkutsk" |
+| KUALA_LUMPUR | "Kuala Lumpur" |
+| ASIA_KUALA_LUMPUR | "Asia/Kuala_Lumpur" |
+| PERTH | "Perth" |
+| AUSTRALIA_PERTH | "Australia/Perth" |
+| SINGAPORE | "Singapore" |
+| ASIA_SINGAPORE | "Asia/Singapore" |
+| TAIPEI | "Taipei" |
+| ASIA_TAIPEI | "Asia/Taipei" |
+| ULAANBAATAR | "Ulaanbaatar" |
+| ASIA_ULAANBAATAR | "Asia/Ulaanbaatar" |
+| OSAKA | "Osaka" |
+| ASIA_TOKYO | "Asia/Tokyo" |
+| SAPPORO | "Sapporo" |
+| ASIA_TOKYO2 | "Asia/Tokyo" |
+| SEOUL | "Seoul" |
+| ASIA_SEOUL | "Asia/Seoul" |
+| TOKYO | "Tokyo" |
+| ASIA_TOKYO3 | "Asia/Tokyo" |
+| YAKUTSK | "Yakutsk" |
+| ASIA_YAKUTSK | "Asia/Yakutsk" |
+| ADELAIDE | "Adelaide" |
+| AUSTRALIA_ADELAIDE | "Australia/Adelaide" |
+| DARWIN | "Darwin" |
+| AUSTRALIA_DARWIN | "Australia/Darwin" |
+| BRISBANE | "Brisbane" |
+| AUSTRALIA_BRISBANE | "Australia/Brisbane" |
+| CANBERRA | "Canberra" |
+| AUSTRALIA_CANBERRA | "Australia/Canberra" |
+| GUAM | "Guam" |
+| PACIFIC_GUAM | "Pacific/Guam" |
+| HOBART | "Hobart" |
+| AUSTRALIA_HOBART | "Australia/Hobart" |
+| MELBOURNE | "Melbourne" |
+| AUSTRALIA_MELBOURNE | "Australia/Melbourne" |
+| PORT_MORESBY | "Port Moresby" |
+| PACIFIC_PORT_MORESBY | "Pacific/Port_Moresby" |
+| SYDNEY | "Sydney" |
+| AUSTRALIA_SYDNEY | "Australia/Sydney" |
+| VLADIVOSTOK | "Vladivostok" |
+| ASIA_VLADIVOSTOK | "Asia/Vladivostok" |
+| MAGADAN | "Magadan" |
+| ASIA_MAGADAN | "Asia/Magadan" |
+| NEW_CALEDONIA | "New Caledonia" |
+| PACIFIC_NOUMEA | "Pacific/Noumea" |
+| SOLOMON_IS_ | "Solomon Is." |
+| PACIFIC_GUADALCANAL | "Pacific/Guadalcanal" |
+| SREDNEKOLYMSK | "Srednekolymsk" |
+| ASIA_SREDNEKOLYMSK | "Asia/Srednekolymsk" |
+| AUCKLAND | "Auckland" |
+| PACIFIC_AUCKLAND | "Pacific/Auckland" |
+| FIJI | "Fiji" |
+| PACIFIC_FIJI | "Pacific/Fiji" |
+| KAMCHATKA | "Kamchatka" |
+| ASIA_KAMCHATKA | "Asia/Kamchatka" |
+| MARSHALL_IS_ | "Marshall Is." |
+| PACIFIC_MAJURO | "Pacific/Majuro" |
+| WELLINGTON | "Wellington" |
+| PACIFIC_AUCKLAND2 | "Pacific/Auckland" |
+| CHATHAM_IS_ | "Chatham Is." |
+| PACIFIC_CHATHAM | "Pacific/Chatham" |
+| NUKU_ALOFA | "Nuku'alofa" |
+| PACIFIC_TONGATAPU | "Pacific/Tongatapu" |
+| SAMOA | "Samoa" |
+| PACIFIC_APIA | "Pacific/Apia" |
+| TOKELAU_IS_ | "Tokelau Is." |
+| PACIFIC_FAKAOFO | "Pacific/Fakaofo" |
+
+
+
diff --git a/docs/EscalationPolicyPathList.md b/docs/EscalationPolicyPathList.md
index f7b62af8..95e7d6ac 100644
--- a/docs/EscalationPolicyPathList.md
+++ b/docs/EscalationPolicyPathList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<EscalationPolicyPathListDataInner>**](EscalationPolicyPathListDataInner.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/FormField.md b/docs/FormField.md
index 68ba3749..51395a6d 100644
--- a/docs/FormField.md
+++ b/docs/FormField.md
@@ -12,13 +12,14 @@
|**valueKind** | [**ValueKindEnum**](#ValueKindEnum) | The value kind of the form field | |
|**valueKindCatalogId** | **String** | The ID of the catalog used when value_kind is `catalog_entity` | [optional] |
|**name** | **String** | The name of the form field | |
-|**slug** | **String** | The slug of the form field | |
+|**slug** | **String** | The slug of the form field | [optional] |
|**description** | **String** | The description of the form field | [optional] |
|**shown** | **List<String>** | | |
|**required** | **List<String>** | | |
|**showOnIncidentDetails** | **Boolean** | Whether the form field is shown on the incident details panel | [optional] |
|**enabled** | **Boolean** | Whether the form field is enabled | [optional] |
|**defaultValues** | **List<String>** | | |
+|**autoSetByCatalogPropertyId** | **String** | Catalog property ID to auto-set this form field. Only reference-kind catalog properties are supported. | [optional] |
|**createdAt** | **String** | Date of creation | |
|**updatedAt** | **String** | Date of last update | |
@@ -56,6 +57,7 @@
| MITIGATED_AT | "mitigated_at" |
| RESOLVED_AT | "resolved_at" |
| CLOSED_AT | "closed_at" |
+| CUSTOM_SUB_STATUS | "custom_sub_status" |
| MANUAL_STARTING_DATETIME_FIELD | "manual_starting_datetime_field" |
@@ -87,6 +89,9 @@
| FUNCTIONALITY | "functionality" |
| USER | "user" |
| CATALOG_ENTITY | "catalog_entity" |
+| ENVIRONMENT | "environment" |
+| CAUSE | "cause" |
+| INCIDENT_TYPE | "incident_type" |
diff --git a/docs/FormFieldList.md b/docs/FormFieldList.md
index 14691bbf..48d62988 100644
--- a/docs/FormFieldList.md
+++ b/docs/FormFieldList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<FormFieldResponseData>**](FormFieldResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/FormFieldOption.md b/docs/FormFieldOption.md
index 5151ad10..85695eba 100644
--- a/docs/FormFieldOption.md
+++ b/docs/FormFieldOption.md
@@ -7,11 +7,12 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | Unique ID of the form field option | [optional] |
|**formFieldId** | **String** | The ID of the parent custom field | [optional] |
-|**value** | **String** | The value of the form_field_option | |
-|**color** | **String** | The hex color of the form_field_option | |
+|**value** | **String** | The value of the form field option | |
+|**color** | **String** | The hex color of the form field option | |
|**_default** | **Boolean** | | [optional] |
-|**position** | **Integer** | The position of the form_field_option | |
+|**position** | **Integer** | The position of the form field option | |
|**createdAt** | **String** | Date of creation | |
|**updatedAt** | **String** | Date of last update | |
diff --git a/docs/FormFieldOptionList.md b/docs/FormFieldOptionList.md
index 3e575830..fcecd8da 100644
--- a/docs/FormFieldOptionList.md
+++ b/docs/FormFieldOptionList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<FormFieldOptionResponseData>**](FormFieldOptionResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/FormFieldOptionResponseData.md b/docs/FormFieldOptionResponseData.md
index 2cba3a2b..0ec80f44 100644
--- a/docs/FormFieldOptionResponseData.md
+++ b/docs/FormFieldOptionResponseData.md
@@ -7,7 +7,7 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
-|**id** | **String** | Unique ID of the form_field_option | |
+|**id** | **String** | Unique ID of the form field option | |
|**type** | [**TypeEnum**](#TypeEnum) | | |
|**attributes** | [**FormFieldOption**](FormFieldOption.md) | | |
diff --git a/docs/FormFieldPlacement.md b/docs/FormFieldPlacement.md
index e2f8d8aa..86515c83 100644
--- a/docs/FormFieldPlacement.md
+++ b/docs/FormFieldPlacement.md
@@ -14,6 +14,7 @@
|**required** | **Boolean** | Whether the field is unconditionally required on this form. | |
|**requiredOperator** | [**RequiredOperatorEnum**](#RequiredOperatorEnum) | Logical operator when evaluating multiple form_field_placement_conditions with conditioned=required | [optional] |
|**placementOperator** | [**PlacementOperatorEnum**](#PlacementOperatorEnum) | Logical operator when evaluating multiple form_field_placement_conditions with conditioned=placement | [optional] |
+|**nonEditable** | **Boolean** | Whether the field is read-only and cannot be edited by users. | [optional] |
diff --git a/docs/FormFieldPlacementCondition.md b/docs/FormFieldPlacementCondition.md
index 9050a4d5..50e5afa6 100644
--- a/docs/FormFieldPlacementCondition.md
+++ b/docs/FormFieldPlacementCondition.md
@@ -30,6 +30,7 @@
| Name | Value |
|---- | -----|
| EQUAL | "equal" |
+| NOT_EQUAL | "not_equal" |
| IS_SET | "is_set" |
| IS_NOT_SET | "is_not_set" |
diff --git a/docs/FormFieldPlacementConditionList.md b/docs/FormFieldPlacementConditionList.md
index 81cb340a..51eebb6f 100644
--- a/docs/FormFieldPlacementConditionList.md
+++ b/docs/FormFieldPlacementConditionList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<FormFieldPlacementConditionResponseData>**](FormFieldPlacementConditionResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/FormFieldPlacementList.md b/docs/FormFieldPlacementList.md
index e0bb7eaa..dedeae76 100644
--- a/docs/FormFieldPlacementList.md
+++ b/docs/FormFieldPlacementList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<FormFieldPlacementResponseData>**](FormFieldPlacementResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/FormFieldPlacementsApi.md b/docs/FormFieldPlacementsApi.md
index 59244665..0b50e3fa 100644
--- a/docs/FormFieldPlacementsApi.md
+++ b/docs/FormFieldPlacementsApi.md
@@ -78,7 +78,7 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **201** | form_field_placement created | - |
+| **201** | form_field_placement created with non_editable true | - |
| **422** | invalid request | - |
| **401** | responds with unauthorized for invalid token | - |
@@ -360,6 +360,6 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **200** | form_field_placement updated | - |
+| **200** | form_field_placement updated with non_editable | - |
| **404** | resource not found | - |
diff --git a/docs/FormFieldPositionList.md b/docs/FormFieldPositionList.md
index bff85d1a..826ecc50 100644
--- a/docs/FormFieldPositionList.md
+++ b/docs/FormFieldPositionList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<FormFieldPositionResponseData>**](FormFieldPositionResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/FormFieldsApi.md b/docs/FormFieldsApi.md
index ed9735f4..f3ba7a6d 100644
--- a/docs/FormFieldsApi.md
+++ b/docs/FormFieldsApi.md
@@ -76,8 +76,8 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **201** | form_field created | - |
-| **422** | invalid request | - |
+| **201** | form_field created with auto_set_by_catalog_property_id | - |
+| **422** | form_field creation fails with auto_set_by_catalog_property_id for catalog fields of different type | - |
| **401** | responds with unauthorized for invalid token | - |
@@ -108,7 +108,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
FormFieldsApi apiInstance = new FormFieldsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
FormFieldResponse result = apiInstance.deleteFormField(id);
System.out.println(result);
@@ -127,7 +127,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -176,7 +176,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
FormFieldsApi apiInstance = new FormFieldsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
String include = "options"; // String | comma separated if needed. eg: options,positions
try {
FormFieldResponse result = apiInstance.getFormField(id, include);
@@ -196,7 +196,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
| **include** | **String**| comma separated if needed. eg: options,positions | [optional] [enum: options, positions] |
### Return type
@@ -215,7 +215,7 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **200** | form_field found | - |
+| **200** | form_field found by slug | - |
| **404** | resource not found | - |
@@ -335,7 +335,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
FormFieldsApi apiInstance = new FormFieldsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
UpdateFormField updateFormField = new UpdateFormField(); // UpdateFormField |
try {
FormFieldResponse result = apiInstance.updateFormField(id, updateFormField);
@@ -355,7 +355,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
| **updateFormField** | [**UpdateFormField**](UpdateFormField.md)| | |
### Return type
diff --git a/docs/FormSet.md b/docs/FormSet.md
index 67d0376c..b2cb6ac1 100644
--- a/docs/FormSet.md
+++ b/docs/FormSet.md
@@ -8,7 +8,7 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**name** | **String** | The name of the form set | |
-|**slug** | **String** | The slug of the form set | |
+|**slug** | **String** | The slug of the form set | [optional] |
|**isDefault** | **Boolean** | Whether the form set is default | |
|**forms** | **List<String>** | The forms included in the form set. Add custom forms using the custom form's `slug` field. Or choose a built-in form: `web_new_incident_form`, `web_update_incident_form`, `web_incident_post_mortem_form`, `web_incident_mitigation_form`, `web_incident_resolution_form`, `web_incident_cancellation_form`, `web_scheduled_incident_form`, `web_update_scheduled_incident_form`, `slack_new_incident_form`, `slack_update_incident_form`, `slack_update_incident_status_form`, `slack_incident_mitigation_form`, `slack_incident_resolution_form`, `slack_incident_cancellation_form`, `slack_scheduled_incident_form`, `slack_update_scheduled_incident_form` | |
|**createdAt** | **String** | Date of creation | |
diff --git a/docs/FormSetConditionList.md b/docs/FormSetConditionList.md
index 5f7ee824..6cad0d56 100644
--- a/docs/FormSetConditionList.md
+++ b/docs/FormSetConditionList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<FormSetConditionResponseData>**](FormSetConditionResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/FormSetList.md b/docs/FormSetList.md
index d91f7ee9..ca072009 100644
--- a/docs/FormSetList.md
+++ b/docs/FormSetList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<FormSetResponseData>**](FormSetResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/FormSetsApi.md b/docs/FormSetsApi.md
index fa4c41ed..63c7291c 100644
--- a/docs/FormSetsApi.md
+++ b/docs/FormSetsApi.md
@@ -108,7 +108,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
FormSetsApi apiInstance = new FormSetsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
FormSetResponse result = apiInstance.deleteFormSet(id);
System.out.println(result);
@@ -127,7 +127,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -176,7 +176,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
FormSetsApi apiInstance = new FormSetsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
FormSetResponse result = apiInstance.getFormSet(id);
System.out.println(result);
@@ -195,7 +195,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -213,7 +213,7 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **200** | form_set found | - |
+| **200** | form_set found by slug | - |
| **404** | resource not found | - |
@@ -327,7 +327,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
FormSetsApi apiInstance = new FormSetsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
UpdateFormSet updateFormSet = new UpdateFormSet(); // UpdateFormSet |
try {
FormSetResponse result = apiInstance.updateFormSet(id, updateFormSet);
@@ -347,7 +347,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
| **updateFormSet** | [**UpdateFormSet**](UpdateFormSet.md)| | |
### Return type
diff --git a/docs/FunctionalitiesApi.md b/docs/FunctionalitiesApi.md
index bb51a812..5774d371 100644
--- a/docs/FunctionalitiesApi.md
+++ b/docs/FunctionalitiesApi.md
@@ -5,11 +5,13 @@ All URIs are relative to *https://api.rootly.com*
| Method | HTTP request | Description |
|------------- | ------------- | -------------|
| [**createFunctionality**](FunctionalitiesApi.md#createFunctionality) | **POST** /v1/functionalities | Creates a functionality |
+| [**createFunctionalityCatalogProperty**](FunctionalitiesApi.md#createFunctionalityCatalogProperty) | **POST** /v1/functionalities/properties | Creates a Catalog Property |
| [**deleteFunctionality**](FunctionalitiesApi.md#deleteFunctionality) | **DELETE** /v1/functionalities/{id} | Delete a functionality |
| [**getFunctionality**](FunctionalitiesApi.md#getFunctionality) | **GET** /v1/functionalities/{id} | Retrieves a functionality |
| [**getFunctionalityIncidentsChart**](FunctionalitiesApi.md#getFunctionalityIncidentsChart) | **GET** /v1/functionalities/{id}/incidents_chart | Get functionality incidents chart |
| [**getFunctionalityUptimeChart**](FunctionalitiesApi.md#getFunctionalityUptimeChart) | **GET** /v1/functionalities/{id}/uptime_chart | Get functionality uptime chart |
| [**listFunctionalities**](FunctionalitiesApi.md#listFunctionalities) | **GET** /v1/functionalities | List functionalities |
+| [**listFunctionalityCatalogProperties**](FunctionalitiesApi.md#listFunctionalityCatalogProperties) | **GET** /v1/functionalities/properties | List Catalog Properties |
| [**updateFunctionality**](FunctionalitiesApi.md#updateFunctionality) | **PUT** /v1/functionalities/{id} | Update a functionality |
@@ -82,6 +84,75 @@ public class Example {
| **422** | invalid request | - |
| **401** | responds with unauthorized for invalid token | - |
+
+# **createFunctionalityCatalogProperty**
+> CatalogPropertyResponse createFunctionalityCatalogProperty(newCatalogProperty)
+
+Creates a Catalog Property
+
+Creates a new Catalog Property from provided data
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.FunctionalitiesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ FunctionalitiesApi apiInstance = new FunctionalitiesApi(defaultClient);
+ NewCatalogProperty newCatalogProperty = new NewCatalogProperty(); // NewCatalogProperty |
+ try {
+ CatalogPropertyResponse result = apiInstance.createFunctionalityCatalogProperty(newCatalogProperty);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling FunctionalitiesApi#createFunctionalityCatalogProperty");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **newCatalogProperty** | [**NewCatalogProperty**](NewCatalogProperty.md)| | |
+
+### Return type
+
+[**CatalogPropertyResponse**](CatalogPropertyResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/vnd.api+json
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | catalog_property created ignores wrong catalog_type attribute | - |
+| **422** | exceeds max fields per catalog | - |
+| **401** | responds with unauthorized for invalid token | - |
+
# **deleteFunctionality**
> FunctionalityResponse deleteFunctionality(id)
@@ -110,7 +181,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
FunctionalitiesApi apiInstance = new FunctionalitiesApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
FunctionalityResponse result = apiInstance.deleteFunctionality(id);
System.out.println(result);
@@ -129,7 +200,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -178,7 +249,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
FunctionalitiesApi apiInstance = new FunctionalitiesApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
FunctionalityResponse result = apiInstance.getFunctionality(id);
System.out.println(result);
@@ -197,7 +268,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -246,7 +317,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
FunctionalitiesApi apiInstance = new FunctionalitiesApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
String period = "period_example"; // String |
try {
Object result = apiInstance.getFunctionalityIncidentsChart(id, period);
@@ -266,7 +337,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
| **period** | **String**| | |
### Return type
@@ -316,7 +387,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
FunctionalitiesApi apiInstance = new FunctionalitiesApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
String period = "period_example"; // String |
try {
Object result = apiInstance.getFunctionalityUptimeChart(id, period);
@@ -336,7 +407,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
| **period** | **String**| | [optional] |
### Return type
@@ -453,6 +524,93 @@ public class Example {
|-------------|-------------|------------------|
| **200** | success | - |
+
+# **listFunctionalityCatalogProperties**
+> CatalogPropertyList listFunctionalityCatalogProperties(include, sort, pageNumber, pageSize, filterSlug, filterName, filterKind, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte)
+
+List Catalog Properties
+
+List Functionality Catalog Properties
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.FunctionalitiesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ FunctionalitiesApi apiInstance = new FunctionalitiesApi(defaultClient);
+ String include = "catalog"; // String | comma separated if needed. eg: catalog
+ String sort = "created_at"; // String | comma separated if needed. eg: created_at,updated_at
+ Integer pageNumber = 56; // Integer |
+ Integer pageSize = 56; // Integer |
+ String filterSlug = "filterSlug_example"; // String |
+ String filterName = "filterName_example"; // String |
+ String filterKind = "filterKind_example"; // String |
+ String filterCreatedAtGt = "filterCreatedAtGt_example"; // String |
+ String filterCreatedAtGte = "filterCreatedAtGte_example"; // String |
+ String filterCreatedAtLt = "filterCreatedAtLt_example"; // String |
+ String filterCreatedAtLte = "filterCreatedAtLte_example"; // String |
+ try {
+ CatalogPropertyList result = apiInstance.listFunctionalityCatalogProperties(include, sort, pageNumber, pageSize, filterSlug, filterName, filterKind, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling FunctionalitiesApi#listFunctionalityCatalogProperties");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **include** | **String**| comma separated if needed. eg: catalog | [optional] [enum: catalog] |
+| **sort** | **String**| comma separated if needed. eg: created_at,updated_at | [optional] [enum: created_at, -created_at, updated_at, -updated_at, position, -position] |
+| **pageNumber** | **Integer**| | [optional] |
+| **pageSize** | **Integer**| | [optional] |
+| **filterSlug** | **String**| | [optional] |
+| **filterName** | **String**| | [optional] |
+| **filterKind** | **String**| | [optional] |
+| **filterCreatedAtGt** | **String**| | [optional] |
+| **filterCreatedAtGte** | **String**| | [optional] |
+| **filterCreatedAtLt** | **String**| | [optional] |
+| **filterCreatedAtLte** | **String**| | [optional] |
+
+### Return type
+
+[**CatalogPropertyList**](CatalogPropertyList.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | success | - |
+
# **updateFunctionality**
> FunctionalityResponse updateFunctionality(id, updateFunctionality)
@@ -481,7 +639,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
FunctionalitiesApi apiInstance = new FunctionalitiesApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
UpdateFunctionality updateFunctionality = new UpdateFunctionality(); // UpdateFunctionality |
try {
FunctionalityResponse result = apiInstance.updateFunctionality(id, updateFunctionality);
@@ -501,7 +659,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
| **updateFunctionality** | [**UpdateFunctionality**](UpdateFunctionality.md)| | |
### Return type
diff --git a/docs/Functionality.md b/docs/Functionality.md
index 506a3dc7..a36e7db2 100644
--- a/docs/Functionality.md
+++ b/docs/Functionality.md
@@ -23,10 +23,12 @@
|**position** | **Integer** | Position of the functionality | [optional] |
|**environmentIds** | **List<String>** | Environments associated with this functionality | [optional] |
|**serviceIds** | **List<String>** | Services associated with this functionality | [optional] |
-|**ownersGroupIds** | **List<String>** | Owner Teams associated with this functionality | [optional] |
-|**ownersUserIds** | **List<Integer>** | Owner Users associated with this functionality | [optional] |
+|**ownerGroupIds** | **List<String>** | Owner Teams associated with this functionality | [optional] |
+|**ownerUserIds** | **List<Integer>** | Owner Users associated with this functionality | [optional] |
+|**escalationPolicyId** | **String** | The escalation policy id of the functionality | [optional] |
|**slackChannels** | [**List<NewEnvironmentDataAttributesSlackChannelsInner>**](NewEnvironmentDataAttributesSlackChannelsInner.md) | Slack Channels associated with this functionality | [optional] |
|**slackAliases** | [**List<NewEnvironmentDataAttributesSlackAliasesInner>**](NewEnvironmentDataAttributesSlackAliasesInner.md) | Slack Aliases associated with this functionality | [optional] |
+|**properties** | [**List<NewCauseDataAttributesPropertiesInner>**](NewCauseDataAttributesPropertiesInner.md) | Array of property values for this functionality. | [optional] |
|**createdAt** | **String** | Date of creation | |
|**updatedAt** | **String** | Date of last update | |
diff --git a/docs/FunctionalityList.md b/docs/FunctionalityList.md
index 6a5887e7..e315d351 100644
--- a/docs/FunctionalityList.md
+++ b/docs/FunctionalityList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<FunctionalityResponseData>**](FunctionalityResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/GetAlertFieldIdParameter.md b/docs/GetAlertFieldIdParameter.md
new file mode 100644
index 00000000..04ba2d8c
--- /dev/null
+++ b/docs/GetAlertFieldIdParameter.md
@@ -0,0 +1,12 @@
+
+
+# GetAlertFieldIdParameter
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+
+
+
diff --git a/docs/GetTeamIdParameter.md b/docs/GetTeamIdParameter.md
new file mode 100644
index 00000000..dcf8404b
--- /dev/null
+++ b/docs/GetTeamIdParameter.md
@@ -0,0 +1,12 @@
+
+
+# GetTeamIdParameter
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+
+
+
diff --git a/docs/Heartbeat.md b/docs/Heartbeat.md
index e0776075..bdeba049 100644
--- a/docs/Heartbeat.md
+++ b/docs/Heartbeat.md
@@ -10,15 +10,17 @@
|**name** | **String** | The name of the heartbeat | |
|**description** | **String** | The description of the heartbeat | [optional] |
|**alertSummary** | **String** | Summary of alerts triggered when heartbeat expires. | |
+|**alertDescription** | **String** | Description of alerts triggered when heartbeat expires. | [optional] |
|**alertUrgencyId** | **String** | Urgency of alerts triggered when heartbeat expires. | [optional] |
|**interval** | **Integer** | | |
|**intervalUnit** | [**IntervalUnitEnum**](#IntervalUnitEnum) | | |
|**notificationTargetId** | **String** | | |
-|**notificationTargetType** | [**NotificationTargetTypeEnum**](#NotificationTargetTypeEnum) | | |
+|**notificationTargetType** | [**NotificationTargetTypeEnum**](#NotificationTargetTypeEnum) | The type of the notification target. Please contact support if you encounter issues using `Functionality` as a target type. | |
|**enabled** | **Boolean** | Whether to trigger alerts when heartbeat is expired. | |
|**status** | [**StatusEnum**](#StatusEnum) | | |
|**pingUrl** | **String** | URL to receive heartbeat pings. | [optional] |
|**secret** | **String** | Secret used as bearer token when pinging heartbeat. | [optional] |
+|**emailAddress** | **String** | Email address to receive heartbeat pings. | |
|**lastPingedAt** | **String** | When the heartbeat was last pinged. | [optional] |
|**expiresAt** | **String** | When heartbeat expires | [optional] |
|**createdAt** | **String** | Date of creation | |
@@ -30,9 +32,9 @@
| Name | Value |
|---- | -----|
-| SECONDS | "seconds" |
| MINUTES | "minutes" |
| HOURS | "hours" |
+| DAYS | "days" |
@@ -44,6 +46,7 @@
| GROUP | "Group" |
| SERVICE | "Service" |
| ESCALATION_POLICY | "EscalationPolicy" |
+| FUNCTIONALITY | "Functionality" |
diff --git a/docs/HeartbeatList.md b/docs/HeartbeatList.md
index 58e68666..12e01800 100644
--- a/docs/HeartbeatList.md
+++ b/docs/HeartbeatList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<HeartbeatResponseData>**](HeartbeatResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/HeartbeatsApi.md b/docs/HeartbeatsApi.md
index 473e747f..d3ebbf4c 100644
--- a/docs/HeartbeatsApi.md
+++ b/docs/HeartbeatsApi.md
@@ -78,7 +78,7 @@ public class Example {
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **201** | heartbeat created | - |
-| **422** | invalid request | - |
+| **422** | interval less than 60 seconds | - |
| **401** | responds with unauthorized for invalid token | - |
@@ -109,7 +109,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
HeartbeatsApi apiInstance = new HeartbeatsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
HeartbeatResponse result = apiInstance.deleteHeartbeat(id);
System.out.println(result);
@@ -128,7 +128,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -177,7 +177,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
HeartbeatsApi apiInstance = new HeartbeatsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
HeartbeatResponse result = apiInstance.getHeartbeat(id);
System.out.println(result);
@@ -196,7 +196,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -214,7 +214,7 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **200** | heartbeat found | - |
+| **200** | heartbeat found by slug | - |
| **404** | resource not found | - |
@@ -300,7 +300,7 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **200** | success | - |
+| **200** | filter by name | - |
# **pingHeartbeat**
@@ -397,7 +397,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
HeartbeatsApi apiInstance = new HeartbeatsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
UpdateHeartbeat updateHeartbeat = new UpdateHeartbeat(); // UpdateHeartbeat |
try {
HeartbeatResponse result = apiInstance.updateHeartbeat(id, updateHeartbeat);
@@ -417,7 +417,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
| **updateHeartbeat** | [**UpdateHeartbeat**](UpdateHeartbeat.md)| | |
### Return type
@@ -438,4 +438,5 @@ public class Example {
|-------------|-------------|------------------|
| **200** | heartbeat updated | - |
| **404** | resource not found | - |
+| **422** | invalid enum value | - |
diff --git a/docs/Incident.md b/docs/Incident.md
index 74002afd..8e80a9c4 100644
--- a/docs/Incident.md
+++ b/docs/Incident.md
@@ -7,13 +7,21 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | Unique ID of the incident | [optional] |
+|**sequentialId** | **Integer** | Sequential ID of the incident | [optional] |
|**title** | **String** | The title of the incident | |
|**kind** | **String** | The kind of the incident | [optional] |
-|**slug** | **String** | The slug of the incident | |
+|**slug** | **String** | The slug of the incident | [optional] |
|**parentIncidentId** | **String** | ID of parent incident | [optional] |
|**duplicateIncidentId** | **String** | ID of duplicated incident | [optional] |
|**summary** | **String** | The summary of the incident | [optional] |
-|**_private** | **Boolean** | Create an incident as private | [optional] |
+|**_private** | **Boolean** | The visibility of the incident | [optional] |
+|**source** | **String** | The source of the incident | [optional] |
+|**status** | **String** | The status of the incident | [optional] |
+|**url** | **String** | The url to the incident | [optional] |
+|**shortUrl** | **String** | The short url to the incident | [optional] |
+|**publicTitle** | **String** | The public title of the incident | [optional] |
+|**user** | **Object** | The user who created the incident | [optional] |
|**severity** | [**SeverityResponse**](SeverityResponse.md) | The Severity of the incident | [optional] |
|**environments** | [**List<EnvironmentResponse>**](EnvironmentResponse.md) | The Environments of the incident | [optional] |
|**incidentTypes** | [**List<IncidentTypeResponse>**](IncidentTypeResponse.md) | The Incident Types of the incident | [optional] |
@@ -24,18 +32,96 @@
|**slackChannelId** | **String** | Slack channel id | [optional] |
|**slackChannelName** | **String** | Slack channel name | [optional] |
|**slackChannelUrl** | **String** | Slack channel url | [optional] |
+|**slackChannelShortUrl** | **String** | Slack channel short url | [optional] |
+|**slackChannelDeepLink** | **String** | Slack channel deep link | [optional] |
+|**slackChannelArchived** | **Boolean** | Whether the Slack channel is archived | [optional] |
+|**slackLastMessageTs** | **String** | Timestamp of last Slack message | [optional] |
+|**zoomMeetingId** | **String** | Zoom meeting ID | [optional] |
+|**zoomMeetingStartUrl** | **String** | Zoom meeting start URL | [optional] |
+|**zoomMeetingJoinUrl** | **String** | Zoom meeting join URL | [optional] |
+|**zoomMeetingPassword** | **String** | Zoom meeting password | [optional] |
+|**zoomMeetingPstnPassword** | **String** | Zoom meeting PSTN password | [optional] |
+|**zoomMeetingH323Password** | **String** | Zoom meeting H323 password | [optional] |
+|**zoomMeetingGlobalDialInNumbers** | [**List<IncidentZoomMeetingGlobalDialInNumbersInner>**](IncidentZoomMeetingGlobalDialInNumbersInner.md) | Zoom meeting global dial-in numbers | [optional] |
+|**googleDriveId** | **String** | Google Drive document ID | [optional] |
+|**googleDriveParentId** | **String** | Google Drive parent folder ID | [optional] |
+|**googleDriveUrl** | **String** | Google Drive URL | [optional] |
+|**googleMeetingId** | **String** | Google meeting ID | [optional] |
+|**googleMeetingUrl** | **String** | Google meeting URL | [optional] |
+|**jiraIssueKey** | **String** | Jira issue key | [optional] |
+|**jiraIssueId** | **String** | Jira issue ID | [optional] |
+|**jiraIssueUrl** | **String** | Jira issue URL | [optional] |
+|**githubIssueId** | **String** | GitHub issue ID | [optional] |
+|**githubIssueUrl** | **String** | GitHub issue URL | [optional] |
+|**gitlabIssueId** | **String** | GitLab issue ID | [optional] |
+|**gitlabIssueUrl** | **String** | GitLab issue URL | [optional] |
+|**asanaTaskId** | **String** | Asana task ID | [optional] |
+|**asanaTaskUrl** | **String** | Asana task URL | [optional] |
+|**linearIssueId** | **String** | Linear issue ID | [optional] |
+|**linearIssueUrl** | **String** | Linear issue URL | [optional] |
+|**trelloCardId** | **String** | Trello card ID | [optional] |
+|**trelloCardUrl** | **String** | Trello card URL | [optional] |
+|**zendeskTicketId** | **String** | Zendesk ticket ID | [optional] |
+|**zendeskTicketUrl** | **String** | Zendesk ticket URL | [optional] |
+|**pagerdutyIncidentId** | **String** | PagerDuty incident ID | [optional] |
+|**pagerdutyIncidentNumber** | **String** | PagerDuty incident number | [optional] |
+|**pagerdutyIncidentUrl** | **String** | PagerDuty incident URL | [optional] |
+|**opsgenieIncidentId** | **String** | Opsgenie incident ID | [optional] |
+|**opsgenieIncidentUrl** | **String** | Opsgenie incident URL | [optional] |
+|**opsgenieAlertId** | **String** | Opsgenie alert ID | [optional] |
+|**opsgenieAlertUrl** | **String** | Opsgenie alert URL | [optional] |
+|**serviceNowIncidentId** | **String** | ServiceNow incident ID | [optional] |
+|**serviceNowIncidentKey** | **String** | ServiceNow incident key | [optional] |
+|**serviceNowIncidentUrl** | **String** | ServiceNow incident URL | [optional] |
+|**mattermostChannelId** | **String** | Mattermost channel ID | [optional] |
+|**mattermostChannelName** | **String** | Mattermost channel name | [optional] |
+|**mattermostChannelUrl** | **String** | Mattermost channel URL | [optional] |
+|**confluencePageId** | **String** | Confluence page ID | [optional] |
+|**confluencePageUrl** | **String** | Confluence page URL | [optional] |
+|**datadogNotebookId** | **String** | Datadog notebook ID | [optional] |
+|**datadogNotebookUrl** | **String** | Datadog notebook URL | [optional] |
+|**shortcutStoryId** | **String** | Shortcut story ID | [optional] |
+|**shortcutStoryUrl** | **String** | Shortcut story URL | [optional] |
+|**shortcutTaskId** | **String** | Shortcut task ID | [optional] |
+|**shortcutTaskUrl** | **String** | Shortcut task URL | [optional] |
+|**motionTaskId** | **String** | Motion task ID | [optional] |
+|**motionTaskUrl** | **String** | Motion task URL | [optional] |
+|**clickupTaskId** | **String** | ClickUp task ID | [optional] |
+|**clickupTaskUrl** | **String** | ClickUp task URL | [optional] |
+|**victorOpsIncidentId** | **String** | VictorOps incident ID | [optional] |
+|**victorOpsIncidentUrl** | **String** | VictorOps incident URL | [optional] |
+|**quipPageId** | **String** | Quip page ID | [optional] |
+|**quipPageUrl** | **String** | Quip page URL | [optional] |
+|**sharepointPageId** | **String** | SharePoint page ID | [optional] |
+|**sharepointPageUrl** | **String** | SharePoint page URL | [optional] |
+|**airtableBaseKey** | **String** | Airtable base key | [optional] |
+|**airtableTableName** | **String** | Airtable table name | [optional] |
+|**airtableRecordId** | **String** | Airtable record ID | [optional] |
+|**airtableRecordUrl** | **String** | Airtable record URL | [optional] |
+|**freshserviceTicketId** | **String** | Freshservice ticket ID | [optional] |
+|**freshserviceTicketUrl** | **String** | Freshservice ticket URL | [optional] |
+|**freshserviceTaskId** | **String** | Freshservice task ID | [optional] |
+|**freshserviceTaskUrl** | **String** | Freshservice task URL | [optional] |
|**mitigationMessage** | **String** | How was the incident mitigated? | [optional] |
|**resolutionMessage** | **String** | How was the incident resolved? | [optional] |
|**cancellationMessage** | **String** | Why was the incident cancelled? | [optional] |
|**scheduledFor** | **String** | Date of when the maintenance begins | [optional] |
|**scheduledUntil** | **String** | Date of when the maintenance ends | [optional] |
+|**mutedServiceIds** | **List<String>** | The Service IDs to mute alerts for during maintenance. Alerts for these services will still be triggered and attached to the incident, but won't page responders. | [optional] |
|**retrospectiveProgressStatus** | [**RetrospectiveProgressStatusEnum**](#RetrospectiveProgressStatusEnum) | The status of the retrospective progress | [optional] |
+|**inTriageBy** | **Object** | The user who triaged the incident | [optional] |
+|**startedBy** | **Object** | The user who started the incident | [optional] |
+|**mitigatedBy** | **Object** | The user who mitigated the incident | [optional] |
+|**resolvedBy** | **Object** | The user who resolved the incident | [optional] |
+|**closedBy** | **Object** | The user who closed the incident | [optional] |
+|**cancelledBy** | **Object** | The user who cancelled the incident | [optional] |
|**inTriageAt** | **String** | Date of triage | [optional] |
|**startedAt** | **String** | Date of start | [optional] |
|**detectedAt** | **String** | Date of detection | [optional] |
|**acknowledgedAt** | **String** | Date of acknowledgment | [optional] |
|**mitigatedAt** | **String** | Date of mitigation | [optional] |
|**resolvedAt** | **String** | Date of resolution | [optional] |
+|**closedAt** | **String** | Date of closure | [optional] |
|**cancelledAt** | **String** | Date of cancellation | [optional] |
|**createdAt** | **String** | Date of creation | |
|**updatedAt** | **String** | Date of last update | |
diff --git a/docs/IncidentActionItem.md b/docs/IncidentActionItem.md
index 90c7fb80..ac3ceb21 100644
--- a/docs/IncidentActionItem.md
+++ b/docs/IncidentActionItem.md
@@ -10,12 +10,13 @@
|**summary** | **String** | The summary of the action item | |
|**description** | **String** | The description of incident action item | [optional] |
|**kind** | [**KindEnum**](#KindEnum) | The kind of the action item | [optional] |
-|**assignedToUserId** | **Integer** | ID of user you wish to assign this action item | [optional] |
+|**assignedTo** | [**UserFlatResponse**](UserFlatResponse.md) | User assigned to this action item | [optional] |
|**assignedToGroupIds** | **List<String>** | IDs of groups you wish to assign this action item | [optional] |
|**priority** | [**PriorityEnum**](#PriorityEnum) | The priority of the action item | [optional] |
|**status** | [**StatusEnum**](#StatusEnum) | The status of the action item | [optional] |
|**dueDate** | **String** | The due date of the action item | [optional] |
|**jiraIssueId** | **String** | The Jira issue ID. | [optional] |
+|**jiraIssueKey** | **String** | The Jira issue key. | [optional] |
|**jiraIssueUrl** | **String** | The Jira issue URL. | [optional] |
|**createdAt** | **String** | Date of creation | |
|**updatedAt** | **String** | Date of last update | |
diff --git a/docs/IncidentActionItemList.md b/docs/IncidentActionItemList.md
index 399936fa..b1b4bf2e 100644
--- a/docs/IncidentActionItemList.md
+++ b/docs/IncidentActionItemList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<IncidentActionItemResponseData>**](IncidentActionItemResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/IncidentCustomFieldSelectionList.md b/docs/IncidentCustomFieldSelectionList.md
index 39bc88f7..699f5524 100644
--- a/docs/IncidentCustomFieldSelectionList.md
+++ b/docs/IncidentCustomFieldSelectionList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<IncidentCustomFieldSelectionResponseData>**](IncidentCustomFieldSelectionResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/IncidentEventFunctionalityList.md b/docs/IncidentEventFunctionalityList.md
index 3edfd6cb..9e1a3676 100644
--- a/docs/IncidentEventFunctionalityList.md
+++ b/docs/IncidentEventFunctionalityList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<IncidentEventFunctionalityResponseData>**](IncidentEventFunctionalityResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/IncidentEventList.md b/docs/IncidentEventList.md
index 73905bfb..51256445 100644
--- a/docs/IncidentEventList.md
+++ b/docs/IncidentEventList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<IncidentEventResponseData>**](IncidentEventResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/IncidentEventServiceList.md b/docs/IncidentEventServiceList.md
index fcda7f64..c56d19a9 100644
--- a/docs/IncidentEventServiceList.md
+++ b/docs/IncidentEventServiceList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<IncidentEventServiceResponseData>**](IncidentEventServiceResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/IncidentFeedbackList.md b/docs/IncidentFeedbackList.md
index b9215b77..cefdc493 100644
--- a/docs/IncidentFeedbackList.md
+++ b/docs/IncidentFeedbackList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<IncidentFeedbackResponseData>**](IncidentFeedbackResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/IncidentFormFieldSelection.md b/docs/IncidentFormFieldSelection.md
index d068b90d..ff7c018f 100644
--- a/docs/IncidentFormFieldSelection.md
+++ b/docs/IncidentFormFieldSelection.md
@@ -16,6 +16,9 @@
|**selectedServiceIds** | **List<String>** | | [optional] |
|**selectedFunctionalityIds** | **List<String>** | | [optional] |
|**selectedUserIds** | **List<Integer>** | | [optional] |
+|**selectedEnvironmentIds** | **List<String>** | | [optional] |
+|**selectedCauseIds** | **List<String>** | | [optional] |
+|**selectedIncidentTypeIds** | **List<String>** | | [optional] |
diff --git a/docs/IncidentFormFieldSelectionList.md b/docs/IncidentFormFieldSelectionList.md
index 7cf9b2a4..986e01c5 100644
--- a/docs/IncidentFormFieldSelectionList.md
+++ b/docs/IncidentFormFieldSelectionList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<IncidentFormFieldSelectionResponseData>**](IncidentFormFieldSelectionResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/IncidentList.md b/docs/IncidentList.md
index 4378be03..8e93b610 100644
--- a/docs/IncidentList.md
+++ b/docs/IncidentList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<IncidentResponseData>**](IncidentResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/IncidentPermissionSet.md b/docs/IncidentPermissionSet.md
index 894cb4e2..864ea859 100644
--- a/docs/IncidentPermissionSet.md
+++ b/docs/IncidentPermissionSet.md
@@ -8,7 +8,7 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**name** | **String** | The incident permission set name. | |
-|**slug** | **String** | The incident permission set slug. | |
+|**slug** | **String** | The incident permission set slug. | [optional] |
|**description** | **String** | The incident permission set description. | [optional] |
|**privateIncidentPermissions** | [**List<PrivateIncidentPermissionsEnum>**](#List<PrivateIncidentPermissionsEnum>) | | [optional] |
|**publicIncidentPermissions** | [**List<PublicIncidentPermissionsEnum>**](#List<PublicIncidentPermissionsEnum>) | | [optional] |
diff --git a/docs/IncidentPermissionSetBooleanList.md b/docs/IncidentPermissionSetBooleanList.md
index d084ba97..fdd6bfec 100644
--- a/docs/IncidentPermissionSetBooleanList.md
+++ b/docs/IncidentPermissionSetBooleanList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<IncidentPermissionSetBooleanResponseData>**](IncidentPermissionSetBooleanResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/IncidentPermissionSetList.md b/docs/IncidentPermissionSetList.md
index 5e764a88..6ce6f0a5 100644
--- a/docs/IncidentPermissionSetList.md
+++ b/docs/IncidentPermissionSetList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<IncidentPermissionSetResponseData>**](IncidentPermissionSetResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/IncidentPermissionSetResourceList.md b/docs/IncidentPermissionSetResourceList.md
index 529c5a02..b0ffb28b 100644
--- a/docs/IncidentPermissionSetResourceList.md
+++ b/docs/IncidentPermissionSetResourceList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<IncidentPermissionSetResourceResponseData>**](IncidentPermissionSetResourceResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/IncidentPermissionSetsApi.md b/docs/IncidentPermissionSetsApi.md
index a4dae2fd..c7f28251 100644
--- a/docs/IncidentPermissionSetsApi.md
+++ b/docs/IncidentPermissionSetsApi.md
@@ -108,7 +108,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
IncidentPermissionSetsApi apiInstance = new IncidentPermissionSetsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
IncidentPermissionSetResponse result = apiInstance.deleteIncidentPermissionSet(id);
System.out.println(result);
@@ -127,7 +127,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -176,7 +176,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
IncidentPermissionSetsApi apiInstance = new IncidentPermissionSetsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
IncidentPermissionSetResponse result = apiInstance.getIncidentPermissionSet(id);
System.out.println(result);
@@ -195,7 +195,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -331,7 +331,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
IncidentPermissionSetsApi apiInstance = new IncidentPermissionSetsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
UpdateIncidentPermissionSet updateIncidentPermissionSet = new UpdateIncidentPermissionSet(); // UpdateIncidentPermissionSet |
try {
IncidentPermissionSetResponse result = apiInstance.updateIncidentPermissionSet(id, updateIncidentPermissionSet);
@@ -351,7 +351,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
| **updateIncidentPermissionSet** | [**UpdateIncidentPermissionSet**](UpdateIncidentPermissionSet.md)| | |
### Return type
diff --git a/docs/IncidentPostMortemList.md b/docs/IncidentPostMortemList.md
index f5609608..6b0725e0 100644
--- a/docs/IncidentPostMortemList.md
+++ b/docs/IncidentPostMortemList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<IncidentPostMortemResponseData>**](IncidentPostMortemResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/IncidentRetrospectivesApi.md b/docs/IncidentRetrospectivesApi.md
index 3fead011..0b18ebda 100644
--- a/docs/IncidentRetrospectivesApi.md
+++ b/docs/IncidentRetrospectivesApi.md
@@ -11,7 +11,7 @@ All URIs are relative to *https://api.rootly.com*
# **listIncidentPostMortems**
-> IncidentPostMortemList listIncidentPostMortems(include, pageNumber, pageSize, filterSearch, filterStatus, filterSeverity, filterType, filterUserId, filterEnvironments, filterFunctionalities, filterServices, filterTeams, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, filterStartedAtGt, filterStartedAtGte, filterStartedAtLt, filterStartedAtLte, filterMitigatedAtGt, filterMitigatedAtGte, filterMitigatedAtLt, filterMitigatedAtLte, filterResolvedAtGt, filterResolvedAtGte, filterResolvedAtLt, filterResolvedAtLte, sort)
+> IncidentPostMortemList listIncidentPostMortems(include, pageNumber, pageSize, filterSearch, filterStatus, filterSeverity, filterType, filterUserId, filterTypes, filterTypeIds, filterEnvironments, filterEnvironmentIds, filterFunctionalities, filterFunctionalityIds, filterServices, filterServiceIds, filterTeams, filterTeamIds, filterCauses, filterCauseIds, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, filterStartedAtGt, filterStartedAtGte, filterStartedAtLt, filterStartedAtLte, filterMitigatedAtGt, filterMitigatedAtGte, filterMitigatedAtLt, filterMitigatedAtLte, filterResolvedAtGt, filterResolvedAtGte, filterResolvedAtLt, filterResolvedAtLte, sort)
List incident retrospectives
@@ -45,10 +45,18 @@ public class Example {
String filterSeverity = "filterSeverity_example"; // String |
String filterType = "filterType_example"; // String |
Integer filterUserId = 56; // Integer |
- String filterEnvironments = "filterEnvironments_example"; // String |
- String filterFunctionalities = "filterFunctionalities_example"; // String |
- String filterServices = "filterServices_example"; // String |
- String filterTeams = "filterTeams_example"; // String |
+ String filterTypes = "filterTypes_example"; // String | Filter by incident type slugs
+ String filterTypeIds = "filterTypeIds_example"; // String | Filter by incident type IDs (UUIDs)
+ String filterEnvironments = "filterEnvironments_example"; // String | Filter by environment slugs
+ String filterEnvironmentIds = "filterEnvironmentIds_example"; // String | Filter by environment IDs (UUIDs)
+ String filterFunctionalities = "filterFunctionalities_example"; // String | Filter by functionality slugs
+ String filterFunctionalityIds = "filterFunctionalityIds_example"; // String | Filter by functionality IDs (UUIDs)
+ String filterServices = "filterServices_example"; // String | Filter by service slugs
+ String filterServiceIds = "filterServiceIds_example"; // String | Filter by service IDs (UUIDs)
+ String filterTeams = "filterTeams_example"; // String | Filter by team/group slugs
+ String filterTeamIds = "filterTeamIds_example"; // String | Filter by team/group IDs (UUIDs)
+ String filterCauses = "filterCauses_example"; // String | Filter by cause slugs
+ String filterCauseIds = "filterCauseIds_example"; // String | Filter by cause IDs (UUIDs)
String filterCreatedAtGt = "filterCreatedAtGt_example"; // String |
String filterCreatedAtGte = "filterCreatedAtGte_example"; // String |
String filterCreatedAtLt = "filterCreatedAtLt_example"; // String |
@@ -67,7 +75,7 @@ public class Example {
String filterResolvedAtLte = "filterResolvedAtLte_example"; // String |
String sort = "sort_example"; // String |
try {
- IncidentPostMortemList result = apiInstance.listIncidentPostMortems(include, pageNumber, pageSize, filterSearch, filterStatus, filterSeverity, filterType, filterUserId, filterEnvironments, filterFunctionalities, filterServices, filterTeams, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, filterStartedAtGt, filterStartedAtGte, filterStartedAtLt, filterStartedAtLte, filterMitigatedAtGt, filterMitigatedAtGte, filterMitigatedAtLt, filterMitigatedAtLte, filterResolvedAtGt, filterResolvedAtGte, filterResolvedAtLt, filterResolvedAtLte, sort);
+ IncidentPostMortemList result = apiInstance.listIncidentPostMortems(include, pageNumber, pageSize, filterSearch, filterStatus, filterSeverity, filterType, filterUserId, filterTypes, filterTypeIds, filterEnvironments, filterEnvironmentIds, filterFunctionalities, filterFunctionalityIds, filterServices, filterServiceIds, filterTeams, filterTeamIds, filterCauses, filterCauseIds, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, filterStartedAtGt, filterStartedAtGte, filterStartedAtLt, filterStartedAtLte, filterMitigatedAtGt, filterMitigatedAtGte, filterMitigatedAtLt, filterMitigatedAtLte, filterResolvedAtGt, filterResolvedAtGte, filterResolvedAtLt, filterResolvedAtLte, sort);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IncidentRetrospectivesApi#listIncidentPostMortems");
@@ -92,10 +100,18 @@ public class Example {
| **filterSeverity** | **String**| | [optional] |
| **filterType** | **String**| | [optional] |
| **filterUserId** | **Integer**| | [optional] |
-| **filterEnvironments** | **String**| | [optional] |
-| **filterFunctionalities** | **String**| | [optional] |
-| **filterServices** | **String**| | [optional] |
-| **filterTeams** | **String**| | [optional] |
+| **filterTypes** | **String**| Filter by incident type slugs | [optional] |
+| **filterTypeIds** | **String**| Filter by incident type IDs (UUIDs) | [optional] |
+| **filterEnvironments** | **String**| Filter by environment slugs | [optional] |
+| **filterEnvironmentIds** | **String**| Filter by environment IDs (UUIDs) | [optional] |
+| **filterFunctionalities** | **String**| Filter by functionality slugs | [optional] |
+| **filterFunctionalityIds** | **String**| Filter by functionality IDs (UUIDs) | [optional] |
+| **filterServices** | **String**| Filter by service slugs | [optional] |
+| **filterServiceIds** | **String**| Filter by service IDs (UUIDs) | [optional] |
+| **filterTeams** | **String**| Filter by team/group slugs | [optional] |
+| **filterTeamIds** | **String**| Filter by team/group IDs (UUIDs) | [optional] |
+| **filterCauses** | **String**| Filter by cause slugs | [optional] |
+| **filterCauseIds** | **String**| Filter by cause IDs (UUIDs) | [optional] |
| **filterCreatedAtGt** | **String**| | [optional] |
| **filterCreatedAtGte** | **String**| | [optional] |
| **filterCreatedAtLt** | **String**| | [optional] |
@@ -160,7 +176,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
IncidentRetrospectivesApi apiInstance = new IncidentRetrospectivesApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
IncidentPostMortemResponse result = apiInstance.listIncidentPostmortem(id);
System.out.println(result);
@@ -179,7 +195,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -228,7 +244,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
IncidentRetrospectivesApi apiInstance = new IncidentRetrospectivesApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
UpdateIncidentPostMortem updateIncidentPostMortem = new UpdateIncidentPostMortem(); // UpdateIncidentPostMortem |
try {
IncidentPostMortemResponse result = apiInstance.updateIncidentPostmortem(id, updateIncidentPostMortem);
@@ -248,7 +264,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
| **updateIncidentPostMortem** | [**UpdateIncidentPostMortem**](UpdateIncidentPostMortem.md)| | |
### Return type
diff --git a/docs/IncidentRoleList.md b/docs/IncidentRoleList.md
index 0e8f2e25..70b075bc 100644
--- a/docs/IncidentRoleList.md
+++ b/docs/IncidentRoleList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<IncidentRoleResponseData>**](IncidentRoleResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/IncidentRoleTaskList.md b/docs/IncidentRoleTaskList.md
index 667b5eb1..2085f3da 100644
--- a/docs/IncidentRoleTaskList.md
+++ b/docs/IncidentRoleTaskList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<IncidentRoleTaskResponseData>**](IncidentRoleTaskResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/IncidentRolesApi.md b/docs/IncidentRolesApi.md
index f53bb744..f421c493 100644
--- a/docs/IncidentRolesApi.md
+++ b/docs/IncidentRolesApi.md
@@ -108,7 +108,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
IncidentRolesApi apiInstance = new IncidentRolesApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
IncidentRoleResponse result = apiInstance.deleteIncidentRole(id);
System.out.println(result);
@@ -127,7 +127,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -176,7 +176,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
IncidentRolesApi apiInstance = new IncidentRolesApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
IncidentRoleResponse result = apiInstance.getIncidentRole(id);
System.out.println(result);
@@ -195,7 +195,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -218,7 +218,7 @@ public class Example {
# **listIncidentRoles**
-> IncidentRoleList listIncidentRoles(include, pageNumber, pageSize, filterSearch, filterSlug, filterName, filterEnabled, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, sort)
+> IncidentRoleList listIncidentRoles(pageNumber, pageSize, filterSearch, filterSlug, filterName, filterEnabled, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, sort)
List incident roles
@@ -244,7 +244,6 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
IncidentRolesApi apiInstance = new IncidentRolesApi(defaultClient);
- String include = "include_example"; // String |
Integer pageNumber = 56; // Integer |
Integer pageSize = 56; // Integer |
String filterSearch = "filterSearch_example"; // String |
@@ -257,7 +256,7 @@ public class Example {
String filterCreatedAtLte = "filterCreatedAtLte_example"; // String |
String sort = "sort_example"; // String |
try {
- IncidentRoleList result = apiInstance.listIncidentRoles(include, pageNumber, pageSize, filterSearch, filterSlug, filterName, filterEnabled, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, sort);
+ IncidentRoleList result = apiInstance.listIncidentRoles(pageNumber, pageSize, filterSearch, filterSlug, filterName, filterEnabled, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, sort);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IncidentRolesApi#listIncidentRoles");
@@ -274,7 +273,6 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **include** | **String**| | [optional] |
| **pageNumber** | **Integer**| | [optional] |
| **pageSize** | **Integer**| | [optional] |
| **filterSearch** | **String**| | [optional] |
@@ -333,7 +331,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
IncidentRolesApi apiInstance = new IncidentRolesApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
UpdateIncidentRole updateIncidentRole = new UpdateIncidentRole(); // UpdateIncidentRole |
try {
IncidentRoleResponse result = apiInstance.updateIncidentRole(id, updateIncidentRole);
@@ -353,7 +351,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
| **updateIncidentRole** | [**UpdateIncidentRole**](UpdateIncidentRole.md)| | |
### Return type
diff --git a/docs/IncidentStatusPageEvent.md b/docs/IncidentStatusPageEvent.md
index bdd86fdc..a0dbfc31 100644
--- a/docs/IncidentStatusPageEvent.md
+++ b/docs/IncidentStatusPageEvent.md
@@ -28,7 +28,6 @@
| RESOLVED | "resolved" |
| SCHEDULED | "scheduled" |
| IN_PROGRESS | "in_progress" |
-| VERIFYING | "verifying" |
| COMPLETED | "completed" |
diff --git a/docs/IncidentStatusPageEventList.md b/docs/IncidentStatusPageEventList.md
index e2838240..a8136f2c 100644
--- a/docs/IncidentStatusPageEventList.md
+++ b/docs/IncidentStatusPageEventList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<IncidentStatusPageEventResponseData>**](IncidentStatusPageEventResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/IncidentSubStatusList.md b/docs/IncidentSubStatusList.md
index 137a5d03..6d9ec4fe 100644
--- a/docs/IncidentSubStatusList.md
+++ b/docs/IncidentSubStatusList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<IncidentSubStatusResponseData>**](IncidentSubStatusResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/IncidentTriggerParams.md b/docs/IncidentTriggerParams.md
index 620c6cd4..182853be 100644
--- a/docs/IncidentTriggerParams.md
+++ b/docs/IncidentTriggerParams.md
@@ -57,6 +57,7 @@
| NORMAL_SUB | "normal_sub" |
| BACKFILLED | "backfilled" |
| SCHEDULED | "scheduled" |
+| SCHEDULED_SUB | "scheduled_sub" |
@@ -93,6 +94,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -108,6 +110,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -123,6 +126,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -138,6 +142,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -153,6 +158,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -168,6 +174,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -183,6 +190,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -198,6 +206,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -213,6 +222,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -228,6 +238,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -243,6 +254,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -258,6 +270,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -273,6 +286,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
diff --git a/docs/IncidentType.md b/docs/IncidentType.md
index 42081e09..5836078c 100644
--- a/docs/IncidentType.md
+++ b/docs/IncidentType.md
@@ -15,6 +15,7 @@
|**notifyEmails** | **List<String>** | Emails to attach to the incident type | [optional] |
|**slackChannels** | [**List<NewEnvironmentDataAttributesSlackChannelsInner>**](NewEnvironmentDataAttributesSlackChannelsInner.md) | Slack Channels associated with this incident type | [optional] |
|**slackAliases** | [**List<NewEnvironmentDataAttributesSlackAliasesInner>**](NewEnvironmentDataAttributesSlackAliasesInner.md) | Slack Aliases associated with this incident type | [optional] |
+|**properties** | [**List<NewCauseDataAttributesPropertiesInner>**](NewCauseDataAttributesPropertiesInner.md) | Array of property values for this incident type. | [optional] |
|**createdAt** | **String** | Date of creation | |
|**updatedAt** | **String** | Date of last update | |
diff --git a/docs/IncidentTypeList.md b/docs/IncidentTypeList.md
index 4439aacd..0d53bc9f 100644
--- a/docs/IncidentTypeList.md
+++ b/docs/IncidentTypeList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<IncidentTypeResponseData>**](IncidentTypeResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/IncidentTypesApi.md b/docs/IncidentTypesApi.md
index c6859ed3..7ff1bf0f 100644
--- a/docs/IncidentTypesApi.md
+++ b/docs/IncidentTypesApi.md
@@ -5,8 +5,10 @@ All URIs are relative to *https://api.rootly.com*
| Method | HTTP request | Description |
|------------- | ------------- | -------------|
| [**createIncidentType**](IncidentTypesApi.md#createIncidentType) | **POST** /v1/incident_types | Creates an incident type |
+| [**createIncidentTypeCatalogProperty**](IncidentTypesApi.md#createIncidentTypeCatalogProperty) | **POST** /v1/incident_types/properties | Creates a Catalog Property |
| [**deleteIncidentType**](IncidentTypesApi.md#deleteIncidentType) | **DELETE** /v1/incident_types/{id} | Delete an incident type |
| [**getIncidentType**](IncidentTypesApi.md#getIncidentType) | **GET** /v1/incident_types/{id} | Retrieves an incident type |
+| [**listIncidentTypeCatalogProperties**](IncidentTypesApi.md#listIncidentTypeCatalogProperties) | **GET** /v1/incident_types/properties | List Catalog Properties |
| [**listIncidentTypes**](IncidentTypesApi.md#listIncidentTypes) | **GET** /v1/incident_types | List incident types |
| [**updateIncidentType**](IncidentTypesApi.md#updateIncidentType) | **PUT** /v1/incident_types/{id} | Update an incident type |
@@ -80,6 +82,75 @@ public class Example {
| **422** | invalid request | - |
| **401** | resource not found | - |
+
+# **createIncidentTypeCatalogProperty**
+> CatalogPropertyResponse createIncidentTypeCatalogProperty(newCatalogProperty)
+
+Creates a Catalog Property
+
+Creates a new Catalog Property from provided data
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.IncidentTypesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ IncidentTypesApi apiInstance = new IncidentTypesApi(defaultClient);
+ NewCatalogProperty newCatalogProperty = new NewCatalogProperty(); // NewCatalogProperty |
+ try {
+ CatalogPropertyResponse result = apiInstance.createIncidentTypeCatalogProperty(newCatalogProperty);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling IncidentTypesApi#createIncidentTypeCatalogProperty");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **newCatalogProperty** | [**NewCatalogProperty**](NewCatalogProperty.md)| | |
+
+### Return type
+
+[**CatalogPropertyResponse**](CatalogPropertyResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/vnd.api+json
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | catalog_property created ignores wrong catalog_type attribute | - |
+| **422** | exceeds max fields per catalog | - |
+| **401** | responds with unauthorized for invalid token | - |
+
# **deleteIncidentType**
> IncidentTypeResponse deleteIncidentType(id)
@@ -108,7 +179,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
IncidentTypesApi apiInstance = new IncidentTypesApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
IncidentTypeResponse result = apiInstance.deleteIncidentType(id);
System.out.println(result);
@@ -127,7 +198,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -176,7 +247,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
IncidentTypesApi apiInstance = new IncidentTypesApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
IncidentTypeResponse result = apiInstance.getIncidentType(id);
System.out.println(result);
@@ -195,7 +266,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -213,9 +284,96 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **200** | incident_type found | - |
+| **200** | incident_type found by slug | - |
| **404** | resource not found | - |
+
+# **listIncidentTypeCatalogProperties**
+> CatalogPropertyList listIncidentTypeCatalogProperties(include, sort, pageNumber, pageSize, filterSlug, filterName, filterKind, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte)
+
+List Catalog Properties
+
+List IncidentType Catalog Properties
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.IncidentTypesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ IncidentTypesApi apiInstance = new IncidentTypesApi(defaultClient);
+ String include = "catalog"; // String | comma separated if needed. eg: catalog
+ String sort = "created_at"; // String | comma separated if needed. eg: created_at,updated_at
+ Integer pageNumber = 56; // Integer |
+ Integer pageSize = 56; // Integer |
+ String filterSlug = "filterSlug_example"; // String |
+ String filterName = "filterName_example"; // String |
+ String filterKind = "filterKind_example"; // String |
+ String filterCreatedAtGt = "filterCreatedAtGt_example"; // String |
+ String filterCreatedAtGte = "filterCreatedAtGte_example"; // String |
+ String filterCreatedAtLt = "filterCreatedAtLt_example"; // String |
+ String filterCreatedAtLte = "filterCreatedAtLte_example"; // String |
+ try {
+ CatalogPropertyList result = apiInstance.listIncidentTypeCatalogProperties(include, sort, pageNumber, pageSize, filterSlug, filterName, filterKind, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling IncidentTypesApi#listIncidentTypeCatalogProperties");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **include** | **String**| comma separated if needed. eg: catalog | [optional] [enum: catalog] |
+| **sort** | **String**| comma separated if needed. eg: created_at,updated_at | [optional] [enum: created_at, -created_at, updated_at, -updated_at, position, -position] |
+| **pageNumber** | **Integer**| | [optional] |
+| **pageSize** | **Integer**| | [optional] |
+| **filterSlug** | **String**| | [optional] |
+| **filterName** | **String**| | [optional] |
+| **filterKind** | **String**| | [optional] |
+| **filterCreatedAtGt** | **String**| | [optional] |
+| **filterCreatedAtGte** | **String**| | [optional] |
+| **filterCreatedAtLt** | **String**| | [optional] |
+| **filterCreatedAtLte** | **String**| | [optional] |
+
+### Return type
+
+[**CatalogPropertyList**](CatalogPropertyList.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | success | - |
+
# **listIncidentTypes**
> IncidentTypeList listIncidentTypes(include, pageNumber, pageSize, filterSlug, filterName, filterColor, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, sort)
@@ -331,7 +489,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
IncidentTypesApi apiInstance = new IncidentTypesApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
UpdateIncidentType updateIncidentType = new UpdateIncidentType(); // UpdateIncidentType |
try {
IncidentTypeResponse result = apiInstance.updateIncidentType(id, updateIncidentType);
@@ -351,7 +509,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
| **updateIncidentType** | [**UpdateIncidentType**](UpdateIncidentType.md)| | |
### Return type
diff --git a/docs/IncidentZoomMeetingGlobalDialInNumbersInner.md b/docs/IncidentZoomMeetingGlobalDialInNumbersInner.md
new file mode 100644
index 00000000..35059e08
--- /dev/null
+++ b/docs/IncidentZoomMeetingGlobalDialInNumbersInner.md
@@ -0,0 +1,17 @@
+
+
+# IncidentZoomMeetingGlobalDialInNumbersInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**country** | **String** | | [optional] |
+|**countryName** | **String** | | [optional] |
+|**city** | **String** | | [optional] |
+|**number** | **String** | | [optional] |
+|**type** | **String** | | [optional] |
+
+
+
diff --git a/docs/IncidentsApi.md b/docs/IncidentsApi.md
index e57ee716..8180af6a 100644
--- a/docs/IncidentsApi.md
+++ b/docs/IncidentsApi.md
@@ -9,6 +9,7 @@ All URIs are relative to *https://api.rootly.com*
| [**cancelIncident**](IncidentsApi.md#cancelIncident) | **PUT** /v1/incidents/{id}/cancel | Cancel an incident |
| [**createIncident**](IncidentsApi.md#createIncident) | **POST** /v1/incidents | Creates an incident |
| [**deleteIncident**](IncidentsApi.md#deleteIncident) | **DELETE** /v1/incidents/{id} | Delete an incident |
+| [**detachFromParentIncident**](IncidentsApi.md#detachFromParentIncident) | **PUT** /v1/incidents/{id}/detach_from_parent | Detach an incident from its parent |
| [**getIncident**](IncidentsApi.md#getIncident) | **GET** /v1/incidents/{id} | Retrieves an incident |
| [**listIncidents**](IncidentsApi.md#listIncidents) | **GET** /v1/incidents | List incidents |
| [**markAsDuplicateIncident**](IncidentsApi.md#markAsDuplicateIncident) | **PUT** /v1/incidents/{id}/duplicate | Mark an incident as a duplicate |
@@ -18,6 +19,7 @@ All URIs are relative to *https://api.rootly.com*
| [**resolveIncident**](IncidentsApi.md#resolveIncident) | **PUT** /v1/incidents/{id}/resolve | Resolve an incident |
| [**restartIncident**](IncidentsApi.md#restartIncident) | **PUT** /v1/incidents/{id}/restart | Restart an incident |
| [**triageIncident**](IncidentsApi.md#triageIncident) | **PUT** /v1/incidents/{id}/in_triage | Triage an incident |
+| [**unmarkAsDuplicateIncident**](IncidentsApi.md#unmarkAsDuplicateIncident) | **PUT** /v1/incidents/{id}/unmark_as_duplicate | Remove duplicate marking from an incident |
| [**updateIncident**](IncidentsApi.md#updateIncident) | **PUT** /v1/incidents/{id} | Update an incident |
@@ -49,7 +51,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
IncidentsApi apiInstance = new IncidentsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
AddSubscribers addSubscribers = new AddSubscribers(); // AddSubscribers |
try {
IncidentResponse result = apiInstance.addSubscribersToIncident(id, addSubscribers);
@@ -69,7 +71,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
| **addSubscribers** | [**AddSubscribers**](AddSubscribers.md)| | |
### Return type
@@ -119,7 +121,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
IncidentsApi apiInstance = new IncidentsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
AssignRoleToUser assignRoleToUser = new AssignRoleToUser(); // AssignRoleToUser |
try {
IncidentResponse result = apiInstance.assignUserToIncident(id, assignRoleToUser);
@@ -139,7 +141,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
| **assignRoleToUser** | [**AssignRoleToUser**](AssignRoleToUser.md)| | |
### Return type
@@ -189,7 +191,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
IncidentsApi apiInstance = new IncidentsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
CancelIncident cancelIncident = new CancelIncident(); // CancelIncident |
try {
IncidentResponse result = apiInstance.cancelIncident(id, cancelIncident);
@@ -209,7 +211,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
| **cancelIncident** | [**CancelIncident**](CancelIncident.md)| | |
### Return type
@@ -328,7 +330,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
IncidentsApi apiInstance = new IncidentsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
IncidentResponse result = apiInstance.deleteIncident(id);
System.out.println(result);
@@ -347,7 +349,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -368,6 +370,75 @@ public class Example {
| **200** | incident deleted | - |
| **404** | resource not found | - |
+
+# **detachFromParentIncident**
+> IncidentResponse detachFromParentIncident(id)
+
+Detach an incident from its parent
+
+Detach a sub-incident from its parent incident
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.IncidentsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ IncidentsApi apiInstance = new IncidentsApi(defaultClient);
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
+ try {
+ IncidentResponse result = apiInstance.detachFromParentIncident(id);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling IncidentsApi#detachFromParentIncident");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
+
+### Return type
+
+[**IncidentResponse**](IncidentResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | incident detached from parent | - |
+| **422** | incident has no parent | - |
+| **404** | resource not found | - |
+
# **getIncident**
> IncidentResponse getIncident(id, include)
@@ -396,7 +467,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
IncidentsApi apiInstance = new IncidentsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
String include = "sub_statuses"; // String | comma separated if needed. eg: sub_statuses,causes,subscribers
try {
IncidentResponse result = apiInstance.getIncident(id, include);
@@ -416,8 +487,8 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
-| **include** | **String**| comma separated if needed. eg: sub_statuses,causes,subscribers | [optional] [enum: sub_statuses, causes, subscribers, roles, slack_messages, environments, incident_types, services, functionalities, groups, events, action_items, custom_field_selections, feedbacks, incident_post_mortem] |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
+| **include** | **String**| comma separated if needed. eg: sub_statuses,causes,subscribers | [optional] [enum: sub_statuses, causes, subscribers, roles, slack_messages, environments, incident_types, services, functionalities, groups, events, action_items, custom_field_selections, feedbacks, incident_post_mortem, alerts] |
### Return type
@@ -435,12 +506,12 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **200** | incident found | - |
+| **200** | incident found by slug | - |
| **404** | resource not found | - |
# **listIncidents**
-> IncidentList listIncidents(pageNumber, pageSize, filterSearch, filterKind, filterStatus, filterPrivate, filterUserId, filterSeverity, filterSeverityId, filterLabels, filterTypes, filterTypeIds, filterEnvironments, filterEnvironmentIds, filterFunctionalities, filterFunctionalityIds, filterServices, filterServiceIds, filterTeams, filterTeamIds, filterCause, filterCauseIds, filterCustomFieldSelectedOptionIds, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, filterUpdatedAtGt, filterUpdatedAtGte, filterUpdatedAtLt, filterUpdatedAtLte, filterStartedAtGt, filterStartedAtGte, filterStartedAtLt, filterStartedAtLte, filterDetectedAtGt, filterDetectedAtGte, filterDetectedAtLt, filterDetectedAtLte, filterAcknowledgedAtGt, filterAcknowledgedAtGte, filterAcknowledgedAtLt, filterAcknowledgedAtLte, filterMitigatedAtGt, filterMitigatedAtGte, filterMitigatedAtLt, filterMitigatedAtLte, filterResolvedAtGt, filterResolvedAtGte, filterResolvedAtLt, filterResolvedAtLte, filterClosedAtGt, filterClosedAtGte, filterClosedAtLt, filterClosedAtLte, filterInTriageAtGt, filterInTriageAtGte, filterInTriageAtLt, filterInTriageAtLte, sort, include)
+> IncidentList listIncidents(pageNumber, pageSize, filterSearch, filterKind, filterStatus, filterPrivate, filterUserId, filterSeverity, filterSeverityId, filterLabels, filterTypes, filterTypeIds, filterEnvironments, filterEnvironmentIds, filterFunctionalities, filterFunctionalityIds, filterFunctionalityNames, filterServices, filterServiceIds, filterServiceNames, filterTeams, filterTeamIds, filterTeamNames, filterCause, filterCauseIds, filterCustomFieldSelectedOptionIds, filterSlackChannelId, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, filterUpdatedAtGt, filterUpdatedAtGte, filterUpdatedAtLt, filterUpdatedAtLte, filterStartedAtGt, filterStartedAtGte, filterStartedAtLt, filterStartedAtLte, filterDetectedAtGt, filterDetectedAtGte, filterDetectedAtLt, filterDetectedAtLte, filterAcknowledgedAtGt, filterAcknowledgedAtGte, filterAcknowledgedAtLt, filterAcknowledgedAtLte, filterMitigatedAtGt, filterMitigatedAtGte, filterMitigatedAtLt, filterMitigatedAtLte, filterResolvedAtGt, filterResolvedAtGte, filterResolvedAtLt, filterResolvedAtLte, filterClosedAtGt, filterClosedAtGte, filterClosedAtLt, filterClosedAtLte, filterInTriageAtGt, filterInTriageAtGte, filterInTriageAtLt, filterInTriageAtLte, sort, include)
List incidents
@@ -482,13 +553,17 @@ public class Example {
String filterEnvironmentIds = "filterEnvironmentIds_example"; // String |
String filterFunctionalities = "filterFunctionalities_example"; // String |
String filterFunctionalityIds = "filterFunctionalityIds_example"; // String |
+ String filterFunctionalityNames = "filterFunctionalityNames_example"; // String |
String filterServices = "filterServices_example"; // String |
String filterServiceIds = "filterServiceIds_example"; // String |
+ String filterServiceNames = "filterServiceNames_example"; // String |
String filterTeams = "filterTeams_example"; // String |
String filterTeamIds = "filterTeamIds_example"; // String |
+ String filterTeamNames = "filterTeamNames_example"; // String |
String filterCause = "filterCause_example"; // String |
String filterCauseIds = "filterCauseIds_example"; // String |
String filterCustomFieldSelectedOptionIds = "filterCustomFieldSelectedOptionIds_example"; // String |
+ String filterSlackChannelId = "filterSlackChannelId_example"; // String |
String filterCreatedAtGt = "filterCreatedAtGt_example"; // String |
String filterCreatedAtGte = "filterCreatedAtGte_example"; // String |
String filterCreatedAtLt = "filterCreatedAtLt_example"; // String |
@@ -528,7 +603,7 @@ public class Example {
String sort = "created_at"; // String | comma separated if needed. eg: created_at,updated_at
String include = "sub_statuses"; // String | comma separated if needed. eg: sub_statuses,causes,subscribers
try {
- IncidentList result = apiInstance.listIncidents(pageNumber, pageSize, filterSearch, filterKind, filterStatus, filterPrivate, filterUserId, filterSeverity, filterSeverityId, filterLabels, filterTypes, filterTypeIds, filterEnvironments, filterEnvironmentIds, filterFunctionalities, filterFunctionalityIds, filterServices, filterServiceIds, filterTeams, filterTeamIds, filterCause, filterCauseIds, filterCustomFieldSelectedOptionIds, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, filterUpdatedAtGt, filterUpdatedAtGte, filterUpdatedAtLt, filterUpdatedAtLte, filterStartedAtGt, filterStartedAtGte, filterStartedAtLt, filterStartedAtLte, filterDetectedAtGt, filterDetectedAtGte, filterDetectedAtLt, filterDetectedAtLte, filterAcknowledgedAtGt, filterAcknowledgedAtGte, filterAcknowledgedAtLt, filterAcknowledgedAtLte, filterMitigatedAtGt, filterMitigatedAtGte, filterMitigatedAtLt, filterMitigatedAtLte, filterResolvedAtGt, filterResolvedAtGte, filterResolvedAtLt, filterResolvedAtLte, filterClosedAtGt, filterClosedAtGte, filterClosedAtLt, filterClosedAtLte, filterInTriageAtGt, filterInTriageAtGte, filterInTriageAtLt, filterInTriageAtLte, sort, include);
+ IncidentList result = apiInstance.listIncidents(pageNumber, pageSize, filterSearch, filterKind, filterStatus, filterPrivate, filterUserId, filterSeverity, filterSeverityId, filterLabels, filterTypes, filterTypeIds, filterEnvironments, filterEnvironmentIds, filterFunctionalities, filterFunctionalityIds, filterFunctionalityNames, filterServices, filterServiceIds, filterServiceNames, filterTeams, filterTeamIds, filterTeamNames, filterCause, filterCauseIds, filterCustomFieldSelectedOptionIds, filterSlackChannelId, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, filterUpdatedAtGt, filterUpdatedAtGte, filterUpdatedAtLt, filterUpdatedAtLte, filterStartedAtGt, filterStartedAtGte, filterStartedAtLt, filterStartedAtLte, filterDetectedAtGt, filterDetectedAtGte, filterDetectedAtLt, filterDetectedAtLte, filterAcknowledgedAtGt, filterAcknowledgedAtGte, filterAcknowledgedAtLt, filterAcknowledgedAtLte, filterMitigatedAtGt, filterMitigatedAtGte, filterMitigatedAtLt, filterMitigatedAtLte, filterResolvedAtGt, filterResolvedAtGte, filterResolvedAtLt, filterResolvedAtLte, filterClosedAtGt, filterClosedAtGte, filterClosedAtLt, filterClosedAtLte, filterInTriageAtGt, filterInTriageAtGte, filterInTriageAtLt, filterInTriageAtLte, sort, include);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IncidentsApi#listIncidents");
@@ -561,13 +636,17 @@ public class Example {
| **filterEnvironmentIds** | **String**| | [optional] |
| **filterFunctionalities** | **String**| | [optional] |
| **filterFunctionalityIds** | **String**| | [optional] |
+| **filterFunctionalityNames** | **String**| | [optional] |
| **filterServices** | **String**| | [optional] |
| **filterServiceIds** | **String**| | [optional] |
+| **filterServiceNames** | **String**| | [optional] |
| **filterTeams** | **String**| | [optional] |
| **filterTeamIds** | **String**| | [optional] |
+| **filterTeamNames** | **String**| | [optional] |
| **filterCause** | **String**| | [optional] |
| **filterCauseIds** | **String**| | [optional] |
| **filterCustomFieldSelectedOptionIds** | **String**| | [optional] |
+| **filterSlackChannelId** | **String**| | [optional] |
| **filterCreatedAtGt** | **String**| | [optional] |
| **filterCreatedAtGte** | **String**| | [optional] |
| **filterCreatedAtLt** | **String**| | [optional] |
@@ -604,8 +683,8 @@ public class Example {
| **filterInTriageAtGte** | **String**| | [optional] |
| **filterInTriageAtLt** | **String**| | [optional] |
| **filterInTriageAtLte** | **String**| | [optional] |
-| **sort** | **String**| comma separated if needed. eg: created_at,updated_at | [optional] [enum: created_at, -created_at, updated_at, -updated_at] |
-| **include** | **String**| comma separated if needed. eg: sub_statuses,causes,subscribers | [optional] [enum: sub_statuses, causes, subscribers, roles, slack_messages, environments, incident_types, services, functionalities, groups, events, action_items, custom_field_selections, feedbacks, incident_post_mortem] |
+| **sort** | **String**| comma separated if needed. eg: created_at,updated_at | [optional] [enum: created_at, -created_at, updated_at, -updated_at, started_at, -started_at, in_triage_at, -in_triage_at, mitigated_at, -mitigated_at, resolved_at, -resolved_at] |
+| **include** | **String**| comma separated if needed. eg: sub_statuses,causes,subscribers | [optional] [enum: sub_statuses, causes, subscribers, roles, slack_messages, environments, incident_types, services, functionalities, groups, events, action_items, custom_field_selections, feedbacks, incident_post_mortem, alerts] |
### Return type
@@ -653,7 +732,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
IncidentsApi apiInstance = new IncidentsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
ResolveIncident resolveIncident = new ResolveIncident(); // ResolveIncident |
try {
IncidentResponse result = apiInstance.markAsDuplicateIncident(id, resolveIncident);
@@ -673,7 +752,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
| **resolveIncident** | [**ResolveIncident**](ResolveIncident.md)| | |
### Return type
@@ -723,7 +802,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
IncidentsApi apiInstance = new IncidentsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
MitigateIncident mitigateIncident = new MitigateIncident(); // MitigateIncident |
try {
IncidentResponse result = apiInstance.mitigateIncident(id, mitigateIncident);
@@ -743,7 +822,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
| **mitigateIncident** | [**MitigateIncident**](MitigateIncident.md)| | |
### Return type
@@ -793,7 +872,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
IncidentsApi apiInstance = new IncidentsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
UnassignRoleFromUser unassignRoleFromUser = new UnassignRoleFromUser(); // UnassignRoleFromUser |
try {
IncidentResponse result = apiInstance.removeAssignedUserFromIncident(id, unassignRoleFromUser);
@@ -813,7 +892,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
| **unassignRoleFromUser** | [**UnassignRoleFromUser**](UnassignRoleFromUser.md)| | |
### Return type
@@ -863,7 +942,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
IncidentsApi apiInstance = new IncidentsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
RemoveSubscribers removeSubscribers = new RemoveSubscribers(); // RemoveSubscribers |
try {
IncidentResponse result = apiInstance.removeSubscribersToIncident(id, removeSubscribers);
@@ -883,7 +962,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
| **removeSubscribers** | [**RemoveSubscribers**](RemoveSubscribers.md)| | |
### Return type
@@ -933,7 +1012,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
IncidentsApi apiInstance = new IncidentsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
ResolveIncident resolveIncident = new ResolveIncident(); // ResolveIncident |
try {
IncidentResponse result = apiInstance.resolveIncident(id, resolveIncident);
@@ -953,7 +1032,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
| **resolveIncident** | [**ResolveIncident**](ResolveIncident.md)| | |
### Return type
@@ -1003,7 +1082,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
IncidentsApi apiInstance = new IncidentsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
RestartIncident restartIncident = new RestartIncident(); // RestartIncident |
try {
IncidentResponse result = apiInstance.restartIncident(id, restartIncident);
@@ -1023,7 +1102,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
| **restartIncident** | [**RestartIncident**](RestartIncident.md)| | |
### Return type
@@ -1073,7 +1152,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
IncidentsApi apiInstance = new IncidentsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
InTriageIncident inTriageIncident = new InTriageIncident(); // InTriageIncident |
try {
IncidentResponse result = apiInstance.triageIncident(id, inTriageIncident);
@@ -1093,7 +1172,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
| **inTriageIncident** | [**InTriageIncident**](InTriageIncident.md)| | |
### Return type
@@ -1115,6 +1194,75 @@ public class Example {
| **200** | incident set to triage | - |
| **404** | resource not found | - |
+
+# **unmarkAsDuplicateIncident**
+> IncidentResponse unmarkAsDuplicateIncident(id)
+
+Remove duplicate marking from an incident
+
+Remove the duplicate marking from an incident
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.IncidentsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ IncidentsApi apiInstance = new IncidentsApi(defaultClient);
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
+ try {
+ IncidentResponse result = apiInstance.unmarkAsDuplicateIncident(id);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling IncidentsApi#unmarkAsDuplicateIncident");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
+
+### Return type
+
+[**IncidentResponse**](IncidentResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | duplicate marking removed | - |
+| **422** | incident is not marked as duplicate | - |
+| **404** | resource not found | - |
+
# **updateIncident**
> IncidentResponse updateIncident(id, updateIncident)
@@ -1143,7 +1291,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
IncidentsApi apiInstance = new IncidentsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
UpdateIncident updateIncident = new UpdateIncident(); // UpdateIncident |
try {
IncidentResponse result = apiInstance.updateIncident(id, updateIncident);
@@ -1163,7 +1311,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
| **updateIncident** | [**UpdateIncident**](UpdateIncident.md)| | |
### Return type
diff --git a/docs/LiveCallRouter.md b/docs/LiveCallRouter.md
index 14a53558..14fab557 100644
--- a/docs/LiveCallRouter.md
+++ b/docs/LiveCallRouter.md
@@ -15,12 +15,14 @@
|**phoneNumber** | **String** | You can select a phone number using [generate_phone_number](#//api/v1/live_call_routers/generate_phone_number) API and pass that phone number here to register | [optional] |
|**voicemailGreeting** | **String** | The voicemail greeting of the live_call_router | [optional] |
|**callerGreeting** | **String** | The caller greeting message of the live_call_router | [optional] |
-|**waitingMusicUrl** | **String** | The waiting music URL of the live_call_router | [optional] |
+|**waitingMusicUrl** | [**WaitingMusicUrlEnum**](#WaitingMusicUrlEnum) | The waiting music URL of the live_call_router | [optional] |
|**sentToVoicemailDelay** | **Integer** | The delay (seconds) after which the caller in redirected to voicemail | [optional] |
|**shouldRedirectToVoicemailOnNoAnswer** | **Boolean** | This prompts the caller to choose voicemail or connect live | [optional] |
|**escalationLevelDelayInSeconds** | **Integer** | This overrides the delay (seconds) in escalation levels | [optional] |
|**shouldAutoResolveAlertOnCallEnd** | **Boolean** | This overrides the delay (seconds) in escalation levels | [optional] |
|**alertUrgencyId** | **String** | This is used in escalation paths to determine who to page | [optional] |
+|**callingTreePrompt** | **String** | The audio instructions callers will hear when they call this number, prompting them to select from available options to route their call | [optional] |
+|**pagingTargets** | [**List<NewLiveCallRouterDataAttributesPagingTargetsInner>**](NewLiveCallRouterDataAttributesPagingTargetsInner.md) | Paging targets that callers can select from when this live call router is configured as a phone tree. | [optional] |
|**escalationPolicyTriggerParams** | [**UpdateLiveCallRouterDataAttributesEscalationPolicyTriggerParams**](UpdateLiveCallRouterDataAttributesEscalationPolicyTriggerParams.md) | | [optional] |
|**createdAt** | **String** | Date of creation | |
|**updatedAt** | **String** | Date of last update | |
@@ -40,11 +42,14 @@
| Name | Value |
|---- | -----|
-| US | "US" |
-| GB | "GB" |
-| NZ | "NZ" |
-| CA | "CA" |
| AU | "AU" |
+| CA | "CA" |
+| DE | "DE" |
+| NL | "NL" |
+| NZ | "NZ" |
+| SE | "SE" |
+| GB | "GB" |
+| US | "US" |
@@ -54,6 +59,21 @@
|---- | -----|
| LOCAL | "local" |
| TOLL_FREE | "toll_free" |
+| MOBILE | "mobile" |
+
+
+
+## Enum: WaitingMusicUrlEnum
+
+| Name | Value |
+|---- | -----|
+| HTTPS_STORAGE_ROOTLY_COM_TWILIO_VOICEMAIL_CLOCKWORK_WALTZ_MP3 | "https://storage.rootly.com/twilio/voicemail/ClockworkWaltz.mp3" |
+| HTTPS_STORAGE_ROOTLY_COM_TWILIO_VOICEMAIL_ITH_BRAHMS_116_4_MP3 | "https://storage.rootly.com/twilio/voicemail/ith_brahms-116-4.mp3" |
+| HTTPS_STORAGE_ROOTLY_COM_TWILIO_VOICEMAIL_MELLOTRONIAC___FLIGHT_OF_YOUNG_HEARTS_FLUTE_MP3 | "https://storage.rootly.com/twilio/voicemail/Mellotroniac_-_Flight_Of_Young_Hearts_Flute.mp3" |
+| HTTPS_STORAGE_ROOTLY_COM_TWILIO_VOICEMAIL_BUSY_STRINGS_MP3 | "https://storage.rootly.com/twilio/voicemail/BusyStrings.mp3" |
+| HTTPS_STORAGE_ROOTLY_COM_TWILIO_VOICEMAIL_OLD_DOG___ENDLESS_GOODBYE__28INSTR_29_MP3 | "https://storage.rootly.com/twilio/voicemail/oldDog_-_endless_goodbye_%28instr.%29.mp3" |
+| HTTPS_STORAGE_ROOTLY_COM_TWILIO_VOICEMAIL_MARKOVICHAMP_BORGHESTRAL_MP3 | "https://storage.rootly.com/twilio/voicemail/MARKOVICHAMP-Borghestral.mp3" |
+| HTTPS_STORAGE_ROOTLY_COM_TWILIO_VOICEMAIL_ITH_CHOPIN_15_2_MP3 | "https://storage.rootly.com/twilio/voicemail/ith_chopin-15-2.mp3" |
diff --git a/docs/LiveCallRouterList.md b/docs/LiveCallRouterList.md
index a28aacaf..fa47c79c 100644
--- a/docs/LiveCallRouterList.md
+++ b/docs/LiveCallRouterList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<LiveCallRouterResponseData>**](LiveCallRouterResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/LiveCallRoutersApi.md b/docs/LiveCallRoutersApi.md
index 2e662d82..364a7e88 100644
--- a/docs/LiveCallRoutersApi.md
+++ b/docs/LiveCallRoutersApi.md
@@ -77,7 +77,7 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **201** | live_call_router created | - |
+| **201** | live_call_router created with multiple targets without calling_tree_enabled (backward compat) | - |
| **422** | invalid request | - |
| **401** | responds with unauthorized for invalid token | - |
@@ -177,7 +177,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
LiveCallRoutersApi apiInstance = new LiveCallRoutersApi(defaultClient);
- String countryCode = "US"; // String |
+ String countryCode = "AU"; // String |
String phoneType = "local"; // String |
try {
apiInstance.generatePhoneNumberLiveCallRouter(countryCode, phoneType);
@@ -196,8 +196,8 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **countryCode** | **String**| | [enum: US, GB, NZ, CA, AU] |
-| **phoneType** | **String**| | [enum: local, toll_free] |
+| **countryCode** | **String**| | [enum: AU, CA, DE, NL, NZ, SE, GB, US] |
+| **phoneType** | **String**| | [enum: local, toll_free, mobile] |
### Return type
diff --git a/docs/MeetingRecording.md b/docs/MeetingRecording.md
new file mode 100644
index 00000000..bcfb6962
--- /dev/null
+++ b/docs/MeetingRecording.md
@@ -0,0 +1,49 @@
+
+
+# MeetingRecording
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**platform** | [**PlatformEnum**](#PlatformEnum) | Meeting platform | |
+|**sessionNumber** | **Integer** | Session number within the incident for this platform (starts at 1, increments on re-invite) | |
+|**status** | [**StatusEnum**](#StatusEnum) | Current recording lifecycle status | |
+|**startedAt** | **OffsetDateTime** | When the bot started recording (null if bot never joined) | [optional] |
+|**endedAt** | **OffsetDateTime** | When the recording ended | [optional] |
+|**durationMinutes** | **BigDecimal** | Recording duration in minutes (null if not started) | [optional] |
+|**speakerCount** | **Integer** | Number of unique speakers detected in the transcript | [optional] |
+|**wordCount** | **Integer** | Total word count across all transcript segments | [optional] |
+|**transcriptSummary** | **String** | AI-generated summary of the meeting transcript (null if no transcript or not yet analyzed) | [optional] |
+|**hasVideo** | **Boolean** | Whether a video recording file is attached | [optional] |
+|**createdAt** | **OffsetDateTime** | When the recording session was created | |
+|**updatedAt** | **OffsetDateTime** | When the recording session was last updated | |
+
+
+
+## Enum: PlatformEnum
+
+| Name | Value |
+|---- | -----|
+| ZOOM | "zoom" |
+| GOOGLE_MEET | "google_meet" |
+| MICROSOFT_TEAMS | "microsoft_teams" |
+| WEBEX | "webex" |
+
+
+
+## Enum: StatusEnum
+
+| Name | Value |
+|---- | -----|
+| PENDING | "pending" |
+| RECORDING | "recording" |
+| PAUSED | "paused" |
+| CALL_ENDED | "call_ended" |
+| ANALYZING | "analyzing" |
+| COMPLETED | "completed" |
+| FAILED | "failed" |
+
+
+
diff --git a/docs/MeetingRecordingList.md b/docs/MeetingRecordingList.md
new file mode 100644
index 00000000..5dc06479
--- /dev/null
+++ b/docs/MeetingRecordingList.md
@@ -0,0 +1,14 @@
+
+
+# MeetingRecordingList
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<MeetingRecordingListDataInner>**](MeetingRecordingListDataInner.md) | | |
+|**meta** | [**Meta**](Meta.md) | | [optional] |
+
+
+
diff --git a/docs/MeetingRecordingListDataInner.md b/docs/MeetingRecordingListDataInner.md
new file mode 100644
index 00000000..c7128239
--- /dev/null
+++ b/docs/MeetingRecordingListDataInner.md
@@ -0,0 +1,23 @@
+
+
+# MeetingRecordingListDataInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | Unique UUID of the meeting recording | |
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**MeetingRecording**](MeetingRecording.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| MEETING_RECORDINGS | "meeting_recordings" |
+
+
+
diff --git a/docs/MeetingRecordingsApi.md b/docs/MeetingRecordingsApi.md
new file mode 100644
index 00000000..c4a89a12
--- /dev/null
+++ b/docs/MeetingRecordingsApi.md
@@ -0,0 +1,627 @@
+# MeetingRecordingsApi
+
+All URIs are relative to *https://api.rootly.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createMeetingRecording**](MeetingRecordingsApi.md#createMeetingRecording) | **POST** /v1/incidents/{incident_id}/meeting_recordings | Create meeting recording |
+| [**deleteMeetingRecording**](MeetingRecordingsApi.md#deleteMeetingRecording) | **DELETE** /v1/meeting_recordings/{id} | Delete a meeting recording |
+| [**deleteMeetingRecordingVideo**](MeetingRecordingsApi.md#deleteMeetingRecordingVideo) | **DELETE** /v1/meeting_recordings/{id}/delete_video | Delete video from a meeting recording |
+| [**getMeetingRecording**](MeetingRecordingsApi.md#getMeetingRecording) | **GET** /v1/meeting_recordings/{id} | Get a meeting recording |
+| [**leaveMeetingRecording**](MeetingRecordingsApi.md#leaveMeetingRecording) | **POST** /v1/meeting_recordings/{id}/leave | Leave a meeting call |
+| [**listMeetingRecordings**](MeetingRecordingsApi.md#listMeetingRecordings) | **GET** /v1/incidents/{incident_id}/meeting_recordings | List meeting recordings |
+| [**pauseMeetingRecording**](MeetingRecordingsApi.md#pauseMeetingRecording) | **POST** /v1/meeting_recordings/{id}/pause | Pause a meeting recording |
+| [**resumeMeetingRecording**](MeetingRecordingsApi.md#resumeMeetingRecording) | **POST** /v1/meeting_recordings/{id}/resume | Resume a meeting recording |
+| [**stopMeetingRecording**](MeetingRecordingsApi.md#stopMeetingRecording) | **POST** /v1/meeting_recordings/{id}/stop | Stop a meeting recording |
+
+
+
+# **createMeetingRecording**
+> createMeetingRecording(incidentId, platform)
+
+Create meeting recording
+
+Invite a recording bot to the incident's meeting. If no previous recordings exist for the platform, a new bot is invited (session 1). If previous sessions exist, a new session is created (re-invite). The bot joins the meeting, records audio/video, and generates a transcript when the session ends.
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.MeetingRecordingsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ MeetingRecordingsApi apiInstance = new MeetingRecordingsApi(defaultClient);
+ String incidentId = "incidentId_example"; // String | Incident UUID
+ String platform = "zoom"; // String | Meeting platform
+ try {
+ apiInstance.createMeetingRecording(incidentId, platform);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling MeetingRecordingsApi#createMeetingRecording");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **incidentId** | **String**| Incident UUID | |
+| **platform** | **String**| Meeting platform | [optional] [enum: zoom, google_meet, microsoft_teams, webex] |
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | recording session created | - |
+| **422** | validation error (e.g. bot already active) | - |
+
+
+# **deleteMeetingRecording**
+> deleteMeetingRecording(id)
+
+Delete a meeting recording
+
+Delete a meeting recording. Only completed or failed recordings can be deleted. Active recordings (pending, recording, paused) must be stopped first.
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.MeetingRecordingsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ MeetingRecordingsApi apiInstance = new MeetingRecordingsApi(defaultClient);
+ String id = "id_example"; // String | Meeting Recording UUID
+ try {
+ apiInstance.deleteMeetingRecording(id);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling MeetingRecordingsApi#deleteMeetingRecording");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| Meeting Recording UUID | |
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | meeting recording deleted | - |
+| **422** | cannot delete active recording | - |
+
+
+# **deleteMeetingRecordingVideo**
+> deleteMeetingRecordingVideo(id)
+
+Delete video from a meeting recording
+
+Delete only the video file from a meeting recording. The transcript, summary, and all metadata are preserved. Only non-active recordings with an attached video can have their video deleted.
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.MeetingRecordingsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ MeetingRecordingsApi apiInstance = new MeetingRecordingsApi(defaultClient);
+ String id = "id_example"; // String | Meeting Recording UUID
+ try {
+ apiInstance.deleteMeetingRecordingVideo(id);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling MeetingRecordingsApi#deleteMeetingRecordingVideo");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| Meeting Recording UUID | |
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | video deleted | - |
+| **422** | cannot delete video (active recording or no video) | - |
+
+
+# **getMeetingRecording**
+> getMeetingRecording(id)
+
+Get a meeting recording
+
+Retrieve a single meeting recording session including its status, duration, speaker count, word count, and transcript summary.
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.MeetingRecordingsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ MeetingRecordingsApi apiInstance = new MeetingRecordingsApi(defaultClient);
+ String id = "id_example"; // String | Meeting Recording UUID
+ try {
+ apiInstance.getMeetingRecording(id);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling MeetingRecordingsApi#getMeetingRecording");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| Meeting Recording UUID | |
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | meeting recording found | - |
+| **404** | meeting recording not found | - |
+
+
+# **leaveMeetingRecording**
+> leaveMeetingRecording(id)
+
+Leave a meeting call
+
+Remove the recording bot from the meeting entirely. Unlike stop, this immediately disconnects the bot. The session will transition to analyzing and then completed once transcript processing finishes.
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.MeetingRecordingsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ MeetingRecordingsApi apiInstance = new MeetingRecordingsApi(defaultClient);
+ String id = "id_example"; // String | Meeting Recording UUID
+ try {
+ apiInstance.leaveMeetingRecording(id);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling MeetingRecordingsApi#leaveMeetingRecording");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| Meeting Recording UUID | |
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | bot left the call | - |
+| **422** | bot is not in a call | - |
+
+
+# **listMeetingRecordings**
+> MeetingRecordingList listMeetingRecordings(incidentId, pageNumber, pageSize)
+
+List meeting recordings
+
+List all meeting recording sessions for an incident. Returns recordings sorted by session number. Each recording represents one bot session with its own transcript, status, and metadata.
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.MeetingRecordingsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ MeetingRecordingsApi apiInstance = new MeetingRecordingsApi(defaultClient);
+ String incidentId = "incidentId_example"; // String | Incident UUID
+ Integer pageNumber = 56; // Integer | Page number
+ Integer pageSize = 56; // Integer | Number of recordings per page
+ try {
+ MeetingRecordingList result = apiInstance.listMeetingRecordings(incidentId, pageNumber, pageSize);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling MeetingRecordingsApi#listMeetingRecordings");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **incidentId** | **String**| Incident UUID | |
+| **pageNumber** | **Integer**| Page number | [optional] |
+| **pageSize** | **Integer**| Number of recordings per page | [optional] |
+
+### Return type
+
+[**MeetingRecordingList**](MeetingRecordingList.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | meeting recordings listed | - |
+| **404** | incident not found | - |
+
+
+# **pauseMeetingRecording**
+> pauseMeetingRecording(id)
+
+Pause a meeting recording
+
+Pause an active recording session. The bot remains in the meeting but stops capturing audio/video. Use the resume endpoint to continue recording.
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.MeetingRecordingsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ MeetingRecordingsApi apiInstance = new MeetingRecordingsApi(defaultClient);
+ String id = "id_example"; // String | Meeting Recording UUID
+ try {
+ apiInstance.pauseMeetingRecording(id);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling MeetingRecordingsApi#pauseMeetingRecording");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| Meeting Recording UUID | |
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | recording paused | - |
+| **422** | recording is not active | - |
+
+
+# **resumeMeetingRecording**
+> resumeMeetingRecording(id)
+
+Resume a meeting recording
+
+Resume a paused recording session. The bot continues capturing audio/video from the meeting.
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.MeetingRecordingsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ MeetingRecordingsApi apiInstance = new MeetingRecordingsApi(defaultClient);
+ String id = "id_example"; // String | Meeting Recording UUID
+ try {
+ apiInstance.resumeMeetingRecording(id);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling MeetingRecordingsApi#resumeMeetingRecording");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| Meeting Recording UUID | |
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | recording resumed | - |
+| **422** | recording is not paused | - |
+
+
+# **stopMeetingRecording**
+> stopMeetingRecording(id)
+
+Stop a meeting recording
+
+Stop an active or paused recording. The bot finishes processing, generates a transcript, and the session status transitions to completed. This is irreversible — to record again, create a new session.
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.MeetingRecordingsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ MeetingRecordingsApi apiInstance = new MeetingRecordingsApi(defaultClient);
+ String id = "id_example"; // String | Meeting Recording UUID
+ try {
+ apiInstance.stopMeetingRecording(id);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling MeetingRecordingsApi#stopMeetingRecording");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| Meeting Recording UUID | |
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | recording stopped | - |
+| **422** | recording cannot be stopped | - |
+
diff --git a/docs/Meta.md b/docs/Meta.md
new file mode 100644
index 00000000..726dffae
--- /dev/null
+++ b/docs/Meta.md
@@ -0,0 +1,18 @@
+
+
+# Meta
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**nextCursor** | **String** | | [optional] |
+|**currentPage** | **Integer** | | |
+|**nextPage** | **Integer** | | |
+|**prevPage** | **Integer** | | |
+|**totalCount** | **Integer** | | |
+|**totalPages** | **Integer** | | |
+
+
+
diff --git a/docs/NewAlertDataAttributes.md b/docs/NewAlertDataAttributes.md
index fa1f4912..5fdae496 100644
--- a/docs/NewAlertDataAttributes.md
+++ b/docs/NewAlertDataAttributes.md
@@ -12,18 +12,20 @@
|**status** | [**StatusEnum**](#StatusEnum) | Only available for organizations with Rootly On-Call enabled. Can be one of open, triggered. | [optional] |
|**summary** | **String** | The summary of the alert | |
|**description** | **String** | The description of the alert | [optional] |
-|**serviceIds** | **List<String>** | The Service ID's to attach to the alert. If your organization has On-Call enabled and your notification target is a Service. This field will be automatically set for you. | [optional] |
-|**groupIds** | **List<String>** | The Group ID's to attach to the alert. If your organization has On-Call enabled and your notification target is a Group. This field will be automatically set for you. | [optional] |
-|**environmentIds** | **List<String>** | The Environment ID's to attach to the alert | [optional] |
+|**serviceIds** | **List<String>** | The Service IDs to attach to the alert. If your organization has On-Call enabled and your notification target is a Service. This field will be automatically set for you. | [optional] |
+|**groupIds** | **List<String>** | The Group IDs to attach to the alert. If your organization has On-Call enabled and your notification target is a Group. This field will be automatically set for you. | [optional] |
+|**environmentIds** | **List<String>** | The Environment IDs to attach to the alert | [optional] |
|**startedAt** | **OffsetDateTime** | Alert start datetime | [optional] |
|**endedAt** | **OffsetDateTime** | Alert end datetime | [optional] |
|**externalId** | **String** | External ID | [optional] |
|**externalUrl** | **String** | External Url | [optional] |
|**alertUrgencyId** | **String** | The ID of the alert urgency | [optional] |
-|**notificationTargetType** | [**NotificationTargetTypeEnum**](#NotificationTargetTypeEnum) | Only available for organizations with Rootly On-Call enabled. Can be one of Group, Service, EscalationPolicy, User. | [optional] |
+|**notificationTargetType** | [**NotificationTargetTypeEnum**](#NotificationTargetTypeEnum) | Only available for organizations with Rootly On-Call enabled. Can be one of Group, Service, EscalationPolicy, Functionality, User. Please contact support if you encounter issues using `Functionality` as a notification target type. | [optional] |
|**notificationTargetId** | **String** | Only available for organizations with Rootly On-Call enabled. The _identifier_ of the notification target object. | [optional] |
|**labels** | [**List<NewAlertDataAttributesLabelsInner>**](NewAlertDataAttributesLabelsInner.md) | | [optional] |
|**data** | **Object** | Additional data | [optional] |
+|**deduplicationKey** | **String** | Alerts sharing the same deduplication key are treated as a single alert. | [optional] |
+|**alertFieldValuesAttributes** | [**List<NewAlertDataAttributesAlertFieldValuesAttributesInner>**](NewAlertDataAttributesAlertFieldValuesAttributesInner.md) | Custom alert field values to create with the alert | [optional] |
@@ -43,16 +45,19 @@
| ROOTLY | "rootly" |
| MANUAL | "manual" |
| API | "api" |
+| HEARTBEAT | "heartbeat" |
| WEB | "web" |
| SLACK | "slack" |
| EMAIL | "email" |
| WORKFLOW | "workflow" |
| LIVE_CALL_ROUTING | "live_call_routing" |
+| MOBILE | "mobile" |
| PAGERDUTY | "pagerduty" |
| OPSGENIE | "opsgenie" |
| VICTOROPS | "victorops" |
| PAGERTREE | "pagertree" |
| DATADOG | "datadog" |
+| DYNATRACE | "dynatrace" |
| NOBL9 | "nobl9" |
| ZENDESK | "zendesk" |
| ASANA | "asana" |
@@ -68,6 +73,7 @@
| GOOGLE_CLOUD | "google_cloud" |
| GENERIC_WEBHOOK | "generic_webhook" |
| CLOUD_WATCH | "cloud_watch" |
+| AWS_SNS | "aws_sns" |
| AZURE | "azure" |
| SPLUNK | "splunk" |
| CHRONOSPHERE | "chronosphere" |
@@ -101,6 +107,7 @@
| GROUP | "Group" |
| ESCALATION_POLICY | "EscalationPolicy" |
| SERVICE | "Service" |
+| FUNCTIONALITY | "Functionality" |
diff --git a/docs/NewAlertDataAttributesAlertFieldValuesAttributesInner.md b/docs/NewAlertDataAttributesAlertFieldValuesAttributesInner.md
new file mode 100644
index 00000000..24648578
--- /dev/null
+++ b/docs/NewAlertDataAttributesAlertFieldValuesAttributesInner.md
@@ -0,0 +1,14 @@
+
+
+# NewAlertDataAttributesAlertFieldValuesAttributesInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**alertFieldId** | **String** | ID of the custom alert field | |
+|**value** | **String** | Value for the alert field | |
+
+
+
diff --git a/docs/NewAlertDataAttributesLabelsInner.md b/docs/NewAlertDataAttributesLabelsInner.md
index fac2d0a7..04268ced 100644
--- a/docs/NewAlertDataAttributesLabelsInner.md
+++ b/docs/NewAlertDataAttributesLabelsInner.md
@@ -8,7 +8,7 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**key** | **String** | Key of the tag | |
-|**value** | **String** | Value of the tag | |
+|**value** | [**NewAlertDataAttributesLabelsInnerValue**](NewAlertDataAttributesLabelsInnerValue.md) | | |
diff --git a/docs/NewAlertDataAttributesLabelsInnerValue.md b/docs/NewAlertDataAttributesLabelsInnerValue.md
new file mode 100644
index 00000000..6f88276e
--- /dev/null
+++ b/docs/NewAlertDataAttributesLabelsInnerValue.md
@@ -0,0 +1,13 @@
+
+
+# NewAlertDataAttributesLabelsInnerValue
+
+Value of the tag
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+
+
+
diff --git a/docs/NewAlertField.md b/docs/NewAlertField.md
new file mode 100644
index 00000000..317482a9
--- /dev/null
+++ b/docs/NewAlertField.md
@@ -0,0 +1,13 @@
+
+
+# NewAlertField
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**NewAlertFieldData**](NewAlertFieldData.md) | | |
+
+
+
diff --git a/docs/NewAlertFieldData.md b/docs/NewAlertFieldData.md
new file mode 100644
index 00000000..6b14120a
--- /dev/null
+++ b/docs/NewAlertFieldData.md
@@ -0,0 +1,22 @@
+
+
+# NewAlertFieldData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**NewAlertFieldDataAttributes**](NewAlertFieldDataAttributes.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| ALERT_FIELDS | "alert_fields" |
+
+
+
diff --git a/docs/NewAlertFieldDataAttributes.md b/docs/NewAlertFieldDataAttributes.md
new file mode 100644
index 00000000..ad08dd07
--- /dev/null
+++ b/docs/NewAlertFieldDataAttributes.md
@@ -0,0 +1,13 @@
+
+
+# NewAlertFieldDataAttributes
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | The name of the alert field | |
+
+
+
diff --git a/docs/NewAlertGroupDataAttributes.md b/docs/NewAlertGroupDataAttributes.md
index cc1a7578..0ded2d6e 100644
--- a/docs/NewAlertGroupDataAttributes.md
+++ b/docs/NewAlertGroupDataAttributes.md
@@ -11,10 +11,11 @@
|**description** | **String** | The description of the alert urgency | [optional] |
|**timeWindow** | **Integer** | The length of time an Alert Group should stay open and accept new alerts | [optional] |
|**targets** | [**List<NewAlertGroupDataAttributesTargetsInner>**](NewAlertGroupDataAttributesTargetsInner.md) | | [optional] |
-|**attributes** | [**List<NewAlertGroupDataAttributesAttributesInner>**](NewAlertGroupDataAttributesAttributesInner.md) | | [optional] |
-|**groupByAlertTitle** | [**GroupByAlertTitleEnum**](#GroupByAlertTitleEnum) | Whether the alerts should be grouped by titles. | [optional] |
-|**groupByAlertUrgency** | [**GroupByAlertUrgencyEnum**](#GroupByAlertUrgencyEnum) | Whether the alerts should be grouped by urgencies. | [optional] |
+|**attributes** | [**List<NewAlertGroupDataAttributesAttributesInner>**](NewAlertGroupDataAttributesAttributesInner.md) | This field is deprecated. Please use the `conditions` field instead, `attributes` will be removed in the future. | [optional] |
+|**groupByAlertTitle** | [**GroupByAlertTitleEnum**](#GroupByAlertTitleEnum) | [DEPRECATED] Whether the alerts should be grouped by titles. This field is deprecated. Please use the `conditions` field with advanced alert grouping instead. | [optional] |
+|**groupByAlertUrgency** | [**GroupByAlertUrgencyEnum**](#GroupByAlertUrgencyEnum) | [DEPRECATED] Whether the alerts should be grouped by urgencies. This field is deprecated. Please use the `conditions` field with advanced alert grouping instead. | [optional] |
|**conditionType** | [**ConditionTypeEnum**](#ConditionTypeEnum) | Group alerts when ANY or ALL of the fields are matching. | [optional] |
+|**conditions** | [**List<NewAlertGroupDataAttributesConditionsInner>**](NewAlertGroupDataAttributesConditionsInner.md) | | [optional] |
diff --git a/docs/NewAlertGroupDataAttributesConditionsInner.md b/docs/NewAlertGroupDataAttributesConditionsInner.md
new file mode 100644
index 00000000..2b366e1d
--- /dev/null
+++ b/docs/NewAlertGroupDataAttributesConditionsInner.md
@@ -0,0 +1,54 @@
+
+
+# NewAlertGroupDataAttributesConditionsInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**propertyFieldType** | [**PropertyFieldTypeEnum**](#PropertyFieldTypeEnum) | The type of the property field | |
+|**propertyFieldName** | **String** | The name of the property field. If the property field type is selected as 'attribute', then the allowed property field names are 'summary' (for Title), 'description', 'alert_urgency' and 'external_url' (for Alert Source URL). If the property field type is selected as 'payload', then the property field name should be supplied in JSON Path syntax. | [optional] |
+|**propertyFieldConditionType** | [**PropertyFieldConditionTypeEnum**](#PropertyFieldConditionTypeEnum) | The condition type of the property field | |
+|**propertyFieldValue** | **String** | The value of the property field. Can be null if the property field condition type is 'is_one_of' or 'is_not_one_of' | [optional] |
+|**propertyFieldValues** | **List<String>** | The values of the property field. Need to be passed if the property field condition type is 'is_one_of' or 'is_not_one_of' except for when property field name is 'alert_urgency' | [optional] |
+|**alertUrgencyIds** | **List<String>** | The Alert Urgency IDs to check in the condition. Only need to be set when the property field type is 'attribute', the property field name is 'alert_urgency' and the property field condition type is 'is_one_of' or 'is_not_one_of' | [optional] |
+|**conditionableType** | [**ConditionableTypeEnum**](#ConditionableTypeEnum) | The type of the conditionable | [optional] |
+|**conditionableId** | **String** | The ID of the conditionable. If conditionable_type is AlertField, this is the ID of the alert field. | [optional] |
+
+
+
+## Enum: PropertyFieldTypeEnum
+
+| Name | Value |
+|---- | -----|
+| ATTRIBUTE | "attribute" |
+| PAYLOAD | "payload" |
+| ALERT_FIELD | "alert_field" |
+
+
+
+## Enum: PropertyFieldConditionTypeEnum
+
+| Name | Value |
+|---- | -----|
+| IS_ONE_OF | "is_one_of" |
+| IS_NOT_ONE_OF | "is_not_one_of" |
+| CONTAINS | "contains" |
+| DOES_NOT_CONTAIN | "does_not_contain" |
+| STARTS_WITH | "starts_with" |
+| ENDS_WITH | "ends_with" |
+| MATCHES_REGEX | "matches_regex" |
+| IS_EMPTY | "is_empty" |
+| MATCHES_EXISTING_ALERT | "matches_existing_alert" |
+
+
+
+## Enum: ConditionableTypeEnum
+
+| Name | Value |
+|---- | -----|
+| ALERT_FIELD | "AlertField" |
+
+
+
diff --git a/docs/NewAlertGroupDataAttributesTargetsInner.md b/docs/NewAlertGroupDataAttributesTargetsInner.md
index f7f789fa..9f12d727 100644
--- a/docs/NewAlertGroupDataAttributesTargetsInner.md
+++ b/docs/NewAlertGroupDataAttributesTargetsInner.md
@@ -7,8 +7,8 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
-|**targetType** | [**TargetTypeEnum**](#TargetTypeEnum) | The type of the target. | |
-|**targetId** | **UUID** | id for the Group, Service or EscalationPolicy | |
+|**targetType** | [**TargetTypeEnum**](#TargetTypeEnum) | The type of the target. Please contact support if you encounter issues using `Functionality` as a target type. | |
+|**targetId** | **UUID** | id for the Group, Service, EscalationPolicy or Functionality | |
@@ -19,6 +19,7 @@
| GROUP | "Group" |
| SERVICE | "Service" |
| ESCALATION_POLICY | "EscalationPolicy" |
+| FUNCTIONALITY | "Functionality" |
diff --git a/docs/NewAlertRoute.md b/docs/NewAlertRoute.md
new file mode 100644
index 00000000..3e041d49
--- /dev/null
+++ b/docs/NewAlertRoute.md
@@ -0,0 +1,13 @@
+
+
+# NewAlertRoute
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**NewAlertRouteData**](NewAlertRouteData.md) | | [optional] |
+
+
+
diff --git a/docs/NewAlertRouteData.md b/docs/NewAlertRouteData.md
new file mode 100644
index 00000000..dc2722ce
--- /dev/null
+++ b/docs/NewAlertRouteData.md
@@ -0,0 +1,22 @@
+
+
+# NewAlertRouteData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | [**TypeEnum**](#TypeEnum) | | [optional] |
+|**attributes** | [**NewAlertRouteDataAttributes**](NewAlertRouteDataAttributes.md) | | [optional] |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| ALERT_ROUTES | "alert_routes" |
+
+
+
diff --git a/docs/NewAlertRouteDataAttributes.md b/docs/NewAlertRouteDataAttributes.md
new file mode 100644
index 00000000..d46a3805
--- /dev/null
+++ b/docs/NewAlertRouteDataAttributes.md
@@ -0,0 +1,17 @@
+
+
+# NewAlertRouteDataAttributes
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | The name of the alert route | |
+|**enabled** | **Boolean** | Whether the alert route is enabled | [optional] |
+|**alertsSourceIds** | **List<UUID>** | | |
+|**owningTeamIds** | **List<UUID>** | | [optional] |
+|**rules** | [**List<NewAlertRouteDataAttributesRulesInner>**](NewAlertRouteDataAttributesRulesInner.md) | | [optional] |
+
+
+
diff --git a/docs/NewAlertRouteDataAttributesRulesInner.md b/docs/NewAlertRouteDataAttributesRulesInner.md
new file mode 100644
index 00000000..ac13d28a
--- /dev/null
+++ b/docs/NewAlertRouteDataAttributesRulesInner.md
@@ -0,0 +1,17 @@
+
+
+# NewAlertRouteDataAttributesRulesInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | The name of the alert routing rule | |
+|**position** | **Integer** | The position of the alert routing rule for ordering evaluation | [optional] |
+|**fallbackRule** | **Boolean** | Whether this is a fallback rule | [optional] |
+|**destinations** | [**List<NewAlertRouteDataAttributesRulesInnerDestinationsInner>**](NewAlertRouteDataAttributesRulesInnerDestinationsInner.md) | | |
+|**conditionGroups** | [**List<NewAlertRouteDataAttributesRulesInnerConditionGroupsInner>**](NewAlertRouteDataAttributesRulesInnerConditionGroupsInner.md) | | |
+
+
+
diff --git a/docs/NewAlertRouteDataAttributesRulesInnerConditionGroupsInner.md b/docs/NewAlertRouteDataAttributesRulesInnerConditionGroupsInner.md
new file mode 100644
index 00000000..67181ae7
--- /dev/null
+++ b/docs/NewAlertRouteDataAttributesRulesInnerConditionGroupsInner.md
@@ -0,0 +1,14 @@
+
+
+# NewAlertRouteDataAttributesRulesInnerConditionGroupsInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**position** | **Integer** | The position of the condition group | [optional] |
+|**conditions** | [**List<NewAlertRouteDataAttributesRulesInnerConditionGroupsInnerConditionsInner>**](NewAlertRouteDataAttributesRulesInnerConditionGroupsInnerConditionsInner.md) | | |
+
+
+
diff --git a/docs/NewAlertRouteDataAttributesRulesInnerConditionGroupsInnerConditionsInner.md b/docs/NewAlertRouteDataAttributesRulesInnerConditionGroupsInnerConditionsInner.md
new file mode 100644
index 00000000..142a11b8
--- /dev/null
+++ b/docs/NewAlertRouteDataAttributesRulesInnerConditionGroupsInnerConditionsInner.md
@@ -0,0 +1,53 @@
+
+
+# NewAlertRouteDataAttributesRulesInnerConditionGroupsInnerConditionsInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**propertyFieldConditionType** | [**PropertyFieldConditionTypeEnum**](#PropertyFieldConditionTypeEnum) | | |
+|**propertyFieldName** | **String** | The name of the property field | [optional] |
+|**propertyFieldType** | [**PropertyFieldTypeEnum**](#PropertyFieldTypeEnum) | | |
+|**propertyFieldValue** | **String** | The value of the property field | [optional] |
+|**propertyFieldValues** | **List<String>** | | [optional] |
+|**alertUrgencyIds** | **List<String>** | The Alert Urgency IDs to check in the condition | [optional] |
+|**conditionableType** | [**ConditionableTypeEnum**](#ConditionableTypeEnum) | The type of the conditionable | [optional] |
+|**conditionableId** | **UUID** | The ID of the conditionable | [optional] |
+
+
+
+## Enum: PropertyFieldConditionTypeEnum
+
+| Name | Value |
+|---- | -----|
+| IS_ONE_OF | "is_one_of" |
+| IS_NOT_ONE_OF | "is_not_one_of" |
+| CONTAINS | "contains" |
+| DOES_NOT_CONTAIN | "does_not_contain" |
+| STARTS_WITH | "starts_with" |
+| ENDS_WITH | "ends_with" |
+| MATCHES_REGEX | "matches_regex" |
+| IS_EMPTY | "is_empty" |
+
+
+
+## Enum: PropertyFieldTypeEnum
+
+| Name | Value |
+|---- | -----|
+| ATTRIBUTE | "attribute" |
+| PAYLOAD | "payload" |
+| ALERT_FIELD | "alert_field" |
+
+
+
+## Enum: ConditionableTypeEnum
+
+| Name | Value |
+|---- | -----|
+| ALERT_FIELD | "AlertField" |
+
+
+
diff --git a/docs/NewAlertRouteDataAttributesRulesInnerDestinationsInner.md b/docs/NewAlertRouteDataAttributesRulesInnerDestinationsInner.md
new file mode 100644
index 00000000..d84afeb6
--- /dev/null
+++ b/docs/NewAlertRouteDataAttributesRulesInnerDestinationsInner.md
@@ -0,0 +1,25 @@
+
+
+# NewAlertRouteDataAttributesRulesInnerDestinationsInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**targetType** | [**TargetTypeEnum**](#TargetTypeEnum) | The type of the target. Please contact support if you encounter issues using `Functionality` as a target type. | |
+|**targetId** | **UUID** | The ID of the target | |
+
+
+
+## Enum: TargetTypeEnum
+
+| Name | Value |
+|---- | -----|
+| SERVICE | "Service" |
+| GROUP | "Group" |
+| FUNCTIONALITY | "Functionality" |
+| ESCALATION_POLICY | "EscalationPolicy" |
+
+
+
diff --git a/docs/NewAlertRoutingRuleDataAttributes.md b/docs/NewAlertRoutingRuleDataAttributes.md
index 928ccd7e..fa4d3e24 100644
--- a/docs/NewAlertRoutingRuleDataAttributes.md
+++ b/docs/NewAlertRoutingRuleDataAttributes.md
@@ -11,9 +11,10 @@
|**enabled** | **Boolean** | Whether the alert routing rule is enabled | [optional] |
|**owningTeamIds** | **List<UUID>** | The IDs of the teams which own the alert routing rule. If the user doesn't have Alert Routing Create Permission in On-Call Roles, then this field is required and can contain Team IDs the user is an admin of. | [optional] |
|**alertsSourceId** | **UUID** | The ID of the alerts source | |
+|**position** | **Integer** | The position of the alert routing rule for ordering evaluation | [optional] |
|**conditionType** | [**ConditionTypeEnum**](#ConditionTypeEnum) | The type of condition for the alert routing rule | [optional] |
|**conditions** | [**List<NewAlertRoutingRuleDataAttributesConditionsInner>**](NewAlertRoutingRuleDataAttributesConditionsInner.md) | | [optional] |
-|**destination** | [**NewAlertRoutingRuleDataAttributesDestination**](NewAlertRoutingRuleDataAttributesDestination.md) | | |
+|**destination** | [**NewAlertRouteDataAttributesRulesInnerDestinationsInner**](NewAlertRouteDataAttributesRulesInnerDestinationsInner.md) | | |
diff --git a/docs/NewAlertsSourceDataAttributes.md b/docs/NewAlertsSourceDataAttributes.md
index a62fd6d1..68fffa4b 100644
--- a/docs/NewAlertsSourceDataAttributes.md
+++ b/docs/NewAlertsSourceDataAttributes.md
@@ -10,11 +10,16 @@
|**name** | **String** | The name of the alert source | |
|**sourceType** | [**SourceTypeEnum**](#SourceTypeEnum) | The alert source type | [optional] |
|**alertUrgencyId** | **String** | ID for the default alert urgency assigned to this alert source | [optional] |
+|**deduplicateAlertsByKey** | **Boolean** | Toggle alert deduplication using deduplication key. If enabled, deduplication_key_kind and deduplication_key_path are required. | [optional] |
+|**deduplicationKeyKind** | [**DeduplicationKeyKindEnum**](#DeduplicationKeyKindEnum) | Kind of deduplication key. | [optional] |
+|**deduplicationKeyPath** | **String** | Path to deduplication key. This is a JSON Path to extract the deduplication key from the request body. | [optional] |
+|**deduplicationKeyRegexp** | **String** | Regular expression to extract key from value found at key path. | [optional] |
|**ownerGroupIds** | **List<String>** | List of team IDs that will own the alert source | [optional] |
|**alertTemplateAttributes** | [**NewAlertsSourceDataAttributesAlertTemplateAttributes**](NewAlertsSourceDataAttributesAlertTemplateAttributes.md) | | [optional] |
|**alertSourceUrgencyRulesAttributes** | [**List<NewAlertsSourceDataAttributesAlertSourceUrgencyRulesAttributesInner>**](NewAlertsSourceDataAttributesAlertSourceUrgencyRulesAttributesInner.md) | List of rules that define the conditions under which the alert urgency will be set automatically based on the alert payload | [optional] |
|**sourceableAttributes** | [**NewAlertsSourceDataAttributesSourceableAttributes**](NewAlertsSourceDataAttributesSourceableAttributes.md) | | [optional] |
|**resolutionRuleAttributes** | [**NewAlertsSourceDataAttributesResolutionRuleAttributes**](NewAlertsSourceDataAttributesResolutionRuleAttributes.md) | | [optional] |
+|**alertSourceFieldsAttributes** | [**List<NewAlertsSourceDataAttributesAlertSourceFieldsAttributesInner>**](NewAlertsSourceDataAttributesAlertSourceFieldsAttributesInner.md) | List of alert fields to be added to the alert source. Note: This attribute requires the alert field feature to be enabled on your account. Contact Rootly customer support if you need assistance with this feature. | [optional] |
@@ -26,12 +31,14 @@
| APP_DYNAMICS | "app_dynamics" |
| CATCHPOINT | "catchpoint" |
| DATADOG | "datadog" |
+| DYNATRACE | "dynatrace" |
| ALERTMANAGER | "alertmanager" |
| GOOGLE_CLOUD | "google_cloud" |
| GRAFANA | "grafana" |
| SENTRY | "sentry" |
| GENERIC_WEBHOOK | "generic_webhook" |
| CLOUD_WATCH | "cloud_watch" |
+| AWS_SNS | "aws_sns" |
| CHECKLY | "checkly" |
| AZURE | "azure" |
| NEW_RELIC | "new_relic" |
@@ -46,3 +53,11 @@
+## Enum: DeduplicationKeyKindEnum
+
+| Name | Value |
+|---- | -----|
+| PAYLOAD | "payload" |
+
+
+
diff --git a/docs/NewAlertsSourceDataAttributesAlertSourceFieldsAttributesInner.md b/docs/NewAlertsSourceDataAttributesAlertSourceFieldsAttributesInner.md
new file mode 100644
index 00000000..249fa6a9
--- /dev/null
+++ b/docs/NewAlertsSourceDataAttributesAlertSourceFieldsAttributesInner.md
@@ -0,0 +1,14 @@
+
+
+# NewAlertsSourceDataAttributesAlertSourceFieldsAttributesInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**alertFieldId** | **String** | The ID of the alert field | [optional] |
+|**templateBody** | **String** | Liquid expression to extract a specific value from the alert's payload for evaluation | [optional] |
+
+
+
diff --git a/docs/NewAlertsSourceDataAttributesAlertSourceUrgencyRulesAttributesInner.md b/docs/NewAlertsSourceDataAttributesAlertSourceUrgencyRulesAttributesInner.md
index b2548e7c..8a239d42 100644
--- a/docs/NewAlertsSourceDataAttributesAlertSourceUrgencyRulesAttributesInner.md
+++ b/docs/NewAlertsSourceDataAttributesAlertSourceUrgencyRulesAttributesInner.md
@@ -10,6 +10,10 @@
|**jsonPath** | **String** | JSON path expression to extract a specific value from the alert's payload for evaluation | [optional] |
|**operator** | [**OperatorEnum**](#OperatorEnum) | Comparison operator used to evaluate the extracted value against the specified condition | [optional] |
|**value** | **String** | Value that the extracted payload data is compared to using the specified operator to determine a match | [optional] |
+|**conditionableType** | [**ConditionableTypeEnum**](#ConditionableTypeEnum) | The type of the conditionable | [optional] |
+|**conditionableId** | **String** | The ID of the conditionable. If conditionable_type is AlertField, this is the ID of the alert field. | [optional] |
+|**kind** | [**KindEnum**](#KindEnum) | The kind of the conditionable | [optional] |
+|**alertUrgencyId** | **String** | The ID of the alert urgency | [optional] |
@@ -24,3 +28,20 @@
+## Enum: ConditionableTypeEnum
+
+| Name | Value |
+|---- | -----|
+| ALERT_FIELD | "AlertField" |
+
+
+
+## Enum: KindEnum
+
+| Name | Value |
+|---- | -----|
+| PAYLOAD | "payload" |
+| ALERT_FIELD | "alert_field" |
+
+
+
diff --git a/docs/NewAlertsSourceDataAttributesResolutionRuleAttributes.md b/docs/NewAlertsSourceDataAttributesResolutionRuleAttributes.md
index 5250c157..20c3721b 100644
--- a/docs/NewAlertsSourceDataAttributesResolutionRuleAttributes.md
+++ b/docs/NewAlertsSourceDataAttributesResolutionRuleAttributes.md
@@ -10,6 +10,9 @@ Provide additional attributes for email alerts source
|------------ | ------------- | ------------- | -------------|
|**enabled** | **Boolean** | Set this to true to enable the auto resolution rule | [optional] |
|**conditionType** | [**ConditionTypeEnum**](#ConditionTypeEnum) | The type of condition to evaluate to apply auto resolution rule | [optional] |
+|**identifierMatchableType** | [**IdentifierMatchableTypeEnum**](#IdentifierMatchableTypeEnum) | The type of the identifier matchable | [optional] |
+|**identifierMatchableId** | **String** | The ID of the identifier matchable. If identifier_matchable_type is AlertField, this is the ID of the alert field. | [optional] |
+|**identifierReferenceKind** | [**IdentifierReferenceKindEnum**](#IdentifierReferenceKindEnum) | The kind of the identifier reference | [optional] |
|**identifierJsonPath** | **String** | JSON path expression to extract unique alert identifier used to match triggered alerts with resolving alerts | [optional] |
|**identifierValueRegex** | **String** | Regex group to further specify the part of the string used as a unique identifier | [optional] |
|**conditionsAttributes** | [**List<NewAlertsSourceDataAttributesResolutionRuleAttributesConditionsAttributesInner>**](NewAlertsSourceDataAttributesResolutionRuleAttributesConditionsAttributesInner.md) | List of conditions to evaluate for auto resolution | [optional] |
@@ -25,3 +28,20 @@ Provide additional attributes for email alerts source
+## Enum: IdentifierMatchableTypeEnum
+
+| Name | Value |
+|---- | -----|
+| ALERT_FIELD | "AlertField" |
+
+
+
+## Enum: IdentifierReferenceKindEnum
+
+| Name | Value |
+|---- | -----|
+| PAYLOAD | "payload" |
+| ALERT_FIELD | "alert_field" |
+
+
+
diff --git a/docs/NewAlertsSourceDataAttributesResolutionRuleAttributesConditionsAttributesInner.md b/docs/NewAlertsSourceDataAttributesResolutionRuleAttributesConditionsAttributesInner.md
index f70b90fe..602aadcd 100644
--- a/docs/NewAlertsSourceDataAttributesResolutionRuleAttributesConditionsAttributesInner.md
+++ b/docs/NewAlertsSourceDataAttributesResolutionRuleAttributesConditionsAttributesInner.md
@@ -10,6 +10,9 @@
|**field** | **String** | JSON path expression to extract a specific value from the alert's payload for evaluation | [optional] |
|**operator** | [**OperatorEnum**](#OperatorEnum) | Comparison operator used to evaluate the extracted value against the specified condition | [optional] |
|**value** | **String** | Value that the extracted payload data is compared to using the specified operator to determine a match | [optional] |
+|**conditionableType** | [**ConditionableTypeEnum**](#ConditionableTypeEnum) | The type of the conditionable | [optional] |
+|**conditionableId** | **String** | The ID of the conditionable. If conditionable_type is AlertField, this is the ID of the alert field. | [optional] |
+|**kind** | [**KindEnum**](#KindEnum) | The kind of the conditionable | [optional] |
@@ -26,3 +29,20 @@
+## Enum: ConditionableTypeEnum
+
+| Name | Value |
+|---- | -----|
+| ALERT_FIELD | "AlertField" |
+
+
+
+## Enum: KindEnum
+
+| Name | Value |
+|---- | -----|
+| PAYLOAD | "payload" |
+| ALERT_FIELD | "alert_field" |
+
+
+
diff --git a/docs/NewAlertsSourceDataAttributesSourceableAttributesFieldMappingsAttributesInner.md b/docs/NewAlertsSourceDataAttributesSourceableAttributesFieldMappingsAttributesInner.md
index 3a54644b..5ff6eecf 100644
--- a/docs/NewAlertsSourceDataAttributesSourceableAttributesFieldMappingsAttributesInner.md
+++ b/docs/NewAlertsSourceDataAttributesSourceableAttributesFieldMappingsAttributesInner.md
@@ -19,6 +19,7 @@
| EXTERNAL_ID | "external_id" |
| STATE | "state" |
| ALERT_TITLE | "alert_title" |
+| ALERT_DESCRIPTION | "alert_description" |
| ALERT_EXTERNAL_URL | "alert_external_url" |
| NOTIFICATION_TARGET_TYPE | "notification_target_type" |
| NOTIFICATION_TARGET_ID | "notification_target_id" |
diff --git a/docs/NewApiKey.md b/docs/NewApiKey.md
new file mode 100644
index 00000000..f159e71f
--- /dev/null
+++ b/docs/NewApiKey.md
@@ -0,0 +1,13 @@
+
+
+# NewApiKey
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**NewApiKeyData**](NewApiKeyData.md) | | |
+
+
+
diff --git a/docs/NewApiKeyData.md b/docs/NewApiKeyData.md
new file mode 100644
index 00000000..97e19913
--- /dev/null
+++ b/docs/NewApiKeyData.md
@@ -0,0 +1,22 @@
+
+
+# NewApiKeyData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**NewApiKeyDataAttributes**](NewApiKeyDataAttributes.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| API_KEYS | "api_keys" |
+
+
+
diff --git a/docs/NewApiKeyDataAttributes.md b/docs/NewApiKeyDataAttributes.md
new file mode 100644
index 00000000..a103fd84
--- /dev/null
+++ b/docs/NewApiKeyDataAttributes.md
@@ -0,0 +1,29 @@
+
+
+# NewApiKeyDataAttributes
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | The name of the API key | |
+|**description** | **String** | A description of the API key | [optional] |
+|**kind** | [**KindEnum**](#KindEnum) | The kind of the API key | |
+|**expiresAt** | **OffsetDateTime** | The expiration date of the API key (ISO 8601) | |
+|**groupId** | **String** | The group (team) ID. Required when kind is 'team'. | [optional] |
+|**roleId** | **String** | The role ID for organization API keys | [optional] |
+|**onCallRoleId** | **String** | The on-call role ID for organization API keys | [optional] |
+
+
+
+## Enum: KindEnum
+
+| Name | Value |
+|---- | -----|
+| PERSONAL | "personal" |
+| TEAM | "team" |
+| ORGANIZATION | "organization" |
+
+
+
diff --git a/docs/NewCatalogChecklistTemplate.md b/docs/NewCatalogChecklistTemplate.md
new file mode 100644
index 00000000..7650e021
--- /dev/null
+++ b/docs/NewCatalogChecklistTemplate.md
@@ -0,0 +1,13 @@
+
+
+# NewCatalogChecklistTemplate
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**NewCatalogChecklistTemplateData**](NewCatalogChecklistTemplateData.md) | | |
+
+
+
diff --git a/docs/NewCatalogChecklistTemplateData.md b/docs/NewCatalogChecklistTemplateData.md
new file mode 100644
index 00000000..12aca06c
--- /dev/null
+++ b/docs/NewCatalogChecklistTemplateData.md
@@ -0,0 +1,22 @@
+
+
+# NewCatalogChecklistTemplateData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**NewCatalogChecklistTemplateDataAttributes**](NewCatalogChecklistTemplateDataAttributes.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| CATALOG_CHECKLIST_TEMPLATES | "catalog_checklist_templates" |
+
+
+
diff --git a/docs/NewCatalogChecklistTemplateDataAttributes.md b/docs/NewCatalogChecklistTemplateDataAttributes.md
new file mode 100644
index 00000000..8d6f683d
--- /dev/null
+++ b/docs/NewCatalogChecklistTemplateDataAttributes.md
@@ -0,0 +1,42 @@
+
+
+# NewCatalogChecklistTemplateDataAttributes
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | The name of the checklist template | |
+|**description** | **String** | The description of the checklist template | [optional] |
+|**catalogType** | [**CatalogTypeEnum**](#CatalogTypeEnum) | The catalog type | |
+|**scopeType** | [**ScopeTypeEnum**](#ScopeTypeEnum) | The scope type | |
+|**scopeId** | **String** | The scope ID (team or catalog UUID) | [optional] |
+|**fields** | [**List<NewCatalogChecklistTemplateDataAttributesFieldsInner>**](NewCatalogChecklistTemplateDataAttributesFieldsInner.md) | Template fields. Position is determined by array order. | [optional] |
+|**owners** | [**List<NewCatalogChecklistTemplateDataAttributesOwnersInner>**](NewCatalogChecklistTemplateDataAttributesOwnersInner.md) | Template owners | [optional] |
+
+
+
+## Enum: CatalogTypeEnum
+
+| Name | Value |
+|---- | -----|
+| SERVICE | "Service" |
+| FUNCTIONALITY | "Functionality" |
+| ENVIRONMENT | "Environment" |
+| GROUP | "Group" |
+| CAUSE | "Cause" |
+| INCIDENT_TYPE | "IncidentType" |
+| CATALOG | "Catalog" |
+
+
+
+## Enum: ScopeTypeEnum
+
+| Name | Value |
+|---- | -----|
+| TEAM | "Team" |
+| CATALOG | "Catalog" |
+
+
+
diff --git a/docs/NewCatalogChecklistTemplateDataAttributesFieldsInner.md b/docs/NewCatalogChecklistTemplateDataAttributesFieldsInner.md
new file mode 100644
index 00000000..2c2ac826
--- /dev/null
+++ b/docs/NewCatalogChecklistTemplateDataAttributesFieldsInner.md
@@ -0,0 +1,23 @@
+
+
+# NewCatalogChecklistTemplateDataAttributesFieldsInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**fieldSource** | [**FieldSourceEnum**](#FieldSourceEnum) | | |
+|**fieldKey** | **String** | Ignored for custom fields (auto-derived from catalog property) | |
+|**catalogPropertyId** | **String** | ID of the catalog property | |
+
+
+
+## Enum: FieldSourceEnum
+
+| Name | Value |
+|---- | -----|
+| CUSTOM | "custom" |
+
+
+
diff --git a/docs/NewCatalogChecklistTemplateDataAttributesOwnersInner.md b/docs/NewCatalogChecklistTemplateDataAttributesOwnersInner.md
new file mode 100644
index 00000000..5e9036f7
--- /dev/null
+++ b/docs/NewCatalogChecklistTemplateDataAttributesOwnersInner.md
@@ -0,0 +1,23 @@
+
+
+# NewCatalogChecklistTemplateDataAttributesOwnersInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | User ID for user owners, or field key for field owners | |
+|**type** | [**TypeEnum**](#TypeEnum) | Type of owner | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| FIELD | "field" |
+| USER | "user" |
+
+
+
diff --git a/docs/NewCatalogEntityDataAttributes.md b/docs/NewCatalogEntityDataAttributes.md
index 8ab1ceb0..0e769c66 100644
--- a/docs/NewCatalogEntityDataAttributes.md
+++ b/docs/NewCatalogEntityDataAttributes.md
@@ -10,6 +10,8 @@
|**name** | **String** | | |
|**description** | **String** | | [optional] |
|**position** | **Integer** | Default position of the item when displayed in a list. | [optional] |
+|**backstageId** | **String** | The Backstage entity ID this catalog entity is linked to. | [optional] |
+|**properties** | [**List<NewCatalogEntityDataAttributesPropertiesInner>**](NewCatalogEntityDataAttributesPropertiesInner.md) | Array of property values for this catalog entity | [optional] |
diff --git a/docs/NewCatalogEntityDataAttributesPropertiesInner.md b/docs/NewCatalogEntityDataAttributesPropertiesInner.md
new file mode 100644
index 00000000..3ec89a29
--- /dev/null
+++ b/docs/NewCatalogEntityDataAttributesPropertiesInner.md
@@ -0,0 +1,14 @@
+
+
+# NewCatalogEntityDataAttributesPropertiesInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**catalogPropertyId** | **String** | Unique ID of the catalog property | |
+|**value** | **String** | The value for this property | |
+
+
+
diff --git a/docs/NewCatalogEntityProperty.md b/docs/NewCatalogEntityProperty.md
index ff94b9db..4af54d61 100644
--- a/docs/NewCatalogEntityProperty.md
+++ b/docs/NewCatalogEntityProperty.md
@@ -2,6 +2,7 @@
# NewCatalogEntityProperty
+**Deprecated:** This endpoint is deprecated, please use the `fields` attribute on catalog entities or native catalog endpoints (teams, services, functionalities, incident_types, causes, environments) to set field values instead.
## Properties
diff --git a/docs/NewCatalogEntityPropertyDataAttributes.md b/docs/NewCatalogEntityPropertyDataAttributes.md
index a062c4a9..9cba7bd3 100644
--- a/docs/NewCatalogEntityPropertyDataAttributes.md
+++ b/docs/NewCatalogEntityPropertyDataAttributes.md
@@ -2,6 +2,7 @@
# NewCatalogEntityPropertyDataAttributes
+Maximum of 50 values allowed per catalog field.
## Properties
@@ -20,6 +21,7 @@
|---- | -----|
| TEXT | "text" |
| CATALOG_ENTITY | "catalog_entity" |
+| SLACK | "slack" |
diff --git a/docs/NewCatalogField.md b/docs/NewCatalogField.md
index 8f0470f7..e62c4b24 100644
--- a/docs/NewCatalogField.md
+++ b/docs/NewCatalogField.md
@@ -2,6 +2,7 @@
# NewCatalogField
+A catalog can have a maximum of 50 fields.
## Properties
diff --git a/docs/NewCatalogFieldData.md b/docs/NewCatalogFieldData.md
index 4f8be025..75e8cc95 100644
--- a/docs/NewCatalogFieldData.md
+++ b/docs/NewCatalogFieldData.md
@@ -16,7 +16,7 @@
| Name | Value |
|---- | -----|
-| CATALOG_FIELDS | "catalog_fields" |
+| CATALOG_PROPERTIES | "catalog_properties" |
diff --git a/docs/NewCatalogFieldDataAttributes.md b/docs/NewCatalogFieldDataAttributes.md
index 6fdd607e..0a6e370a 100644
--- a/docs/NewCatalogFieldDataAttributes.md
+++ b/docs/NewCatalogFieldDataAttributes.md
@@ -12,6 +12,8 @@
|**kindCatalogId** | **String** | Restricts values to items of specified catalog. | [optional] |
|**multiple** | **Boolean** | Whether the attribute accepts multiple values. | [optional] |
|**position** | **Integer** | Default position of the item when displayed in a list. | [optional] |
+|**required** | **Boolean** | Whether the field is required. | [optional] |
+|**catalogType** | [**CatalogTypeEnum**](#CatalogTypeEnum) | The type of catalog the field belongs to. | [optional] |
@@ -21,6 +23,29 @@
|---- | -----|
| TEXT | "text" |
| REFERENCE | "reference" |
+| BOOLEAN | "boolean" |
+| REFERENCE2 | "reference" |
+| SERVICE | "service" |
+| FUNCTIONALITY | "functionality" |
+| ENVIRONMENT | "environment" |
+| GROUP | "group" |
+| CAUSE | "cause" |
+| INCIDENT_TYPE | "incident_type" |
+| USER | "user" |
+
+
+
+## Enum: CatalogTypeEnum
+
+| Name | Value |
+|---- | -----|
+| CATALOG | "catalog" |
+| CAUSE | "cause" |
+| ENVIRONMENT | "environment" |
+| FUNCTIONALITY | "functionality" |
+| INCIDENT_TYPE | "incident_type" |
+| SERVICE | "service" |
+| TEAM | "team" |
diff --git a/docs/NewCatalogProperty.md b/docs/NewCatalogProperty.md
new file mode 100644
index 00000000..dbfd0fdb
--- /dev/null
+++ b/docs/NewCatalogProperty.md
@@ -0,0 +1,14 @@
+
+
+# NewCatalogProperty
+
+A catalog can have a maximum of 50 properties.
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**NewCatalogPropertyData**](NewCatalogPropertyData.md) | | |
+
+
+
diff --git a/docs/NewCatalogPropertyData.md b/docs/NewCatalogPropertyData.md
new file mode 100644
index 00000000..3cccf73a
--- /dev/null
+++ b/docs/NewCatalogPropertyData.md
@@ -0,0 +1,22 @@
+
+
+# NewCatalogPropertyData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**NewCatalogPropertyDataAttributes**](NewCatalogPropertyDataAttributes.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| CATALOG_PROPERTIES | "catalog_properties" |
+
+
+
diff --git a/docs/NewCatalogPropertyDataAttributes.md b/docs/NewCatalogPropertyDataAttributes.md
new file mode 100644
index 00000000..c7151874
--- /dev/null
+++ b/docs/NewCatalogPropertyDataAttributes.md
@@ -0,0 +1,51 @@
+
+
+# NewCatalogPropertyDataAttributes
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | | |
+|**kind** | [**KindEnum**](#KindEnum) | | |
+|**kindCatalogId** | **String** | Restricts values to items of specified catalog. | [optional] |
+|**multiple** | **Boolean** | Whether the attribute accepts multiple values. | [optional] |
+|**position** | **Integer** | Default position of the item when displayed in a list. | [optional] |
+|**required** | **Boolean** | Whether the property is required. | [optional] |
+|**catalogType** | [**CatalogTypeEnum**](#CatalogTypeEnum) | The type of catalog the property belongs to. | [optional] |
+
+
+
+## Enum: KindEnum
+
+| Name | Value |
+|---- | -----|
+| TEXT | "text" |
+| REFERENCE | "reference" |
+| BOOLEAN | "boolean" |
+| REFERENCE2 | "reference" |
+| SERVICE | "service" |
+| FUNCTIONALITY | "functionality" |
+| ENVIRONMENT | "environment" |
+| GROUP | "group" |
+| CAUSE | "cause" |
+| INCIDENT_TYPE | "incident_type" |
+| USER | "user" |
+
+
+
+## Enum: CatalogTypeEnum
+
+| Name | Value |
+|---- | -----|
+| CATALOG | "catalog" |
+| CAUSE | "cause" |
+| ENVIRONMENT | "environment" |
+| FUNCTIONALITY | "functionality" |
+| INCIDENT_TYPE | "incident_type" |
+| SERVICE | "service" |
+| TEAM | "team" |
+
+
+
diff --git a/docs/NewCauseDataAttributes.md b/docs/NewCauseDataAttributes.md
index a35349f6..cad4a564 100644
--- a/docs/NewCauseDataAttributes.md
+++ b/docs/NewCauseDataAttributes.md
@@ -10,6 +10,7 @@
|**name** | **String** | The name of the cause | |
|**description** | **String** | The description of the cause | [optional] |
|**position** | **Integer** | Position of the cause | [optional] |
+|**properties** | [**List<NewCauseDataAttributesPropertiesInner>**](NewCauseDataAttributesPropertiesInner.md) | Array of property values for this cause. | [optional] |
diff --git a/docs/NewCauseDataAttributesPropertiesInner.md b/docs/NewCauseDataAttributesPropertiesInner.md
new file mode 100644
index 00000000..2c49f564
--- /dev/null
+++ b/docs/NewCauseDataAttributesPropertiesInner.md
@@ -0,0 +1,15 @@
+
+
+# NewCauseDataAttributesPropertiesInner
+
+Set a value for a catalog property
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**catalogPropertyId** | **String** | Catalog property ID | |
+|**value** | **String** | The property value | |
+
+
+
diff --git a/docs/NewCommunicationsGroup.md b/docs/NewCommunicationsGroup.md
new file mode 100644
index 00000000..37dfd328
--- /dev/null
+++ b/docs/NewCommunicationsGroup.md
@@ -0,0 +1,13 @@
+
+
+# NewCommunicationsGroup
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**NewCommunicationsGroupData**](NewCommunicationsGroupData.md) | | |
+
+
+
diff --git a/docs/NewCommunicationsGroupData.md b/docs/NewCommunicationsGroupData.md
new file mode 100644
index 00000000..e6caa2a3
--- /dev/null
+++ b/docs/NewCommunicationsGroupData.md
@@ -0,0 +1,22 @@
+
+
+# NewCommunicationsGroupData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**NewCommunicationsGroupDataAttributes**](NewCommunicationsGroupDataAttributes.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| COMMUNICATIONS_GROUPS | "communications_groups" |
+
+
+
diff --git a/docs/NewCommunicationsGroupDataAttributes.md b/docs/NewCommunicationsGroupDataAttributes.md
new file mode 100644
index 00000000..880f24fe
--- /dev/null
+++ b/docs/NewCommunicationsGroupDataAttributes.md
@@ -0,0 +1,32 @@
+
+
+# NewCommunicationsGroupDataAttributes
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | The name of the communications group | |
+|**description** | **String** | The description of the communications group | [optional] |
+|**communicationTypeId** | **String** | The communication type ID | |
+|**isPrivate** | **Boolean** | Whether the group is private | [optional] |
+|**conditionType** | [**ConditionTypeEnum**](#ConditionTypeEnum) | Condition type | [optional] |
+|**smsChannel** | **Boolean** | SMS channel enabled | [optional] |
+|**emailChannel** | **Boolean** | Email channel enabled | [optional] |
+|**memberIds** | **List<Integer>** | Array of member user IDs | [optional] |
+|**slackChannelIds** | **List<String>** | Array of Slack channel IDs | [optional] |
+|**communicationGroupConditions** | [**List<NewCommunicationsGroupDataAttributesCommunicationGroupConditionsInner>**](NewCommunicationsGroupDataAttributesCommunicationGroupConditionsInner.md) | Group conditions attributes | [optional] |
+|**communicationExternalGroupMembers** | [**List<NewCommunicationsGroupDataAttributesCommunicationExternalGroupMembersInner>**](NewCommunicationsGroupDataAttributesCommunicationExternalGroupMembersInner.md) | External group members attributes | [optional] |
+
+
+
+## Enum: ConditionTypeEnum
+
+| Name | Value |
+|---- | -----|
+| ANY | "any" |
+| ALL | "all" |
+
+
+
diff --git a/docs/NewCommunicationsGroupDataAttributesCommunicationExternalGroupMembersInner.md b/docs/NewCommunicationsGroupDataAttributesCommunicationExternalGroupMembersInner.md
new file mode 100644
index 00000000..ef9d290a
--- /dev/null
+++ b/docs/NewCommunicationsGroupDataAttributesCommunicationExternalGroupMembersInner.md
@@ -0,0 +1,15 @@
+
+
+# NewCommunicationsGroupDataAttributesCommunicationExternalGroupMembersInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | Name of the external member | [optional] |
+|**email** | **String** | Email of the external member | [optional] |
+|**phoneNumber** | **String** | Phone number of the external member | [optional] |
+
+
+
diff --git a/docs/NewCommunicationsGroupDataAttributesCommunicationGroupConditionsInner.md b/docs/NewCommunicationsGroupDataAttributesCommunicationGroupConditionsInner.md
new file mode 100644
index 00000000..e25fc0cf
--- /dev/null
+++ b/docs/NewCommunicationsGroupDataAttributesCommunicationGroupConditionsInner.md
@@ -0,0 +1,30 @@
+
+
+# NewCommunicationsGroupDataAttributesCommunicationGroupConditionsInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**propertyType** | [**PropertyTypeEnum**](#PropertyTypeEnum) | Property type | [optional] |
+|**serviceIds** | **List<String>** | Array of service IDs | [optional] |
+|**severityIds** | **List<String>** | Array of severity IDs | [optional] |
+|**functionalityIds** | **List<String>** | Array of functionality IDs | [optional] |
+|**groupIds** | **List<String>** | Array of group IDs | [optional] |
+|**incidentTypeIds** | **List<String>** | Array of incident type IDs | [optional] |
+
+
+
+## Enum: PropertyTypeEnum
+
+| Name | Value |
+|---- | -----|
+| SERVICE | "service" |
+| SEVERITY | "severity" |
+| FUNCTIONALITY | "functionality" |
+| GROUP | "group" |
+| INCIDENT_TYPE | "incident_type" |
+
+
+
diff --git a/docs/NewCommunicationsStage.md b/docs/NewCommunicationsStage.md
new file mode 100644
index 00000000..5c434f19
--- /dev/null
+++ b/docs/NewCommunicationsStage.md
@@ -0,0 +1,13 @@
+
+
+# NewCommunicationsStage
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**NewCommunicationsStageData**](NewCommunicationsStageData.md) | | |
+
+
+
diff --git a/docs/NewCommunicationsStageData.md b/docs/NewCommunicationsStageData.md
new file mode 100644
index 00000000..dd06006c
--- /dev/null
+++ b/docs/NewCommunicationsStageData.md
@@ -0,0 +1,22 @@
+
+
+# NewCommunicationsStageData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**NewCommunicationsStageDataAttributes**](NewCommunicationsStageDataAttributes.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| COMMUNICATIONS_STAGES | "communications_stages" |
+
+
+
diff --git a/docs/NewCommunicationsStageDataAttributes.md b/docs/NewCommunicationsStageDataAttributes.md
new file mode 100644
index 00000000..fecf068a
--- /dev/null
+++ b/docs/NewCommunicationsStageDataAttributes.md
@@ -0,0 +1,15 @@
+
+
+# NewCommunicationsStageDataAttributes
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | The name of the communications stage | |
+|**description** | **String** | The description of the communications stage | [optional] |
+|**position** | **Integer** | Position of the communications stage | [optional] |
+
+
+
diff --git a/docs/NewCommunicationsTemplate.md b/docs/NewCommunicationsTemplate.md
new file mode 100644
index 00000000..86d69ee4
--- /dev/null
+++ b/docs/NewCommunicationsTemplate.md
@@ -0,0 +1,13 @@
+
+
+# NewCommunicationsTemplate
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**NewCommunicationsTemplateData**](NewCommunicationsTemplateData.md) | | |
+
+
+
diff --git a/docs/NewCommunicationsTemplateData.md b/docs/NewCommunicationsTemplateData.md
new file mode 100644
index 00000000..dbffcde9
--- /dev/null
+++ b/docs/NewCommunicationsTemplateData.md
@@ -0,0 +1,22 @@
+
+
+# NewCommunicationsTemplateData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**NewCommunicationsTemplateDataAttributes**](NewCommunicationsTemplateDataAttributes.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| COMMUNICATIONS_TEMPLATES | "communications_templates" |
+
+
+
diff --git a/docs/NewCommunicationsTemplateDataAttributes.md b/docs/NewCommunicationsTemplateDataAttributes.md
new file mode 100644
index 00000000..8b7f64f7
--- /dev/null
+++ b/docs/NewCommunicationsTemplateDataAttributes.md
@@ -0,0 +1,17 @@
+
+
+# NewCommunicationsTemplateDataAttributes
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | The name of the communications template | |
+|**description** | **String** | The description of the communications template | [optional] |
+|**communicationTypeId** | **String** | The communication type ID | |
+|**position** | **Integer** | Position of the communications template | [optional] |
+|**communicationTemplateStagesAttributes** | [**List<NewCommunicationsTemplateDataAttributesCommunicationTemplateStagesAttributesInner>**](NewCommunicationsTemplateDataAttributesCommunicationTemplateStagesAttributesInner.md) | Template stages attributes | [optional] |
+
+
+
diff --git a/docs/NewCommunicationsTemplateDataAttributesCommunicationTemplateStagesAttributesInner.md b/docs/NewCommunicationsTemplateDataAttributesCommunicationTemplateStagesAttributesInner.md
new file mode 100644
index 00000000..8ab6809f
--- /dev/null
+++ b/docs/NewCommunicationsTemplateDataAttributesCommunicationTemplateStagesAttributesInner.md
@@ -0,0 +1,17 @@
+
+
+# NewCommunicationsTemplateDataAttributesCommunicationTemplateStagesAttributesInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**communicationStageId** | **String** | The communication stage ID | [optional] |
+|**smsContent** | **String** | SMS content for the stage | [optional] |
+|**emailSubject** | **String** | Email subject for the stage | [optional] |
+|**emailBody** | **String** | Email body for the stage | [optional] |
+|**slackContent** | **String** | Slack content for the stage | [optional] |
+
+
+
diff --git a/docs/NewCommunicationsType.md b/docs/NewCommunicationsType.md
new file mode 100644
index 00000000..119bd33e
--- /dev/null
+++ b/docs/NewCommunicationsType.md
@@ -0,0 +1,13 @@
+
+
+# NewCommunicationsType
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**NewCommunicationsTypeData**](NewCommunicationsTypeData.md) | | |
+
+
+
diff --git a/docs/NewCommunicationsTypeData.md b/docs/NewCommunicationsTypeData.md
new file mode 100644
index 00000000..06294c9b
--- /dev/null
+++ b/docs/NewCommunicationsTypeData.md
@@ -0,0 +1,22 @@
+
+
+# NewCommunicationsTypeData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**NewCommunicationsTypeDataAttributes**](NewCommunicationsTypeDataAttributes.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| COMMUNICATIONS_TYPES | "communications_types" |
+
+
+
diff --git a/docs/NewCommunicationsTypeDataAttributes.md b/docs/NewCommunicationsTypeDataAttributes.md
new file mode 100644
index 00000000..dbd5459b
--- /dev/null
+++ b/docs/NewCommunicationsTypeDataAttributes.md
@@ -0,0 +1,16 @@
+
+
+# NewCommunicationsTypeDataAttributes
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | The name of the communications type | |
+|**description** | **String** | The description of the communications type | [optional] |
+|**color** | **String** | The color of the communications type | |
+|**position** | **Integer** | Position of the communications type | [optional] |
+
+
+
diff --git a/docs/NewCustomFormDataAttributes.md b/docs/NewCustomFormDataAttributes.md
index 2614f623..1a449dec 100644
--- a/docs/NewCustomFormDataAttributes.md
+++ b/docs/NewCustomFormDataAttributes.md
@@ -8,7 +8,6 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**name** | **String** | The name of the custom form. | |
-|**slug** | **String** | The custom form slug. Add this to form_field.shown or form_field.required to associate form fields with custom forms. | [optional] |
|**description** | **String** | | [optional] |
|**enabled** | **Boolean** | | [optional] |
|**command** | **String** | The Slack command used to trigger this form. | |
diff --git a/docs/NewDashboardPanelDataAttributesParamsDatasetsInner.md b/docs/NewDashboardPanelDataAttributesParamsDatasetsInner.md
index abef5b50..3115fdb1 100644
--- a/docs/NewDashboardPanelDataAttributesParamsDatasetsInner.md
+++ b/docs/NewDashboardPanelDataAttributesParamsDatasetsInner.md
@@ -10,7 +10,7 @@
|**name** | **String** | | [optional] |
|**collection** | [**CollectionEnum**](#CollectionEnum) | | [optional] |
|**filter** | [**List<NewDashboardPanelDataAttributesParamsDatasetsInnerFilterInner>**](NewDashboardPanelDataAttributesParamsDatasetsInnerFilterInner.md) | | [optional] |
-|**groupBy** | **String** | | [optional] |
+|**groupBy** | [**NewDashboardPanelDataAttributesParamsDatasetsInnerGroupBy**](NewDashboardPanelDataAttributesParamsDatasetsInnerGroupBy.md) | | [optional] |
|**aggregate** | [**NewDashboardPanelDataAttributesParamsDatasetsInnerAggregate**](NewDashboardPanelDataAttributesParamsDatasetsInnerAggregate.md) | | [optional] |
diff --git a/docs/NewDashboardPanelDataAttributesParamsDatasetsInnerFilterInnerRulesInner.md b/docs/NewDashboardPanelDataAttributesParamsDatasetsInnerFilterInnerRulesInner.md
index 40dd58b9..666df088 100644
--- a/docs/NewDashboardPanelDataAttributesParamsDatasetsInnerFilterInnerRulesInner.md
+++ b/docs/NewDashboardPanelDataAttributesParamsDatasetsInnerFilterInnerRulesInner.md
@@ -35,6 +35,8 @@
| NOT_EXISTS | "not_exists" |
| CONTAINS | "contains" |
| NOT_CONTAINS | "not_contains" |
+| ASSIGNED | "assigned" |
+| UNASSIGNED | "unassigned" |
diff --git a/docs/NewDashboardPanelDataAttributesParamsDatasetsInnerGroupBy.md b/docs/NewDashboardPanelDataAttributesParamsDatasetsInnerGroupBy.md
new file mode 100644
index 00000000..7a6529dd
--- /dev/null
+++ b/docs/NewDashboardPanelDataAttributesParamsDatasetsInnerGroupBy.md
@@ -0,0 +1,24 @@
+
+
+# NewDashboardPanelDataAttributesParamsDatasetsInnerGroupBy
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**key** | [**KeyEnum**](#KeyEnum) | | |
+|**value** | **String** | | |
+
+
+
+## Enum: KeyEnum
+
+| Name | Value |
+|---- | -----|
+| CUSTOM_FIELD | "custom_field" |
+| INCIDENT_ROLE | "incident_role" |
+| ALERT_FIELD | "alert_field" |
+
+
+
diff --git a/docs/NewDashboardPanelDataAttributesParamsDatasetsInnerGroupByOneOf.md b/docs/NewDashboardPanelDataAttributesParamsDatasetsInnerGroupByOneOf.md
new file mode 100644
index 00000000..c6f2a328
--- /dev/null
+++ b/docs/NewDashboardPanelDataAttributesParamsDatasetsInnerGroupByOneOf.md
@@ -0,0 +1,24 @@
+
+
+# NewDashboardPanelDataAttributesParamsDatasetsInnerGroupByOneOf
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**key** | [**KeyEnum**](#KeyEnum) | | |
+|**value** | **String** | | |
+
+
+
+## Enum: KeyEnum
+
+| Name | Value |
+|---- | -----|
+| CUSTOM_FIELD | "custom_field" |
+| INCIDENT_ROLE | "incident_role" |
+| ALERT_FIELD | "alert_field" |
+
+
+
diff --git a/docs/NewEdgeConnector.md b/docs/NewEdgeConnector.md
new file mode 100644
index 00000000..ba4ced8e
--- /dev/null
+++ b/docs/NewEdgeConnector.md
@@ -0,0 +1,13 @@
+
+
+# NewEdgeConnector
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**edgeConnector** | [**NewEdgeConnectorEdgeConnector**](NewEdgeConnectorEdgeConnector.md) | | |
+
+
+
diff --git a/docs/NewEdgeConnectorAction.md b/docs/NewEdgeConnectorAction.md
new file mode 100644
index 00000000..41d7efdb
--- /dev/null
+++ b/docs/NewEdgeConnectorAction.md
@@ -0,0 +1,13 @@
+
+
+# NewEdgeConnectorAction
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**action** | [**NewEdgeConnectorActionAction**](NewEdgeConnectorActionAction.md) | | |
+
+
+
diff --git a/docs/NewEdgeConnectorActionAction.md b/docs/NewEdgeConnectorActionAction.md
new file mode 100644
index 00000000..f5ddcddd
--- /dev/null
+++ b/docs/NewEdgeConnectorActionAction.md
@@ -0,0 +1,24 @@
+
+
+# NewEdgeConnectorActionAction
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | Action name | |
+|**actionType** | [**ActionTypeEnum**](#ActionTypeEnum) | Action type | |
+|**metadata** | [**NewEdgeConnectorActionActionMetadata**](NewEdgeConnectorActionActionMetadata.md) | | [optional] |
+
+
+
+## Enum: ActionTypeEnum
+
+| Name | Value |
+|---- | -----|
+| SCRIPT | "script" |
+| HTTP | "http" |
+
+
+
diff --git a/docs/NewEdgeConnectorActionActionMetadata.md b/docs/NewEdgeConnectorActionActionMetadata.md
new file mode 100644
index 00000000..01b40e2f
--- /dev/null
+++ b/docs/NewEdgeConnectorActionActionMetadata.md
@@ -0,0 +1,35 @@
+
+
+# NewEdgeConnectorActionActionMetadata
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**description** | **String** | | [optional] |
+|**timeout** | **Integer** | | [optional] |
+|**icon** | [**IconEnum**](#IconEnum) | | [optional] |
+|**parameters** | [**List<EdgeConnectorActionDataAttributesParametersInner>**](EdgeConnectorActionDataAttributesParametersInner.md) | | [optional] |
+
+
+
+## Enum: IconEnum
+
+| Name | Value |
+|---- | -----|
+| BOLT | "bolt" |
+| BOLT_SLASH | "bolt-slash" |
+| COG | "cog" |
+| COMMAND_LINE | "command-line" |
+| CODE_BRACKET | "code-bracket" |
+| SERVER | "server" |
+| SERVER_STACK | "server-stack" |
+| PLAY | "play" |
+| ARROW_PATH | "arrow-path" |
+| WRENCH_SCREWDRIVER | "wrench-screwdriver" |
+| CUBE | "cube" |
+| ROCKET_LAUNCH | "rocket-launch" |
+
+
+
diff --git a/docs/NewEdgeConnectorEdgeConnector.md b/docs/NewEdgeConnectorEdgeConnector.md
new file mode 100644
index 00000000..19afe3c4
--- /dev/null
+++ b/docs/NewEdgeConnectorEdgeConnector.md
@@ -0,0 +1,25 @@
+
+
+# NewEdgeConnectorEdgeConnector
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | Connector name | |
+|**description** | **String** | Connector description | [optional] |
+|**status** | [**StatusEnum**](#StatusEnum) | Connector status | [optional] |
+|**subscriptions** | **List<String>** | Array of event types to subscribe to | [optional] |
+
+
+
+## Enum: StatusEnum
+
+| Name | Value |
+|---- | -----|
+| ACTIVE | "active" |
+| PAUSED | "paused" |
+
+
+
diff --git a/docs/NewEnvironmentDataAttributes.md b/docs/NewEnvironmentDataAttributes.md
index 92aecebb..dd836a48 100644
--- a/docs/NewEnvironmentDataAttributes.md
+++ b/docs/NewEnvironmentDataAttributes.md
@@ -14,6 +14,7 @@
|**notifyEmails** | **List<String>** | Emails to attach to the environment | [optional] |
|**slackChannels** | [**List<NewEnvironmentDataAttributesSlackChannelsInner>**](NewEnvironmentDataAttributesSlackChannelsInner.md) | Slack Channels associated with this environment | [optional] |
|**slackAliases** | [**List<NewEnvironmentDataAttributesSlackAliasesInner>**](NewEnvironmentDataAttributesSlackAliasesInner.md) | Slack Aliases associated with this environment | [optional] |
+|**properties** | [**List<NewCauseDataAttributesPropertiesInner>**](NewCauseDataAttributesPropertiesInner.md) | Array of property values for this environment. | [optional] |
diff --git a/docs/NewEscalationPolicyDataAttributesBusinessHours.md b/docs/NewEscalationPolicyDataAttributesBusinessHours.md
index 50dcc8aa..f721ca79 100644
--- a/docs/NewEscalationPolicyDataAttributesBusinessHours.md
+++ b/docs/NewEscalationPolicyDataAttributesBusinessHours.md
@@ -7,13 +7,324 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
-|**timeZone** | **String** | Time zone for business hours | [optional] |
+|**timeZone** | [**TimeZoneEnum**](#TimeZoneEnum) | Time zone for business hours | [optional] |
|**days** | [**List<DaysEnum>**](#List<DaysEnum>) | Business days | [optional] |
|**startTime** | **String** | Start time for business hours (HH:MM) | [optional] |
|**endTime** | **String** | End time for business hours (HH:MM) | [optional] |
+## Enum: TimeZoneEnum
+
+| Name | Value |
+|---- | -----|
+| INTERNATIONAL_DATE_LINE_WEST | "International Date Line West" |
+| ETC_GMT_12 | "Etc/GMT+12" |
+| AMERICAN_SAMOA | "American Samoa" |
+| PACIFIC_PAGO_PAGO | "Pacific/Pago_Pago" |
+| MIDWAY_ISLAND | "Midway Island" |
+| PACIFIC_MIDWAY | "Pacific/Midway" |
+| HAWAII | "Hawaii" |
+| PACIFIC_HONOLULU | "Pacific/Honolulu" |
+| ALASKA | "Alaska" |
+| AMERICA_JUNEAU | "America/Juneau" |
+| PACIFIC_TIME_US_CANADA_ | "Pacific Time (US & Canada)" |
+| AMERICA_LOS_ANGELES | "America/Los_Angeles" |
+| TIJUANA | "Tijuana" |
+| AMERICA_TIJUANA | "America/Tijuana" |
+| ARIZONA | "Arizona" |
+| AMERICA_PHOENIX | "America/Phoenix" |
+| MAZATLAN | "Mazatlan" |
+| AMERICA_MAZATLAN | "America/Mazatlan" |
+| MOUNTAIN_TIME_US_CANADA_ | "Mountain Time (US & Canada)" |
+| AMERICA_DENVER | "America/Denver" |
+| CENTRAL_AMERICA | "Central America" |
+| AMERICA_GUATEMALA | "America/Guatemala" |
+| CENTRAL_TIME_US_CANADA_ | "Central Time (US & Canada)" |
+| AMERICA_CHICAGO | "America/Chicago" |
+| CHIHUAHUA | "Chihuahua" |
+| AMERICA_CHIHUAHUA | "America/Chihuahua" |
+| GUADALAJARA | "Guadalajara" |
+| AMERICA_MEXICO_CITY | "America/Mexico_City" |
+| MEXICO_CITY | "Mexico City" |
+| AMERICA_MEXICO_CITY2 | "America/Mexico_City" |
+| MONTERREY | "Monterrey" |
+| AMERICA_MONTERREY | "America/Monterrey" |
+| SASKATCHEWAN | "Saskatchewan" |
+| AMERICA_REGINA | "America/Regina" |
+| BOGOTA | "Bogota" |
+| AMERICA_BOGOTA | "America/Bogota" |
+| EASTERN_TIME_US_CANADA_ | "Eastern Time (US & Canada)" |
+| AMERICA_NEW_YORK | "America/New_York" |
+| INDIANA_EAST_ | "Indiana (East)" |
+| AMERICA_INDIANA_INDIANAPOLIS | "America/Indiana/Indianapolis" |
+| LIMA | "Lima" |
+| AMERICA_LIMA | "America/Lima" |
+| QUITO | "Quito" |
+| AMERICA_LIMA2 | "America/Lima" |
+| ATLANTIC_TIME_CANADA_ | "Atlantic Time (Canada)" |
+| AMERICA_HALIFAX | "America/Halifax" |
+| CARACAS | "Caracas" |
+| AMERICA_CARACAS | "America/Caracas" |
+| GEORGETOWN | "Georgetown" |
+| AMERICA_GUYANA | "America/Guyana" |
+| LA_PAZ | "La Paz" |
+| AMERICA_LA_PAZ | "America/La_Paz" |
+| PUERTO_RICO | "Puerto Rico" |
+| AMERICA_PUERTO_RICO | "America/Puerto_Rico" |
+| SANTIAGO | "Santiago" |
+| AMERICA_SANTIAGO | "America/Santiago" |
+| NEWFOUNDLAND | "Newfoundland" |
+| AMERICA_ST_JOHNS | "America/St_Johns" |
+| ASUNCION | "Asuncion" |
+| AMERICA_ASUNCION | "America/Asuncion" |
+| BRASILIA | "Brasilia" |
+| AMERICA_SAO_PAULO | "America/Sao_Paulo" |
+| BUENOS_AIRES | "Buenos Aires" |
+| AMERICA_ARGENTINA_BUENOS_AIRES | "America/Argentina/Buenos_Aires" |
+| MONTEVIDEO | "Montevideo" |
+| AMERICA_MONTEVIDEO | "America/Montevideo" |
+| GREENLAND | "Greenland" |
+| AMERICA_NUUK | "America/Nuuk" |
+| MID_ATLANTIC | "Mid-Atlantic" |
+| ATLANTIC_SOUTH_GEORGIA | "Atlantic/South_Georgia" |
+| AZORES | "Azores" |
+| ATLANTIC_AZORES | "Atlantic/Azores" |
+| CAPE_VERDE_IS_ | "Cape Verde Is." |
+| ATLANTIC_CAPE_VERDE | "Atlantic/Cape_Verde" |
+| EDINBURGH | "Edinburgh" |
+| EUROPE_LONDON | "Europe/London" |
+| LISBON | "Lisbon" |
+| EUROPE_LISBON | "Europe/Lisbon" |
+| LONDON | "London" |
+| EUROPE_LONDON2 | "Europe/London" |
+| MONROVIA | "Monrovia" |
+| AFRICA_MONROVIA | "Africa/Monrovia" |
+| UTC | "UTC" |
+| ETC_UTC | "Etc/UTC" |
+| AMSTERDAM | "Amsterdam" |
+| EUROPE_AMSTERDAM | "Europe/Amsterdam" |
+| BELGRADE | "Belgrade" |
+| EUROPE_BELGRADE | "Europe/Belgrade" |
+| BERLIN | "Berlin" |
+| EUROPE_BERLIN | "Europe/Berlin" |
+| BERN | "Bern" |
+| EUROPE_ZURICH | "Europe/Zurich" |
+| BRATISLAVA | "Bratislava" |
+| EUROPE_BRATISLAVA | "Europe/Bratislava" |
+| BRUSSELS | "Brussels" |
+| EUROPE_BRUSSELS | "Europe/Brussels" |
+| BUDAPEST | "Budapest" |
+| EUROPE_BUDAPEST | "Europe/Budapest" |
+| CASABLANCA | "Casablanca" |
+| AFRICA_CASABLANCA | "Africa/Casablanca" |
+| COPENHAGEN | "Copenhagen" |
+| EUROPE_COPENHAGEN | "Europe/Copenhagen" |
+| DUBLIN | "Dublin" |
+| EUROPE_DUBLIN | "Europe/Dublin" |
+| LJUBLJANA | "Ljubljana" |
+| EUROPE_LJUBLJANA | "Europe/Ljubljana" |
+| MADRID | "Madrid" |
+| EUROPE_MADRID | "Europe/Madrid" |
+| PARIS | "Paris" |
+| EUROPE_PARIS | "Europe/Paris" |
+| PRAGUE | "Prague" |
+| EUROPE_PRAGUE | "Europe/Prague" |
+| ROME | "Rome" |
+| EUROPE_ROME | "Europe/Rome" |
+| SARAJEVO | "Sarajevo" |
+| EUROPE_SARAJEVO | "Europe/Sarajevo" |
+| SKOPJE | "Skopje" |
+| EUROPE_SKOPJE | "Europe/Skopje" |
+| STOCKHOLM | "Stockholm" |
+| EUROPE_STOCKHOLM | "Europe/Stockholm" |
+| VIENNA | "Vienna" |
+| EUROPE_VIENNA | "Europe/Vienna" |
+| WARSAW | "Warsaw" |
+| EUROPE_WARSAW | "Europe/Warsaw" |
+| WEST_CENTRAL_AFRICA | "West Central Africa" |
+| AFRICA_ALGIERS | "Africa/Algiers" |
+| ZAGREB | "Zagreb" |
+| EUROPE_ZAGREB | "Europe/Zagreb" |
+| ZURICH | "Zurich" |
+| EUROPE_ZURICH2 | "Europe/Zurich" |
+| ATHENS | "Athens" |
+| EUROPE_ATHENS | "Europe/Athens" |
+| BUCHAREST | "Bucharest" |
+| EUROPE_BUCHAREST | "Europe/Bucharest" |
+| CAIRO | "Cairo" |
+| AFRICA_CAIRO | "Africa/Cairo" |
+| HARARE | "Harare" |
+| AFRICA_HARARE | "Africa/Harare" |
+| HELSINKI | "Helsinki" |
+| EUROPE_HELSINKI | "Europe/Helsinki" |
+| JERUSALEM | "Jerusalem" |
+| ASIA_JERUSALEM | "Asia/Jerusalem" |
+| KALININGRAD | "Kaliningrad" |
+| EUROPE_KALININGRAD | "Europe/Kaliningrad" |
+| KYIV | "Kyiv" |
+| EUROPE_KIEV | "Europe/Kiev" |
+| PRETORIA | "Pretoria" |
+| AFRICA_JOHANNESBURG | "Africa/Johannesburg" |
+| RIGA | "Riga" |
+| EUROPE_RIGA | "Europe/Riga" |
+| SOFIA | "Sofia" |
+| EUROPE_SOFIA | "Europe/Sofia" |
+| TALLINN | "Tallinn" |
+| EUROPE_TALLINN | "Europe/Tallinn" |
+| VILNIUS | "Vilnius" |
+| EUROPE_VILNIUS | "Europe/Vilnius" |
+| BAGHDAD | "Baghdad" |
+| ASIA_BAGHDAD | "Asia/Baghdad" |
+| ISTANBUL | "Istanbul" |
+| EUROPE_ISTANBUL | "Europe/Istanbul" |
+| KUWAIT | "Kuwait" |
+| ASIA_KUWAIT | "Asia/Kuwait" |
+| MINSK | "Minsk" |
+| EUROPE_MINSK | "Europe/Minsk" |
+| MOSCOW | "Moscow" |
+| EUROPE_MOSCOW | "Europe/Moscow" |
+| NAIROBI | "Nairobi" |
+| AFRICA_NAIROBI | "Africa/Nairobi" |
+| RIYADH | "Riyadh" |
+| ASIA_RIYADH | "Asia/Riyadh" |
+| ST_PETERSBURG | "St. Petersburg" |
+| EUROPE_MOSCOW2 | "Europe/Moscow" |
+| VOLGOGRAD | "Volgograd" |
+| EUROPE_VOLGOGRAD | "Europe/Volgograd" |
+| TEHRAN | "Tehran" |
+| ASIA_TEHRAN | "Asia/Tehran" |
+| ABU_DHABI | "Abu Dhabi" |
+| ASIA_MUSCAT | "Asia/Muscat" |
+| BAKU | "Baku" |
+| ASIA_BAKU | "Asia/Baku" |
+| MUSCAT | "Muscat" |
+| ASIA_MUSCAT2 | "Asia/Muscat" |
+| SAMARA | "Samara" |
+| EUROPE_SAMARA | "Europe/Samara" |
+| TBILISI | "Tbilisi" |
+| ASIA_TBILISI | "Asia/Tbilisi" |
+| YEREVAN | "Yerevan" |
+| ASIA_YEREVAN | "Asia/Yerevan" |
+| KABUL | "Kabul" |
+| ASIA_KABUL | "Asia/Kabul" |
+| ALMATY | "Almaty" |
+| ASIA_ALMATY | "Asia/Almaty" |
+| ASTANA | "Astana" |
+| ASIA_ALMATY2 | "Asia/Almaty" |
+| EKATERINBURG | "Ekaterinburg" |
+| ASIA_YEKATERINBURG | "Asia/Yekaterinburg" |
+| ISLAMABAD | "Islamabad" |
+| ASIA_KARACHI | "Asia/Karachi" |
+| KARACHI | "Karachi" |
+| ASIA_KARACHI2 | "Asia/Karachi" |
+| TASHKENT | "Tashkent" |
+| ASIA_TASHKENT | "Asia/Tashkent" |
+| CHENNAI | "Chennai" |
+| ASIA_KOLKATA | "Asia/Kolkata" |
+| KOLKATA | "Kolkata" |
+| ASIA_KOLKATA2 | "Asia/Kolkata" |
+| MUMBAI | "Mumbai" |
+| ASIA_KOLKATA3 | "Asia/Kolkata" |
+| NEW_DELHI | "New Delhi" |
+| ASIA_KOLKATA4 | "Asia/Kolkata" |
+| SRI_JAYAWARDENEPURA | "Sri Jayawardenepura" |
+| ASIA_COLOMBO | "Asia/Colombo" |
+| KATHMANDU | "Kathmandu" |
+| ASIA_KATHMANDU | "Asia/Kathmandu" |
+| DHAKA | "Dhaka" |
+| ASIA_DHAKA | "Asia/Dhaka" |
+| URUMQI | "Urumqi" |
+| ASIA_URUMQI | "Asia/Urumqi" |
+| RANGOON | "Rangoon" |
+| ASIA_RANGOON | "Asia/Rangoon" |
+| BANGKOK | "Bangkok" |
+| ASIA_BANGKOK | "Asia/Bangkok" |
+| HANOI | "Hanoi" |
+| ASIA_BANGKOK2 | "Asia/Bangkok" |
+| JAKARTA | "Jakarta" |
+| ASIA_JAKARTA | "Asia/Jakarta" |
+| KRASNOYARSK | "Krasnoyarsk" |
+| ASIA_KRASNOYARSK | "Asia/Krasnoyarsk" |
+| NOVOSIBIRSK | "Novosibirsk" |
+| ASIA_NOVOSIBIRSK | "Asia/Novosibirsk" |
+| BEIJING | "Beijing" |
+| ASIA_SHANGHAI | "Asia/Shanghai" |
+| CHONGQING | "Chongqing" |
+| ASIA_CHONGQING | "Asia/Chongqing" |
+| HONG_KONG | "Hong Kong" |
+| ASIA_HONG_KONG | "Asia/Hong_Kong" |
+| IRKUTSK | "Irkutsk" |
+| ASIA_IRKUTSK | "Asia/Irkutsk" |
+| KUALA_LUMPUR | "Kuala Lumpur" |
+| ASIA_KUALA_LUMPUR | "Asia/Kuala_Lumpur" |
+| PERTH | "Perth" |
+| AUSTRALIA_PERTH | "Australia/Perth" |
+| SINGAPORE | "Singapore" |
+| ASIA_SINGAPORE | "Asia/Singapore" |
+| TAIPEI | "Taipei" |
+| ASIA_TAIPEI | "Asia/Taipei" |
+| ULAANBAATAR | "Ulaanbaatar" |
+| ASIA_ULAANBAATAR | "Asia/Ulaanbaatar" |
+| OSAKA | "Osaka" |
+| ASIA_TOKYO | "Asia/Tokyo" |
+| SAPPORO | "Sapporo" |
+| ASIA_TOKYO2 | "Asia/Tokyo" |
+| SEOUL | "Seoul" |
+| ASIA_SEOUL | "Asia/Seoul" |
+| TOKYO | "Tokyo" |
+| ASIA_TOKYO3 | "Asia/Tokyo" |
+| YAKUTSK | "Yakutsk" |
+| ASIA_YAKUTSK | "Asia/Yakutsk" |
+| ADELAIDE | "Adelaide" |
+| AUSTRALIA_ADELAIDE | "Australia/Adelaide" |
+| DARWIN | "Darwin" |
+| AUSTRALIA_DARWIN | "Australia/Darwin" |
+| BRISBANE | "Brisbane" |
+| AUSTRALIA_BRISBANE | "Australia/Brisbane" |
+| CANBERRA | "Canberra" |
+| AUSTRALIA_CANBERRA | "Australia/Canberra" |
+| GUAM | "Guam" |
+| PACIFIC_GUAM | "Pacific/Guam" |
+| HOBART | "Hobart" |
+| AUSTRALIA_HOBART | "Australia/Hobart" |
+| MELBOURNE | "Melbourne" |
+| AUSTRALIA_MELBOURNE | "Australia/Melbourne" |
+| PORT_MORESBY | "Port Moresby" |
+| PACIFIC_PORT_MORESBY | "Pacific/Port_Moresby" |
+| SYDNEY | "Sydney" |
+| AUSTRALIA_SYDNEY | "Australia/Sydney" |
+| VLADIVOSTOK | "Vladivostok" |
+| ASIA_VLADIVOSTOK | "Asia/Vladivostok" |
+| MAGADAN | "Magadan" |
+| ASIA_MAGADAN | "Asia/Magadan" |
+| NEW_CALEDONIA | "New Caledonia" |
+| PACIFIC_NOUMEA | "Pacific/Noumea" |
+| SOLOMON_IS_ | "Solomon Is." |
+| PACIFIC_GUADALCANAL | "Pacific/Guadalcanal" |
+| SREDNEKOLYMSK | "Srednekolymsk" |
+| ASIA_SREDNEKOLYMSK | "Asia/Srednekolymsk" |
+| AUCKLAND | "Auckland" |
+| PACIFIC_AUCKLAND | "Pacific/Auckland" |
+| FIJI | "Fiji" |
+| PACIFIC_FIJI | "Pacific/Fiji" |
+| KAMCHATKA | "Kamchatka" |
+| ASIA_KAMCHATKA | "Asia/Kamchatka" |
+| MARSHALL_IS_ | "Marshall Is." |
+| PACIFIC_MAJURO | "Pacific/Majuro" |
+| WELLINGTON | "Wellington" |
+| PACIFIC_AUCKLAND2 | "Pacific/Auckland" |
+| CHATHAM_IS_ | "Chatham Is." |
+| PACIFIC_CHATHAM | "Pacific/Chatham" |
+| NUKU_ALOFA | "Nuku'alofa" |
+| PACIFIC_TONGATAPU | "Pacific/Tongatapu" |
+| SAMOA | "Samoa" |
+| PACIFIC_APIA | "Pacific/Apia" |
+| TOKELAU_IS_ | "Tokelau Is." |
+| PACIFIC_FAKAOFO | "Pacific/Fakaofo" |
+
+
+
## Enum: List<DaysEnum>
| Name | Value |
diff --git a/docs/NewEscalationPolicyLevelDataAttributes.md b/docs/NewEscalationPolicyLevelDataAttributes.md
index e14b15e6..e3909b59 100644
--- a/docs/NewEscalationPolicyLevelDataAttributes.md
+++ b/docs/NewEscalationPolicyLevelDataAttributes.md
@@ -7,7 +7,7 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
-|**delay** | **Integer** | Delay before notification targets will be alerted. | [optional] |
+|**delay** | **Integer** | Delay before notifying targets in the next Escalation Level. | [optional] |
|**position** | **Integer** | Position of the escalation policy level | |
|**pagingStrategyConfigurationStrategy** | [**PagingStrategyConfigurationStrategyEnum**](#PagingStrategyConfigurationStrategyEnum) | | [optional] |
|**pagingStrategyConfigurationScheduleStrategy** | [**PagingStrategyConfigurationScheduleStrategyEnum**](#PagingStrategyConfigurationScheduleStrategyEnum) | | [optional] |
diff --git a/docs/NewEscalationPolicyPathDataAttributes.md b/docs/NewEscalationPolicyPathDataAttributes.md
index 4d4e58f6..a8997cbd 100644
--- a/docs/NewEscalationPolicyPathDataAttributes.md
+++ b/docs/NewEscalationPolicyPathDataAttributes.md
@@ -9,6 +9,9 @@
|------------ | ------------- | ------------- | -------------|
|**name** | **String** | The name of the escalation path | |
|**notificationType** | [**NotificationTypeEnum**](#NotificationTypeEnum) | Notification rule type to be used | [optional] |
+|**pathType** | [**PathTypeEnum**](#PathTypeEnum) | The type of escalation path to create | [optional] |
+|**afterDeferralBehavior** | [**AfterDeferralBehaviorEnum**](#AfterDeferralBehaviorEnum) | What happens after a deferral path finishes. Required for deferral paths. | [optional] |
+|**afterDeferralPathId** | **String** | The escalation path to execute after this deferral path when after_deferral_behavior is execute_path. | [optional] |
|**_default** | **Boolean** | Whether this escalation path is the default path | [optional] |
|**matchMode** | [**MatchModeEnum**](#MatchModeEnum) | How path rules are matched. | [optional] |
|**position** | **Integer** | The position of this path in the paths for this EP. | [optional] |
@@ -16,6 +19,8 @@
|**repeatCount** | **Integer** | The number of times this path will be executed until someone acknowledges the alert | [optional] |
|**initialDelay** | **Integer** | Initial delay for escalation path in minutes. Maximum 1 week (10080). | [optional] |
|**rules** | [**List<NewEscalationPolicyPathDataAttributesRulesInner>**](NewEscalationPolicyPathDataAttributesRulesInner.md) | Escalation path conditions | [optional] |
+|**timeRestrictionTimeZone** | [**TimeRestrictionTimeZoneEnum**](#TimeRestrictionTimeZoneEnum) | Time zone used for time restrictions. | [optional] |
+|**timeRestrictions** | [**List<NewEscalationPolicyPathDataAttributesTimeRestrictionsInner>**](NewEscalationPolicyPathDataAttributesTimeRestrictionsInner.md) | If time restrictions are set, alerts will follow this path when they arrive within the specified time ranges and meet the rules. | [optional] |
@@ -28,6 +33,24 @@
+## Enum: PathTypeEnum
+
+| Name | Value |
+|---- | -----|
+| ESCALATION | "escalation" |
+| DEFERRAL | "deferral" |
+
+
+
+## Enum: AfterDeferralBehaviorEnum
+
+| Name | Value |
+|---- | -----|
+| RE_EVALUATE | "re_evaluate" |
+| EXECUTE_PATH | "execute_path" |
+
+
+
## Enum: MatchModeEnum
| Name | Value |
@@ -37,3 +60,314 @@
+## Enum: TimeRestrictionTimeZoneEnum
+
+| Name | Value |
+|---- | -----|
+| INTERNATIONAL_DATE_LINE_WEST | "International Date Line West" |
+| ETC_GMT_12 | "Etc/GMT+12" |
+| AMERICAN_SAMOA | "American Samoa" |
+| PACIFIC_PAGO_PAGO | "Pacific/Pago_Pago" |
+| MIDWAY_ISLAND | "Midway Island" |
+| PACIFIC_MIDWAY | "Pacific/Midway" |
+| HAWAII | "Hawaii" |
+| PACIFIC_HONOLULU | "Pacific/Honolulu" |
+| ALASKA | "Alaska" |
+| AMERICA_JUNEAU | "America/Juneau" |
+| PACIFIC_TIME_US_CANADA_ | "Pacific Time (US & Canada)" |
+| AMERICA_LOS_ANGELES | "America/Los_Angeles" |
+| TIJUANA | "Tijuana" |
+| AMERICA_TIJUANA | "America/Tijuana" |
+| ARIZONA | "Arizona" |
+| AMERICA_PHOENIX | "America/Phoenix" |
+| MAZATLAN | "Mazatlan" |
+| AMERICA_MAZATLAN | "America/Mazatlan" |
+| MOUNTAIN_TIME_US_CANADA_ | "Mountain Time (US & Canada)" |
+| AMERICA_DENVER | "America/Denver" |
+| CENTRAL_AMERICA | "Central America" |
+| AMERICA_GUATEMALA | "America/Guatemala" |
+| CENTRAL_TIME_US_CANADA_ | "Central Time (US & Canada)" |
+| AMERICA_CHICAGO | "America/Chicago" |
+| CHIHUAHUA | "Chihuahua" |
+| AMERICA_CHIHUAHUA | "America/Chihuahua" |
+| GUADALAJARA | "Guadalajara" |
+| AMERICA_MEXICO_CITY | "America/Mexico_City" |
+| MEXICO_CITY | "Mexico City" |
+| AMERICA_MEXICO_CITY2 | "America/Mexico_City" |
+| MONTERREY | "Monterrey" |
+| AMERICA_MONTERREY | "America/Monterrey" |
+| SASKATCHEWAN | "Saskatchewan" |
+| AMERICA_REGINA | "America/Regina" |
+| BOGOTA | "Bogota" |
+| AMERICA_BOGOTA | "America/Bogota" |
+| EASTERN_TIME_US_CANADA_ | "Eastern Time (US & Canada)" |
+| AMERICA_NEW_YORK | "America/New_York" |
+| INDIANA_EAST_ | "Indiana (East)" |
+| AMERICA_INDIANA_INDIANAPOLIS | "America/Indiana/Indianapolis" |
+| LIMA | "Lima" |
+| AMERICA_LIMA | "America/Lima" |
+| QUITO | "Quito" |
+| AMERICA_LIMA2 | "America/Lima" |
+| ATLANTIC_TIME_CANADA_ | "Atlantic Time (Canada)" |
+| AMERICA_HALIFAX | "America/Halifax" |
+| CARACAS | "Caracas" |
+| AMERICA_CARACAS | "America/Caracas" |
+| GEORGETOWN | "Georgetown" |
+| AMERICA_GUYANA | "America/Guyana" |
+| LA_PAZ | "La Paz" |
+| AMERICA_LA_PAZ | "America/La_Paz" |
+| PUERTO_RICO | "Puerto Rico" |
+| AMERICA_PUERTO_RICO | "America/Puerto_Rico" |
+| SANTIAGO | "Santiago" |
+| AMERICA_SANTIAGO | "America/Santiago" |
+| NEWFOUNDLAND | "Newfoundland" |
+| AMERICA_ST_JOHNS | "America/St_Johns" |
+| ASUNCION | "Asuncion" |
+| AMERICA_ASUNCION | "America/Asuncion" |
+| BRASILIA | "Brasilia" |
+| AMERICA_SAO_PAULO | "America/Sao_Paulo" |
+| BUENOS_AIRES | "Buenos Aires" |
+| AMERICA_ARGENTINA_BUENOS_AIRES | "America/Argentina/Buenos_Aires" |
+| MONTEVIDEO | "Montevideo" |
+| AMERICA_MONTEVIDEO | "America/Montevideo" |
+| GREENLAND | "Greenland" |
+| AMERICA_NUUK | "America/Nuuk" |
+| MID_ATLANTIC | "Mid-Atlantic" |
+| ATLANTIC_SOUTH_GEORGIA | "Atlantic/South_Georgia" |
+| AZORES | "Azores" |
+| ATLANTIC_AZORES | "Atlantic/Azores" |
+| CAPE_VERDE_IS_ | "Cape Verde Is." |
+| ATLANTIC_CAPE_VERDE | "Atlantic/Cape_Verde" |
+| EDINBURGH | "Edinburgh" |
+| EUROPE_LONDON | "Europe/London" |
+| LISBON | "Lisbon" |
+| EUROPE_LISBON | "Europe/Lisbon" |
+| LONDON | "London" |
+| EUROPE_LONDON2 | "Europe/London" |
+| MONROVIA | "Monrovia" |
+| AFRICA_MONROVIA | "Africa/Monrovia" |
+| UTC | "UTC" |
+| ETC_UTC | "Etc/UTC" |
+| AMSTERDAM | "Amsterdam" |
+| EUROPE_AMSTERDAM | "Europe/Amsterdam" |
+| BELGRADE | "Belgrade" |
+| EUROPE_BELGRADE | "Europe/Belgrade" |
+| BERLIN | "Berlin" |
+| EUROPE_BERLIN | "Europe/Berlin" |
+| BERN | "Bern" |
+| EUROPE_ZURICH | "Europe/Zurich" |
+| BRATISLAVA | "Bratislava" |
+| EUROPE_BRATISLAVA | "Europe/Bratislava" |
+| BRUSSELS | "Brussels" |
+| EUROPE_BRUSSELS | "Europe/Brussels" |
+| BUDAPEST | "Budapest" |
+| EUROPE_BUDAPEST | "Europe/Budapest" |
+| CASABLANCA | "Casablanca" |
+| AFRICA_CASABLANCA | "Africa/Casablanca" |
+| COPENHAGEN | "Copenhagen" |
+| EUROPE_COPENHAGEN | "Europe/Copenhagen" |
+| DUBLIN | "Dublin" |
+| EUROPE_DUBLIN | "Europe/Dublin" |
+| LJUBLJANA | "Ljubljana" |
+| EUROPE_LJUBLJANA | "Europe/Ljubljana" |
+| MADRID | "Madrid" |
+| EUROPE_MADRID | "Europe/Madrid" |
+| PARIS | "Paris" |
+| EUROPE_PARIS | "Europe/Paris" |
+| PRAGUE | "Prague" |
+| EUROPE_PRAGUE | "Europe/Prague" |
+| ROME | "Rome" |
+| EUROPE_ROME | "Europe/Rome" |
+| SARAJEVO | "Sarajevo" |
+| EUROPE_SARAJEVO | "Europe/Sarajevo" |
+| SKOPJE | "Skopje" |
+| EUROPE_SKOPJE | "Europe/Skopje" |
+| STOCKHOLM | "Stockholm" |
+| EUROPE_STOCKHOLM | "Europe/Stockholm" |
+| VIENNA | "Vienna" |
+| EUROPE_VIENNA | "Europe/Vienna" |
+| WARSAW | "Warsaw" |
+| EUROPE_WARSAW | "Europe/Warsaw" |
+| WEST_CENTRAL_AFRICA | "West Central Africa" |
+| AFRICA_ALGIERS | "Africa/Algiers" |
+| ZAGREB | "Zagreb" |
+| EUROPE_ZAGREB | "Europe/Zagreb" |
+| ZURICH | "Zurich" |
+| EUROPE_ZURICH2 | "Europe/Zurich" |
+| ATHENS | "Athens" |
+| EUROPE_ATHENS | "Europe/Athens" |
+| BUCHAREST | "Bucharest" |
+| EUROPE_BUCHAREST | "Europe/Bucharest" |
+| CAIRO | "Cairo" |
+| AFRICA_CAIRO | "Africa/Cairo" |
+| HARARE | "Harare" |
+| AFRICA_HARARE | "Africa/Harare" |
+| HELSINKI | "Helsinki" |
+| EUROPE_HELSINKI | "Europe/Helsinki" |
+| JERUSALEM | "Jerusalem" |
+| ASIA_JERUSALEM | "Asia/Jerusalem" |
+| KALININGRAD | "Kaliningrad" |
+| EUROPE_KALININGRAD | "Europe/Kaliningrad" |
+| KYIV | "Kyiv" |
+| EUROPE_KIEV | "Europe/Kiev" |
+| PRETORIA | "Pretoria" |
+| AFRICA_JOHANNESBURG | "Africa/Johannesburg" |
+| RIGA | "Riga" |
+| EUROPE_RIGA | "Europe/Riga" |
+| SOFIA | "Sofia" |
+| EUROPE_SOFIA | "Europe/Sofia" |
+| TALLINN | "Tallinn" |
+| EUROPE_TALLINN | "Europe/Tallinn" |
+| VILNIUS | "Vilnius" |
+| EUROPE_VILNIUS | "Europe/Vilnius" |
+| BAGHDAD | "Baghdad" |
+| ASIA_BAGHDAD | "Asia/Baghdad" |
+| ISTANBUL | "Istanbul" |
+| EUROPE_ISTANBUL | "Europe/Istanbul" |
+| KUWAIT | "Kuwait" |
+| ASIA_KUWAIT | "Asia/Kuwait" |
+| MINSK | "Minsk" |
+| EUROPE_MINSK | "Europe/Minsk" |
+| MOSCOW | "Moscow" |
+| EUROPE_MOSCOW | "Europe/Moscow" |
+| NAIROBI | "Nairobi" |
+| AFRICA_NAIROBI | "Africa/Nairobi" |
+| RIYADH | "Riyadh" |
+| ASIA_RIYADH | "Asia/Riyadh" |
+| ST_PETERSBURG | "St. Petersburg" |
+| EUROPE_MOSCOW2 | "Europe/Moscow" |
+| VOLGOGRAD | "Volgograd" |
+| EUROPE_VOLGOGRAD | "Europe/Volgograd" |
+| TEHRAN | "Tehran" |
+| ASIA_TEHRAN | "Asia/Tehran" |
+| ABU_DHABI | "Abu Dhabi" |
+| ASIA_MUSCAT | "Asia/Muscat" |
+| BAKU | "Baku" |
+| ASIA_BAKU | "Asia/Baku" |
+| MUSCAT | "Muscat" |
+| ASIA_MUSCAT2 | "Asia/Muscat" |
+| SAMARA | "Samara" |
+| EUROPE_SAMARA | "Europe/Samara" |
+| TBILISI | "Tbilisi" |
+| ASIA_TBILISI | "Asia/Tbilisi" |
+| YEREVAN | "Yerevan" |
+| ASIA_YEREVAN | "Asia/Yerevan" |
+| KABUL | "Kabul" |
+| ASIA_KABUL | "Asia/Kabul" |
+| ALMATY | "Almaty" |
+| ASIA_ALMATY | "Asia/Almaty" |
+| ASTANA | "Astana" |
+| ASIA_ALMATY2 | "Asia/Almaty" |
+| EKATERINBURG | "Ekaterinburg" |
+| ASIA_YEKATERINBURG | "Asia/Yekaterinburg" |
+| ISLAMABAD | "Islamabad" |
+| ASIA_KARACHI | "Asia/Karachi" |
+| KARACHI | "Karachi" |
+| ASIA_KARACHI2 | "Asia/Karachi" |
+| TASHKENT | "Tashkent" |
+| ASIA_TASHKENT | "Asia/Tashkent" |
+| CHENNAI | "Chennai" |
+| ASIA_KOLKATA | "Asia/Kolkata" |
+| KOLKATA | "Kolkata" |
+| ASIA_KOLKATA2 | "Asia/Kolkata" |
+| MUMBAI | "Mumbai" |
+| ASIA_KOLKATA3 | "Asia/Kolkata" |
+| NEW_DELHI | "New Delhi" |
+| ASIA_KOLKATA4 | "Asia/Kolkata" |
+| SRI_JAYAWARDENEPURA | "Sri Jayawardenepura" |
+| ASIA_COLOMBO | "Asia/Colombo" |
+| KATHMANDU | "Kathmandu" |
+| ASIA_KATHMANDU | "Asia/Kathmandu" |
+| DHAKA | "Dhaka" |
+| ASIA_DHAKA | "Asia/Dhaka" |
+| URUMQI | "Urumqi" |
+| ASIA_URUMQI | "Asia/Urumqi" |
+| RANGOON | "Rangoon" |
+| ASIA_RANGOON | "Asia/Rangoon" |
+| BANGKOK | "Bangkok" |
+| ASIA_BANGKOK | "Asia/Bangkok" |
+| HANOI | "Hanoi" |
+| ASIA_BANGKOK2 | "Asia/Bangkok" |
+| JAKARTA | "Jakarta" |
+| ASIA_JAKARTA | "Asia/Jakarta" |
+| KRASNOYARSK | "Krasnoyarsk" |
+| ASIA_KRASNOYARSK | "Asia/Krasnoyarsk" |
+| NOVOSIBIRSK | "Novosibirsk" |
+| ASIA_NOVOSIBIRSK | "Asia/Novosibirsk" |
+| BEIJING | "Beijing" |
+| ASIA_SHANGHAI | "Asia/Shanghai" |
+| CHONGQING | "Chongqing" |
+| ASIA_CHONGQING | "Asia/Chongqing" |
+| HONG_KONG | "Hong Kong" |
+| ASIA_HONG_KONG | "Asia/Hong_Kong" |
+| IRKUTSK | "Irkutsk" |
+| ASIA_IRKUTSK | "Asia/Irkutsk" |
+| KUALA_LUMPUR | "Kuala Lumpur" |
+| ASIA_KUALA_LUMPUR | "Asia/Kuala_Lumpur" |
+| PERTH | "Perth" |
+| AUSTRALIA_PERTH | "Australia/Perth" |
+| SINGAPORE | "Singapore" |
+| ASIA_SINGAPORE | "Asia/Singapore" |
+| TAIPEI | "Taipei" |
+| ASIA_TAIPEI | "Asia/Taipei" |
+| ULAANBAATAR | "Ulaanbaatar" |
+| ASIA_ULAANBAATAR | "Asia/Ulaanbaatar" |
+| OSAKA | "Osaka" |
+| ASIA_TOKYO | "Asia/Tokyo" |
+| SAPPORO | "Sapporo" |
+| ASIA_TOKYO2 | "Asia/Tokyo" |
+| SEOUL | "Seoul" |
+| ASIA_SEOUL | "Asia/Seoul" |
+| TOKYO | "Tokyo" |
+| ASIA_TOKYO3 | "Asia/Tokyo" |
+| YAKUTSK | "Yakutsk" |
+| ASIA_YAKUTSK | "Asia/Yakutsk" |
+| ADELAIDE | "Adelaide" |
+| AUSTRALIA_ADELAIDE | "Australia/Adelaide" |
+| DARWIN | "Darwin" |
+| AUSTRALIA_DARWIN | "Australia/Darwin" |
+| BRISBANE | "Brisbane" |
+| AUSTRALIA_BRISBANE | "Australia/Brisbane" |
+| CANBERRA | "Canberra" |
+| AUSTRALIA_CANBERRA | "Australia/Canberra" |
+| GUAM | "Guam" |
+| PACIFIC_GUAM | "Pacific/Guam" |
+| HOBART | "Hobart" |
+| AUSTRALIA_HOBART | "Australia/Hobart" |
+| MELBOURNE | "Melbourne" |
+| AUSTRALIA_MELBOURNE | "Australia/Melbourne" |
+| PORT_MORESBY | "Port Moresby" |
+| PACIFIC_PORT_MORESBY | "Pacific/Port_Moresby" |
+| SYDNEY | "Sydney" |
+| AUSTRALIA_SYDNEY | "Australia/Sydney" |
+| VLADIVOSTOK | "Vladivostok" |
+| ASIA_VLADIVOSTOK | "Asia/Vladivostok" |
+| MAGADAN | "Magadan" |
+| ASIA_MAGADAN | "Asia/Magadan" |
+| NEW_CALEDONIA | "New Caledonia" |
+| PACIFIC_NOUMEA | "Pacific/Noumea" |
+| SOLOMON_IS_ | "Solomon Is." |
+| PACIFIC_GUADALCANAL | "Pacific/Guadalcanal" |
+| SREDNEKOLYMSK | "Srednekolymsk" |
+| ASIA_SREDNEKOLYMSK | "Asia/Srednekolymsk" |
+| AUCKLAND | "Auckland" |
+| PACIFIC_AUCKLAND | "Pacific/Auckland" |
+| FIJI | "Fiji" |
+| PACIFIC_FIJI | "Pacific/Fiji" |
+| KAMCHATKA | "Kamchatka" |
+| ASIA_KAMCHATKA | "Asia/Kamchatka" |
+| MARSHALL_IS_ | "Marshall Is." |
+| PACIFIC_MAJURO | "Pacific/Majuro" |
+| WELLINGTON | "Wellington" |
+| PACIFIC_AUCKLAND2 | "Pacific/Auckland" |
+| CHATHAM_IS_ | "Chatham Is." |
+| PACIFIC_CHATHAM | "Pacific/Chatham" |
+| NUKU_ALOFA | "Nuku'alofa" |
+| PACIFIC_TONGATAPU | "Pacific/Tongatapu" |
+| SAMOA | "Samoa" |
+| PACIFIC_APIA | "Pacific/Apia" |
+| TOKELAU_IS_ | "Tokelau Is." |
+| PACIFIC_FAKAOFO | "Pacific/Fakaofo" |
+
+
+
diff --git a/docs/NewEscalationPolicyPathDataAttributesRulesInner.md b/docs/NewEscalationPolicyPathDataAttributesRulesInner.md
index 55756c0a..20daca90 100644
--- a/docs/NewEscalationPolicyPathDataAttributesRulesInner.md
+++ b/docs/NewEscalationPolicyPathDataAttributesRulesInner.md
@@ -11,8 +11,14 @@
|**urgencyIds** | **List<String>** | Alert urgency ids for which this escalation path should be used | |
|**withinWorkingHour** | **Boolean** | Whether the escalation path should be used within working hours | |
|**jsonPath** | **String** | JSON path to extract value from payload | |
-|**operator** | [**OperatorEnum**](#OperatorEnum) | How JSON path value should be matched | |
-|**value** | **String** | Value with which JSON path value should be matched | |
+|**operator** | [**OperatorEnum**](#OperatorEnum) | How the alert field value should be matched | |
+|**value** | **String** | Value with which JSON path value should be matched | [optional] |
+|**values** | **List<String>** | Values to match against | [optional] |
+|**fieldableType** | **String** | The type of the fieldable (e.g., AlertField) | |
+|**fieldableId** | **String** | The ID of the alert field | |
+|**serviceIds** | **List<String>** | Service ids for which this escalation path should be used | |
+|**timeZone** | [**TimeZoneEnum**](#TimeZoneEnum) | Time zone for the deferral window | |
+|**timeBlocks** | [**List<NewEscalationPolicyPathDataAttributesRulesInnerOneOf5TimeBlocksInner>**](NewEscalationPolicyPathDataAttributesRulesInnerOneOf5TimeBlocksInner.md) | Time windows during which alerts are deferred | |
@@ -20,7 +26,7 @@
| Name | Value |
|---- | -----|
-| JSON_PATH | "json_path" |
+| DEFERRAL_WINDOW | "deferral_window" |
@@ -30,8 +36,329 @@
|---- | -----|
| IS | "is" |
| IS_NOT | "is_not" |
+| IS_ONE_OF | "is_one_of" |
+| IS_NOT_ONE_OF | "is_not_one_of" |
| CONTAINS | "contains" |
| DOES_NOT_CONTAIN | "does_not_contain" |
+| IS_EMPTY | "is_empty" |
+| IS_NOT_EMPTY | "is_not_empty" |
+| CONTAINS_KEY | "contains_key" |
+| DOES_NOT_CONTAIN_KEY | "does_not_contain_key" |
+| STARTS_WITH | "starts_with" |
+| DOES_NOT_START_WITH | "does_not_start_with" |
+| MATCHES | "matches" |
+| DOES_NOT_MATCH | "does_not_match" |
+
+
+
+## Enum: TimeZoneEnum
+
+| Name | Value |
+|---- | -----|
+| INTERNATIONAL_DATE_LINE_WEST | "International Date Line West" |
+| ETC_GMT_12 | "Etc/GMT+12" |
+| AMERICAN_SAMOA | "American Samoa" |
+| PACIFIC_PAGO_PAGO | "Pacific/Pago_Pago" |
+| MIDWAY_ISLAND | "Midway Island" |
+| PACIFIC_MIDWAY | "Pacific/Midway" |
+| HAWAII | "Hawaii" |
+| PACIFIC_HONOLULU | "Pacific/Honolulu" |
+| ALASKA | "Alaska" |
+| AMERICA_JUNEAU | "America/Juneau" |
+| PACIFIC_TIME_US_CANADA_ | "Pacific Time (US & Canada)" |
+| AMERICA_LOS_ANGELES | "America/Los_Angeles" |
+| TIJUANA | "Tijuana" |
+| AMERICA_TIJUANA | "America/Tijuana" |
+| ARIZONA | "Arizona" |
+| AMERICA_PHOENIX | "America/Phoenix" |
+| MAZATLAN | "Mazatlan" |
+| AMERICA_MAZATLAN | "America/Mazatlan" |
+| MOUNTAIN_TIME_US_CANADA_ | "Mountain Time (US & Canada)" |
+| AMERICA_DENVER | "America/Denver" |
+| CENTRAL_AMERICA | "Central America" |
+| AMERICA_GUATEMALA | "America/Guatemala" |
+| CENTRAL_TIME_US_CANADA_ | "Central Time (US & Canada)" |
+| AMERICA_CHICAGO | "America/Chicago" |
+| CHIHUAHUA | "Chihuahua" |
+| AMERICA_CHIHUAHUA | "America/Chihuahua" |
+| GUADALAJARA | "Guadalajara" |
+| AMERICA_MEXICO_CITY | "America/Mexico_City" |
+| MEXICO_CITY | "Mexico City" |
+| AMERICA_MEXICO_CITY2 | "America/Mexico_City" |
+| MONTERREY | "Monterrey" |
+| AMERICA_MONTERREY | "America/Monterrey" |
+| SASKATCHEWAN | "Saskatchewan" |
+| AMERICA_REGINA | "America/Regina" |
+| BOGOTA | "Bogota" |
+| AMERICA_BOGOTA | "America/Bogota" |
+| EASTERN_TIME_US_CANADA_ | "Eastern Time (US & Canada)" |
+| AMERICA_NEW_YORK | "America/New_York" |
+| INDIANA_EAST_ | "Indiana (East)" |
+| AMERICA_INDIANA_INDIANAPOLIS | "America/Indiana/Indianapolis" |
+| LIMA | "Lima" |
+| AMERICA_LIMA | "America/Lima" |
+| QUITO | "Quito" |
+| AMERICA_LIMA2 | "America/Lima" |
+| ATLANTIC_TIME_CANADA_ | "Atlantic Time (Canada)" |
+| AMERICA_HALIFAX | "America/Halifax" |
+| CARACAS | "Caracas" |
+| AMERICA_CARACAS | "America/Caracas" |
+| GEORGETOWN | "Georgetown" |
+| AMERICA_GUYANA | "America/Guyana" |
+| LA_PAZ | "La Paz" |
+| AMERICA_LA_PAZ | "America/La_Paz" |
+| PUERTO_RICO | "Puerto Rico" |
+| AMERICA_PUERTO_RICO | "America/Puerto_Rico" |
+| SANTIAGO | "Santiago" |
+| AMERICA_SANTIAGO | "America/Santiago" |
+| NEWFOUNDLAND | "Newfoundland" |
+| AMERICA_ST_JOHNS | "America/St_Johns" |
+| ASUNCION | "Asuncion" |
+| AMERICA_ASUNCION | "America/Asuncion" |
+| BRASILIA | "Brasilia" |
+| AMERICA_SAO_PAULO | "America/Sao_Paulo" |
+| BUENOS_AIRES | "Buenos Aires" |
+| AMERICA_ARGENTINA_BUENOS_AIRES | "America/Argentina/Buenos_Aires" |
+| MONTEVIDEO | "Montevideo" |
+| AMERICA_MONTEVIDEO | "America/Montevideo" |
+| GREENLAND | "Greenland" |
+| AMERICA_NUUK | "America/Nuuk" |
+| MID_ATLANTIC | "Mid-Atlantic" |
+| ATLANTIC_SOUTH_GEORGIA | "Atlantic/South_Georgia" |
+| AZORES | "Azores" |
+| ATLANTIC_AZORES | "Atlantic/Azores" |
+| CAPE_VERDE_IS_ | "Cape Verde Is." |
+| ATLANTIC_CAPE_VERDE | "Atlantic/Cape_Verde" |
+| EDINBURGH | "Edinburgh" |
+| EUROPE_LONDON | "Europe/London" |
+| LISBON | "Lisbon" |
+| EUROPE_LISBON | "Europe/Lisbon" |
+| LONDON | "London" |
+| EUROPE_LONDON2 | "Europe/London" |
+| MONROVIA | "Monrovia" |
+| AFRICA_MONROVIA | "Africa/Monrovia" |
+| UTC | "UTC" |
+| ETC_UTC | "Etc/UTC" |
+| AMSTERDAM | "Amsterdam" |
+| EUROPE_AMSTERDAM | "Europe/Amsterdam" |
+| BELGRADE | "Belgrade" |
+| EUROPE_BELGRADE | "Europe/Belgrade" |
+| BERLIN | "Berlin" |
+| EUROPE_BERLIN | "Europe/Berlin" |
+| BERN | "Bern" |
+| EUROPE_ZURICH | "Europe/Zurich" |
+| BRATISLAVA | "Bratislava" |
+| EUROPE_BRATISLAVA | "Europe/Bratislava" |
+| BRUSSELS | "Brussels" |
+| EUROPE_BRUSSELS | "Europe/Brussels" |
+| BUDAPEST | "Budapest" |
+| EUROPE_BUDAPEST | "Europe/Budapest" |
+| CASABLANCA | "Casablanca" |
+| AFRICA_CASABLANCA | "Africa/Casablanca" |
+| COPENHAGEN | "Copenhagen" |
+| EUROPE_COPENHAGEN | "Europe/Copenhagen" |
+| DUBLIN | "Dublin" |
+| EUROPE_DUBLIN | "Europe/Dublin" |
+| LJUBLJANA | "Ljubljana" |
+| EUROPE_LJUBLJANA | "Europe/Ljubljana" |
+| MADRID | "Madrid" |
+| EUROPE_MADRID | "Europe/Madrid" |
+| PARIS | "Paris" |
+| EUROPE_PARIS | "Europe/Paris" |
+| PRAGUE | "Prague" |
+| EUROPE_PRAGUE | "Europe/Prague" |
+| ROME | "Rome" |
+| EUROPE_ROME | "Europe/Rome" |
+| SARAJEVO | "Sarajevo" |
+| EUROPE_SARAJEVO | "Europe/Sarajevo" |
+| SKOPJE | "Skopje" |
+| EUROPE_SKOPJE | "Europe/Skopje" |
+| STOCKHOLM | "Stockholm" |
+| EUROPE_STOCKHOLM | "Europe/Stockholm" |
+| VIENNA | "Vienna" |
+| EUROPE_VIENNA | "Europe/Vienna" |
+| WARSAW | "Warsaw" |
+| EUROPE_WARSAW | "Europe/Warsaw" |
+| WEST_CENTRAL_AFRICA | "West Central Africa" |
+| AFRICA_ALGIERS | "Africa/Algiers" |
+| ZAGREB | "Zagreb" |
+| EUROPE_ZAGREB | "Europe/Zagreb" |
+| ZURICH | "Zurich" |
+| EUROPE_ZURICH2 | "Europe/Zurich" |
+| ATHENS | "Athens" |
+| EUROPE_ATHENS | "Europe/Athens" |
+| BUCHAREST | "Bucharest" |
+| EUROPE_BUCHAREST | "Europe/Bucharest" |
+| CAIRO | "Cairo" |
+| AFRICA_CAIRO | "Africa/Cairo" |
+| HARARE | "Harare" |
+| AFRICA_HARARE | "Africa/Harare" |
+| HELSINKI | "Helsinki" |
+| EUROPE_HELSINKI | "Europe/Helsinki" |
+| JERUSALEM | "Jerusalem" |
+| ASIA_JERUSALEM | "Asia/Jerusalem" |
+| KALININGRAD | "Kaliningrad" |
+| EUROPE_KALININGRAD | "Europe/Kaliningrad" |
+| KYIV | "Kyiv" |
+| EUROPE_KIEV | "Europe/Kiev" |
+| PRETORIA | "Pretoria" |
+| AFRICA_JOHANNESBURG | "Africa/Johannesburg" |
+| RIGA | "Riga" |
+| EUROPE_RIGA | "Europe/Riga" |
+| SOFIA | "Sofia" |
+| EUROPE_SOFIA | "Europe/Sofia" |
+| TALLINN | "Tallinn" |
+| EUROPE_TALLINN | "Europe/Tallinn" |
+| VILNIUS | "Vilnius" |
+| EUROPE_VILNIUS | "Europe/Vilnius" |
+| BAGHDAD | "Baghdad" |
+| ASIA_BAGHDAD | "Asia/Baghdad" |
+| ISTANBUL | "Istanbul" |
+| EUROPE_ISTANBUL | "Europe/Istanbul" |
+| KUWAIT | "Kuwait" |
+| ASIA_KUWAIT | "Asia/Kuwait" |
+| MINSK | "Minsk" |
+| EUROPE_MINSK | "Europe/Minsk" |
+| MOSCOW | "Moscow" |
+| EUROPE_MOSCOW | "Europe/Moscow" |
+| NAIROBI | "Nairobi" |
+| AFRICA_NAIROBI | "Africa/Nairobi" |
+| RIYADH | "Riyadh" |
+| ASIA_RIYADH | "Asia/Riyadh" |
+| ST_PETERSBURG | "St. Petersburg" |
+| EUROPE_MOSCOW2 | "Europe/Moscow" |
+| VOLGOGRAD | "Volgograd" |
+| EUROPE_VOLGOGRAD | "Europe/Volgograd" |
+| TEHRAN | "Tehran" |
+| ASIA_TEHRAN | "Asia/Tehran" |
+| ABU_DHABI | "Abu Dhabi" |
+| ASIA_MUSCAT | "Asia/Muscat" |
+| BAKU | "Baku" |
+| ASIA_BAKU | "Asia/Baku" |
+| MUSCAT | "Muscat" |
+| ASIA_MUSCAT2 | "Asia/Muscat" |
+| SAMARA | "Samara" |
+| EUROPE_SAMARA | "Europe/Samara" |
+| TBILISI | "Tbilisi" |
+| ASIA_TBILISI | "Asia/Tbilisi" |
+| YEREVAN | "Yerevan" |
+| ASIA_YEREVAN | "Asia/Yerevan" |
+| KABUL | "Kabul" |
+| ASIA_KABUL | "Asia/Kabul" |
+| ALMATY | "Almaty" |
+| ASIA_ALMATY | "Asia/Almaty" |
+| ASTANA | "Astana" |
+| ASIA_ALMATY2 | "Asia/Almaty" |
+| EKATERINBURG | "Ekaterinburg" |
+| ASIA_YEKATERINBURG | "Asia/Yekaterinburg" |
+| ISLAMABAD | "Islamabad" |
+| ASIA_KARACHI | "Asia/Karachi" |
+| KARACHI | "Karachi" |
+| ASIA_KARACHI2 | "Asia/Karachi" |
+| TASHKENT | "Tashkent" |
+| ASIA_TASHKENT | "Asia/Tashkent" |
+| CHENNAI | "Chennai" |
+| ASIA_KOLKATA | "Asia/Kolkata" |
+| KOLKATA | "Kolkata" |
+| ASIA_KOLKATA2 | "Asia/Kolkata" |
+| MUMBAI | "Mumbai" |
+| ASIA_KOLKATA3 | "Asia/Kolkata" |
+| NEW_DELHI | "New Delhi" |
+| ASIA_KOLKATA4 | "Asia/Kolkata" |
+| SRI_JAYAWARDENEPURA | "Sri Jayawardenepura" |
+| ASIA_COLOMBO | "Asia/Colombo" |
+| KATHMANDU | "Kathmandu" |
+| ASIA_KATHMANDU | "Asia/Kathmandu" |
+| DHAKA | "Dhaka" |
+| ASIA_DHAKA | "Asia/Dhaka" |
+| URUMQI | "Urumqi" |
+| ASIA_URUMQI | "Asia/Urumqi" |
+| RANGOON | "Rangoon" |
+| ASIA_RANGOON | "Asia/Rangoon" |
+| BANGKOK | "Bangkok" |
+| ASIA_BANGKOK | "Asia/Bangkok" |
+| HANOI | "Hanoi" |
+| ASIA_BANGKOK2 | "Asia/Bangkok" |
+| JAKARTA | "Jakarta" |
+| ASIA_JAKARTA | "Asia/Jakarta" |
+| KRASNOYARSK | "Krasnoyarsk" |
+| ASIA_KRASNOYARSK | "Asia/Krasnoyarsk" |
+| NOVOSIBIRSK | "Novosibirsk" |
+| ASIA_NOVOSIBIRSK | "Asia/Novosibirsk" |
+| BEIJING | "Beijing" |
+| ASIA_SHANGHAI | "Asia/Shanghai" |
+| CHONGQING | "Chongqing" |
+| ASIA_CHONGQING | "Asia/Chongqing" |
+| HONG_KONG | "Hong Kong" |
+| ASIA_HONG_KONG | "Asia/Hong_Kong" |
+| IRKUTSK | "Irkutsk" |
+| ASIA_IRKUTSK | "Asia/Irkutsk" |
+| KUALA_LUMPUR | "Kuala Lumpur" |
+| ASIA_KUALA_LUMPUR | "Asia/Kuala_Lumpur" |
+| PERTH | "Perth" |
+| AUSTRALIA_PERTH | "Australia/Perth" |
+| SINGAPORE | "Singapore" |
+| ASIA_SINGAPORE | "Asia/Singapore" |
+| TAIPEI | "Taipei" |
+| ASIA_TAIPEI | "Asia/Taipei" |
+| ULAANBAATAR | "Ulaanbaatar" |
+| ASIA_ULAANBAATAR | "Asia/Ulaanbaatar" |
+| OSAKA | "Osaka" |
+| ASIA_TOKYO | "Asia/Tokyo" |
+| SAPPORO | "Sapporo" |
+| ASIA_TOKYO2 | "Asia/Tokyo" |
+| SEOUL | "Seoul" |
+| ASIA_SEOUL | "Asia/Seoul" |
+| TOKYO | "Tokyo" |
+| ASIA_TOKYO3 | "Asia/Tokyo" |
+| YAKUTSK | "Yakutsk" |
+| ASIA_YAKUTSK | "Asia/Yakutsk" |
+| ADELAIDE | "Adelaide" |
+| AUSTRALIA_ADELAIDE | "Australia/Adelaide" |
+| DARWIN | "Darwin" |
+| AUSTRALIA_DARWIN | "Australia/Darwin" |
+| BRISBANE | "Brisbane" |
+| AUSTRALIA_BRISBANE | "Australia/Brisbane" |
+| CANBERRA | "Canberra" |
+| AUSTRALIA_CANBERRA | "Australia/Canberra" |
+| GUAM | "Guam" |
+| PACIFIC_GUAM | "Pacific/Guam" |
+| HOBART | "Hobart" |
+| AUSTRALIA_HOBART | "Australia/Hobart" |
+| MELBOURNE | "Melbourne" |
+| AUSTRALIA_MELBOURNE | "Australia/Melbourne" |
+| PORT_MORESBY | "Port Moresby" |
+| PACIFIC_PORT_MORESBY | "Pacific/Port_Moresby" |
+| SYDNEY | "Sydney" |
+| AUSTRALIA_SYDNEY | "Australia/Sydney" |
+| VLADIVOSTOK | "Vladivostok" |
+| ASIA_VLADIVOSTOK | "Asia/Vladivostok" |
+| MAGADAN | "Magadan" |
+| ASIA_MAGADAN | "Asia/Magadan" |
+| NEW_CALEDONIA | "New Caledonia" |
+| PACIFIC_NOUMEA | "Pacific/Noumea" |
+| SOLOMON_IS_ | "Solomon Is." |
+| PACIFIC_GUADALCANAL | "Pacific/Guadalcanal" |
+| SREDNEKOLYMSK | "Srednekolymsk" |
+| ASIA_SREDNEKOLYMSK | "Asia/Srednekolymsk" |
+| AUCKLAND | "Auckland" |
+| PACIFIC_AUCKLAND | "Pacific/Auckland" |
+| FIJI | "Fiji" |
+| PACIFIC_FIJI | "Pacific/Fiji" |
+| KAMCHATKA | "Kamchatka" |
+| ASIA_KAMCHATKA | "Asia/Kamchatka" |
+| MARSHALL_IS_ | "Marshall Is." |
+| PACIFIC_MAJURO | "Pacific/Majuro" |
+| WELLINGTON | "Wellington" |
+| PACIFIC_AUCKLAND2 | "Pacific/Auckland" |
+| CHATHAM_IS_ | "Chatham Is." |
+| PACIFIC_CHATHAM | "Pacific/Chatham" |
+| NUKU_ALOFA | "Nuku'alofa" |
+| PACIFIC_TONGATAPU | "Pacific/Tongatapu" |
+| SAMOA | "Samoa" |
+| PACIFIC_APIA | "Pacific/Apia" |
+| TOKELAU_IS_ | "Tokelau Is." |
+| PACIFIC_FAKAOFO | "Pacific/Fakaofo" |
diff --git a/docs/NewEscalationPolicyPathDataAttributesRulesInnerOneOf.md b/docs/NewEscalationPolicyPathDataAttributesRulesInnerOneOf.md
new file mode 100644
index 00000000..f9d44d0e
--- /dev/null
+++ b/docs/NewEscalationPolicyPathDataAttributesRulesInnerOneOf.md
@@ -0,0 +1,22 @@
+
+
+# NewEscalationPolicyPathDataAttributesRulesInnerOneOf
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**ruleType** | [**RuleTypeEnum**](#RuleTypeEnum) | The type of the escalation path rule | |
+|**urgencyIds** | **List<String>** | Alert urgency ids for which this escalation path should be used | |
+
+
+
+## Enum: RuleTypeEnum
+
+| Name | Value |
+|---- | -----|
+| ALERT_URGENCY | "alert_urgency" |
+
+
+
diff --git a/docs/NewEscalationPolicyPathDataAttributesRulesInnerOneOf1.md b/docs/NewEscalationPolicyPathDataAttributesRulesInnerOneOf1.md
new file mode 100644
index 00000000..195f0504
--- /dev/null
+++ b/docs/NewEscalationPolicyPathDataAttributesRulesInnerOneOf1.md
@@ -0,0 +1,22 @@
+
+
+# NewEscalationPolicyPathDataAttributesRulesInnerOneOf1
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**ruleType** | [**RuleTypeEnum**](#RuleTypeEnum) | The type of the escalation path rule | |
+|**withinWorkingHour** | **Boolean** | Whether the escalation path should be used within working hours | |
+
+
+
+## Enum: RuleTypeEnum
+
+| Name | Value |
+|---- | -----|
+| WORKING_HOUR | "working_hour" |
+
+
+
diff --git a/docs/NewEscalationPolicyPathDataAttributesRulesInnerOneOf2.md b/docs/NewEscalationPolicyPathDataAttributesRulesInnerOneOf2.md
new file mode 100644
index 00000000..cb2edb40
--- /dev/null
+++ b/docs/NewEscalationPolicyPathDataAttributesRulesInnerOneOf2.md
@@ -0,0 +1,40 @@
+
+
+# NewEscalationPolicyPathDataAttributesRulesInnerOneOf2
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**ruleType** | [**RuleTypeEnum**](#RuleTypeEnum) | The type of the escalation path rule | |
+|**jsonPath** | **String** | JSON path to extract value from payload | |
+|**operator** | [**OperatorEnum**](#OperatorEnum) | How JSON path value should be matched | |
+|**value** | **String** | Value with which JSON path value should be matched | [optional] |
+|**values** | **List<String>** | Values to match against (for is_one_of / is_not_one_of operators) | [optional] |
+
+
+
+## Enum: RuleTypeEnum
+
+| Name | Value |
+|---- | -----|
+| JSON_PATH | "json_path" |
+
+
+
+## Enum: OperatorEnum
+
+| Name | Value |
+|---- | -----|
+| IS | "is" |
+| IS_NOT | "is_not" |
+| CONTAINS | "contains" |
+| DOES_NOT_CONTAIN | "does_not_contain" |
+| IS_ONE_OF | "is_one_of" |
+| IS_NOT_ONE_OF | "is_not_one_of" |
+| IS_SET | "is_set" |
+| IS_NOT_SET | "is_not_set" |
+
+
+
diff --git a/docs/NewEscalationPolicyPathDataAttributesRulesInnerOneOf3.md b/docs/NewEscalationPolicyPathDataAttributesRulesInnerOneOf3.md
new file mode 100644
index 00000000..c7f6be45
--- /dev/null
+++ b/docs/NewEscalationPolicyPathDataAttributesRulesInnerOneOf3.md
@@ -0,0 +1,46 @@
+
+
+# NewEscalationPolicyPathDataAttributesRulesInnerOneOf3
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**ruleType** | [**RuleTypeEnum**](#RuleTypeEnum) | The type of the escalation path rule | |
+|**fieldableType** | **String** | The type of the fieldable (e.g., AlertField) | |
+|**fieldableId** | **String** | The ID of the alert field | |
+|**operator** | [**OperatorEnum**](#OperatorEnum) | How the alert field value should be matched | |
+|**values** | **List<String>** | Values to match against | [optional] |
+
+
+
+## Enum: RuleTypeEnum
+
+| Name | Value |
+|---- | -----|
+| FIELD | "field" |
+
+
+
+## Enum: OperatorEnum
+
+| Name | Value |
+|---- | -----|
+| IS | "is" |
+| IS_NOT | "is_not" |
+| IS_ONE_OF | "is_one_of" |
+| IS_NOT_ONE_OF | "is_not_one_of" |
+| CONTAINS | "contains" |
+| DOES_NOT_CONTAIN | "does_not_contain" |
+| IS_EMPTY | "is_empty" |
+| IS_NOT_EMPTY | "is_not_empty" |
+| CONTAINS_KEY | "contains_key" |
+| DOES_NOT_CONTAIN_KEY | "does_not_contain_key" |
+| STARTS_WITH | "starts_with" |
+| DOES_NOT_START_WITH | "does_not_start_with" |
+| MATCHES | "matches" |
+| DOES_NOT_MATCH | "does_not_match" |
+
+
+
diff --git a/docs/NewEscalationPolicyPathDataAttributesRulesInnerOneOf4.md b/docs/NewEscalationPolicyPathDataAttributesRulesInnerOneOf4.md
new file mode 100644
index 00000000..a5aa06e4
--- /dev/null
+++ b/docs/NewEscalationPolicyPathDataAttributesRulesInnerOneOf4.md
@@ -0,0 +1,22 @@
+
+
+# NewEscalationPolicyPathDataAttributesRulesInnerOneOf4
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**ruleType** | [**RuleTypeEnum**](#RuleTypeEnum) | The type of the escalation path rule | |
+|**serviceIds** | **List<String>** | Service ids for which this escalation path should be used | |
+
+
+
+## Enum: RuleTypeEnum
+
+| Name | Value |
+|---- | -----|
+| SERVICE | "service" |
+
+
+
diff --git a/docs/NewEscalationPolicyPathDataAttributesRulesInnerOneOf5.md b/docs/NewEscalationPolicyPathDataAttributesRulesInnerOneOf5.md
new file mode 100644
index 00000000..c525141a
--- /dev/null
+++ b/docs/NewEscalationPolicyPathDataAttributesRulesInnerOneOf5.md
@@ -0,0 +1,334 @@
+
+
+# NewEscalationPolicyPathDataAttributesRulesInnerOneOf5
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**ruleType** | [**RuleTypeEnum**](#RuleTypeEnum) | The type of the escalation path rule | |
+|**timeZone** | [**TimeZoneEnum**](#TimeZoneEnum) | Time zone for the deferral window | |
+|**timeBlocks** | [**List<NewEscalationPolicyPathDataAttributesRulesInnerOneOf5TimeBlocksInner>**](NewEscalationPolicyPathDataAttributesRulesInnerOneOf5TimeBlocksInner.md) | Time windows during which alerts are deferred | |
+
+
+
+## Enum: RuleTypeEnum
+
+| Name | Value |
+|---- | -----|
+| DEFERRAL_WINDOW | "deferral_window" |
+
+
+
+## Enum: TimeZoneEnum
+
+| Name | Value |
+|---- | -----|
+| INTERNATIONAL_DATE_LINE_WEST | "International Date Line West" |
+| ETC_GMT_12 | "Etc/GMT+12" |
+| AMERICAN_SAMOA | "American Samoa" |
+| PACIFIC_PAGO_PAGO | "Pacific/Pago_Pago" |
+| MIDWAY_ISLAND | "Midway Island" |
+| PACIFIC_MIDWAY | "Pacific/Midway" |
+| HAWAII | "Hawaii" |
+| PACIFIC_HONOLULU | "Pacific/Honolulu" |
+| ALASKA | "Alaska" |
+| AMERICA_JUNEAU | "America/Juneau" |
+| PACIFIC_TIME_US_CANADA_ | "Pacific Time (US & Canada)" |
+| AMERICA_LOS_ANGELES | "America/Los_Angeles" |
+| TIJUANA | "Tijuana" |
+| AMERICA_TIJUANA | "America/Tijuana" |
+| ARIZONA | "Arizona" |
+| AMERICA_PHOENIX | "America/Phoenix" |
+| MAZATLAN | "Mazatlan" |
+| AMERICA_MAZATLAN | "America/Mazatlan" |
+| MOUNTAIN_TIME_US_CANADA_ | "Mountain Time (US & Canada)" |
+| AMERICA_DENVER | "America/Denver" |
+| CENTRAL_AMERICA | "Central America" |
+| AMERICA_GUATEMALA | "America/Guatemala" |
+| CENTRAL_TIME_US_CANADA_ | "Central Time (US & Canada)" |
+| AMERICA_CHICAGO | "America/Chicago" |
+| CHIHUAHUA | "Chihuahua" |
+| AMERICA_CHIHUAHUA | "America/Chihuahua" |
+| GUADALAJARA | "Guadalajara" |
+| AMERICA_MEXICO_CITY | "America/Mexico_City" |
+| MEXICO_CITY | "Mexico City" |
+| AMERICA_MEXICO_CITY2 | "America/Mexico_City" |
+| MONTERREY | "Monterrey" |
+| AMERICA_MONTERREY | "America/Monterrey" |
+| SASKATCHEWAN | "Saskatchewan" |
+| AMERICA_REGINA | "America/Regina" |
+| BOGOTA | "Bogota" |
+| AMERICA_BOGOTA | "America/Bogota" |
+| EASTERN_TIME_US_CANADA_ | "Eastern Time (US & Canada)" |
+| AMERICA_NEW_YORK | "America/New_York" |
+| INDIANA_EAST_ | "Indiana (East)" |
+| AMERICA_INDIANA_INDIANAPOLIS | "America/Indiana/Indianapolis" |
+| LIMA | "Lima" |
+| AMERICA_LIMA | "America/Lima" |
+| QUITO | "Quito" |
+| AMERICA_LIMA2 | "America/Lima" |
+| ATLANTIC_TIME_CANADA_ | "Atlantic Time (Canada)" |
+| AMERICA_HALIFAX | "America/Halifax" |
+| CARACAS | "Caracas" |
+| AMERICA_CARACAS | "America/Caracas" |
+| GEORGETOWN | "Georgetown" |
+| AMERICA_GUYANA | "America/Guyana" |
+| LA_PAZ | "La Paz" |
+| AMERICA_LA_PAZ | "America/La_Paz" |
+| PUERTO_RICO | "Puerto Rico" |
+| AMERICA_PUERTO_RICO | "America/Puerto_Rico" |
+| SANTIAGO | "Santiago" |
+| AMERICA_SANTIAGO | "America/Santiago" |
+| NEWFOUNDLAND | "Newfoundland" |
+| AMERICA_ST_JOHNS | "America/St_Johns" |
+| ASUNCION | "Asuncion" |
+| AMERICA_ASUNCION | "America/Asuncion" |
+| BRASILIA | "Brasilia" |
+| AMERICA_SAO_PAULO | "America/Sao_Paulo" |
+| BUENOS_AIRES | "Buenos Aires" |
+| AMERICA_ARGENTINA_BUENOS_AIRES | "America/Argentina/Buenos_Aires" |
+| MONTEVIDEO | "Montevideo" |
+| AMERICA_MONTEVIDEO | "America/Montevideo" |
+| GREENLAND | "Greenland" |
+| AMERICA_NUUK | "America/Nuuk" |
+| MID_ATLANTIC | "Mid-Atlantic" |
+| ATLANTIC_SOUTH_GEORGIA | "Atlantic/South_Georgia" |
+| AZORES | "Azores" |
+| ATLANTIC_AZORES | "Atlantic/Azores" |
+| CAPE_VERDE_IS_ | "Cape Verde Is." |
+| ATLANTIC_CAPE_VERDE | "Atlantic/Cape_Verde" |
+| EDINBURGH | "Edinburgh" |
+| EUROPE_LONDON | "Europe/London" |
+| LISBON | "Lisbon" |
+| EUROPE_LISBON | "Europe/Lisbon" |
+| LONDON | "London" |
+| EUROPE_LONDON2 | "Europe/London" |
+| MONROVIA | "Monrovia" |
+| AFRICA_MONROVIA | "Africa/Monrovia" |
+| UTC | "UTC" |
+| ETC_UTC | "Etc/UTC" |
+| AMSTERDAM | "Amsterdam" |
+| EUROPE_AMSTERDAM | "Europe/Amsterdam" |
+| BELGRADE | "Belgrade" |
+| EUROPE_BELGRADE | "Europe/Belgrade" |
+| BERLIN | "Berlin" |
+| EUROPE_BERLIN | "Europe/Berlin" |
+| BERN | "Bern" |
+| EUROPE_ZURICH | "Europe/Zurich" |
+| BRATISLAVA | "Bratislava" |
+| EUROPE_BRATISLAVA | "Europe/Bratislava" |
+| BRUSSELS | "Brussels" |
+| EUROPE_BRUSSELS | "Europe/Brussels" |
+| BUDAPEST | "Budapest" |
+| EUROPE_BUDAPEST | "Europe/Budapest" |
+| CASABLANCA | "Casablanca" |
+| AFRICA_CASABLANCA | "Africa/Casablanca" |
+| COPENHAGEN | "Copenhagen" |
+| EUROPE_COPENHAGEN | "Europe/Copenhagen" |
+| DUBLIN | "Dublin" |
+| EUROPE_DUBLIN | "Europe/Dublin" |
+| LJUBLJANA | "Ljubljana" |
+| EUROPE_LJUBLJANA | "Europe/Ljubljana" |
+| MADRID | "Madrid" |
+| EUROPE_MADRID | "Europe/Madrid" |
+| PARIS | "Paris" |
+| EUROPE_PARIS | "Europe/Paris" |
+| PRAGUE | "Prague" |
+| EUROPE_PRAGUE | "Europe/Prague" |
+| ROME | "Rome" |
+| EUROPE_ROME | "Europe/Rome" |
+| SARAJEVO | "Sarajevo" |
+| EUROPE_SARAJEVO | "Europe/Sarajevo" |
+| SKOPJE | "Skopje" |
+| EUROPE_SKOPJE | "Europe/Skopje" |
+| STOCKHOLM | "Stockholm" |
+| EUROPE_STOCKHOLM | "Europe/Stockholm" |
+| VIENNA | "Vienna" |
+| EUROPE_VIENNA | "Europe/Vienna" |
+| WARSAW | "Warsaw" |
+| EUROPE_WARSAW | "Europe/Warsaw" |
+| WEST_CENTRAL_AFRICA | "West Central Africa" |
+| AFRICA_ALGIERS | "Africa/Algiers" |
+| ZAGREB | "Zagreb" |
+| EUROPE_ZAGREB | "Europe/Zagreb" |
+| ZURICH | "Zurich" |
+| EUROPE_ZURICH2 | "Europe/Zurich" |
+| ATHENS | "Athens" |
+| EUROPE_ATHENS | "Europe/Athens" |
+| BUCHAREST | "Bucharest" |
+| EUROPE_BUCHAREST | "Europe/Bucharest" |
+| CAIRO | "Cairo" |
+| AFRICA_CAIRO | "Africa/Cairo" |
+| HARARE | "Harare" |
+| AFRICA_HARARE | "Africa/Harare" |
+| HELSINKI | "Helsinki" |
+| EUROPE_HELSINKI | "Europe/Helsinki" |
+| JERUSALEM | "Jerusalem" |
+| ASIA_JERUSALEM | "Asia/Jerusalem" |
+| KALININGRAD | "Kaliningrad" |
+| EUROPE_KALININGRAD | "Europe/Kaliningrad" |
+| KYIV | "Kyiv" |
+| EUROPE_KIEV | "Europe/Kiev" |
+| PRETORIA | "Pretoria" |
+| AFRICA_JOHANNESBURG | "Africa/Johannesburg" |
+| RIGA | "Riga" |
+| EUROPE_RIGA | "Europe/Riga" |
+| SOFIA | "Sofia" |
+| EUROPE_SOFIA | "Europe/Sofia" |
+| TALLINN | "Tallinn" |
+| EUROPE_TALLINN | "Europe/Tallinn" |
+| VILNIUS | "Vilnius" |
+| EUROPE_VILNIUS | "Europe/Vilnius" |
+| BAGHDAD | "Baghdad" |
+| ASIA_BAGHDAD | "Asia/Baghdad" |
+| ISTANBUL | "Istanbul" |
+| EUROPE_ISTANBUL | "Europe/Istanbul" |
+| KUWAIT | "Kuwait" |
+| ASIA_KUWAIT | "Asia/Kuwait" |
+| MINSK | "Minsk" |
+| EUROPE_MINSK | "Europe/Minsk" |
+| MOSCOW | "Moscow" |
+| EUROPE_MOSCOW | "Europe/Moscow" |
+| NAIROBI | "Nairobi" |
+| AFRICA_NAIROBI | "Africa/Nairobi" |
+| RIYADH | "Riyadh" |
+| ASIA_RIYADH | "Asia/Riyadh" |
+| ST_PETERSBURG | "St. Petersburg" |
+| EUROPE_MOSCOW2 | "Europe/Moscow" |
+| VOLGOGRAD | "Volgograd" |
+| EUROPE_VOLGOGRAD | "Europe/Volgograd" |
+| TEHRAN | "Tehran" |
+| ASIA_TEHRAN | "Asia/Tehran" |
+| ABU_DHABI | "Abu Dhabi" |
+| ASIA_MUSCAT | "Asia/Muscat" |
+| BAKU | "Baku" |
+| ASIA_BAKU | "Asia/Baku" |
+| MUSCAT | "Muscat" |
+| ASIA_MUSCAT2 | "Asia/Muscat" |
+| SAMARA | "Samara" |
+| EUROPE_SAMARA | "Europe/Samara" |
+| TBILISI | "Tbilisi" |
+| ASIA_TBILISI | "Asia/Tbilisi" |
+| YEREVAN | "Yerevan" |
+| ASIA_YEREVAN | "Asia/Yerevan" |
+| KABUL | "Kabul" |
+| ASIA_KABUL | "Asia/Kabul" |
+| ALMATY | "Almaty" |
+| ASIA_ALMATY | "Asia/Almaty" |
+| ASTANA | "Astana" |
+| ASIA_ALMATY2 | "Asia/Almaty" |
+| EKATERINBURG | "Ekaterinburg" |
+| ASIA_YEKATERINBURG | "Asia/Yekaterinburg" |
+| ISLAMABAD | "Islamabad" |
+| ASIA_KARACHI | "Asia/Karachi" |
+| KARACHI | "Karachi" |
+| ASIA_KARACHI2 | "Asia/Karachi" |
+| TASHKENT | "Tashkent" |
+| ASIA_TASHKENT | "Asia/Tashkent" |
+| CHENNAI | "Chennai" |
+| ASIA_KOLKATA | "Asia/Kolkata" |
+| KOLKATA | "Kolkata" |
+| ASIA_KOLKATA2 | "Asia/Kolkata" |
+| MUMBAI | "Mumbai" |
+| ASIA_KOLKATA3 | "Asia/Kolkata" |
+| NEW_DELHI | "New Delhi" |
+| ASIA_KOLKATA4 | "Asia/Kolkata" |
+| SRI_JAYAWARDENEPURA | "Sri Jayawardenepura" |
+| ASIA_COLOMBO | "Asia/Colombo" |
+| KATHMANDU | "Kathmandu" |
+| ASIA_KATHMANDU | "Asia/Kathmandu" |
+| DHAKA | "Dhaka" |
+| ASIA_DHAKA | "Asia/Dhaka" |
+| URUMQI | "Urumqi" |
+| ASIA_URUMQI | "Asia/Urumqi" |
+| RANGOON | "Rangoon" |
+| ASIA_RANGOON | "Asia/Rangoon" |
+| BANGKOK | "Bangkok" |
+| ASIA_BANGKOK | "Asia/Bangkok" |
+| HANOI | "Hanoi" |
+| ASIA_BANGKOK2 | "Asia/Bangkok" |
+| JAKARTA | "Jakarta" |
+| ASIA_JAKARTA | "Asia/Jakarta" |
+| KRASNOYARSK | "Krasnoyarsk" |
+| ASIA_KRASNOYARSK | "Asia/Krasnoyarsk" |
+| NOVOSIBIRSK | "Novosibirsk" |
+| ASIA_NOVOSIBIRSK | "Asia/Novosibirsk" |
+| BEIJING | "Beijing" |
+| ASIA_SHANGHAI | "Asia/Shanghai" |
+| CHONGQING | "Chongqing" |
+| ASIA_CHONGQING | "Asia/Chongqing" |
+| HONG_KONG | "Hong Kong" |
+| ASIA_HONG_KONG | "Asia/Hong_Kong" |
+| IRKUTSK | "Irkutsk" |
+| ASIA_IRKUTSK | "Asia/Irkutsk" |
+| KUALA_LUMPUR | "Kuala Lumpur" |
+| ASIA_KUALA_LUMPUR | "Asia/Kuala_Lumpur" |
+| PERTH | "Perth" |
+| AUSTRALIA_PERTH | "Australia/Perth" |
+| SINGAPORE | "Singapore" |
+| ASIA_SINGAPORE | "Asia/Singapore" |
+| TAIPEI | "Taipei" |
+| ASIA_TAIPEI | "Asia/Taipei" |
+| ULAANBAATAR | "Ulaanbaatar" |
+| ASIA_ULAANBAATAR | "Asia/Ulaanbaatar" |
+| OSAKA | "Osaka" |
+| ASIA_TOKYO | "Asia/Tokyo" |
+| SAPPORO | "Sapporo" |
+| ASIA_TOKYO2 | "Asia/Tokyo" |
+| SEOUL | "Seoul" |
+| ASIA_SEOUL | "Asia/Seoul" |
+| TOKYO | "Tokyo" |
+| ASIA_TOKYO3 | "Asia/Tokyo" |
+| YAKUTSK | "Yakutsk" |
+| ASIA_YAKUTSK | "Asia/Yakutsk" |
+| ADELAIDE | "Adelaide" |
+| AUSTRALIA_ADELAIDE | "Australia/Adelaide" |
+| DARWIN | "Darwin" |
+| AUSTRALIA_DARWIN | "Australia/Darwin" |
+| BRISBANE | "Brisbane" |
+| AUSTRALIA_BRISBANE | "Australia/Brisbane" |
+| CANBERRA | "Canberra" |
+| AUSTRALIA_CANBERRA | "Australia/Canberra" |
+| GUAM | "Guam" |
+| PACIFIC_GUAM | "Pacific/Guam" |
+| HOBART | "Hobart" |
+| AUSTRALIA_HOBART | "Australia/Hobart" |
+| MELBOURNE | "Melbourne" |
+| AUSTRALIA_MELBOURNE | "Australia/Melbourne" |
+| PORT_MORESBY | "Port Moresby" |
+| PACIFIC_PORT_MORESBY | "Pacific/Port_Moresby" |
+| SYDNEY | "Sydney" |
+| AUSTRALIA_SYDNEY | "Australia/Sydney" |
+| VLADIVOSTOK | "Vladivostok" |
+| ASIA_VLADIVOSTOK | "Asia/Vladivostok" |
+| MAGADAN | "Magadan" |
+| ASIA_MAGADAN | "Asia/Magadan" |
+| NEW_CALEDONIA | "New Caledonia" |
+| PACIFIC_NOUMEA | "Pacific/Noumea" |
+| SOLOMON_IS_ | "Solomon Is." |
+| PACIFIC_GUADALCANAL | "Pacific/Guadalcanal" |
+| SREDNEKOLYMSK | "Srednekolymsk" |
+| ASIA_SREDNEKOLYMSK | "Asia/Srednekolymsk" |
+| AUCKLAND | "Auckland" |
+| PACIFIC_AUCKLAND | "Pacific/Auckland" |
+| FIJI | "Fiji" |
+| PACIFIC_FIJI | "Pacific/Fiji" |
+| KAMCHATKA | "Kamchatka" |
+| ASIA_KAMCHATKA | "Asia/Kamchatka" |
+| MARSHALL_IS_ | "Marshall Is." |
+| PACIFIC_MAJURO | "Pacific/Majuro" |
+| WELLINGTON | "Wellington" |
+| PACIFIC_AUCKLAND2 | "Pacific/Auckland" |
+| CHATHAM_IS_ | "Chatham Is." |
+| PACIFIC_CHATHAM | "Pacific/Chatham" |
+| NUKU_ALOFA | "Nuku'alofa" |
+| PACIFIC_TONGATAPU | "Pacific/Tongatapu" |
+| SAMOA | "Samoa" |
+| PACIFIC_APIA | "Pacific/Apia" |
+| TOKELAU_IS_ | "Tokelau Is." |
+| PACIFIC_FAKAOFO | "Pacific/Fakaofo" |
+
+
+
diff --git a/docs/NewEscalationPolicyPathDataAttributesRulesInnerOneOf5TimeBlocksInner.md b/docs/NewEscalationPolicyPathDataAttributesRulesInnerOneOf5TimeBlocksInner.md
new file mode 100644
index 00000000..46cdbe5a
--- /dev/null
+++ b/docs/NewEscalationPolicyPathDataAttributesRulesInnerOneOf5TimeBlocksInner.md
@@ -0,0 +1,23 @@
+
+
+# NewEscalationPolicyPathDataAttributesRulesInnerOneOf5TimeBlocksInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**monday** | **Boolean** | | [optional] |
+|**tuesday** | **Boolean** | | [optional] |
+|**wednesday** | **Boolean** | | [optional] |
+|**thursday** | **Boolean** | | [optional] |
+|**friday** | **Boolean** | | [optional] |
+|**saturday** | **Boolean** | | [optional] |
+|**sunday** | **Boolean** | | [optional] |
+|**startTime** | **String** | Formatted as HH:MM | [optional] |
+|**endTime** | **String** | Formatted as HH:MM | [optional] |
+|**allDay** | **Boolean** | | [optional] |
+|**position** | **Integer** | | [optional] |
+
+
+
diff --git a/docs/NewEscalationPolicyPathDataAttributesTimeRestrictionsInner.md b/docs/NewEscalationPolicyPathDataAttributesTimeRestrictionsInner.md
new file mode 100644
index 00000000..2143fc5a
--- /dev/null
+++ b/docs/NewEscalationPolicyPathDataAttributesTimeRestrictionsInner.md
@@ -0,0 +1,44 @@
+
+
+# NewEscalationPolicyPathDataAttributesTimeRestrictionsInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**startDay** | [**StartDayEnum**](#StartDayEnum) | | |
+|**startTime** | **String** | Formatted as HH:MM | |
+|**endDay** | [**EndDayEnum**](#EndDayEnum) | | |
+|**endTime** | **String** | Formatted as HH:MM | |
+
+
+
+## Enum: StartDayEnum
+
+| Name | Value |
+|---- | -----|
+| MONDAY | "monday" |
+| TUESDAY | "tuesday" |
+| WEDNESDAY | "wednesday" |
+| THURSDAY | "thursday" |
+| FRIDAY | "friday" |
+| SATURDAY | "saturday" |
+| SUNDAY | "sunday" |
+
+
+
+## Enum: EndDayEnum
+
+| Name | Value |
+|---- | -----|
+| MONDAY | "monday" |
+| TUESDAY | "tuesday" |
+| WEDNESDAY | "wednesday" |
+| THURSDAY | "thursday" |
+| FRIDAY | "friday" |
+| SATURDAY | "saturday" |
+| SUNDAY | "sunday" |
+
+
+
diff --git a/docs/NewFormFieldDataAttributes.md b/docs/NewFormFieldDataAttributes.md
index 64d58411..c11f935a 100644
--- a/docs/NewFormFieldDataAttributes.md
+++ b/docs/NewFormFieldDataAttributes.md
@@ -18,6 +18,7 @@
|**showOnIncidentDetails** | **Boolean** | Whether the form field is shown on the incident details panel | [optional] |
|**enabled** | **Boolean** | Whether the form field is enabled | [optional] |
|**defaultValues** | **List<String>** | | [optional] |
+|**autoSetByCatalogPropertyId** | **String** | Catalog property ID to auto-set this form field. Only reference-kind catalog properties are supported. | [optional] |
@@ -53,6 +54,7 @@
| MITIGATED_AT | "mitigated_at" |
| RESOLVED_AT | "resolved_at" |
| CLOSED_AT | "closed_at" |
+| CUSTOM_SUB_STATUS | "custom_sub_status" |
| MANUAL_STARTING_DATETIME_FIELD | "manual_starting_datetime_field" |
@@ -84,6 +86,9 @@
| FUNCTIONALITY | "functionality" |
| USER | "user" |
| CATALOG_ENTITY | "catalog_entity" |
+| ENVIRONMENT | "environment" |
+| CAUSE | "cause" |
+| INCIDENT_TYPE | "incident_type" |
diff --git a/docs/NewFormFieldOptionDataAttributes.md b/docs/NewFormFieldOptionDataAttributes.md
index bbae32c8..841db554 100644
--- a/docs/NewFormFieldOptionDataAttributes.md
+++ b/docs/NewFormFieldOptionDataAttributes.md
@@ -8,10 +8,10 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**formFieldId** | **String** | The ID of the form field | |
-|**value** | **String** | The value of the form_field_option | |
-|**color** | **String** | The hex color of the form_field_option | [optional] |
+|**value** | **String** | The value of the form field option | |
+|**color** | **String** | The hex color of the form field option | [optional] |
|**_default** | **Boolean** | | [optional] |
-|**position** | **Integer** | The position of the form_field_option | [optional] |
+|**position** | **Integer** | The position of the form field option | [optional] |
diff --git a/docs/NewFormFieldPlacementConditionDataAttributes.md b/docs/NewFormFieldPlacementConditionDataAttributes.md
index eef5b190..4f9a9891 100644
--- a/docs/NewFormFieldPlacementConditionDataAttributes.md
+++ b/docs/NewFormFieldPlacementConditionDataAttributes.md
@@ -29,6 +29,7 @@
| Name | Value |
|---- | -----|
| EQUAL | "equal" |
+| NOT_EQUAL | "not_equal" |
| IS_SET | "is_set" |
| IS_NOT_SET | "is_not_set" |
diff --git a/docs/NewFormFieldPlacementDataAttributes.md b/docs/NewFormFieldPlacementDataAttributes.md
index 8818fb1f..011001b6 100644
--- a/docs/NewFormFieldPlacementDataAttributes.md
+++ b/docs/NewFormFieldPlacementDataAttributes.md
@@ -13,6 +13,7 @@
|**required** | **Boolean** | Whether the field is unconditionally required on this form. | [optional] |
|**requiredOperator** | [**RequiredOperatorEnum**](#RequiredOperatorEnum) | Logical operator when evaluating multiple form_field_placement_conditions with conditioned=required | [optional] |
|**placementOperator** | [**PlacementOperatorEnum**](#PlacementOperatorEnum) | Logical operator when evaluating multiple form_field_placement_conditions with conditioned=placement | [optional] |
+|**nonEditable** | **Boolean** | Whether the field is read-only and cannot be edited by users. | [optional] |
diff --git a/docs/NewFunctionalityDataAttributes.md b/docs/NewFunctionalityDataAttributes.md
index 16730103..b41f7522 100644
--- a/docs/NewFunctionalityDataAttributes.md
+++ b/docs/NewFunctionalityDataAttributes.md
@@ -24,10 +24,12 @@
|**showUptimeLastDays** | [**ShowUptimeLastDaysEnum**](#ShowUptimeLastDaysEnum) | Show uptime over x days | [optional] |
|**environmentIds** | **List<String>** | Environments associated with this functionality | [optional] |
|**serviceIds** | **List<String>** | Services associated with this functionality | [optional] |
-|**ownersGroupIds** | **List<String>** | Owner Teams associated with this functionality | [optional] |
-|**ownersUserIds** | **List<Integer>** | Owner Users associated with this functionality | [optional] |
+|**ownerGroupIds** | **List<String>** | Owner Teams associated with this functionality | [optional] |
+|**ownerUserIds** | **List<Integer>** | Owner Users associated with this functionality | [optional] |
+|**escalationPolicyId** | **String** | The escalation policy id of the functionality | [optional] |
|**slackChannels** | [**List<NewEnvironmentDataAttributesSlackChannelsInner>**](NewEnvironmentDataAttributesSlackChannelsInner.md) | Slack Channels associated with this functionality | [optional] |
|**slackAliases** | [**List<NewEnvironmentDataAttributesSlackAliasesInner>**](NewEnvironmentDataAttributesSlackAliasesInner.md) | Slack Aliases associated with this functionality | [optional] |
+|**properties** | [**List<NewCauseDataAttributesPropertiesInner>**](NewCauseDataAttributesPropertiesInner.md) | Array of property values for this functionality. | [optional] |
diff --git a/docs/NewHeartbeatDataAttributes.md b/docs/NewHeartbeatDataAttributes.md
index 11ba520a..0c9ef628 100644
--- a/docs/NewHeartbeatDataAttributes.md
+++ b/docs/NewHeartbeatDataAttributes.md
@@ -10,11 +10,12 @@
|**name** | **String** | The name of the heartbeat | |
|**description** | **String** | The description of the heartbeat | [optional] |
|**alertSummary** | **String** | Summary of alerts triggered when heartbeat expires. | |
+|**alertDescription** | **String** | Description of alerts triggered when heartbeat expires. | [optional] |
|**alertUrgencyId** | **String** | Urgency of alerts triggered when heartbeat expires. | [optional] |
|**interval** | **Integer** | | |
|**intervalUnit** | [**IntervalUnitEnum**](#IntervalUnitEnum) | | |
|**notificationTargetId** | **String** | | |
-|**notificationTargetType** | [**NotificationTargetTypeEnum**](#NotificationTargetTypeEnum) | | |
+|**notificationTargetType** | [**NotificationTargetTypeEnum**](#NotificationTargetTypeEnum) | The type of the notification target. Please contact support if you encounter issues using `Functionality` as a target type. | |
|**enabled** | **Boolean** | Whether to trigger alerts when heartbeat is expired. | [optional] |
@@ -23,9 +24,9 @@
| Name | Value |
|---- | -----|
-| SECONDS | "seconds" |
| MINUTES | "minutes" |
| HOURS | "hours" |
+| DAYS | "days" |
@@ -37,6 +38,7 @@
| GROUP | "Group" |
| SERVICE | "Service" |
| ESCALATION_POLICY | "EscalationPolicy" |
+| FUNCTIONALITY | "Functionality" |
diff --git a/docs/NewIncidentActionItemDataAttributes.md b/docs/NewIncidentActionItemDataAttributes.md
index 6afe98e5..66e0dc33 100644
--- a/docs/NewIncidentActionItemDataAttributes.md
+++ b/docs/NewIncidentActionItemDataAttributes.md
@@ -16,6 +16,7 @@
|**status** | [**StatusEnum**](#StatusEnum) | The status of the action item | [optional] |
|**dueDate** | **String** | The due date of the action item | [optional] |
|**jiraIssueId** | **String** | The Jira issue ID. | [optional] |
+|**jiraIssueKey** | **String** | The Jira issue key. | [optional] |
|**jiraIssueUrl** | **String** | The Jira issue URL. | [optional] |
diff --git a/docs/NewIncidentDataAttributes.md b/docs/NewIncidentDataAttributes.md
index ef9f34a5..72bee114 100644
--- a/docs/NewIncidentDataAttributes.md
+++ b/docs/NewIncidentDataAttributes.md
@@ -15,14 +15,25 @@
|**summary** | **String** | The summary of the incident | [optional] |
|**userId** | **String** | User ID of the creator of the incident. Default to the user attached to the Api Key | [optional] |
|**severityId** | **String** | The Severity ID to attach to the incident | [optional] |
-|**environmentIds** | **List<String>** | The Environment ID's to attach to the incident | [optional] |
-|**incidentTypeIds** | **List<String>** | The Incident Type ID's to attach to the incident | [optional] |
-|**serviceIds** | **List<String>** | The Service ID's to attach to the incident | [optional] |
-|**functionalityIds** | **List<String>** | The Functionality ID's to attach to the incident | [optional] |
-|**groupIds** | **List<String>** | The Team ID's to attach to the incident | [optional] |
-|**causeIds** | **List<String>** | The Cause ID's to attach to the incident | [optional] |
+|**publicTitle** | **String** | The public title of the incident | [optional] |
+|**alertIds** | **List<String>** | The Alert IDs to attach to the incident | [optional] |
+|**environmentIds** | **List<String>** | The Environment IDs to attach to the incident | [optional] |
+|**incidentTypeIds** | **List<String>** | The Incident Type IDs to attach to the incident | [optional] |
+|**serviceIds** | **List<String>** | The Service IDs to attach to the incident | [optional] |
+|**functionalityIds** | **List<String>** | The Functionality IDs to attach to the incident | [optional] |
+|**groupIds** | **List<String>** | The Team IDs to attach to the incident | [optional] |
+|**causeIds** | **List<String>** | The Cause IDs to attach to the incident | [optional] |
+|**mutedServiceIds** | **List<String>** | The Service IDs to mute alerts for during maintenance. Alerts for these services will still be triggered and attached to the incident, but won't page responders. | [optional] |
|**labels** | **Object** | Labels to attach to the incidents. eg: {\"platform\":\"osx\", \"version\": \"1.29\"} | [optional] |
|**slackChannelName** | **String** | Slack channel name | [optional] |
+|**slackChannelId** | **String** | Slack channel id | [optional] |
+|**slackChannelUrl** | **String** | Slack channel url | [optional] |
+|**slackChannelArchived** | **Boolean** | Whether the Slack channel is archived | [optional] |
+|**googleDriveParentId** | **String** | Google Drive parent folder ID | [optional] |
+|**googleDriveUrl** | **String** | Google Drive URL | [optional] |
+|**jiraIssueKey** | **String** | Jira issue key | [optional] |
+|**jiraIssueId** | **String** | Jira issue ID | [optional] |
+|**jiraIssueUrl** | **String** | Jira issue URL | [optional] |
|**notifyEmails** | **List<String>** | Emails you want to notify | [optional] |
|**status** | [**StatusEnum**](#StatusEnum) | The status of the incident | [optional] |
|**url** | **String** | The url to the incident | [optional] |
@@ -34,6 +45,7 @@
|**acknowledgedAt** | **String** | Date of acknowledgment | [optional] |
|**mitigatedAt** | **String** | Date of mitigation | [optional] |
|**resolvedAt** | **String** | Date of resolution | [optional] |
+|**closedAt** | **String** | Date of closure | [optional] |
|**cancelledAt** | **String** | Date of cancellation | [optional] |
@@ -50,6 +62,7 @@
| NORMAL_SUB | "normal_sub" |
| BACKFILLED | "backfilled" |
| SCHEDULED | "scheduled" |
+| SCHEDULED_SUB | "scheduled_sub" |
diff --git a/docs/NewIncidentFormFieldSelectionDataAttributes.md b/docs/NewIncidentFormFieldSelectionDataAttributes.md
index 72ef32dc..35d6e79d 100644
--- a/docs/NewIncidentFormFieldSelectionDataAttributes.md
+++ b/docs/NewIncidentFormFieldSelectionDataAttributes.md
@@ -16,6 +16,9 @@
|**selectedServiceIds** | **List<String>** | | [optional] |
|**selectedFunctionalityIds** | **List<String>** | | [optional] |
|**selectedUserIds** | **List<Integer>** | | [optional] |
+|**selectedEnvironmentIds** | **List<String>** | | [optional] |
+|**selectedCauseIds** | **List<String>** | | [optional] |
+|**selectedIncidentTypeIds** | **List<String>** | | [optional] |
diff --git a/docs/NewIncidentPermissionSetDataAttributes.md b/docs/NewIncidentPermissionSetDataAttributes.md
index fbc46160..2551ad23 100644
--- a/docs/NewIncidentPermissionSetDataAttributes.md
+++ b/docs/NewIncidentPermissionSetDataAttributes.md
@@ -8,7 +8,6 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**name** | **String** | The incident permission set name. | |
-|**slug** | **String** | The incident permission set slug. | [optional] |
|**description** | **String** | The incident permission set description. | [optional] |
|**privateIncidentPermissions** | [**List<PrivateIncidentPermissionsEnum>**](#List<PrivateIncidentPermissionsEnum>) | | [optional] |
|**publicIncidentPermissions** | [**List<PublicIncidentPermissionsEnum>**](#List<PublicIncidentPermissionsEnum>) | | [optional] |
diff --git a/docs/NewIncidentStatusPageEventDataAttributes.md b/docs/NewIncidentStatusPageEventDataAttributes.md
index 77e8ba19..be4dbd3c 100644
--- a/docs/NewIncidentStatusPageEventDataAttributes.md
+++ b/docs/NewIncidentStatusPageEventDataAttributes.md
@@ -25,7 +25,6 @@
| RESOLVED | "resolved" |
| SCHEDULED | "scheduled" |
| IN_PROGRESS | "in_progress" |
-| VERIFYING | "verifying" |
| COMPLETED | "completed" |
diff --git a/docs/NewIncidentTypeDataAttributes.md b/docs/NewIncidentTypeDataAttributes.md
index 4305fc1c..d9409b98 100644
--- a/docs/NewIncidentTypeDataAttributes.md
+++ b/docs/NewIncidentTypeDataAttributes.md
@@ -14,6 +14,7 @@
|**notifyEmails** | **List<String>** | Emails to attach to the incident type | [optional] |
|**slackChannels** | [**List<NewEnvironmentDataAttributesSlackChannelsInner>**](NewEnvironmentDataAttributesSlackChannelsInner.md) | Slack Channels associated with this incident type | [optional] |
|**slackAliases** | [**List<NewEnvironmentDataAttributesSlackAliasesInner>**](NewEnvironmentDataAttributesSlackAliasesInner.md) | Slack Aliases associated with this incident type | [optional] |
+|**properties** | [**List<NewCauseDataAttributesPropertiesInner>**](NewCauseDataAttributesPropertiesInner.md) | Array of property values for this incident type. | [optional] |
diff --git a/docs/NewLiveCallRouterDataAttributes.md b/docs/NewLiveCallRouterDataAttributes.md
index 448dc966..fcdb0f04 100644
--- a/docs/NewLiveCallRouterDataAttributes.md
+++ b/docs/NewLiveCallRouterDataAttributes.md
@@ -13,15 +13,18 @@
|**countryCode** | [**CountryCodeEnum**](#CountryCodeEnum) | The country code of the live_call_router | |
|**phoneType** | [**PhoneTypeEnum**](#PhoneTypeEnum) | The phone type of the live_call_router | |
|**phoneNumber** | **String** | You can select a phone number using [generate_phone_number](#//api/v1/live_call_routers/generate_phone_number) API and pass that phone number here to register | |
-|**voicemailGreeting** | **String** | The voicemail greeting of the live_call_router | [optional] |
+|**voicemailGreeting** | **String** | The voicemail greeting of the live_call_router | |
|**callerGreeting** | **String** | The caller greeting message of the live_call_router | [optional] |
-|**waitingMusicUrl** | **String** | The waiting music URL of the live_call_router | [optional] |
+|**waitingMusicUrl** | [**WaitingMusicUrlEnum**](#WaitingMusicUrlEnum) | The waiting music URL of the live_call_router | [optional] |
|**sentToVoicemailDelay** | **Integer** | The delay (seconds) after which the caller in redirected to voicemail | [optional] |
|**shouldRedirectToVoicemailOnNoAnswer** | **Boolean** | This prompts the caller to choose voicemail or connect live | [optional] |
|**escalationLevelDelayInSeconds** | **Integer** | This overrides the delay (seconds) in escalation levels | [optional] |
|**shouldAutoResolveAlertOnCallEnd** | **Boolean** | This overrides the delay (seconds) in escalation levels | [optional] |
|**alertUrgencyId** | **String** | This is used in escalation paths to determine who to page | [optional] |
-|**escalationPolicyTriggerParams** | [**NewLiveCallRouterDataAttributesEscalationPolicyTriggerParams**](NewLiveCallRouterDataAttributesEscalationPolicyTriggerParams.md) | | |
+|**callingTreeEnabled** | **Boolean** | Whether the live call router is configured as a phone tree, requiring callers to press a key before being connected | [optional] |
+|**callingTreePrompt** | **String** | The audio instructions callers will hear when they call this number, prompting them to select from available options to route their call | [optional] |
+|**pagingTargets** | [**List<NewLiveCallRouterDataAttributesPagingTargetsInner>**](NewLiveCallRouterDataAttributesPagingTargetsInner.md) | Paging targets that callers can select from when this live call router is configured as a phone tree. | |
+|**escalationPolicyTriggerParams** | [**NewLiveCallRouterDataAttributesEscalationPolicyTriggerParams**](NewLiveCallRouterDataAttributesEscalationPolicyTriggerParams.md) | | [optional] |
@@ -38,11 +41,14 @@
| Name | Value |
|---- | -----|
-| US | "US" |
-| GB | "GB" |
-| NZ | "NZ" |
-| CA | "CA" |
| AU | "AU" |
+| CA | "CA" |
+| DE | "DE" |
+| NL | "NL" |
+| NZ | "NZ" |
+| SE | "SE" |
+| GB | "GB" |
+| US | "US" |
@@ -52,6 +58,21 @@
|---- | -----|
| LOCAL | "local" |
| TOLL_FREE | "toll_free" |
+| MOBILE | "mobile" |
+
+
+
+## Enum: WaitingMusicUrlEnum
+
+| Name | Value |
+|---- | -----|
+| HTTPS_STORAGE_ROOTLY_COM_TWILIO_VOICEMAIL_CLOCKWORK_WALTZ_MP3 | "https://storage.rootly.com/twilio/voicemail/ClockworkWaltz.mp3" |
+| HTTPS_STORAGE_ROOTLY_COM_TWILIO_VOICEMAIL_ITH_BRAHMS_116_4_MP3 | "https://storage.rootly.com/twilio/voicemail/ith_brahms-116-4.mp3" |
+| HTTPS_STORAGE_ROOTLY_COM_TWILIO_VOICEMAIL_MELLOTRONIAC___FLIGHT_OF_YOUNG_HEARTS_FLUTE_MP3 | "https://storage.rootly.com/twilio/voicemail/Mellotroniac_-_Flight_Of_Young_Hearts_Flute.mp3" |
+| HTTPS_STORAGE_ROOTLY_COM_TWILIO_VOICEMAIL_BUSY_STRINGS_MP3 | "https://storage.rootly.com/twilio/voicemail/BusyStrings.mp3" |
+| HTTPS_STORAGE_ROOTLY_COM_TWILIO_VOICEMAIL_OLD_DOG___ENDLESS_GOODBYE__28INSTR_29_MP3 | "https://storage.rootly.com/twilio/voicemail/oldDog_-_endless_goodbye_%28instr.%29.mp3" |
+| HTTPS_STORAGE_ROOTLY_COM_TWILIO_VOICEMAIL_MARKOVICHAMP_BORGHESTRAL_MP3 | "https://storage.rootly.com/twilio/voicemail/MARKOVICHAMP-Borghestral.mp3" |
+| HTTPS_STORAGE_ROOTLY_COM_TWILIO_VOICEMAIL_ITH_CHOPIN_15_2_MP3 | "https://storage.rootly.com/twilio/voicemail/ith_chopin-15-2.mp3" |
diff --git a/docs/NewLiveCallRouterDataAttributesEscalationPolicyTriggerParams.md b/docs/NewLiveCallRouterDataAttributesEscalationPolicyTriggerParams.md
index cb762f0b..84fc3b1e 100644
--- a/docs/NewLiveCallRouterDataAttributesEscalationPolicyTriggerParams.md
+++ b/docs/NewLiveCallRouterDataAttributesEscalationPolicyTriggerParams.md
@@ -8,7 +8,7 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**id** | **String** | The ID of notification target | |
-|**type** | [**TypeEnum**](#TypeEnum) | The type of the notification target | |
+|**type** | [**TypeEnum**](#TypeEnum) | The type of the notification target. Please contact support if you encounter issues using `functionality` as a target type. | |
@@ -19,6 +19,7 @@
| SERVICE | "service" |
| GROUP | "group" |
| ESCALATION_POLICY | "escalation_policy" |
+| FUNCTIONALITY | "functionality" |
diff --git a/docs/NewLiveCallRouterDataAttributesPagingTargetsInner.md b/docs/NewLiveCallRouterDataAttributesPagingTargetsInner.md
new file mode 100644
index 00000000..631bcad4
--- /dev/null
+++ b/docs/NewLiveCallRouterDataAttributesPagingTargetsInner.md
@@ -0,0 +1,26 @@
+
+
+# NewLiveCallRouterDataAttributesPagingTargetsInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | The ID of paging target | |
+|**type** | [**TypeEnum**](#TypeEnum) | The type of the paging target. Please contact support if you encounter issues using `functionality` as a target type. | |
+|**alertUrgencyId** | **String** | This is used in escalation paths to determine who to page | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| SERVICE | "service" |
+| TEAM | "team" |
+| ESCALATION_POLICY | "escalation_policy" |
+| FUNCTIONALITY | "functionality" |
+
+
+
diff --git a/docs/NewOnCallPayReport.md b/docs/NewOnCallPayReport.md
new file mode 100644
index 00000000..78f6edad
--- /dev/null
+++ b/docs/NewOnCallPayReport.md
@@ -0,0 +1,13 @@
+
+
+# NewOnCallPayReport
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**NewOnCallPayReportData**](NewOnCallPayReportData.md) | | |
+
+
+
diff --git a/docs/NewOnCallPayReportData.md b/docs/NewOnCallPayReportData.md
new file mode 100644
index 00000000..ae396668
--- /dev/null
+++ b/docs/NewOnCallPayReportData.md
@@ -0,0 +1,22 @@
+
+
+# NewOnCallPayReportData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**NewOnCallPayReportDataAttributes**](NewOnCallPayReportDataAttributes.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| ON_CALL_PAY_REPORTS | "on_call_pay_reports" |
+
+
+
diff --git a/docs/NewOnCallPayReportDataAttributes.md b/docs/NewOnCallPayReportDataAttributes.md
new file mode 100644
index 00000000..f715af9a
--- /dev/null
+++ b/docs/NewOnCallPayReportDataAttributes.md
@@ -0,0 +1,15 @@
+
+
+# NewOnCallPayReportDataAttributes
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**startDate** | **LocalDate** | The start date for the report period. | |
+|**endDate** | **LocalDate** | The end date for the report period. | |
+|**scheduleIds** | **List<String>** | List of schedule UUIDs to scope the report. | [optional] |
+
+
+
diff --git a/docs/NewOnCallRoleDataAttributes.md b/docs/NewOnCallRoleDataAttributes.md
index 78bf8a73..05409c52 100644
--- a/docs/NewOnCallRoleDataAttributes.md
+++ b/docs/NewOnCallRoleDataAttributes.md
@@ -8,8 +8,12 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**name** | **String** | The role name. | |
-|**slug** | **String** | The role slug. | [optional] |
-|**systemRole** | [**List<SystemRoleEnum>**](#List<SystemRoleEnum>) | The kind of role (user and custom type roles are only editable) | |
+|**systemRole** | [**List<SystemRoleEnum>**](#List<SystemRoleEnum>) | The kind of role (user and custom type roles are only editable) | [optional] |
+|**alertFieldsPermissions** | [**List<AlertFieldsPermissionsEnum>**](#List<AlertFieldsPermissionsEnum>) | | [optional] |
+|**alertGroupsPermissions** | [**List<AlertGroupsPermissionsEnum>**](#List<AlertGroupsPermissionsEnum>) | | [optional] |
+|**alertRoutingRulesPermissions** | [**List<AlertRoutingRulesPermissionsEnum>**](#List<AlertRoutingRulesPermissionsEnum>) | | [optional] |
+|**onCallReadinessReportPermissions** | [**List<OnCallReadinessReportPermissionsEnum>**](#List<OnCallReadinessReportPermissionsEnum>) | | [optional] |
+|**onCallRolesPermissions** | [**List<OnCallRolesPermissionsEnum>**](#List<OnCallRolesPermissionsEnum>) | | [optional] |
|**alertSourcesPermissions** | [**List<AlertSourcesPermissionsEnum>**](#List<AlertSourcesPermissionsEnum>) | | [optional] |
|**alertUrgencyPermissions** | [**List<AlertUrgencyPermissionsEnum>**](#List<AlertUrgencyPermissionsEnum>) | | [optional] |
|**alertsPermissions** | [**List<AlertsPermissionsEnum>**](#List<AlertsPermissionsEnum>) | | [optional] |
@@ -37,15 +41,69 @@
| ADMIN | "admin" |
| USER | "user" |
| CUSTOM | "custom" |
+| OBSERVER | "observer" |
| NO_ACCESS | "no_access" |
+## Enum: List<AlertFieldsPermissionsEnum>
+
+| Name | Value |
+|---- | -----|
+| CREATE | "create" |
+| READ | "read" |
+| UPDATE | "update" |
+| DELETE | "delete" |
+
+
+
+## Enum: List<AlertGroupsPermissionsEnum>
+
+| Name | Value |
+|---- | -----|
+| CREATE | "create" |
+| READ | "read" |
+| UPDATE | "update" |
+| DELETE | "delete" |
+
+
+
+## Enum: List<AlertRoutingRulesPermissionsEnum>
+
+| Name | Value |
+|---- | -----|
+| CREATE | "create" |
+| READ | "read" |
+| UPDATE | "update" |
+| DELETE | "delete" |
+
+
+
+## Enum: List<OnCallReadinessReportPermissionsEnum>
+
+| Name | Value |
+|---- | -----|
+| READ | "read" |
+
+
+
+## Enum: List<OnCallRolesPermissionsEnum>
+
+| Name | Value |
+|---- | -----|
+| CREATE | "create" |
+| READ | "read" |
+| UPDATE | "update" |
+| DELETE | "delete" |
+
+
+
## Enum: List<AlertSourcesPermissionsEnum>
| Name | Value |
|---- | -----|
| CREATE | "create" |
+| READ | "read" |
| UPDATE | "update" |
| DELETE | "delete" |
@@ -69,6 +127,7 @@
| CREATE | "create" |
| UPDATE | "update" |
| READ | "read" |
+| DELETE | "delete" |
diff --git a/docs/NewPlaybookDataAttributes.md b/docs/NewPlaybookDataAttributes.md
index c30895a8..8a5a6dd9 100644
--- a/docs/NewPlaybookDataAttributes.md
+++ b/docs/NewPlaybookDataAttributes.md
@@ -10,12 +10,12 @@
|**title** | **String** | The title of the playbook | |
|**summary** | **String** | The summary of the playbook | [optional] |
|**externalUrl** | **String** | The external url of the playbook | [optional] |
-|**severityIds** | **List<String>** | The Severity ID's to attach to the incident | [optional] |
-|**environmentIds** | **List<String>** | The Environment ID's to attach to the incident | [optional] |
-|**serviceIds** | **List<String>** | The Service ID's to attach to the incident | [optional] |
-|**functionalityIds** | **List<String>** | The Functionality ID's to attach to the incident | [optional] |
-|**groupIds** | **List<String>** | The Team ID's to attach to the incident | [optional] |
-|**incidentTypeIds** | **List<String>** | The Incident Type ID's to attach to the incident | [optional] |
+|**severityIds** | **List<String>** | The Severity IDs to attach to the incident | [optional] |
+|**environmentIds** | **List<String>** | The Environment IDs to attach to the incident | [optional] |
+|**serviceIds** | **List<String>** | The Service IDs to attach to the incident | [optional] |
+|**functionalityIds** | **List<String>** | The Functionality IDs to attach to the incident | [optional] |
+|**groupIds** | **List<String>** | The Team IDs to attach to the incident | [optional] |
+|**incidentTypeIds** | **List<String>** | The Incident Type IDs to attach to the incident | [optional] |
diff --git a/docs/NewPostMortemTemplateDataAttributes.md b/docs/NewPostMortemTemplateDataAttributes.md
index f0b2a60b..ccaa39be 100644
--- a/docs/NewPostMortemTemplateDataAttributes.md
+++ b/docs/NewPostMortemTemplateDataAttributes.md
@@ -9,7 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**name** | **String** | The name of the postmortem template | |
|**_default** | **Boolean** | Default selected template when editing a postmortem | [optional] |
-|**content** | **String** | The postmortem template. Liquid syntax is supported | |
+|**content** | **String** | The postmortem template. Supports TipTap blocks (followup and timeline components), Liquid syntax, and HTML. Will be sanitized and applied to both content and content_html fields. | [optional] |
|**format** | [**FormatEnum**](#FormatEnum) | The format of the input | [optional] |
diff --git a/docs/NewPulseDataAttributes.md b/docs/NewPulseDataAttributes.md
index 12f418a8..ff27e26b 100644
--- a/docs/NewPulseDataAttributes.md
+++ b/docs/NewPulseDataAttributes.md
@@ -9,12 +9,12 @@
|------------ | ------------- | ------------- | -------------|
|**source** | **String** | The source of the pulse (eg: k8s) | [optional] |
|**summary** | **String** | The summary of the pulse | |
-|**serviceIds** | **List<String>** | The Service ID's to attach to the pulse | [optional] |
-|**environmentIds** | **List<String>** | The Environment ID's to attach to the pulse | [optional] |
+|**serviceIds** | **List<String>** | The Service IDs to attach to the pulse | [optional] |
+|**environmentIds** | **List<String>** | The Environment IDs to attach to the pulse | [optional] |
|**startedAt** | **OffsetDateTime** | Pulse start datetime | [optional] |
|**endedAt** | **OffsetDateTime** | Pulse end datetime | [optional] |
|**externalUrl** | **String** | The external url of the pulse | [optional] |
-|**labels** | [**List<NewAlertDataAttributesLabelsInner>**](NewAlertDataAttributesLabelsInner.md) | | [optional] |
+|**labels** | [**List<NewPulseDataAttributesLabelsInner>**](NewPulseDataAttributesLabelsInner.md) | | [optional] |
|**refs** | [**List<NewPulseDataAttributesRefsInner>**](NewPulseDataAttributesRefsInner.md) | | [optional] |
|**data** | **Object** | Additional data | [optional] |
diff --git a/docs/NewPulseDataAttributesLabelsInner.md b/docs/NewPulseDataAttributesLabelsInner.md
new file mode 100644
index 00000000..3b46eae4
--- /dev/null
+++ b/docs/NewPulseDataAttributesLabelsInner.md
@@ -0,0 +1,14 @@
+
+
+# NewPulseDataAttributesLabelsInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**key** | **String** | Key of the tag | |
+|**value** | **String** | Value of the tag | |
+
+
+
diff --git a/docs/NewRetrospectiveProcessDataAttributesRetrospectiveProcessMatchingCriteria.md b/docs/NewRetrospectiveProcessDataAttributesRetrospectiveProcessMatchingCriteria.md
index baece415..5271de68 100644
--- a/docs/NewRetrospectiveProcessDataAttributesRetrospectiveProcessMatchingCriteria.md
+++ b/docs/NewRetrospectiveProcessDataAttributesRetrospectiveProcessMatchingCriteria.md
@@ -7,9 +7,9 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
-|**severityIds** | **List<String>** | Severity ID's for retrospective process matching criteria | |
-|**groupIds** | **List<String>** | Team ID's for retrospective process matching criteria | |
-|**incidentTypeIds** | **List<String>** | Incident type ID's for retrospective process matching criteria | |
+|**severityIds** | **List<String>** | Severity IDs for retrospective process matching criteria | |
+|**groupIds** | **List<String>** | Team IDs for retrospective process matching criteria | |
+|**incidentTypeIds** | **List<String>** | Incident type IDs for retrospective process matching criteria | |
diff --git a/docs/NewRetrospectiveProcessDataAttributesRetrospectiveProcessMatchingCriteriaOneOf.md b/docs/NewRetrospectiveProcessDataAttributesRetrospectiveProcessMatchingCriteriaOneOf.md
index 725b9716..2056172c 100644
--- a/docs/NewRetrospectiveProcessDataAttributesRetrospectiveProcessMatchingCriteriaOneOf.md
+++ b/docs/NewRetrospectiveProcessDataAttributesRetrospectiveProcessMatchingCriteriaOneOf.md
@@ -7,7 +7,7 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
-|**severityIds** | **List<String>** | Severity ID's for retrospective process matching criteria | |
+|**severityIds** | **List<String>** | Severity IDs for retrospective process matching criteria | |
diff --git a/docs/NewRetrospectiveProcessDataAttributesRetrospectiveProcessMatchingCriteriaOneOf1.md b/docs/NewRetrospectiveProcessDataAttributesRetrospectiveProcessMatchingCriteriaOneOf1.md
index 0f8e2540..c80bb66c 100644
--- a/docs/NewRetrospectiveProcessDataAttributesRetrospectiveProcessMatchingCriteriaOneOf1.md
+++ b/docs/NewRetrospectiveProcessDataAttributesRetrospectiveProcessMatchingCriteriaOneOf1.md
@@ -7,7 +7,7 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
-|**groupIds** | **List<String>** | Team ID's for retrospective process matching criteria | |
+|**groupIds** | **List<String>** | Team IDs for retrospective process matching criteria | |
diff --git a/docs/NewRetrospectiveProcessDataAttributesRetrospectiveProcessMatchingCriteriaOneOf2.md b/docs/NewRetrospectiveProcessDataAttributesRetrospectiveProcessMatchingCriteriaOneOf2.md
index 4846caf0..6e240c08 100644
--- a/docs/NewRetrospectiveProcessDataAttributesRetrospectiveProcessMatchingCriteriaOneOf2.md
+++ b/docs/NewRetrospectiveProcessDataAttributesRetrospectiveProcessMatchingCriteriaOneOf2.md
@@ -7,7 +7,7 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
-|**incidentTypeIds** | **List<String>** | Incident type ID's for retrospective process matching criteria | |
+|**incidentTypeIds** | **List<String>** | Incident type IDs for retrospective process matching criteria | |
diff --git a/docs/NewRoleDataAttributes.md b/docs/NewRoleDataAttributes.md
index 6ae589c4..132d6335 100644
--- a/docs/NewRoleDataAttributes.md
+++ b/docs/NewRoleDataAttributes.md
@@ -8,7 +8,6 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**name** | **String** | The role name. | |
-|**slug** | **String** | The role slug. | [optional] |
|**incidentPermissionSetId** | **String** | Associated incident permissions set. | [optional] |
|**alertsPermissions** | [**List<AlertsPermissionsEnum>**](#List<AlertsPermissionsEnum>) | | [optional] |
|**apiKeysPermissions** | [**List<ApiKeysPermissionsEnum>**](#List<ApiKeysPermissionsEnum>) | | [optional] |
@@ -36,6 +35,13 @@
|**statusPagesPermissions** | [**List<StatusPagesPermissionsEnum>**](#List<StatusPagesPermissionsEnum>) | | [optional] |
|**webhooksPermissions** | [**List<WebhooksPermissionsEnum>**](#List<WebhooksPermissionsEnum>) | | [optional] |
|**workflowsPermissions** | [**List<WorkflowsPermissionsEnum>**](#List<WorkflowsPermissionsEnum>) | | [optional] |
+|**catalogsPermissions** | [**List<CatalogsPermissionsEnum>**](#List<CatalogsPermissionsEnum>) | | [optional] |
+|**subStatusesPermissions** | [**List<SubStatusesPermissionsEnum>**](#List<SubStatusesPermissionsEnum>) | | [optional] |
+|**edgeConnectorPermissions** | [**List<EdgeConnectorPermissionsEnum>**](#List<EdgeConnectorPermissionsEnum>) | | [optional] |
+|**slasPermissions** | [**List<SlasPermissionsEnum>**](#List<SlasPermissionsEnum>) | | [optional] |
+|**pagingPermissions** | [**List<PagingPermissionsEnum>**](#List<PagingPermissionsEnum>) | | [optional] |
+|**incidentCommunicationPermissions** | [**List<IncidentCommunicationPermissionsEnum>**](#List<IncidentCommunicationPermissionsEnum>) | | [optional] |
+|**communicationPermissions** | [**List<CommunicationPermissionsEnum>**](#List<CommunicationPermissionsEnum>) | | [optional] |
@@ -322,3 +328,81 @@
+## Enum: List<CatalogsPermissionsEnum>
+
+| Name | Value |
+|---- | -----|
+| CREATE | "create" |
+| READ | "read" |
+| UPDATE | "update" |
+| DELETE | "delete" |
+
+
+
+## Enum: List<SubStatusesPermissionsEnum>
+
+| Name | Value |
+|---- | -----|
+| CREATE | "create" |
+| READ | "read" |
+| UPDATE | "update" |
+| DELETE | "delete" |
+
+
+
+## Enum: List<EdgeConnectorPermissionsEnum>
+
+| Name | Value |
+|---- | -----|
+| CREATE | "create" |
+| READ | "read" |
+| UPDATE | "update" |
+| DELETE | "delete" |
+
+
+
+## Enum: List<SlasPermissionsEnum>
+
+| Name | Value |
+|---- | -----|
+| CREATE | "create" |
+| READ | "read" |
+| UPDATE | "update" |
+| DELETE | "delete" |
+
+
+
+## Enum: List<PagingPermissionsEnum>
+
+| Name | Value |
+|---- | -----|
+| CREATE | "create" |
+| READ | "read" |
+| UPDATE | "update" |
+| DELETE | "delete" |
+
+
+
+## Enum: List<IncidentCommunicationPermissionsEnum>
+
+| Name | Value |
+|---- | -----|
+| CREATE | "create" |
+| READ | "read" |
+| UPDATE | "update" |
+| DELETE | "delete" |
+| SEND | "send" |
+
+
+
+## Enum: List<CommunicationPermissionsEnum>
+
+| Name | Value |
+|---- | -----|
+| CREATE | "create" |
+| READ | "read" |
+| UPDATE | "update" |
+| DELETE | "delete" |
+
+
+
diff --git a/docs/NewScheduleDataAttributes.md b/docs/NewScheduleDataAttributes.md
index d6b2aa7d..aeeec447 100644
--- a/docs/NewScheduleDataAttributes.md
+++ b/docs/NewScheduleDataAttributes.md
@@ -11,8 +11,11 @@
|**description** | **String** | The description of the schedule | [optional] |
|**allTimeCoverage** | **Boolean** | 24/7 coverage of the schedule | [optional] |
|**slackUserGroup** | [**NewScheduleDataAttributesSlackUserGroup**](NewScheduleDataAttributesSlackUserGroup.md) | | [optional] |
+|**slackChannel** | [**NewScheduleDataAttributesSlackChannel**](NewScheduleDataAttributesSlackChannel.md) | | [optional] |
|**ownerGroupIds** | **List<String>** | Owning teams. | [optional] |
-|**ownerUserId** | **Integer** | ID of the owner of the schedule | [optional] |
+|**ownerUserId** | **Integer** | ID of the owner of the schedule | |
+|**shiftStartNotificationsEnabled** | **Boolean** | Whether shift-start notifications are enabled | [optional] |
+|**shiftUpdateNotificationsEnabled** | **Boolean** | Whether shift-update notifications are enabled | [optional] |
diff --git a/docs/NewScheduleDataAttributesSlackChannel.md b/docs/NewScheduleDataAttributesSlackChannel.md
new file mode 100644
index 00000000..cb167489
--- /dev/null
+++ b/docs/NewScheduleDataAttributesSlackChannel.md
@@ -0,0 +1,14 @@
+
+
+# NewScheduleDataAttributesSlackChannel
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | Slack channel ID | [optional] |
+|**name** | **String** | Slack channel name | [optional] |
+
+
+
diff --git a/docs/NewScheduleDataAttributesSlackUserGroup.md b/docs/NewScheduleDataAttributesSlackUserGroup.md
index dedc6d50..cea281b0 100644
--- a/docs/NewScheduleDataAttributesSlackUserGroup.md
+++ b/docs/NewScheduleDataAttributesSlackUserGroup.md
@@ -7,8 +7,8 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
-|**id** | **String** | Slack channel ID | [optional] |
-|**name** | **String** | Slack channel name | [optional] |
+|**id** | **String** | Slack user group ID | [optional] |
+|**name** | **String** | Slack user group name | [optional] |
diff --git a/docs/NewScheduleRotationDataAttributes.md b/docs/NewScheduleRotationDataAttributes.md
index dc73b7d7..646e981f 100644
--- a/docs/NewScheduleRotationDataAttributes.md
+++ b/docs/NewScheduleRotationDataAttributes.md
@@ -16,6 +16,9 @@
|**activeTimeAttributes** | [**List<NewScheduleRotationDataAttributesActiveTimeAttributesInner>**](NewScheduleRotationDataAttributesActiveTimeAttributesInner.md) | Schedule rotation's active times | [optional] |
|**timeZone** | **String** | A valid IANA time zone name. | [optional] |
|**scheduleRotationableAttributes** | [**NewScheduleRotationDataAttributesScheduleRotationableAttributes**](NewScheduleRotationDataAttributesScheduleRotationableAttributes.md) | | |
+|**startTime** | **OffsetDateTime** | RFC3339 date-time when rotation starts. Shifts will only be created after this time. | [optional] |
+|**endTime** | **OffsetDateTime** | RFC3339 date-time when rotation ends. Shifts will only be created before this time. | [optional] |
+|**scheduleRotationMembers** | [**List<NewScheduleRotationDataAttributesScheduleRotationMembersInner>**](NewScheduleRotationDataAttributesScheduleRotationMembersInner.md) | You can only add schedule rotation members if your account has schedule nesting feature enabled | [optional] |
diff --git a/docs/NewScheduleRotationDataAttributesScheduleRotationMembersInner.md b/docs/NewScheduleRotationDataAttributesScheduleRotationMembersInner.md
new file mode 100644
index 00000000..ba69d155
--- /dev/null
+++ b/docs/NewScheduleRotationDataAttributesScheduleRotationMembersInner.md
@@ -0,0 +1,24 @@
+
+
+# NewScheduleRotationDataAttributesScheduleRotationMembersInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**memberType** | [**MemberTypeEnum**](#MemberTypeEnum) | Type of member | |
+|**memberId** | **String** | ID of the member | |
+|**position** | **Integer** | Position of the member in rotation | [optional] |
+
+
+
+## Enum: MemberTypeEnum
+
+| Name | Value |
+|---- | -----|
+| USER | "User" |
+| SCHEDULE | "Schedule" |
+
+
+
diff --git a/docs/NewServiceDataAttributes.md b/docs/NewServiceDataAttributes.md
index d21f986d..d50c6d30 100644
--- a/docs/NewServiceDataAttributes.md
+++ b/docs/NewServiceDataAttributes.md
@@ -28,12 +28,19 @@
|**gitlabRepositoryBranch** | **String** | The GitLab repository branch associated to this service. eg: main | [optional] |
|**environmentIds** | **List<String>** | Environments associated with this service | [optional] |
|**serviceIds** | **List<String>** | Services dependent on this service | [optional] |
-|**ownersGroupIds** | **List<String>** | Owner Teams associated with this service | [optional] |
-|**ownersUserIds** | **List<Integer>** | Owner Users associated with this service | [optional] |
+|**ownerGroupIds** | **List<String>** | Owner Teams associated with this service | [optional] |
+|**ownerUserIds** | **List<Integer>** | Owner Users associated with this service | [optional] |
+|**kubernetesDeploymentName** | **String** | The Kubernetes deployment name associated to this service. eg: namespace/deployment-name | [optional] |
|**alertsEmailEnabled** | **Boolean** | Enable alerts through email | [optional] |
|**alertUrgencyId** | **String** | The alert urgency id of the service | [optional] |
+|**escalationPolicyId** | **String** | The escalation policy id of the service | [optional] |
|**slackChannels** | [**List<NewEnvironmentDataAttributesSlackChannelsInner>**](NewEnvironmentDataAttributesSlackChannelsInner.md) | Slack Channels associated with this service | [optional] |
|**slackAliases** | [**List<NewEnvironmentDataAttributesSlackAliasesInner>**](NewEnvironmentDataAttributesSlackAliasesInner.md) | Slack Aliases associated with this service | [optional] |
+|**alertBroadcastEnabled** | **Boolean** | Enable alerts to be broadcasted to a specific channel | [optional] |
+|**alertBroadcastChannel** | [**NewServiceDataAttributesAlertBroadcastChannel**](NewServiceDataAttributesAlertBroadcastChannel.md) | | [optional] |
+|**incidentBroadcastEnabled** | **Boolean** | Enable incidents to be broadcasted to a specific channel | [optional] |
+|**incidentBroadcastChannel** | [**NewServiceDataAttributesIncidentBroadcastChannel**](NewServiceDataAttributesIncidentBroadcastChannel.md) | | [optional] |
+|**properties** | [**List<NewCauseDataAttributesPropertiesInner>**](NewCauseDataAttributesPropertiesInner.md) | Array of property values for this service. | [optional] |
diff --git a/docs/NewServiceDataAttributesAlertBroadcastChannel.md b/docs/NewServiceDataAttributesAlertBroadcastChannel.md
new file mode 100644
index 00000000..f95c1867
--- /dev/null
+++ b/docs/NewServiceDataAttributesAlertBroadcastChannel.md
@@ -0,0 +1,15 @@
+
+
+# NewServiceDataAttributesAlertBroadcastChannel
+
+Slack channel to broadcast alerts to
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | Slack channel ID | |
+|**name** | **String** | Slack channel name | [optional] |
+
+
+
diff --git a/docs/NewServiceDataAttributesIncidentBroadcastChannel.md b/docs/NewServiceDataAttributesIncidentBroadcastChannel.md
new file mode 100644
index 00000000..4d0746f4
--- /dev/null
+++ b/docs/NewServiceDataAttributesIncidentBroadcastChannel.md
@@ -0,0 +1,15 @@
+
+
+# NewServiceDataAttributesIncidentBroadcastChannel
+
+Slack channel to broadcast incidents to
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | Slack channel ID | |
+|**name** | **String** | Slack channel name | [optional] |
+
+
+
diff --git a/docs/NewSla.md b/docs/NewSla.md
new file mode 100644
index 00000000..fb3a3176
--- /dev/null
+++ b/docs/NewSla.md
@@ -0,0 +1,13 @@
+
+
+# NewSla
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**NewSlaData**](NewSlaData.md) | | |
+
+
+
diff --git a/docs/NewSlaData.md b/docs/NewSlaData.md
new file mode 100644
index 00000000..efb8e5df
--- /dev/null
+++ b/docs/NewSlaData.md
@@ -0,0 +1,22 @@
+
+
+# NewSlaData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**NewSlaDataAttributes**](NewSlaDataAttributes.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| SLAS | "slas" |
+
+
+
diff --git a/docs/NewSlaDataAttributes.md b/docs/NewSlaDataAttributes.md
new file mode 100644
index 00000000..512cd906
--- /dev/null
+++ b/docs/NewSlaDataAttributes.md
@@ -0,0 +1,97 @@
+
+
+# NewSlaDataAttributes
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | The name of the SLA | |
+|**description** | **String** | A description of the SLA | [optional] |
+|**position** | **Integer** | Position of the SLA for ordering | [optional] |
+|**conditionMatchType** | [**ConditionMatchTypeEnum**](#ConditionMatchTypeEnum) | Whether all or any conditions must match | [optional] |
+|**managerRoleId** | **UUID** | The ID of the incident role responsible for this SLA. Must provide either manager_role_id or manager_user_id. | [optional] |
+|**managerUserId** | **Integer** | The ID of the user responsible for this SLA. Must provide either manager_role_id or manager_user_id. | [optional] |
+|**assignmentDeadlineDays** | [**AssignmentDeadlineDaysEnum**](#AssignmentDeadlineDaysEnum) | Number of days for the assignment deadline | |
+|**assignmentDeadlineParentStatus** | [**AssignmentDeadlineParentStatusEnum**](#AssignmentDeadlineParentStatusEnum) | The incident parent status that triggers the assignment deadline | |
+|**assignmentDeadlineSubStatusId** | **UUID** | Sub-status for the assignment deadline. Required when custom lifecycle statuses are enabled on the team. | [optional] |
+|**assignmentSkipWeekends** | **Boolean** | Whether to skip weekends when calculating the assignment deadline | [optional] |
+|**completionDeadlineDays** | [**CompletionDeadlineDaysEnum**](#CompletionDeadlineDaysEnum) | Number of days for the completion deadline | |
+|**completionDeadlineParentStatus** | [**CompletionDeadlineParentStatusEnum**](#CompletionDeadlineParentStatusEnum) | The incident parent status that triggers the completion deadline | |
+|**completionDeadlineSubStatusId** | **UUID** | Sub-status for the completion deadline. Required when custom lifecycle statuses are enabled on the team. | [optional] |
+|**completionSkipWeekends** | **Boolean** | Whether to skip weekends when calculating the completion deadline | [optional] |
+|**conditions** | [**List<NewSlaDataAttributesConditionsInner>**](NewSlaDataAttributesConditionsInner.md) | Conditions that determine which incidents this SLA applies to. Maximum 20. | [optional] |
+|**notificationConfigurations** | [**List<NewSlaDataAttributesNotificationConfigurationsInner>**](NewSlaDataAttributesNotificationConfigurationsInner.md) | Notification timing configurations. Maximum 20. | [optional] |
+
+
+
+## Enum: ConditionMatchTypeEnum
+
+| Name | Value |
+|---- | -----|
+| ALL | "ALL" |
+| ANY | "ANY" |
+
+
+
+## Enum: AssignmentDeadlineDaysEnum
+
+| Name | Value |
+|---- | -----|
+| NUMBER_1 | 1 |
+| NUMBER_2 | 2 |
+| NUMBER_3 | 3 |
+| NUMBER_4 | 4 |
+| NUMBER_5 | 5 |
+| NUMBER_6 | 6 |
+| NUMBER_7 | 7 |
+| NUMBER_14 | 14 |
+| NUMBER_21 | 21 |
+| NUMBER_30 | 30 |
+
+
+
+## Enum: AssignmentDeadlineParentStatusEnum
+
+| Name | Value |
+|---- | -----|
+| IN_TRIAGE | "in_triage" |
+| STARTED | "started" |
+| MITIGATED | "mitigated" |
+| RESOLVED | "resolved" |
+| CLOSED | "closed" |
+| CANCELLED | "cancelled" |
+
+
+
+## Enum: CompletionDeadlineDaysEnum
+
+| Name | Value |
+|---- | -----|
+| NUMBER_1 | 1 |
+| NUMBER_2 | 2 |
+| NUMBER_3 | 3 |
+| NUMBER_4 | 4 |
+| NUMBER_5 | 5 |
+| NUMBER_6 | 6 |
+| NUMBER_7 | 7 |
+| NUMBER_14 | 14 |
+| NUMBER_21 | 21 |
+| NUMBER_30 | 30 |
+
+
+
+## Enum: CompletionDeadlineParentStatusEnum
+
+| Name | Value |
+|---- | -----|
+| IN_TRIAGE | "in_triage" |
+| STARTED | "started" |
+| MITIGATED | "mitigated" |
+| RESOLVED | "resolved" |
+| CLOSED | "closed" |
+| CANCELLED | "cancelled" |
+
+
+
diff --git a/docs/NewSlaDataAttributesConditionsInner.md b/docs/NewSlaDataAttributesConditionsInner.md
new file mode 100644
index 00000000..b9666870
--- /dev/null
+++ b/docs/NewSlaDataAttributesConditionsInner.md
@@ -0,0 +1,52 @@
+
+
+# NewSlaDataAttributesConditionsInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**conditionableType** | [**ConditionableTypeEnum**](#ConditionableTypeEnum) | The type of condition | |
+|**property** | [**PropertyEnum**](#PropertyEnum) | The property to evaluate (for built-in field conditions). When the team has custom lifecycle statuses enabled, use 'sub_status' (with sub-status IDs as values); otherwise use 'status' (with parent status names). Sending the wrong one will return a validation error. | [optional] |
+|**operator** | **String** | The comparison operator | |
+|**values** | **List<String>** | The values to compare against | [optional] |
+|**formFieldId** | **UUID** | The ID of the form field (for custom field conditions) | [optional] |
+|**position** | **Integer** | The position of the condition for ordering | [optional] |
+
+
+
+## Enum: ConditionableTypeEnum
+
+| Name | Value |
+|---- | -----|
+| SLAS_BUILT_IN_FIELD_CONDITION | "SLAs::BuiltInFieldCondition" |
+| SLAS_CUSTOM_FIELD_CONDITION | "SLAs::CustomFieldCondition" |
+
+
+
+## Enum: PropertyEnum
+
+| Name | Value |
+|---- | -----|
+| SEVERITY | "severity" |
+| ENVIRONMENT | "environment" |
+| SERVICE | "service" |
+| FUNCTIONALITY | "functionality" |
+| INCIDENT_TYPE | "incident_type" |
+| GROUP | "group" |
+| CAUSE | "cause" |
+| SUB_STATUS | "sub_status" |
+| INCIDENT_ROLE | "incident_role" |
+| STATUS | "status" |
+| KIND | "kind" |
+| VISIBILITY | "visibility" |
+| SUMMARY | "summary" |
+| STARTED_AT | "started_at" |
+| DETECTED_AT | "detected_at" |
+| ACKNOWLEDGED_AT | "acknowledged_at" |
+| MITIGATED_AT | "mitigated_at" |
+| RESOLVED_AT | "resolved_at" |
+
+
+
diff --git a/docs/NewSlaDataAttributesNotificationConfigurationsInner.md b/docs/NewSlaDataAttributesNotificationConfigurationsInner.md
new file mode 100644
index 00000000..6c86657a
--- /dev/null
+++ b/docs/NewSlaDataAttributesNotificationConfigurationsInner.md
@@ -0,0 +1,24 @@
+
+
+# NewSlaDataAttributesNotificationConfigurationsInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**offsetType** | [**OffsetTypeEnum**](#OffsetTypeEnum) | When to send the notification relative to the deadline | |
+|**offsetDays** | **Integer** | Number of days before or after the deadline. Must be 0 for when_due. | |
+
+
+
+## Enum: OffsetTypeEnum
+
+| Name | Value |
+|---- | -----|
+| BEFORE_DUE | "before_due" |
+| WHEN_DUE | "when_due" |
+| AFTER_DUE | "after_due" |
+
+
+
diff --git a/docs/NewStatusPageDataAttributes.md b/docs/NewStatusPageDataAttributes.md
index 71fe2305..f6e31cbc 100644
--- a/docs/NewStatusPageDataAttributes.md
+++ b/docs/NewStatusPageDataAttributes.md
@@ -18,8 +18,15 @@
|**showUptimeLastDays** | [**ShowUptimeLastDaysEnum**](#ShowUptimeLastDaysEnum) | Show uptime over x days | [optional] |
|**successMessage** | **String** | Message showing when all components are operational | [optional] |
|**failureMessage** | **String** | Message showing when at least one component is not operational | [optional] |
-|**authenticationEnabled** | **Boolean** | Enable authentication | [optional] |
+|**authenticationMethod** | [**AuthenticationMethodEnum**](#AuthenticationMethodEnum) | Authentication method | [optional] |
+|**authenticationEnabled** | **Boolean** | Enable authentication (deprecated - use authentication_method instead) | [optional] |
|**authenticationPassword** | **String** | Authentication password | [optional] |
+|**samlIdpSsoServiceUrl** | **String** | SAML IdP SSO service URL | [optional] |
+|**samlIdpSloServiceUrl** | **String** | SAML IdP SLO service URL | [optional] |
+|**samlIdpCert** | **String** | SAML IdP certificate | [optional] |
+|**samlNameIdentifierFormat** | [**SamlNameIdentifierFormatEnum**](#SamlNameIdentifierFormatEnum) | SAML name identifier format | [optional] |
+|**sectionOrder** | [**List<SectionOrderEnum>**](#List<SectionOrderEnum>) | Order of sections on the status page | [optional] |
+|**externalDomainNames** | **List<String>** | External domain names attached to the status page | [optional] |
|**websiteUrl** | **String** | Website URL | [optional] |
|**websitePrivacyUrl** | **String** | Website Privacy URL | [optional] |
|**websiteSupportUrl** | **String** | Website Support URL | [optional] |
@@ -39,8 +46,37 @@
| NUMBER_30 | 30 |
| NUMBER_60 | 60 |
| NUMBER_90 | 90 |
-| NUMBER_180 | 180 |
-| NUMBER_360 | 360 |
+
+
+
+## Enum: AuthenticationMethodEnum
+
+| Name | Value |
+|---- | -----|
+| NONE | "none" |
+| PASSWORD | "password" |
+| SAML | "saml" |
+
+
+
+## Enum: SamlNameIdentifierFormatEnum
+
+| Name | Value |
+|---- | -----|
+| URN_OASIS_NAMES_TC_SAML_1_1_NAMEID_FORMAT_EMAIL_ADDRESS | "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress" |
+| URN_OASIS_NAMES_TC_SAML_2_0_NAMEID_FORMAT_PERSISTENT | "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent" |
+| URN_OASIS_NAMES_TC_SAML_2_0_NAMEID_FORMAT_TRANSIENT | "urn:oasis:names:tc:SAML:2.0:nameid-format:transient" |
+| URN_OASIS_NAMES_TC_SAML_1_1_NAMEID_FORMAT_UNSPECIFIED | "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified" |
+
+
+
+## Enum: List<SectionOrderEnum>
+
+| Name | Value |
+|---- | -----|
+| MAINTENANCE | "maintenance" |
+| SYSTEM_STATUS | "system_status" |
+| INCIDENTS | "incidents" |
diff --git a/docs/NewStatusPageTemplateDataAttributes.md b/docs/NewStatusPageTemplateDataAttributes.md
index 82da1d05..0963b598 100644
--- a/docs/NewStatusPageTemplateDataAttributes.md
+++ b/docs/NewStatusPageTemplateDataAttributes.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**statusPageId** | **String** | | [optional] |
|**title** | **String** | Title of the template | |
+|**updateTitle** | **String** | Title that will be used for the status page update | [optional] |
|**body** | **String** | Description of the event the template will populate | |
|**updateStatus** | [**UpdateStatusEnum**](#UpdateStatusEnum) | Status of the event the template will populate | [optional] |
|**kind** | [**KindEnum**](#KindEnum) | The kind of the status page template | [optional] |
@@ -28,7 +29,6 @@
| RESOLVED | "resolved" |
| SCHEDULED | "scheduled" |
| IN_PROGRESS | "in_progress" |
-| VERIFYING | "verifying" |
| COMPLETED | "completed" |
diff --git a/docs/NewSubStatusDataAttributes.md b/docs/NewSubStatusDataAttributes.md
index 3007cb6e..8e1bfb5f 100644
--- a/docs/NewSubStatusDataAttributes.md
+++ b/docs/NewSubStatusDataAttributes.md
@@ -8,7 +8,6 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**name** | **String** | | |
-|**slug** | **String** | | [optional] |
|**description** | **String** | | [optional] |
|**parentStatus** | [**ParentStatusEnum**](#ParentStatusEnum) | | |
|**position** | **Integer** | | [optional] |
diff --git a/docs/NewTeamDataAttributes.md b/docs/NewTeamDataAttributes.md
index c3f34a83..252032bc 100644
--- a/docs/NewTeamDataAttributes.md
+++ b/docs/NewTeamDataAttributes.md
@@ -28,6 +28,12 @@
|**alertUrgencyId** | **String** | The alert urgency id of the team | [optional] |
|**slackChannels** | [**List<NewEnvironmentDataAttributesSlackChannelsInner>**](NewEnvironmentDataAttributesSlackChannelsInner.md) | Slack Channels associated with this team | [optional] |
|**slackAliases** | [**List<NewEnvironmentDataAttributesSlackAliasesInner>**](NewEnvironmentDataAttributesSlackAliasesInner.md) | Slack Aliases associated with this team | [optional] |
+|**alertBroadcastEnabled** | **Boolean** | Enable alerts to be broadcasted to a specific channel | [optional] |
+|**alertBroadcastChannel** | [**NewServiceDataAttributesAlertBroadcastChannel**](NewServiceDataAttributesAlertBroadcastChannel.md) | | [optional] |
+|**incidentBroadcastEnabled** | **Boolean** | Enable incidents to be broadcasted to a specific channel | [optional] |
+|**incidentBroadcastChannel** | [**NewServiceDataAttributesIncidentBroadcastChannel**](NewServiceDataAttributesIncidentBroadcastChannel.md) | | [optional] |
+|**autoAddMembersWhenAttached** | **Boolean** | Auto add members to incident channel when team is attached | [optional] |
+|**properties** | [**List<NewCauseDataAttributesPropertiesInner>**](NewCauseDataAttributesPropertiesInner.md) | Array of property values for this team. | [optional] |
diff --git a/docs/NewUserEmailAddress.md b/docs/NewUserEmailAddress.md
new file mode 100644
index 00000000..4b56264d
--- /dev/null
+++ b/docs/NewUserEmailAddress.md
@@ -0,0 +1,13 @@
+
+
+# NewUserEmailAddress
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**NewUserEmailAddressData**](NewUserEmailAddressData.md) | | |
+
+
+
diff --git a/docs/NewUserEmailAddressData.md b/docs/NewUserEmailAddressData.md
new file mode 100644
index 00000000..acb656ba
--- /dev/null
+++ b/docs/NewUserEmailAddressData.md
@@ -0,0 +1,22 @@
+
+
+# NewUserEmailAddressData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**NewUserEmailAddressDataAttributes**](NewUserEmailAddressDataAttributes.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| USER_EMAIL_ADDRESSES | "user_email_addresses" |
+
+
+
diff --git a/docs/NewUserEmailAddressDataAttributes.md b/docs/NewUserEmailAddressDataAttributes.md
new file mode 100644
index 00000000..6a92cd9a
--- /dev/null
+++ b/docs/NewUserEmailAddressDataAttributes.md
@@ -0,0 +1,13 @@
+
+
+# NewUserEmailAddressDataAttributes
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**email** | **String** | Email address | |
+
+
+
diff --git a/docs/NewUserNotificationRuleDataAttributes.md b/docs/NewUserNotificationRuleDataAttributes.md
index 30673071..2256757d 100644
--- a/docs/NewUserNotificationRuleDataAttributes.md
+++ b/docs/NewUserNotificationRuleDataAttributes.md
@@ -26,6 +26,7 @@
| CALL | "call" |
| DEVICE | "device" |
| NON_CRITICAL_DEVICE | "non_critical_device" |
+| SLACK | "slack" |
diff --git a/docs/NewUserPhoneNumber.md b/docs/NewUserPhoneNumber.md
new file mode 100644
index 00000000..501f1a5e
--- /dev/null
+++ b/docs/NewUserPhoneNumber.md
@@ -0,0 +1,13 @@
+
+
+# NewUserPhoneNumber
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**NewUserPhoneNumberData**](NewUserPhoneNumberData.md) | | |
+
+
+
diff --git a/docs/NewUserPhoneNumberData.md b/docs/NewUserPhoneNumberData.md
new file mode 100644
index 00000000..fa58b6d9
--- /dev/null
+++ b/docs/NewUserPhoneNumberData.md
@@ -0,0 +1,22 @@
+
+
+# NewUserPhoneNumberData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**NewUserPhoneNumberDataAttributes**](NewUserPhoneNumberDataAttributes.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| USER_PHONE_NUMBERS | "user_phone_numbers" |
+
+
+
diff --git a/docs/NewUserPhoneNumberDataAttributes.md b/docs/NewUserPhoneNumberDataAttributes.md
new file mode 100644
index 00000000..3f835a4f
--- /dev/null
+++ b/docs/NewUserPhoneNumberDataAttributes.md
@@ -0,0 +1,13 @@
+
+
+# NewUserPhoneNumberDataAttributes
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**phone** | **String** | Phone number in international format | |
+
+
+
diff --git a/docs/NewWebhooksEndpointDataAttributes.md b/docs/NewWebhooksEndpointDataAttributes.md
index 9301660c..ce3b4f1d 100644
--- a/docs/NewWebhooksEndpointDataAttributes.md
+++ b/docs/NewWebhooksEndpointDataAttributes.md
@@ -48,6 +48,7 @@
| GENIUS_WORKFLOW_RUN_COMPLETED | "genius_workflow_run.completed" |
| GENIUS_WORKFLOW_RUN_FAILED | "genius_workflow_run.failed" |
| GENIUS_WORKFLOW_RUN_CANCELED | "genius_workflow_run.canceled" |
+| AUDIT_LOG_CREATED | "audit_log.created" |
diff --git a/docs/NewWorkflowCustomFieldSelectionDataAttributes.md b/docs/NewWorkflowCustomFieldSelectionDataAttributes.md
index c8f89fce..c46c3d8b 100644
--- a/docs/NewWorkflowCustomFieldSelectionDataAttributes.md
+++ b/docs/NewWorkflowCustomFieldSelectionDataAttributes.md
@@ -20,6 +20,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
diff --git a/docs/NewWorkflowDataAttributes.md b/docs/NewWorkflowDataAttributes.md
index 0cb7655a..096686c1 100644
--- a/docs/NewWorkflowDataAttributes.md
+++ b/docs/NewWorkflowDataAttributes.md
@@ -8,7 +8,6 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**name** | **String** | The title of the workflow | |
-|**slug** | **String** | The slug of the workflow | [optional] |
|**description** | **String** | The description of the workflow | [optional] |
|**command** | **String** | Workflow command | [optional] |
|**commandFeedbackEnabled** | **Boolean** | This will notify you back when the workflow is starting | [optional] |
diff --git a/docs/NewWorkflowDataAttributesTriggerParams.md b/docs/NewWorkflowDataAttributesTriggerParams.md
index 677c531f..11c030fb 100644
--- a/docs/NewWorkflowDataAttributesTriggerParams.md
+++ b/docs/NewWorkflowDataAttributesTriggerParams.md
@@ -53,10 +53,14 @@
|**alertConditionStatusUseRegexp** | **Boolean** | | [optional] |
|**alertStatuses** | **List<String>** | | [optional] |
|**alertLabels** | **List<String>** | | [optional] |
+|**alertConditionUrgency** | [**AlertConditionUrgencyEnum**](#AlertConditionUrgencyEnum) | | [optional] |
+|**alertUrgencyIds** | **List<UUID>** | | [optional] |
|**alertConditionPayload** | [**AlertConditionPayloadEnum**](#AlertConditionPayloadEnum) | | [optional] |
|**alertConditionPayloadUseRegexp** | **Boolean** | | [optional] |
|**alertPayload** | **List<String>** | | [optional] |
|**alertQueryPayload** | **String** | You can use jsonpath syntax. eg: $.incident.teams[*] | [optional] |
+|**alertFieldConditions** | [**List<AlertTriggerParamsAlertFieldConditionsInner>**](AlertTriggerParamsAlertFieldConditionsInner.md) | | [optional] |
+|**alertPayloadConditions** | [**AlertTriggerParamsAlertPayloadConditions**](AlertTriggerParamsAlertPayloadConditions.md) | | [optional] |
|**pulseCondition** | [**PulseConditionEnum**](#PulseConditionEnum) | | [optional] |
|**pulseConditionSource** | [**PulseConditionSourceEnum**](#PulseConditionSourceEnum) | | [optional] |
|**pulseConditionSourceUseRegexp** | **Boolean** | | [optional] |
@@ -99,6 +103,7 @@
| NORMAL_SUB | "normal_sub" |
| BACKFILLED | "backfilled" |
| SCHEDULED | "scheduled" |
+| SCHEDULED_SUB | "scheduled_sub" |
@@ -135,6 +140,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -150,6 +156,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -165,6 +172,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -180,6 +188,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -195,6 +204,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -210,6 +220,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -225,6 +236,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -240,6 +252,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -255,6 +268,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -270,6 +284,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -285,6 +300,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -300,6 +316,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -315,6 +332,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -402,6 +420,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -426,6 +445,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -452,6 +472,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -477,6 +498,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -502,6 +524,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -517,6 +540,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -532,6 +556,23 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
+| ANY | "ANY" |
+| CONTAINS | "CONTAINS" |
+| CONTAINS_ALL | "CONTAINS_ALL" |
+| CONTAINS_NONE | "CONTAINS_NONE" |
+| NONE | "NONE" |
+| SET | "SET" |
+| UNSET | "UNSET" |
+
+
+
+## Enum: AlertConditionUrgencyEnum
+
+| Name | Value |
+|---- | -----|
+| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -547,6 +588,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -572,6 +614,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -587,6 +630,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -602,6 +646,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
diff --git a/docs/NewWorkflowFormFieldConditionDataAttributes.md b/docs/NewWorkflowFormFieldConditionDataAttributes.md
index 06539108..2618c21f 100644
--- a/docs/NewWorkflowFormFieldConditionDataAttributes.md
+++ b/docs/NewWorkflowFormFieldConditionDataAttributes.md
@@ -17,6 +17,9 @@
|**selectedOptionIds** | **List<String>** | | [optional] |
|**selectedServiceIds** | **List<String>** | | [optional] |
|**selectedUserIds** | **List<Integer>** | | [optional] |
+|**selectedCauseIds** | **List<String>** | | [optional] |
+|**selectedEnvironmentIds** | **List<String>** | | [optional] |
+|**selectedIncidentTypeIds** | **List<String>** | | [optional] |
@@ -25,6 +28,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
diff --git a/docs/NewWorkflowTaskDataAttributesTaskParams.md b/docs/NewWorkflowTaskDataAttributesTaskParams.md
index 5f4e0850..653fe1bb 100644
--- a/docs/NewWorkflowTaskDataAttributesTaskParams.md
+++ b/docs/NewWorkflowTaskDataAttributesTaskParams.md
@@ -21,11 +21,11 @@
|**postToIncidentTimeline** | **Boolean** | | [optional] |
|**customFieldsMapping** | **String** | Custom field mappings. Can contain liquid markup and need to be valid JSON | [optional] |
|**postToSlackChannels** | [**List<AddActionItemTaskParamsPostToSlackChannelsInner>**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | [optional] |
-|**groupIds** | **List<String>** | | [optional] |
+|**groupIds** | **List<String>** | Array of group/team UUIDs | [optional] |
|**playbookId** | **String** | The playbook id if tab is of an incident playbook | [optional] |
|**channel** | [**AddActionItemTaskParamsPostToSlackChannelsInner**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | |
|**title** | **String** | The task title | |
-|**link** | **String** | The tab link. Required if not a playbook tab | [optional] |
+|**link** | **String** | The tab link | |
|**emoji** | **String** | The bookmark emoji | [optional] |
|**groupId** | **String** | The team id | |
|**event** | **String** | Incident event description | |
@@ -68,17 +68,19 @@
|**integration** | [**CreateJiraIssueTaskParamsIntegration**](CreateJiraIssueTaskParamsIntegration.md) | | [optional] |
|**space** | [**AddActionItemTaskParamsPostToSlackChannelsInner**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | |
|**ancestor** | [**AddActionItemTaskParamsPostToSlackChannelsInner**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | [optional] |
-|**template** | [**CreateIncidentPostmortemTaskParamsTemplate**](CreateIncidentPostmortemTaskParamsTemplate.md) | | [optional] |
-|**postMortemTemplateId** | **String** | Retrospective template to use when creating page task, if desired | [optional] |
+|**template** | [**UpdateDatadogNotebookTaskParamsTemplate**](UpdateDatadogNotebookTaskParamsTemplate.md) | | [optional] |
+|**postMortemTemplateId** | **String** | Retrospective template to use when updating notebook, if desired | [optional] |
|**markPostMortemAsPublished** | **Boolean** | | [optional] |
|**subtitle** | **String** | The Coda page subtitle | [optional] |
|**folderId** | **String** | The Coda folder id | [optional] |
+|**doc** | [**CreateCodaPageTaskParamsDoc**](CreateCodaPageTaskParamsDoc.md) | | [optional] |
|**namespace** | [**AddActionItemTaskParamsPostToSlackChannelsInner**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | [optional] |
|**parentFolder** | [**AddActionItemTaskParamsPostToSlackChannelsInner**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | [optional] |
|**body** | **String** | The issue body | |
-|**repository** | [**AddActionItemTaskParamsPostToSlackChannelsInner**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | |
-|**issueType** | [**IssueTypeEnum**](#IssueTypeEnum) | The issue type | |
+|**repository** | [**UpdateGithubIssueTaskParamsRepository**](UpdateGithubIssueTaskParamsRepository.md) | | |
|**labels** | **List<String>** | | [optional] |
+|**issueType** | [**IssueTypeEnum**](#IssueTypeEnum) | The issue type | |
+|**parentIssueNumber** | **String** | The parent issue number for sub-issue linking | [optional] |
|**calendar** | [**AddActionItemTaskParamsPostToSlackChannelsInner**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | |
|**attendees** | **List<String>** | Emails of attendees | [optional] |
|**timeZone** | **String** | A valid IANA time zone name. | [optional] |
@@ -86,13 +88,14 @@
|**timeOfMeeting** | **String** | Time of meeting in format HH:MM | |
|**meetingDuration** | **String** | Meeting duration in format like '1 hour', '30 minutes' | |
|**excludeWeekends** | **Boolean** | | [optional] |
+|**enableOnlineMeeting** | **Boolean** | Enable Microsoft Teams online meeting | [optional] |
|**calendarId** | **String** | | [optional] |
|**sendUpdates** | **Boolean** | Send an email to the attendees notifying them of the event | [optional] |
|**canGuestsModifyEvent** | **Boolean** | | [optional] |
|**canGuestsSeeOtherGuests** | **Boolean** | | [optional] |
|**canGuestsInviteOthers** | **Boolean** | | [optional] |
|**conferenceSolutionKey** | [**ConferenceSolutionKeyEnum**](#ConferenceSolutionKeyEnum) | [DEPRECATED] Sets the video conference type attached to the meeting | [optional] |
-|**fileId** | **String** | The Notion page ID | |
+|**fileId** | **String** | The Datadog notebook ID | |
|**templateId** | **String** | The Quip file ID to use as a template | [optional] |
|**docId** | **String** | The Coda doc id | [optional] |
|**pageId** | **String** | The Coda page id | |
@@ -107,13 +110,14 @@
|**value** | **String** | | |
|**parentFolderId** | **String** | The parent folder id | [optional] |
|**recordMeeting** | **Boolean** | Rootly AI will record the meeting and automatically generate a transcript and summary from your meeting | [optional] |
+|**recordingMode** | [**RecordingModeEnum**](#RecordingModeEnum) | The video layout for the bot's recording (e.g. speaker_view, gallery_view, gallery_view_v2, audio_only) | [optional] |
|**subject** | **String** | The ticket subject | |
|**conferenceCallInfo** | [**ConferenceCallInfoEnum**](#ConferenceCallInfoEnum) | | [optional] |
|**passwordRequired** | **Boolean** | | [optional] |
|**severityId** | **String** | | [optional] |
|**incidentTypeIds** | **List<String>** | | [optional] |
-|**serviceIds** | **List<String>** | | [optional] |
-|**functionalityIds** | **List<String>** | | [optional] |
+|**serviceIds** | **List<String>** | Array of service UUIDs | [optional] |
+|**functionalityIds** | **List<String>** | Array of functionality UUIDs | [optional] |
|**environmentIds** | **List<String>** | | [optional] |
|**_private** | **Boolean** | | [optional] |
|**incidentId** | **String** | The incident id | |
@@ -122,14 +126,19 @@
|**updatePayload** | **String** | Update payload. Can contain liquid markup and need to be valid JSON | [optional] |
|**parentIssueId** | **String** | The parent issue | |
|**subtaskIssueType** | [**CreateJiraIssueTaskParamsIssueType**](CreateJiraIssueTaskParamsIssueType.md) | | |
-|**state** | [**CreateLinearIssueTaskParamsState**](CreateLinearIssueTaskParamsState.md) | | |
+|**state** | [**UpdateLinearIssueTaskParamsState**](UpdateLinearIssueTaskParamsState.md) | | |
|**project** | [**CreateLinearIssueTaskParamsProject**](CreateLinearIssueTaskParamsProject.md) | | [optional] |
|**issueId** | **String** | The issue id | |
+|**topic** | **String** | | |
+|**chatType** | [**ChatTypeEnum**](#ChatTypeEnum) | Type of chat to create | [optional] |
+|**members** | [**List<CreateMicrosoftTeamsChatTaskParamsMembersInner>**](CreateMicrosoftTeamsChatTaskParamsMembersInner.md) | Array of members to include in the chat | |
+|**chat** | [**AddActionItemTaskParamsPostToSlackChannelsInner**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | |
|**emails** | **String** | Comma separated list of emails to invite | |
|**parentPage** | [**CreateNotionPageTaskParamsParentPage**](CreateNotionPageTaskParamsParentPage.md) | | |
|**showTimelineAsTable** | **Boolean** | | [optional] |
|**showActionItemsAsTable** | **Boolean** | | [optional] |
|**text** | **String** | The message text | |
+|**chats** | [**List<AddActionItemTaskParamsPostToSlackChannelsInner>**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | |
|**attachments** | **String** | Support liquid markup. Needs to be a valid JSON string after liquid is parsed | |
|**archivation** | [**CreateTrelloCardTaskParamsArchivation**](CreateTrelloCardTaskParamsArchivation.md) | | |
|**group** | [**Object**](Object.md) | The group id and display name | [optional] |
@@ -137,7 +146,6 @@
|**parentStoryId** | **String** | The parent story | |
|**board** | [**CreateTrelloCardTaskParamsBoard**](CreateTrelloCardTaskParamsBoard.md) | | |
|**_list** | [**CreateTrelloCardTaskParamsList**](CreateTrelloCardTaskParamsList.md) | | |
-|**topic** | **String** | | |
|**password** | **String** | The meeting password | [optional] |
|**comment** | **String** | The ticket comment | [optional] |
|**tags** | **String** | The ticket tags | [optional] |
@@ -173,7 +181,8 @@
|**details** | **String** | Details payload. Can contain liquid markup and need to be valid JSON | [optional] |
|**alertId** | **String** | Opsgenie Alert ID | |
|**opsgenieIncidentId** | **String** | The Opsgenie incident ID, this can also be a Rootly incident variable ex. {{ incident.opsgenie_incident_id }} | |
-|**alertUrgencyId** | **String** | Alert urgency ID | [optional] |
+|**functionalityTarget** | [**AddActionItemTaskParamsPostToSlackChannelsInner**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | [optional] |
+|**alertUrgencyId** | **String** | Alert urgency ID | |
|**escalationNote** | **String** | | [optional] |
|**escalationPolicies** | [**List<Object>**](Object.md) | | [optional] |
|**createNewIncidentOnConflict** | **Boolean** | Rootly only supports linking to a single PagerDuty incident. If this feature is disabled Rootly will add responders from any additional pages to the existing PagerDuty incident that is linked to the Rootly incident. If enabled, Rootly will create a new PagerDuty incident that is not linked to any Rootly incidents | [optional] |
@@ -214,6 +223,7 @@
|**tableName** | **String** | The table name | |
|**recordId** | **String** | The record id | |
|**taskId** | **String** | The task id | |
+|**labelsMode** | [**LabelsModeEnum**](#LabelsModeEnum) | How to apply labels. 'replace' (default) overwrites all existing labels. 'append' adds to existing labels without removing them. | [optional] |
|**startedAt** | **String** | | [optional] |
|**detectedAt** | **String** | | [optional] |
|**acknowledgedAt** | **String** | | [optional] |
@@ -230,8 +240,14 @@
|**workflow** | [**AddActionItemTaskParamsPostToSlackChannelsInner**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | |
|**checkWorkflowConditions** | **Boolean** | | [optional] |
|**blocks** | **String** | Support liquid markup. Needs to be a valid JSON string after liquid is parsed | |
-|**model** | [**GeniusCreateWatsonxChatCompletionTaskParamsModel**](GeniusCreateWatsonxChatCompletionTaskParamsModel.md) | | |
-|**prompt** | **String** | The prompt to send to WatsonX | |
+|**model** | [**CreateAnthropicChatCompletionTaskParamsModel**](CreateAnthropicChatCompletionTaskParamsModel.md) | | |
+|**systemPrompt** | **String** | The system prompt to send to Anthropic (optional) | [optional] |
+|**prompt** | **String** | The prompt to send to Anthropic | |
+|**temperature** | **BigDecimal** | Sampling temperature (0.0-1.5). Higher values make output more random. | [optional] |
+|**maxTokens** | **Integer** | Maximum number of tokens to generate | [optional] |
+|**topP** | **BigDecimal** | Nucleus sampling parameter (0.0-1.0) | [optional] |
+|**reasoningEffort** | [**ReasoningEffortEnum**](#ReasoningEffortEnum) | Constrains effort on reasoning for GPT-5 and o-series models | [optional] |
+|**reasoningSummary** | [**ReasoningSummaryEnum**](#ReasoningSummaryEnum) | Summary of the reasoning performed by the model for GPT-5 and o-series models | [optional] |
|**projectId** | **String** | | |
@@ -240,7 +256,7 @@
| Name | Value |
|---- | -----|
-| GENIUS_CREATE_WATSONX_CHAT_COMPLETION_TASK | "genius_create_watsonx_chat_completion_task" |
+| CREATE_ANTHROPIC_CHAT_COMPLETION_TASK | "create_anthropic_chat_completion_task" |
@@ -344,6 +360,17 @@
+## Enum: RecordingModeEnum
+
+| Name | Value |
+|---- | -----|
+| SPEAKER_VIEW | "speaker_view" |
+| GALLERY_VIEW | "gallery_view" |
+| GALLERY_VIEW_V2 | "gallery_view_v2" |
+| AUDIO_ONLY | "audio_only" |
+
+
+
## Enum: ConferenceCallInfoEnum
| Name | Value |
@@ -355,6 +382,15 @@
+## Enum: ChatTypeEnum
+
+| Name | Value |
+|---- | -----|
+| GROUP | "group" |
+| ONE_ON_ONE | "oneOnOne" |
+
+
+
## Enum: AutoRecordingEnum
| Name | Value |
@@ -445,3 +481,33 @@
+## Enum: LabelsModeEnum
+
+| Name | Value |
+|---- | -----|
+| REPLACE | "replace" |
+| APPEND | "append" |
+
+
+
+## Enum: ReasoningEffortEnum
+
+| Name | Value |
+|---- | -----|
+| MINIMAL | "minimal" |
+| LOW | "low" |
+| MEDIUM | "medium" |
+| HIGH | "high" |
+
+
+
+## Enum: ReasoningSummaryEnum
+
+| Name | Value |
+|---- | -----|
+| AUTO | "auto" |
+| CONCISE | "concise" |
+| DETAILED | "detailed" |
+
+
+
diff --git a/docs/OnCallPayReport.md b/docs/OnCallPayReport.md
new file mode 100644
index 00000000..47cdd7e6
--- /dev/null
+++ b/docs/OnCallPayReport.md
@@ -0,0 +1,51 @@
+
+
+# OnCallPayReport
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**status** | [**StatusEnum**](#StatusEnum) | The current status of the report. | |
+|**startDate** | **LocalDate** | The start date of the report period. | |
+|**endDate** | **LocalDate** | The end date of the report period. | |
+|**totalDuration** | **Integer** | Total on-call duration in seconds. | [optional] |
+|**usersCount** | **Integer** | Number of users included in the report. | [optional] |
+|**currency** | **String** | The currency code for monetary values. | [optional] |
+|**payType** | [**PayTypeEnum**](#PayTypeEnum) | The pay calculation type. | [optional] |
+|**hourlyRateCents** | **Integer** | Hourly pay rate in cents. | [optional] |
+|**dailyRateCents** | **Integer** | Daily pay rate in cents. | [optional] |
+|**totalPayCents** | **Integer** | Total pay amount in cents. | [optional] |
+|**includeShadow** | **Boolean** | Whether shadow shifts are included. | [optional] |
+|**showIndividualShiftData** | **Boolean** | Whether individual shift data is shown. | [optional] |
+|**hasSingleRate** | **Boolean** | Whether a single rate is applied to all users. | [optional] |
+|**enabledGranularTimeBreakdown** | **Boolean** | Whether granular time breakdown is enabled. | [optional] |
+|**lastGeneratedAt** | **OffsetDateTime** | When the report was last generated. | [optional] |
+|**timeZone** | **String** | The team's IANA timezone used to interpret start_date and end_date. | [optional] |
+|**csvFileUrl** | **URI** | Download URL for the generated CSV report. Null until the report is generated. | [optional] |
+|**xlsxFileUrl** | **URI** | Download URL for the generated XLSX report. Null until the report is generated. | [optional] |
+|**createdAt** | **OffsetDateTime** | | |
+|**updatedAt** | **OffsetDateTime** | | |
+
+
+
+## Enum: StatusEnum
+
+| Name | Value |
+|---- | -----|
+| PROCESSING | "processing" |
+| GENERATED | "generated" |
+| DOWNLOADED | "downloaded" |
+
+
+
+## Enum: PayTypeEnum
+
+| Name | Value |
+|---- | -----|
+| HOURLY | "hourly" |
+| DAILY | "daily" |
+
+
+
diff --git a/docs/OnCallPayReportList.md b/docs/OnCallPayReportList.md
new file mode 100644
index 00000000..b56490da
--- /dev/null
+++ b/docs/OnCallPayReportList.md
@@ -0,0 +1,15 @@
+
+
+# OnCallPayReportList
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<OnCallPayReportResponseData>**](OnCallPayReportResponseData.md) | | |
+|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
+
+
+
diff --git a/docs/OnCallPayReportResponse.md b/docs/OnCallPayReportResponse.md
new file mode 100644
index 00000000..7f4f2fc3
--- /dev/null
+++ b/docs/OnCallPayReportResponse.md
@@ -0,0 +1,13 @@
+
+
+# OnCallPayReportResponse
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**OnCallPayReportResponseData**](OnCallPayReportResponseData.md) | | |
+
+
+
diff --git a/docs/OnCallPayReportResponseData.md b/docs/OnCallPayReportResponseData.md
new file mode 100644
index 00000000..d752a880
--- /dev/null
+++ b/docs/OnCallPayReportResponseData.md
@@ -0,0 +1,23 @@
+
+
+# OnCallPayReportResponseData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | Unique ID of the on_call_pay_report | |
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**OnCallPayReport**](OnCallPayReport.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| ON_CALL_PAY_REPORTS | "on_call_pay_reports" |
+
+
+
diff --git a/docs/OnCallPayReportsApi.md b/docs/OnCallPayReportsApi.md
new file mode 100644
index 00000000..c54d9036
--- /dev/null
+++ b/docs/OnCallPayReportsApi.md
@@ -0,0 +1,372 @@
+# OnCallPayReportsApi
+
+All URIs are relative to *https://api.rootly.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createOnCallPayReport**](OnCallPayReportsApi.md#createOnCallPayReport) | **POST** /v1/on_call_pay_reports | Creates an On-Call Pay Report |
+| [**getOnCallPayReport**](OnCallPayReportsApi.md#getOnCallPayReport) | **GET** /v1/on_call_pay_reports/{id} | Retrieves an On-Call Pay Report |
+| [**listOnCallPayReports**](OnCallPayReportsApi.md#listOnCallPayReports) | **GET** /v1/on_call_pay_reports | List On-Call Pay Reports |
+| [**regenerateOnCallPayReport**](OnCallPayReportsApi.md#regenerateOnCallPayReport) | **POST** /v1/on_call_pay_reports/{id}/regenerate | Regenerate an On-Call Pay Report |
+| [**updateOnCallPayReport**](OnCallPayReportsApi.md#updateOnCallPayReport) | **PUT** /v1/on_call_pay_reports/{id} | Update an On-Call Pay Report |
+
+
+
+# **createOnCallPayReport**
+> OnCallPayReportResponse createOnCallPayReport(newOnCallPayReport)
+
+Creates an On-Call Pay Report
+
+Generates a new on-call pay report for the given date range. The report is generated asynchronously.
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.OnCallPayReportsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ OnCallPayReportsApi apiInstance = new OnCallPayReportsApi(defaultClient);
+ NewOnCallPayReport newOnCallPayReport = new NewOnCallPayReport(); // NewOnCallPayReport |
+ try {
+ OnCallPayReportResponse result = apiInstance.createOnCallPayReport(newOnCallPayReport);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling OnCallPayReportsApi#createOnCallPayReport");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **newOnCallPayReport** | [**NewOnCallPayReport**](NewOnCallPayReport.md)| | |
+
+### Return type
+
+[**OnCallPayReportResponse**](OnCallPayReportResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/vnd.api+json
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | on_call_pay_report created | - |
+| **422** | invalid request | - |
+| **401** | responds with unauthorized for invalid token | - |
+
+
+# **getOnCallPayReport**
+> OnCallPayReportResponse getOnCallPayReport(id, include)
+
+Retrieves an On-Call Pay Report
+
+Retrieves a specific on-call pay report by id
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.OnCallPayReportsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ OnCallPayReportsApi apiInstance = new OnCallPayReportsApi(defaultClient);
+ String id = "id_example"; // String |
+ String include = "include_example"; // String |
+ try {
+ OnCallPayReportResponse result = apiInstance.getOnCallPayReport(id, include);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling OnCallPayReportsApi#getOnCallPayReport");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| | |
+| **include** | **String**| | [optional] |
+
+### Return type
+
+[**OnCallPayReportResponse**](OnCallPayReportResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | on_call_pay_report found | - |
+| **404** | resource not found for different team | - |
+
+
+# **listOnCallPayReports**
+> OnCallPayReportList listOnCallPayReports(include, pageNumber, pageSize, filterStatus, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte)
+
+List On-Call Pay Reports
+
+List on-call pay reports
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.OnCallPayReportsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ OnCallPayReportsApi apiInstance = new OnCallPayReportsApi(defaultClient);
+ String include = "include_example"; // String |
+ Integer pageNumber = 56; // Integer |
+ Integer pageSize = 56; // Integer |
+ String filterStatus = "filterStatus_example"; // String |
+ String filterCreatedAtGt = "filterCreatedAtGt_example"; // String |
+ String filterCreatedAtGte = "filterCreatedAtGte_example"; // String |
+ String filterCreatedAtLt = "filterCreatedAtLt_example"; // String |
+ String filterCreatedAtLte = "filterCreatedAtLte_example"; // String |
+ try {
+ OnCallPayReportList result = apiInstance.listOnCallPayReports(include, pageNumber, pageSize, filterStatus, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling OnCallPayReportsApi#listOnCallPayReports");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **include** | **String**| | [optional] |
+| **pageNumber** | **Integer**| | [optional] |
+| **pageSize** | **Integer**| | [optional] |
+| **filterStatus** | **String**| | [optional] |
+| **filterCreatedAtGt** | **String**| | [optional] |
+| **filterCreatedAtGte** | **String**| | [optional] |
+| **filterCreatedAtLt** | **String**| | [optional] |
+| **filterCreatedAtLte** | **String**| | [optional] |
+
+### Return type
+
+[**OnCallPayReportList**](OnCallPayReportList.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | success | - |
+
+
+# **regenerateOnCallPayReport**
+> OnCallPayReportResponse regenerateOnCallPayReport(id)
+
+Regenerate an On-Call Pay Report
+
+Triggers regeneration of an existing on-call pay report.
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.OnCallPayReportsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ OnCallPayReportsApi apiInstance = new OnCallPayReportsApi(defaultClient);
+ String id = "id_example"; // String |
+ try {
+ OnCallPayReportResponse result = apiInstance.regenerateOnCallPayReport(id);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling OnCallPayReportsApi#regenerateOnCallPayReport");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| | |
+
+### Return type
+
+[**OnCallPayReportResponse**](OnCallPayReportResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | on_call_pay_report regeneration triggered | - |
+| **404** | on_call_pay_report not found | - |
+
+
+# **updateOnCallPayReport**
+> OnCallPayReportResponse updateOnCallPayReport(id, updateOnCallPayReport)
+
+Update an On-Call Pay Report
+
+Update a specific on-call pay report by id. Triggers report regeneration.
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.OnCallPayReportsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ OnCallPayReportsApi apiInstance = new OnCallPayReportsApi(defaultClient);
+ String id = "id_example"; // String |
+ UpdateOnCallPayReport updateOnCallPayReport = new UpdateOnCallPayReport(); // UpdateOnCallPayReport |
+ try {
+ OnCallPayReportResponse result = apiInstance.updateOnCallPayReport(id, updateOnCallPayReport);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling OnCallPayReportsApi#updateOnCallPayReport");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| | |
+| **updateOnCallPayReport** | [**UpdateOnCallPayReport**](UpdateOnCallPayReport.md)| | |
+
+### Return type
+
+[**OnCallPayReportResponse**](OnCallPayReportResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/vnd.api+json
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | on_call_pay_report updated | - |
+| **404** | not allowed when flipper disabled | - |
+| **422** | invalid request | - |
+
diff --git a/docs/OnCallRole.md b/docs/OnCallRole.md
index e1ee794a..7d8e82c9 100644
--- a/docs/OnCallRole.md
+++ b/docs/OnCallRole.md
@@ -8,10 +8,15 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**name** | **String** | The role name. | |
-|**slug** | **String** | The role slug. | |
-|**systemRole** | [**List<SystemRoleEnum>**](#List<SystemRoleEnum>) | The kind of role | |
+|**slug** | **String** | The role slug. | [optional] |
+|**systemRole** | [**List<SystemRoleEnum>**](#List<SystemRoleEnum>) | The kind of role | [optional] |
|**alertSourcesPermissions** | [**List<AlertSourcesPermissionsEnum>**](#List<AlertSourcesPermissionsEnum>) | | [optional] |
|**alertUrgencyPermissions** | [**List<AlertUrgencyPermissionsEnum>**](#List<AlertUrgencyPermissionsEnum>) | | [optional] |
+|**alertFieldsPermissions** | [**List<AlertFieldsPermissionsEnum>**](#List<AlertFieldsPermissionsEnum>) | | [optional] |
+|**alertGroupsPermissions** | [**List<AlertGroupsPermissionsEnum>**](#List<AlertGroupsPermissionsEnum>) | | [optional] |
+|**alertRoutingRulesPermissions** | [**List<AlertRoutingRulesPermissionsEnum>**](#List<AlertRoutingRulesPermissionsEnum>) | | [optional] |
+|**onCallReadinessReportPermissions** | [**List<OnCallReadinessReportPermissionsEnum>**](#List<OnCallReadinessReportPermissionsEnum>) | | [optional] |
+|**onCallRolesPermissions** | [**List<OnCallRolesPermissionsEnum>**](#List<OnCallRolesPermissionsEnum>) | | [optional] |
|**alertsPermissions** | [**List<AlertsPermissionsEnum>**](#List<AlertsPermissionsEnum>) | | [optional] |
|**apiKeysPermissions** | [**List<ApiKeysPermissionsEnum>**](#List<ApiKeysPermissionsEnum>) | | [optional] |
|**auditsPermissions** | [**List<AuditsPermissionsEnum>**](#List<AuditsPermissionsEnum>) | | [optional] |
@@ -39,6 +44,7 @@
| ADMIN | "admin" |
| USER | "user" |
| CUSTOM | "custom" |
+| OBSERVER | "observer" |
| NO_ACCESS | "no_access" |
@@ -48,6 +54,7 @@
| Name | Value |
|---- | -----|
| CREATE | "create" |
+| READ | "read" |
| UPDATE | "update" |
| DELETE | "delete" |
@@ -64,6 +71,58 @@
+## Enum: List<AlertFieldsPermissionsEnum>
+
+| Name | Value |
+|---- | -----|
+| CREATE | "create" |
+| READ | "read" |
+| UPDATE | "update" |
+| DELETE | "delete" |
+
+
+
+## Enum: List<AlertGroupsPermissionsEnum>
+
+| Name | Value |
+|---- | -----|
+| CREATE | "create" |
+| READ | "read" |
+| UPDATE | "update" |
+| DELETE | "delete" |
+
+
+
+## Enum: List<AlertRoutingRulesPermissionsEnum>
+
+| Name | Value |
+|---- | -----|
+| CREATE | "create" |
+| READ | "read" |
+| UPDATE | "update" |
+| DELETE | "delete" |
+
+
+
+## Enum: List<OnCallReadinessReportPermissionsEnum>
+
+| Name | Value |
+|---- | -----|
+| READ | "read" |
+
+
+
+## Enum: List<OnCallRolesPermissionsEnum>
+
+| Name | Value |
+|---- | -----|
+| CREATE | "create" |
+| READ | "read" |
+| UPDATE | "update" |
+| DELETE | "delete" |
+
+
+
## Enum: List<AlertsPermissionsEnum>
| Name | Value |
@@ -71,6 +130,7 @@
| CREATE | "create" |
| UPDATE | "update" |
| READ | "read" |
+| DELETE | "delete" |
diff --git a/docs/OnCallRoleList.md b/docs/OnCallRoleList.md
index 2eae3d2a..01625e9a 100644
--- a/docs/OnCallRoleList.md
+++ b/docs/OnCallRoleList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<OnCallRoleResponseData>**](OnCallRoleResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/OnCallShadowsList.md b/docs/OnCallShadowsList.md
index 379c83a5..e918f3de 100644
--- a/docs/OnCallShadowsList.md
+++ b/docs/OnCallShadowsList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<OnCallShadowsListDataInner>**](OnCallShadowsListDataInner.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/OnCallsApi.md b/docs/OnCallsApi.md
new file mode 100644
index 00000000..1d4b13ca
--- /dev/null
+++ b/docs/OnCallsApi.md
@@ -0,0 +1,97 @@
+# OnCallsApi
+
+All URIs are relative to *https://api.rootly.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**listOncalls**](OnCallsApi.md#listOncalls) | **GET** /v1/oncalls | List on-calls |
+
+
+
+# **listOncalls**
+> listOncalls(include, since, until, earliest, timeZone, filterEscalationPolicyIds, filterScheduleIds, filterUserIds, filterServiceIds, filterGroupIds, filterNotificationTypes)
+
+List on-calls
+
+List who is currently on-call, with support for filtering by escalation policy, schedule, and user. Returns on-call entries grouped by escalation policy level.
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.OnCallsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ OnCallsApi apiInstance = new OnCallsApi(defaultClient);
+ String include = "user"; // String | comma separated if needed. eg: user,schedule
+ String since = "since_example"; // String | Start of time range in ISO-8601 format (e.g., 2025-01-01T00:00:00Z). Defaults to current time.
+ String until = "until_example"; // String | End of time range in ISO-8601 format (e.g., 2025-01-01T00:00:00Z). Defaults to 'since' time.
+ Boolean earliest = true; // Boolean | When true, returns only the first on-call user per escalation policy level
+ String timeZone = "timeZone_example"; // String | Timezone for response times (e.g., America/New_York). Defaults to UTC.
+ String filterEscalationPolicyIds = "filterEscalationPolicyIds_example"; // String | Comma-separated escalation policy IDs
+ String filterScheduleIds = "filterScheduleIds_example"; // String | Comma-separated schedule IDs
+ String filterUserIds = "filterUserIds_example"; // String | Comma-separated user IDs
+ String filterServiceIds = "filterServiceIds_example"; // String | Comma-separated service IDs
+ String filterGroupIds = "filterGroupIds_example"; // String | Comma-separated group IDs (teams)
+ String filterNotificationTypes = "filterNotificationTypes_example"; // String | Comma-separated notification types to include. One or both of: audible, quiet. When present, oncalls are returned from every non-deferral escalation path whose notification_type is in the filter, sorted audible-first. When absent, only the default path's oncalls are returned (existing behavior).
+ try {
+ apiInstance.listOncalls(include, since, until, earliest, timeZone, filterEscalationPolicyIds, filterScheduleIds, filterUserIds, filterServiceIds, filterGroupIds, filterNotificationTypes);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling OnCallsApi#listOncalls");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **include** | **String**| comma separated if needed. eg: user,schedule | [optional] [enum: user, schedule, escalation_policy] |
+| **since** | **String**| Start of time range in ISO-8601 format (e.g., 2025-01-01T00:00:00Z). Defaults to current time. | [optional] |
+| **until** | **String**| End of time range in ISO-8601 format (e.g., 2025-01-01T00:00:00Z). Defaults to 'since' time. | [optional] |
+| **earliest** | **Boolean**| When true, returns only the first on-call user per escalation policy level | [optional] |
+| **timeZone** | **String**| Timezone for response times (e.g., America/New_York). Defaults to UTC. | [optional] |
+| **filterEscalationPolicyIds** | **String**| Comma-separated escalation policy IDs | [optional] |
+| **filterScheduleIds** | **String**| Comma-separated schedule IDs | [optional] |
+| **filterUserIds** | **String**| Comma-separated user IDs | [optional] |
+| **filterServiceIds** | **String**| Comma-separated service IDs | [optional] |
+| **filterGroupIds** | **String**| Comma-separated group IDs (teams) | [optional] |
+| **filterNotificationTypes** | **String**| Comma-separated notification types to include. One or both of: audible, quiet. When present, oncalls are returned from every non-deferral escalation path whose notification_type is in the filter, sorted audible-first. When absent, only the default path's oncalls are returned (existing behavior). | [optional] |
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | success | - |
+| **404** | resource not found when alerting is disabled | - |
+| **401** | responds with unauthorized for invalid token | - |
+
diff --git a/docs/OverrideShift.md b/docs/OverrideShift.md
index 9d392852..94341606 100644
--- a/docs/OverrideShift.md
+++ b/docs/OverrideShift.md
@@ -15,6 +15,7 @@
|**createdAt** | **String** | Date of creation | [optional] |
|**updatedAt** | **String** | Date of last update | [optional] |
|**shiftOverride** | [**ShiftOverrideResponse**](ShiftOverrideResponse.md) | Override metadata | [optional] |
+|**userId** | **Integer** | Override shift user | [optional] |
|**user** | [**UserResponse**](UserResponse.md) | User metadata | [optional] |
diff --git a/docs/OverrideShiftList.md b/docs/OverrideShiftList.md
index 381e83ef..7168a4e1 100644
--- a/docs/OverrideShiftList.md
+++ b/docs/OverrideShiftList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<OverrideShiftResponseData>**](OverrideShiftResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/OverrideShiftsApi.md b/docs/OverrideShiftsApi.md
index f4f56761..71524da8 100644
--- a/docs/OverrideShiftsApi.md
+++ b/docs/OverrideShiftsApi.md
@@ -18,7 +18,7 @@ All URIs are relative to *https://api.rootly.com*
creates an override shift
-Creates a new override shift from provided data
+Creates a new override shift from provided data. If any existing override shifts overlap with the specified time range, they will be automatically deleted and replaced by the new override.
### Example
```java
@@ -79,8 +79,8 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **201** | override_shift created | - |
-| **422** | invalid request | - |
+| **201** | returns assignee relationship when schedule nesting enabled | - |
+| **422** | cannot create schedule-based override shift | - |
| **401** | responds with unauthorized for invalid token | - |
@@ -89,7 +89,7 @@ public class Example {
Delete an on call shadow configuration
-Delete a specific on call shadow configuration by id
+Delete a specific on call shadow configuration by id. Future shadows are hard-deleted. Active shadows (started in the past) have their end time truncated to preserve historical data.
### Example
```java
@@ -148,7 +148,8 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **200** | override shift deleted | - |
+| **200** | active shadow is preserved with truncated end time | - |
+| **422** | shadow period already ended | - |
| **404** | resource not found | - |
diff --git a/docs/PageJsmopsOnCallRespondersTaskParams.md b/docs/PageJsmopsOnCallRespondersTaskParams.md
new file mode 100644
index 00000000..f8bcbb27
--- /dev/null
+++ b/docs/PageJsmopsOnCallRespondersTaskParams.md
@@ -0,0 +1,41 @@
+
+
+# PageJsmopsOnCallRespondersTaskParams
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**taskType** | [**TaskTypeEnum**](#TaskTypeEnum) | | [optional] |
+|**title** | **String** | Incident title. | [optional] |
+|**message** | **String** | Message of the incident | [optional] |
+|**description** | **String** | Description field of the incident that is generally used to provide a detailed information about the incident | [optional] |
+|**teams** | [**List<AddActionItemTaskParamsPostToSlackChannelsInner>**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | [optional] |
+|**users** | [**List<AddActionItemTaskParamsPostToSlackChannelsInner>**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | [optional] |
+|**priority** | [**PriorityEnum**](#PriorityEnum) | | [optional] |
+
+
+
+## Enum: TaskTypeEnum
+
+| Name | Value |
+|---- | -----|
+| PAGE_JSMOPS_ON_CALL_RESPONDERS | "page_jsmops_on_call_responders" |
+
+
+
+## Enum: PriorityEnum
+
+| Name | Value |
+|---- | -----|
+| P3 | "P3" |
+| P1 | "P1" |
+| P2 | "P2" |
+| P32 | "P3" |
+| P4 | "P4" |
+| P5 | "P5" |
+| AUTO | "auto" |
+
+
+
diff --git a/docs/PageRootlyOnCallRespondersTaskParams.md b/docs/PageRootlyOnCallRespondersTaskParams.md
index 3a441587..97021ef5 100644
--- a/docs/PageRootlyOnCallRespondersTaskParams.md
+++ b/docs/PageRootlyOnCallRespondersTaskParams.md
@@ -12,7 +12,8 @@
|**serviceTarget** | [**AddActionItemTaskParamsPostToSlackChannelsInner**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | [optional] |
|**userTarget** | [**AddActionItemTaskParamsPostToSlackChannelsInner**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | [optional] |
|**groupTarget** | [**AddActionItemTaskParamsPostToSlackChannelsInner**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | [optional] |
-|**alertUrgencyId** | **String** | Alert urgency ID | [optional] |
+|**functionalityTarget** | [**AddActionItemTaskParamsPostToSlackChannelsInner**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | [optional] |
+|**alertUrgencyId** | **String** | Alert urgency ID | |
|**summary** | **String** | Alert title | |
|**description** | **String** | Alert description | [optional] |
|**escalationNote** | **String** | | [optional] |
diff --git a/docs/PatchAlertRoute.md b/docs/PatchAlertRoute.md
new file mode 100644
index 00000000..7ba4db4e
--- /dev/null
+++ b/docs/PatchAlertRoute.md
@@ -0,0 +1,13 @@
+
+
+# PatchAlertRoute
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**PatchAlertRouteData**](PatchAlertRouteData.md) | | |
+
+
+
diff --git a/docs/PatchAlertRouteData.md b/docs/PatchAlertRouteData.md
new file mode 100644
index 00000000..288acd8c
--- /dev/null
+++ b/docs/PatchAlertRouteData.md
@@ -0,0 +1,22 @@
+
+
+# PatchAlertRouteData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**PatchAlertRouteDataAttributes**](PatchAlertRouteDataAttributes.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| ALERT_ROUTES | "alert_routes" |
+
+
+
diff --git a/docs/PatchAlertRouteDataAttributes.md b/docs/PatchAlertRouteDataAttributes.md
new file mode 100644
index 00000000..6970d842
--- /dev/null
+++ b/docs/PatchAlertRouteDataAttributes.md
@@ -0,0 +1,17 @@
+
+
+# PatchAlertRouteDataAttributes
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | The name of the alert route | [optional] |
+|**enabled** | **Boolean** | Whether the alert route is enabled | [optional] |
+|**alertsSourceIds** | **List<UUID>** | | [optional] |
+|**owningTeamIds** | **List<UUID>** | | [optional] |
+|**rules** | [**List<PatchAlertRouteDataAttributesRulesInner>**](PatchAlertRouteDataAttributesRulesInner.md) | | [optional] |
+
+
+
diff --git a/docs/PatchAlertRouteDataAttributesRulesInner.md b/docs/PatchAlertRouteDataAttributesRulesInner.md
new file mode 100644
index 00000000..5a3b4b90
--- /dev/null
+++ b/docs/PatchAlertRouteDataAttributesRulesInner.md
@@ -0,0 +1,19 @@
+
+
+# PatchAlertRouteDataAttributesRulesInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | The ID of the alert routing rule. Required for updating or deleting existing rules. | [optional] |
+|**destroy** | **Boolean** | Set to true to delete this rule. When true, only the id field is required. | [optional] |
+|**name** | **String** | The name of the alert routing rule | [optional] |
+|**position** | **Integer** | The position of the alert routing rule for ordering evaluation | [optional] |
+|**fallbackRule** | **Boolean** | Whether this is a fallback rule | [optional] |
+|**destinations** | [**List<PatchAlertRouteDataAttributesRulesInnerDestinationsInner>**](PatchAlertRouteDataAttributesRulesInnerDestinationsInner.md) | | [optional] |
+|**conditionGroups** | [**List<PatchAlertRouteDataAttributesRulesInnerConditionGroupsInner>**](PatchAlertRouteDataAttributesRulesInnerConditionGroupsInner.md) | | [optional] |
+
+
+
diff --git a/docs/PatchAlertRouteDataAttributesRulesInnerConditionGroupsInner.md b/docs/PatchAlertRouteDataAttributesRulesInnerConditionGroupsInner.md
new file mode 100644
index 00000000..d8bef177
--- /dev/null
+++ b/docs/PatchAlertRouteDataAttributesRulesInnerConditionGroupsInner.md
@@ -0,0 +1,16 @@
+
+
+# PatchAlertRouteDataAttributesRulesInnerConditionGroupsInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | The ID of the condition group. Required for updating or deleting existing condition groups. | [optional] |
+|**destroy** | **Boolean** | Set to true to delete this condition group | [optional] |
+|**position** | **Integer** | The position of the condition group | [optional] |
+|**conditions** | [**List<PatchAlertRouteDataAttributesRulesInnerConditionGroupsInnerConditionsInner>**](PatchAlertRouteDataAttributesRulesInnerConditionGroupsInnerConditionsInner.md) | | [optional] |
+
+
+
diff --git a/docs/PatchAlertRouteDataAttributesRulesInnerConditionGroupsInnerConditionsInner.md b/docs/PatchAlertRouteDataAttributesRulesInnerConditionGroupsInnerConditionsInner.md
new file mode 100644
index 00000000..ba61f8c2
--- /dev/null
+++ b/docs/PatchAlertRouteDataAttributesRulesInnerConditionGroupsInnerConditionsInner.md
@@ -0,0 +1,55 @@
+
+
+# PatchAlertRouteDataAttributesRulesInnerConditionGroupsInnerConditionsInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | The ID of the condition. Required for updating or deleting existing conditions. | [optional] |
+|**destroy** | **Boolean** | Set to true to delete this condition | [optional] |
+|**propertyFieldConditionType** | [**PropertyFieldConditionTypeEnum**](#PropertyFieldConditionTypeEnum) | | [optional] |
+|**propertyFieldName** | **String** | The name of the property field | [optional] |
+|**propertyFieldType** | [**PropertyFieldTypeEnum**](#PropertyFieldTypeEnum) | | [optional] |
+|**propertyFieldValue** | **String** | The value of the property field | [optional] |
+|**propertyFieldValues** | **List<String>** | | [optional] |
+|**alertUrgencyIds** | **List<String>** | The Alert Urgency IDs to check in the condition | [optional] |
+|**conditionableType** | [**ConditionableTypeEnum**](#ConditionableTypeEnum) | The type of the conditionable | [optional] |
+|**conditionableId** | **UUID** | The ID of the conditionable | [optional] |
+
+
+
+## Enum: PropertyFieldConditionTypeEnum
+
+| Name | Value |
+|---- | -----|
+| IS_ONE_OF | "is_one_of" |
+| IS_NOT_ONE_OF | "is_not_one_of" |
+| CONTAINS | "contains" |
+| DOES_NOT_CONTAIN | "does_not_contain" |
+| STARTS_WITH | "starts_with" |
+| ENDS_WITH | "ends_with" |
+| MATCHES_REGEX | "matches_regex" |
+| IS_EMPTY | "is_empty" |
+
+
+
+## Enum: PropertyFieldTypeEnum
+
+| Name | Value |
+|---- | -----|
+| ATTRIBUTE | "attribute" |
+| PAYLOAD | "payload" |
+| ALERT_FIELD | "alert_field" |
+
+
+
+## Enum: ConditionableTypeEnum
+
+| Name | Value |
+|---- | -----|
+| ALERT_FIELD | "AlertField" |
+
+
+
diff --git a/docs/PatchAlertRouteDataAttributesRulesInnerDestinationsInner.md b/docs/PatchAlertRouteDataAttributesRulesInnerDestinationsInner.md
new file mode 100644
index 00000000..b325e304
--- /dev/null
+++ b/docs/PatchAlertRouteDataAttributesRulesInnerDestinationsInner.md
@@ -0,0 +1,27 @@
+
+
+# PatchAlertRouteDataAttributesRulesInnerDestinationsInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | The ID of the destination. Required for updating or deleting existing destinations. | [optional] |
+|**destroy** | **Boolean** | Set to true to delete this destination | [optional] |
+|**targetType** | [**TargetTypeEnum**](#TargetTypeEnum) | The type of the target. Please contact support if you encounter issues using `Functionality` as a target type. | [optional] |
+|**targetId** | **UUID** | The ID of the target | [optional] |
+
+
+
+## Enum: TargetTypeEnum
+
+| Name | Value |
+|---- | -----|
+| SERVICE | "Service" |
+| GROUP | "Group" |
+| FUNCTIONALITY | "Functionality" |
+| ESCALATION_POLICY | "EscalationPolicy" |
+
+
+
diff --git a/docs/PhoneVerificationResponse.md b/docs/PhoneVerificationResponse.md
new file mode 100644
index 00000000..87472246
--- /dev/null
+++ b/docs/PhoneVerificationResponse.md
@@ -0,0 +1,14 @@
+
+
+# PhoneVerificationResponse
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**message** | **String** | Success message | [optional] |
+|**error** | **String** | Error message | [optional] |
+
+
+
diff --git a/docs/Playbook.md b/docs/Playbook.md
index 0f046a89..2ddd5233 100644
--- a/docs/Playbook.md
+++ b/docs/Playbook.md
@@ -10,12 +10,12 @@
|**title** | **String** | The title of the playbook | |
|**summary** | **String** | The summary of the playbook | [optional] |
|**externalUrl** | **String** | The external url of the playbook | [optional] |
-|**severityIds** | **List<String>** | The Severity ID's to attach to the incident | [optional] |
-|**environmentIds** | **List<String>** | The Environment ID's to attach to the incident | [optional] |
-|**functionalityIds** | **List<String>** | The Functionality ID's to attach to the incident | [optional] |
-|**serviceIds** | **List<String>** | The Service ID's to attach to the incident | [optional] |
-|**groupIds** | **List<String>** | The Team ID's to attach to the incident | [optional] |
-|**incidentTypeIds** | **List<String>** | The Incident Type ID's to attach to the incident | [optional] |
+|**severityIds** | **List<String>** | The Severity IDs to attach to the incident | [optional] |
+|**environmentIds** | **List<String>** | The Environment IDs to attach to the incident | [optional] |
+|**functionalityIds** | **List<String>** | The Functionality IDs to attach to the incident | [optional] |
+|**serviceIds** | **List<String>** | The Service IDs to attach to the incident | [optional] |
+|**groupIds** | **List<String>** | The Team IDs to attach to the incident | [optional] |
+|**incidentTypeIds** | **List<String>** | The Incident Type IDs to attach to the incident | [optional] |
|**createdAt** | **String** | Date of creation | |
|**updatedAt** | **String** | Date of last update | |
diff --git a/docs/PlaybookList.md b/docs/PlaybookList.md
index dab4cda9..8513ea77 100644
--- a/docs/PlaybookList.md
+++ b/docs/PlaybookList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<PlaybookResponseData>**](PlaybookResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/PlaybookTaskList.md b/docs/PlaybookTaskList.md
index 207bbb60..76a4eab5 100644
--- a/docs/PlaybookTaskList.md
+++ b/docs/PlaybookTaskList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<PlaybookTaskResponseData>**](PlaybookTaskResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/PostMortemTemplate.md b/docs/PostMortemTemplate.md
index ef7c6e94..c83dad34 100644
--- a/docs/PostMortemTemplate.md
+++ b/docs/PostMortemTemplate.md
@@ -11,6 +11,8 @@
|**slug** | **String** | The slugified name of the postmortem template | [optional] |
|**_default** | **Boolean** | Default selected template when editing a postmortem | [optional] |
|**content** | **String** | The postmortem template. Liquid syntax and markdown are supported | [optional] |
+|**contentHtml** | **String** | The postmortem template in HTML format with TipTap blocks support. Supports followup and timeline components. Liquid syntax is supported. | [optional] |
+|**contentJson** | **Object** | The postmortem template in TipTap JSON format | [optional] |
|**format** | [**FormatEnum**](#FormatEnum) | The format of the input | [optional] |
|**createdAt** | **String** | Date of creation | |
|**updatedAt** | **String** | Date of last update | |
diff --git a/docs/PostMortemTemplateList.md b/docs/PostMortemTemplateList.md
index 8b6eb195..640fe15d 100644
--- a/docs/PostMortemTemplateList.md
+++ b/docs/PostMortemTemplateList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<PostMortemTemplateResponseData>**](PostMortemTemplateResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/PostMortemTriggerParams.md b/docs/PostMortemTriggerParams.md
index 876d7827..76a000f9 100644
--- a/docs/PostMortemTriggerParams.md
+++ b/docs/PostMortemTriggerParams.md
@@ -60,6 +60,7 @@
| NORMAL_SUB | "normal_sub" |
| BACKFILLED | "backfilled" |
| SCHEDULED | "scheduled" |
+| SCHEDULED_SUB | "scheduled_sub" |
@@ -96,6 +97,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -111,6 +113,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -126,6 +129,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -141,6 +145,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -156,6 +161,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -171,6 +177,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -186,6 +193,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -201,6 +209,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -216,6 +225,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -231,6 +241,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -246,6 +257,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -261,6 +273,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -276,6 +289,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -363,6 +377,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
diff --git a/docs/PublishIncidentTaskParams.md b/docs/PublishIncidentTaskParams.md
index c91504be..4a2eb365 100644
--- a/docs/PublishIncidentTaskParams.md
+++ b/docs/PublishIncidentTaskParams.md
@@ -38,7 +38,6 @@
| RESOLVED | "resolved" |
| SCHEDULED | "scheduled" |
| IN_PROGRESS | "in_progress" |
-| VERIFYING | "verifying" |
| COMPLETED | "completed" |
diff --git a/docs/Pulse.md b/docs/Pulse.md
index 81ec4120..b1d94a50 100644
--- a/docs/Pulse.md
+++ b/docs/Pulse.md
@@ -12,7 +12,7 @@
|**services** | [**List<Service>**](Service.md) | Services attached to the pulse | [optional] |
|**environments** | [**List<Environment>**](Environment.md) | Environments attached to the pulse | [optional] |
|**externalUrl** | **String** | The external url of the pulse | [optional] |
-|**labels** | [**List<NewAlertDataAttributesLabelsInner>**](NewAlertDataAttributesLabelsInner.md) | | [optional] |
+|**labels** | [**List<NewPulseDataAttributesLabelsInner>**](NewPulseDataAttributesLabelsInner.md) | | [optional] |
|**refs** | [**List<NewPulseDataAttributesRefsInner>**](NewPulseDataAttributesRefsInner.md) | | [optional] |
|**data** | **Object** | Additional data | [optional] |
|**createdAt** | **String** | Date of creation | |
diff --git a/docs/PulseList.md b/docs/PulseList.md
index 44dd43f9..fd5eb389 100644
--- a/docs/PulseList.md
+++ b/docs/PulseList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<PulseResponseData>**](PulseResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/PulseTriggerParams.md b/docs/PulseTriggerParams.md
index d179f479..55c00551 100644
--- a/docs/PulseTriggerParams.md
+++ b/docs/PulseTriggerParams.md
@@ -54,6 +54,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -69,6 +70,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
@@ -84,6 +86,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
diff --git a/docs/RetrospectiveConfiguration.md b/docs/RetrospectiveConfiguration.md
index 7381452f..46773d66 100644
--- a/docs/RetrospectiveConfiguration.md
+++ b/docs/RetrospectiveConfiguration.md
@@ -8,9 +8,9 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**kind** | [**KindEnum**](#KindEnum) | The kind of the configuration. | [optional] |
-|**severityIds** | **List<String>** | The Severity ID's to attach to the retrospective configuration | [optional] |
-|**groupIds** | **List<String>** | The Team ID's to attach to the retrospective configuration | [optional] |
-|**incidentTypeIds** | **List<String>** | The Incident Type ID's to attach to the retrospective configuration | [optional] |
+|**severityIds** | **List<String>** | The Severity IDs to attach to the retrospective configuration | [optional] |
+|**groupIds** | **List<String>** | The Team IDs to attach to the retrospective configuration | [optional] |
+|**incidentTypeIds** | **List<String>** | The Incident Type IDs to attach to the retrospective configuration | [optional] |
|**createdAt** | **String** | Date of creation | [optional] |
|**updatedAt** | **String** | Date of last update | [optional] |
diff --git a/docs/RetrospectiveProcessGroupList.md b/docs/RetrospectiveProcessGroupList.md
index 55a96542..e7daf364 100644
--- a/docs/RetrospectiveProcessGroupList.md
+++ b/docs/RetrospectiveProcessGroupList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<RetrospectiveProcessGroupResponseData>**](RetrospectiveProcessGroupResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/RetrospectiveProcessGroupStepList.md b/docs/RetrospectiveProcessGroupStepList.md
index a81f58b3..6566d824 100644
--- a/docs/RetrospectiveProcessGroupStepList.md
+++ b/docs/RetrospectiveProcessGroupStepList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<RetrospectiveProcessGroupStepResponseData>**](RetrospectiveProcessGroupStepResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/RetrospectiveProcessList.md b/docs/RetrospectiveProcessList.md
index 1b8392b9..041028c2 100644
--- a/docs/RetrospectiveProcessList.md
+++ b/docs/RetrospectiveProcessList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<RetrospectiveProcessListDataInner>**](RetrospectiveProcessListDataInner.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/RetrospectiveStepList.md b/docs/RetrospectiveStepList.md
index ad2fcf7b..550a8ed6 100644
--- a/docs/RetrospectiveStepList.md
+++ b/docs/RetrospectiveStepList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<RetrospectiveStepResponseData>**](RetrospectiveStepResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/RetrospectiveTemplatesApi.md b/docs/RetrospectiveTemplatesApi.md
index 45659773..ec5ac3bd 100644
--- a/docs/RetrospectiveTemplatesApi.md
+++ b/docs/RetrospectiveTemplatesApi.md
@@ -76,7 +76,7 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **201** | post_mortem_template created | - |
+| **201** | post_mortem_template created with TipTap blocks | - |
| **422** | invalid request | - |
| **401** | responds with unauthorized for invalid token | - |
@@ -108,7 +108,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
RetrospectiveTemplatesApi apiInstance = new RetrospectiveTemplatesApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
PostMortemTemplateResponse result = apiInstance.deletePostmortemTemplate(id);
System.out.println(result);
@@ -127,7 +127,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -176,7 +176,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
RetrospectiveTemplatesApi apiInstance = new RetrospectiveTemplatesApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
PostMortemTemplateResponse result = apiInstance.getPostmortemTemplate(id);
System.out.println(result);
@@ -195,7 +195,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -315,7 +315,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
RetrospectiveTemplatesApi apiInstance = new RetrospectiveTemplatesApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
UpdatePostMortemTemplate updatePostMortemTemplate = new UpdatePostMortemTemplate(); // UpdatePostMortemTemplate |
try {
PostMortemTemplateResponse result = apiInstance.updatePostmortemTemplate(id, updatePostMortemTemplate);
@@ -335,7 +335,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
| **updatePostMortemTemplate** | [**UpdatePostMortemTemplate**](UpdatePostMortemTemplate.md)| | |
### Return type
@@ -354,6 +354,6 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **200** | Retrospective Template updated | - |
+| **200** | Retrospective Template updated with sanitized content | - |
| **404** | resource not found | - |
diff --git a/docs/Role.md b/docs/Role.md
index 44d06c64..d8413178 100644
--- a/docs/Role.md
+++ b/docs/Role.md
@@ -8,7 +8,7 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**name** | **String** | The role name. | |
-|**slug** | **String** | The role slug. | |
+|**slug** | **String** | The role slug. | [optional] |
|**incidentPermissionSetId** | **String** | Associated incident permissions set. | [optional] |
|**isDeletable** | **Boolean** | Whether the role can be deleted. | [optional] |
|**isEditable** | **Boolean** | Whether the role can be edited. | [optional] |
@@ -38,6 +38,13 @@
|**statusPagesPermissions** | [**List<StatusPagesPermissionsEnum>**](#List<StatusPagesPermissionsEnum>) | | [optional] |
|**webhooksPermissions** | [**List<WebhooksPermissionsEnum>**](#List<WebhooksPermissionsEnum>) | | [optional] |
|**workflowsPermissions** | [**List<WorkflowsPermissionsEnum>**](#List<WorkflowsPermissionsEnum>) | | [optional] |
+|**catalogsPermissions** | [**List<CatalogsPermissionsEnum>**](#List<CatalogsPermissionsEnum>) | | [optional] |
+|**subStatusesPermissions** | [**List<SubStatusesPermissionsEnum>**](#List<SubStatusesPermissionsEnum>) | | [optional] |
+|**edgeConnectorPermissions** | [**List<EdgeConnectorPermissionsEnum>**](#List<EdgeConnectorPermissionsEnum>) | | [optional] |
+|**slasPermissions** | [**List<SlasPermissionsEnum>**](#List<SlasPermissionsEnum>) | | [optional] |
+|**pagingPermissions** | [**List<PagingPermissionsEnum>**](#List<PagingPermissionsEnum>) | | [optional] |
+|**incidentCommunicationPermissions** | [**List<IncidentCommunicationPermissionsEnum>**](#List<IncidentCommunicationPermissionsEnum>) | | [optional] |
+|**communicationPermissions** | [**List<CommunicationPermissionsEnum>**](#List<CommunicationPermissionsEnum>) | | [optional] |
|**createdAt** | **String** | | |
|**updatedAt** | **String** | | |
@@ -326,3 +333,81 @@
+## Enum: List<CatalogsPermissionsEnum>
+
+| Name | Value |
+|---- | -----|
+| CREATE | "create" |
+| READ | "read" |
+| UPDATE | "update" |
+| DELETE | "delete" |
+
+
+
+## Enum: List<SubStatusesPermissionsEnum>
+
+| Name | Value |
+|---- | -----|
+| CREATE | "create" |
+| READ | "read" |
+| UPDATE | "update" |
+| DELETE | "delete" |
+
+
+
+## Enum: List<EdgeConnectorPermissionsEnum>
+
+| Name | Value |
+|---- | -----|
+| CREATE | "create" |
+| READ | "read" |
+| UPDATE | "update" |
+| DELETE | "delete" |
+
+
+
+## Enum: List<SlasPermissionsEnum>
+
+| Name | Value |
+|---- | -----|
+| CREATE | "create" |
+| READ | "read" |
+| UPDATE | "update" |
+| DELETE | "delete" |
+
+
+
+## Enum: List<PagingPermissionsEnum>
+
+| Name | Value |
+|---- | -----|
+| CREATE | "create" |
+| READ | "read" |
+| UPDATE | "update" |
+| DELETE | "delete" |
+
+
+
+## Enum: List<IncidentCommunicationPermissionsEnum>
+
+| Name | Value |
+|---- | -----|
+| CREATE | "create" |
+| READ | "read" |
+| UPDATE | "update" |
+| DELETE | "delete" |
+| SEND | "send" |
+
+
+
+## Enum: List<CommunicationPermissionsEnum>
+
+| Name | Value |
+|---- | -----|
+| CREATE | "create" |
+| READ | "read" |
+| UPDATE | "update" |
+| DELETE | "delete" |
+
+
+
diff --git a/docs/RoleList.md b/docs/RoleList.md
index df102690..81ae58c2 100644
--- a/docs/RoleList.md
+++ b/docs/RoleList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<RoleResponseData>**](RoleResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/RolesApi.md b/docs/RolesApi.md
index 9bcdd0de..f865d60f 100644
--- a/docs/RolesApi.md
+++ b/docs/RolesApi.md
@@ -108,7 +108,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
RolesApi apiInstance = new RolesApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
RoleResponse result = apiInstance.deleteRole(id);
System.out.println(result);
@@ -127,7 +127,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -176,7 +176,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
RolesApi apiInstance = new RolesApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
RoleResponse result = apiInstance.getRole(id);
System.out.println(result);
@@ -195,7 +195,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -331,7 +331,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
RolesApi apiInstance = new RolesApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
UpdateRole updateRole = new UpdateRole(); // UpdateRole |
try {
RoleResponse result = apiInstance.updateRole(id, updateRole);
@@ -351,7 +351,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
| **updateRole** | [**UpdateRole**](UpdateRole.md)| | |
### Return type
diff --git a/docs/RotateApiKey.md b/docs/RotateApiKey.md
new file mode 100644
index 00000000..5b547d69
--- /dev/null
+++ b/docs/RotateApiKey.md
@@ -0,0 +1,13 @@
+
+
+# RotateApiKey
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**RotateApiKeyData**](RotateApiKeyData.md) | | |
+
+
+
diff --git a/docs/RotateApiKeyData.md b/docs/RotateApiKeyData.md
new file mode 100644
index 00000000..815f5808
--- /dev/null
+++ b/docs/RotateApiKeyData.md
@@ -0,0 +1,22 @@
+
+
+# RotateApiKeyData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**RotateApiKeyDataAttributes**](RotateApiKeyDataAttributes.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| API_KEYS | "api_keys" |
+
+
+
diff --git a/docs/RotateApiKeyDataAttributes.md b/docs/RotateApiKeyDataAttributes.md
new file mode 100644
index 00000000..8f5787f2
--- /dev/null
+++ b/docs/RotateApiKeyDataAttributes.md
@@ -0,0 +1,14 @@
+
+
+# RotateApiKeyDataAttributes
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**expiresAt** | **OffsetDateTime** | The new expiration date after rotation (ISO 8601) | [optional] |
+|**gracePeriodMinutes** | **Integer** | How many minutes to keep the old token valid. Only applies when the grace period feature is enabled for your organization. Defaults to 30. | [optional] |
+
+
+
diff --git a/docs/Schedule.md b/docs/Schedule.md
index 0f4be9b3..b407e553 100644
--- a/docs/Schedule.md
+++ b/docs/Schedule.md
@@ -11,8 +11,11 @@
|**description** | **String** | The description of the schedule | [optional] |
|**allTimeCoverage** | **Boolean** | 24/7 coverage of the schedule | [optional] |
|**slackUserGroup** | [**ScheduleSlackUserGroup**](ScheduleSlackUserGroup.md) | | [optional] |
+|**slackChannel** | [**ScheduleSlackChannel**](ScheduleSlackChannel.md) | | [optional] |
|**ownerGroupIds** | **List<String>** | Owning teams. | [optional] |
-|**ownerUserId** | **Integer** | ID of user assigned as owner of the schedule | [optional] |
+|**ownerUserId** | **Integer** | ID of user assigned as owner of the schedule | |
+|**shiftStartNotificationsEnabled** | **Boolean** | Whether shift-start notifications are enabled | [optional] |
+|**shiftUpdateNotificationsEnabled** | **Boolean** | Whether shift-update notifications are enabled | [optional] |
|**createdAt** | **String** | Date of creation | |
|**updatedAt** | **String** | Date of last update | |
diff --git a/docs/ScheduleList.md b/docs/ScheduleList.md
index 4aad9c7b..b4b029f5 100644
--- a/docs/ScheduleList.md
+++ b/docs/ScheduleList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<ScheduleListDataInner>**](ScheduleListDataInner.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/ScheduleRotation.md b/docs/ScheduleRotation.md
index a5f7c3ed..92788832 100644
--- a/docs/ScheduleRotation.md
+++ b/docs/ScheduleRotation.md
@@ -17,6 +17,8 @@
|**activeTimeAttributes** | [**List<NewScheduleRotationDataAttributesActiveTimeAttributesInner>**](NewScheduleRotationDataAttributesActiveTimeAttributesInner.md) | Schedule rotation's active times | [optional] |
|**timeZone** | **String** | A valid IANA time zone name. | [optional] |
|**scheduleRotationableAttributes** | [**NewScheduleRotationDataAttributesScheduleRotationableAttributes**](NewScheduleRotationDataAttributesScheduleRotationableAttributes.md) | | |
+|**startTime** | **OffsetDateTime** | RFC3339 date-time when rotation starts. Shifts will only be created after this time. | [optional] |
+|**endTime** | **OffsetDateTime** | RFC3339 date-time when rotation ends. Shifts will only be created before this time. | [optional] |
diff --git a/docs/ScheduleRotationActiveDayList.md b/docs/ScheduleRotationActiveDayList.md
index 8215a0d0..dd687c54 100644
--- a/docs/ScheduleRotationActiveDayList.md
+++ b/docs/ScheduleRotationActiveDayList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<ScheduleRotationActiveDayListDataInner>**](ScheduleRotationActiveDayListDataInner.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/ScheduleRotationList.md b/docs/ScheduleRotationList.md
index e4bc2813..0d64ae1c 100644
--- a/docs/ScheduleRotationList.md
+++ b/docs/ScheduleRotationList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<ScheduleRotationResponseData>**](ScheduleRotationResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/ScheduleRotationUserList.md b/docs/ScheduleRotationUserList.md
index 822ae27f..02226d0c 100644
--- a/docs/ScheduleRotationUserList.md
+++ b/docs/ScheduleRotationUserList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<ScheduleRotationUserListDataInner>**](ScheduleRotationUserListDataInner.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/ScheduleSlackChannel.md b/docs/ScheduleSlackChannel.md
new file mode 100644
index 00000000..b7661c89
--- /dev/null
+++ b/docs/ScheduleSlackChannel.md
@@ -0,0 +1,15 @@
+
+
+# ScheduleSlackChannel
+
+Synced slack channel of the schedule
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | Slack channel ID | [optional] |
+|**name** | **String** | Slack channel name | [optional] |
+
+
+
diff --git a/docs/ScheduleSlackUserGroup.md b/docs/ScheduleSlackUserGroup.md
index 925a801d..7c0ad0e2 100644
--- a/docs/ScheduleSlackUserGroup.md
+++ b/docs/ScheduleSlackUserGroup.md
@@ -8,8 +8,8 @@ Synced slack group of the schedule
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
-|**id** | **String** | Slack channel ID | [optional] |
-|**name** | **String** | Slack channel name | [optional] |
+|**id** | **String** | Slack user group ID | [optional] |
+|**name** | **String** | Slack user group name | [optional] |
diff --git a/docs/SecretList.md b/docs/SecretList.md
index 66f232e1..e5bf2703 100644
--- a/docs/SecretList.md
+++ b/docs/SecretList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<SecretResponseData>**](SecretResponseData.md) | | |
|**links** | [**Links**](Links.md) | | [optional] |
+|**meta** | [**Meta**](Meta.md) | | [optional] |
diff --git a/docs/SendMicrosoftTeamsChatMessageTaskParams.md b/docs/SendMicrosoftTeamsChatMessageTaskParams.md
new file mode 100644
index 00000000..4060fcf6
--- /dev/null
+++ b/docs/SendMicrosoftTeamsChatMessageTaskParams.md
@@ -0,0 +1,23 @@
+
+
+# SendMicrosoftTeamsChatMessageTaskParams
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**taskType** | [**TaskTypeEnum**](#TaskTypeEnum) | | [optional] |
+|**chats** | [**List<AddActionItemTaskParamsPostToSlackChannelsInner>**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | |
+|**text** | **String** | The message text | |
+
+
+
+## Enum: TaskTypeEnum
+
+| Name | Value |
+|---- | -----|
+| SEND_MICROSOFT_TEAMS_CHAT_MESSAGE | "send_microsoft_teams_chat_message" |
+
+
+
diff --git a/docs/Service.md b/docs/Service.md
index dcb219e1..4ca330b3 100644
--- a/docs/Service.md
+++ b/docs/Service.md
@@ -24,15 +24,22 @@
|**githubRepositoryBranch** | **String** | The GitHub repository branch associated to this service. eg: main | [optional] |
|**gitlabRepositoryName** | **String** | The GitLab repository name associated to this service. eg: rootlyhq/my-service | [optional] |
|**gitlabRepositoryBranch** | **String** | The GitLab repository branch associated to this service. eg: main | [optional] |
+|**kubernetesDeploymentName** | **String** | The Kubernetes deployment name associated to this service. eg: namespace/deployment-name | [optional] |
|**environmentIds** | **List<String>** | Environments associated with this service | [optional] |
|**serviceIds** | **List<String>** | Services dependent on this service | [optional] |
-|**ownersGroupIds** | **List<String>** | Owner Teams associated with this service | [optional] |
-|**ownersUserIds** | **List<Integer>** | Owner Users associated with this service | [optional] |
+|**ownerGroupIds** | **List<String>** | Owner Teams associated with this service | [optional] |
+|**ownerUserIds** | **List<Integer>** | Owner Users associated with this service | [optional] |
|**alertUrgencyId** | **String** | The alert urgency id of the service | [optional] |
+|**escalationPolicyId** | **String** | The escalation policy id of the service | [optional] |
|**alertsEmailEnabled** | **Boolean** | Enable alerts through email | [optional] |
|**alertsEmailAddress** | **String** | Email generated to send alerts to | [optional] |
|**slackChannels** | [**List<NewEnvironmentDataAttributesSlackChannelsInner>**](NewEnvironmentDataAttributesSlackChannelsInner.md) | Slack Channels associated with this service | [optional] |
|**slackAliases** | [**List<NewEnvironmentDataAttributesSlackAliasesInner>**](NewEnvironmentDataAttributesSlackAliasesInner.md) | Slack Aliases associated with this service | [optional] |
+|**alertBroadcastEnabled** | **Boolean** | Enable alerts to be broadcasted to a specific channel | [optional] |
+|**alertBroadcastChannel** | [**ServiceAlertBroadcastChannel**](ServiceAlertBroadcastChannel.md) | | [optional] |
+|**incidentBroadcastEnabled** | **Boolean** | Enable incidents to be broadcasted to a specific channel | [optional] |
+|**incidentBroadcastChannel** | [**ServiceIncidentBroadcastChannel**](ServiceIncidentBroadcastChannel.md) | | [optional] |
+|**properties** | [**List<NewCauseDataAttributesPropertiesInner>**](NewCauseDataAttributesPropertiesInner.md) | Array of property values for this service. | [optional] |
|**createdAt** | **String** | Date of creation | |
|**updatedAt** | **String** | Date of last update | |
diff --git a/docs/ServiceAlertBroadcastChannel.md b/docs/ServiceAlertBroadcastChannel.md
new file mode 100644
index 00000000..d2b191f2
--- /dev/null
+++ b/docs/ServiceAlertBroadcastChannel.md
@@ -0,0 +1,15 @@
+
+
+# ServiceAlertBroadcastChannel
+
+Slack channel to broadcast alerts to
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | Slack channel ID | [optional] |
+|**name** | **String** | Slack channel name | [optional] |
+
+
+
diff --git a/docs/ServiceIncidentBroadcastChannel.md b/docs/ServiceIncidentBroadcastChannel.md
new file mode 100644
index 00000000..acc70c81
--- /dev/null
+++ b/docs/ServiceIncidentBroadcastChannel.md
@@ -0,0 +1,15 @@
+
+
+# ServiceIncidentBroadcastChannel
+
+Slack channel to broadcast incidents to
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | Slack channel ID | [optional] |
+|**name** | **String** | Slack channel name | [optional] |
+
+
+
diff --git a/docs/ServiceList.md b/docs/ServiceList.md
index 6f740888..cdc9ada4 100644
--- a/docs/ServiceList.md
+++ b/docs/ServiceList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<ServiceResponseData>**](ServiceResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/ServicesApi.md b/docs/ServicesApi.md
index 8c7ea8eb..7355784a 100644
--- a/docs/ServicesApi.md
+++ b/docs/ServicesApi.md
@@ -5,10 +5,12 @@ All URIs are relative to *https://api.rootly.com*
| Method | HTTP request | Description |
|------------- | ------------- | -------------|
| [**createService**](ServicesApi.md#createService) | **POST** /v1/services | Creates a service |
+| [**createServiceCatalogProperty**](ServicesApi.md#createServiceCatalogProperty) | **POST** /v1/services/properties | Creates a Catalog Property |
| [**deleteService**](ServicesApi.md#deleteService) | **DELETE** /v1/services/{id} | Delete a service |
| [**getService**](ServicesApi.md#getService) | **GET** /v1/services/{id} | Retrieves a service |
| [**getServiceIncidentsChart**](ServicesApi.md#getServiceIncidentsChart) | **GET** /v1/services/{id}/incidents_chart | Get service incidents chart |
| [**getServiceUptimeChart**](ServicesApi.md#getServiceUptimeChart) | **GET** /v1/services/{id}/uptime_chart | Get service uptime chart |
+| [**listServiceCatalogProperties**](ServicesApi.md#listServiceCatalogProperties) | **GET** /v1/services/properties | List Catalog Properties |
| [**listServices**](ServicesApi.md#listServices) | **GET** /v1/services | List services |
| [**updateService**](ServicesApi.md#updateService) | **PUT** /v1/services/{id} | Update a service |
@@ -82,6 +84,75 @@ public class Example {
| **422** | invalid request | - |
| **401** | responds with unauthorized for invalid token | - |
+
+# **createServiceCatalogProperty**
+> CatalogPropertyResponse createServiceCatalogProperty(newCatalogProperty)
+
+Creates a Catalog Property
+
+Creates a new Catalog Property from provided data
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.ServicesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ ServicesApi apiInstance = new ServicesApi(defaultClient);
+ NewCatalogProperty newCatalogProperty = new NewCatalogProperty(); // NewCatalogProperty |
+ try {
+ CatalogPropertyResponse result = apiInstance.createServiceCatalogProperty(newCatalogProperty);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling ServicesApi#createServiceCatalogProperty");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **newCatalogProperty** | [**NewCatalogProperty**](NewCatalogProperty.md)| | |
+
+### Return type
+
+[**CatalogPropertyResponse**](CatalogPropertyResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/vnd.api+json
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | catalog_property created ignores wrong catalog_type attribute | - |
+| **422** | exceeds max fields per catalog | - |
+| **401** | responds with unauthorized for invalid token | - |
+
# **deleteService**
> ServiceResponse deleteService(id)
@@ -110,7 +181,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
ServicesApi apiInstance = new ServicesApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
ServiceResponse result = apiInstance.deleteService(id);
System.out.println(result);
@@ -129,7 +200,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -178,7 +249,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
ServicesApi apiInstance = new ServicesApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
ServiceResponse result = apiInstance.getService(id);
System.out.println(result);
@@ -197,7 +268,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -215,7 +286,7 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **200** | service found | - |
+| **200** | service found by slug | - |
| **404** | resource not found | - |
@@ -246,7 +317,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
ServicesApi apiInstance = new ServicesApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
String period = "period_example"; // String |
try {
Object result = apiInstance.getServiceIncidentsChart(id, period);
@@ -266,7 +337,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
| **period** | **String**| | |
### Return type
@@ -316,7 +387,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
ServicesApi apiInstance = new ServicesApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
String period = "period_example"; // String |
try {
Object result = apiInstance.getServiceUptimeChart(id, period);
@@ -336,7 +407,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
| **period** | **String**| | [optional] |
### Return type
@@ -358,9 +429,96 @@ public class Example {
| **200** | success | - |
| **404** | resource not found | - |
+
+# **listServiceCatalogProperties**
+> CatalogPropertyList listServiceCatalogProperties(include, sort, pageNumber, pageSize, filterSlug, filterName, filterKind, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte)
+
+List Catalog Properties
+
+List Service Catalog Properties
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.ServicesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ ServicesApi apiInstance = new ServicesApi(defaultClient);
+ String include = "catalog"; // String | comma separated if needed. eg: catalog
+ String sort = "created_at"; // String | comma separated if needed. eg: created_at,updated_at
+ Integer pageNumber = 56; // Integer |
+ Integer pageSize = 56; // Integer |
+ String filterSlug = "filterSlug_example"; // String |
+ String filterName = "filterName_example"; // String |
+ String filterKind = "filterKind_example"; // String |
+ String filterCreatedAtGt = "filterCreatedAtGt_example"; // String |
+ String filterCreatedAtGte = "filterCreatedAtGte_example"; // String |
+ String filterCreatedAtLt = "filterCreatedAtLt_example"; // String |
+ String filterCreatedAtLte = "filterCreatedAtLte_example"; // String |
+ try {
+ CatalogPropertyList result = apiInstance.listServiceCatalogProperties(include, sort, pageNumber, pageSize, filterSlug, filterName, filterKind, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling ServicesApi#listServiceCatalogProperties");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **include** | **String**| comma separated if needed. eg: catalog | [optional] [enum: catalog] |
+| **sort** | **String**| comma separated if needed. eg: created_at,updated_at | [optional] [enum: created_at, -created_at, updated_at, -updated_at, position, -position] |
+| **pageNumber** | **Integer**| | [optional] |
+| **pageSize** | **Integer**| | [optional] |
+| **filterSlug** | **String**| | [optional] |
+| **filterName** | **String**| | [optional] |
+| **filterKind** | **String**| | [optional] |
+| **filterCreatedAtGt** | **String**| | [optional] |
+| **filterCreatedAtGte** | **String**| | [optional] |
+| **filterCreatedAtLt** | **String**| | [optional] |
+| **filterCreatedAtLte** | **String**| | [optional] |
+
+### Return type
+
+[**CatalogPropertyList**](CatalogPropertyList.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | success | - |
+
# **listServices**
-> ServiceList listServices(include, pageNumber, pageSize, filterSearch, filterName, filterSlug, filterBackstageId, filterCortexId, filterOpslevelId, filterExternalId, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, sort)
+> ServiceList listServices(include, pageNumber, pageSize, filterSearch, filterName, filterSlug, filterBackstageId, filterCortexId, filterOpslevelId, filterExternalId, filterAlertBroadcastEnabled, filterIncidentBroadcastEnabled, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, sort)
List services
@@ -396,13 +554,15 @@ public class Example {
String filterCortexId = "filterCortexId_example"; // String |
String filterOpslevelId = "filterOpslevelId_example"; // String |
String filterExternalId = "filterExternalId_example"; // String |
+ Boolean filterAlertBroadcastEnabled = true; // Boolean |
+ Boolean filterIncidentBroadcastEnabled = true; // Boolean |
String filterCreatedAtGt = "filterCreatedAtGt_example"; // String |
String filterCreatedAtGte = "filterCreatedAtGte_example"; // String |
String filterCreatedAtLt = "filterCreatedAtLt_example"; // String |
String filterCreatedAtLte = "filterCreatedAtLte_example"; // String |
String sort = "sort_example"; // String |
try {
- ServiceList result = apiInstance.listServices(include, pageNumber, pageSize, filterSearch, filterName, filterSlug, filterBackstageId, filterCortexId, filterOpslevelId, filterExternalId, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, sort);
+ ServiceList result = apiInstance.listServices(include, pageNumber, pageSize, filterSearch, filterName, filterSlug, filterBackstageId, filterCortexId, filterOpslevelId, filterExternalId, filterAlertBroadcastEnabled, filterIncidentBroadcastEnabled, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, sort);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ServicesApi#listServices");
@@ -429,6 +589,8 @@ public class Example {
| **filterCortexId** | **String**| | [optional] |
| **filterOpslevelId** | **String**| | [optional] |
| **filterExternalId** | **String**| | [optional] |
+| **filterAlertBroadcastEnabled** | **Boolean**| | [optional] |
+| **filterIncidentBroadcastEnabled** | **Boolean**| | [optional] |
| **filterCreatedAtGt** | **String**| | [optional] |
| **filterCreatedAtGte** | **String**| | [optional] |
| **filterCreatedAtLt** | **String**| | [optional] |
@@ -481,7 +643,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
ServicesApi apiInstance = new ServicesApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
UpdateService updateService = new UpdateService(); // UpdateService |
try {
ServiceResponse result = apiInstance.updateService(id, updateService);
@@ -501,7 +663,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
| **updateService** | [**UpdateService**](UpdateService.md)| | |
### Return type
diff --git a/docs/SeveritiesApi.md b/docs/SeveritiesApi.md
index 90c2a981..b9f9b51c 100644
--- a/docs/SeveritiesApi.md
+++ b/docs/SeveritiesApi.md
@@ -108,7 +108,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
SeveritiesApi apiInstance = new SeveritiesApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
SeverityResponse result = apiInstance.deleteSeverity(id);
System.out.println(result);
@@ -127,7 +127,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -176,7 +176,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
SeveritiesApi apiInstance = new SeveritiesApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
SeverityResponse result = apiInstance.getSeverity(id);
System.out.println(result);
@@ -195,7 +195,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -335,7 +335,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
SeveritiesApi apiInstance = new SeveritiesApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
UpdateSeverity updateSeverity = new UpdateSeverity(); // UpdateSeverity |
try {
SeverityResponse result = apiInstance.updateSeverity(id, updateSeverity);
@@ -355,7 +355,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
| **updateSeverity** | [**UpdateSeverity**](UpdateSeverity.md)| | |
### Return type
diff --git a/docs/SeverityList.md b/docs/SeverityList.md
index 6d8895c6..8b222e5e 100644
--- a/docs/SeverityList.md
+++ b/docs/SeverityList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<SeverityResponseData>**](SeverityResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/Shift.md b/docs/Shift.md
index 11e88f5d..64101c05 100644
--- a/docs/Shift.md
+++ b/docs/Shift.md
@@ -12,8 +12,8 @@
|**startsAt** | **String** | Start datetime of shift | |
|**endsAt** | **String** | End datetime of shift | |
|**isOverride** | **Boolean** | Denotes shift is an override shift | |
-|**shiftOverride** | [**ShiftOverrideResponse**](ShiftOverrideResponse.md) | Override metadata | [optional] |
-|**user** | [**UserResponse**](UserResponse.md) | User metadata | [optional] |
+|**isShadow** | **Boolean** | Denotes shift is a shadow shift | |
+|**userId** | **Integer** | ID of user on shift | [optional] |
diff --git a/docs/ShiftList.md b/docs/ShiftList.md
index 7da89339..8347a73a 100644
--- a/docs/ShiftList.md
+++ b/docs/ShiftList.md
@@ -8,6 +8,7 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<ShiftListDataInner>**](ShiftListDataInner.md) | | |
+|**meta** | [**Meta**](Meta.md) | | [optional] |
diff --git a/docs/ShiftListDataInner.md b/docs/ShiftListDataInner.md
index 8305cc22..12e121a8 100644
--- a/docs/ShiftListDataInner.md
+++ b/docs/ShiftListDataInner.md
@@ -10,6 +10,7 @@
|**id** | **String** | Unique ID of the shift | |
|**type** | [**TypeEnum**](#TypeEnum) | | |
|**attributes** | [**Shift**](Shift.md) | | |
+|**relationships** | [**ShiftRelationships**](ShiftRelationships.md) | | [optional] |
diff --git a/docs/ShiftRelationships.md b/docs/ShiftRelationships.md
new file mode 100644
index 00000000..a79ae2ef
--- /dev/null
+++ b/docs/ShiftRelationships.md
@@ -0,0 +1,15 @@
+
+
+# ShiftRelationships
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**shiftOverride** | [**ShiftRelationshipsShiftOverride**](ShiftRelationshipsShiftOverride.md) | | [optional] |
+|**user** | [**ShiftRelationshipsUser**](ShiftRelationshipsUser.md) | | [optional] |
+|**assignee** | [**ShiftRelationshipsAssignee**](ShiftRelationshipsAssignee.md) | | [optional] |
+
+
+
diff --git a/docs/ShiftRelationshipsAssignee.md b/docs/ShiftRelationshipsAssignee.md
new file mode 100644
index 00000000..3797f365
--- /dev/null
+++ b/docs/ShiftRelationshipsAssignee.md
@@ -0,0 +1,14 @@
+
+
+# ShiftRelationshipsAssignee
+
+Assignee can be either a User or Schedule
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**ShiftRelationshipsAssigneeData**](ShiftRelationshipsAssigneeData.md) | | [optional] |
+
+
+
diff --git a/docs/ShiftRelationshipsAssigneeData.md b/docs/ShiftRelationshipsAssigneeData.md
new file mode 100644
index 00000000..4ace9289
--- /dev/null
+++ b/docs/ShiftRelationshipsAssigneeData.md
@@ -0,0 +1,14 @@
+
+
+# ShiftRelationshipsAssigneeData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | | [optional] |
+|**type** | **String** | | [optional] |
+
+
+
diff --git a/docs/ShiftRelationshipsShiftOverride.md b/docs/ShiftRelationshipsShiftOverride.md
new file mode 100644
index 00000000..6b45ad2a
--- /dev/null
+++ b/docs/ShiftRelationshipsShiftOverride.md
@@ -0,0 +1,13 @@
+
+
+# ShiftRelationshipsShiftOverride
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**ShiftRelationshipsShiftOverrideData**](ShiftRelationshipsShiftOverrideData.md) | | [optional] |
+
+
+
diff --git a/docs/ShiftRelationshipsShiftOverrideData.md b/docs/ShiftRelationshipsShiftOverrideData.md
new file mode 100644
index 00000000..2b0f27b0
--- /dev/null
+++ b/docs/ShiftRelationshipsShiftOverrideData.md
@@ -0,0 +1,22 @@
+
+
+# ShiftRelationshipsShiftOverrideData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | | [optional] |
+|**type** | [**TypeEnum**](#TypeEnum) | | [optional] |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| SHIFT_OVERRIDES | "shift_overrides" |
+
+
+
diff --git a/docs/ShiftRelationshipsUser.md b/docs/ShiftRelationshipsUser.md
new file mode 100644
index 00000000..96947a4e
--- /dev/null
+++ b/docs/ShiftRelationshipsUser.md
@@ -0,0 +1,13 @@
+
+
+# ShiftRelationshipsUser
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**ShiftRelationshipsUserData**](ShiftRelationshipsUserData.md) | | [optional] |
+
+
+
diff --git a/docs/ShiftRelationshipsUserData.md b/docs/ShiftRelationshipsUserData.md
new file mode 100644
index 00000000..3fc9497b
--- /dev/null
+++ b/docs/ShiftRelationshipsUserData.md
@@ -0,0 +1,22 @@
+
+
+# ShiftRelationshipsUserData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | | [optional] |
+|**type** | [**TypeEnum**](#TypeEnum) | | [optional] |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| USERS | "users" |
+
+
+
diff --git a/docs/ShiftsApi.md b/docs/ShiftsApi.md
index 5a301099..9ccd734a 100644
--- a/docs/ShiftsApi.md
+++ b/docs/ShiftsApi.md
@@ -82,7 +82,7 @@ public class Example {
# **listShifts**
-> ShiftList listShifts(include, to, from, userIds, scheduleIds)
+> ShiftList listShifts(include, from, to, userIds, scheduleIds, pageNumber, pageSize)
List shifts
@@ -108,13 +108,15 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
ShiftsApi apiInstance = new ShiftsApi(defaultClient);
- String include = "shift_override"; // String | comma separated if needed. eg: shift_override,user
- String to = "to_example"; // String | Start range for shifts
- String from = "from_example"; // String | End range for shifts
+ String include = "shift_override"; // String | comma separated if needed. eg: shift_override,user. Note: `user` is deprecated, use `assignee` instead.
+ String from = "from_example"; // String | Start range for shifts in ISO-8601 format (e.g., 2025-01-01T00:00:00Z or 2025-01-01T00:00:00+00:00)
+ String to = "to_example"; // String | End range for shifts in ISO-8601 format (e.g., 2025-01-01T00:00:00Z or 2025-01-01T00:00:00+00:00)
List userIds = Arrays.asList(); // List |
List scheduleIds = Arrays.asList(); // List |
+ Integer pageNumber = 56; // Integer | Page number (defaults to 1)
+ Integer pageSize = 56; // Integer | Number of shifts per page (defaults to 50, max 1000)
try {
- ShiftList result = apiInstance.listShifts(include, to, from, userIds, scheduleIds);
+ ShiftList result = apiInstance.listShifts(include, from, to, userIds, scheduleIds, pageNumber, pageSize);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ShiftsApi#listShifts");
@@ -131,11 +133,13 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **include** | **String**| comma separated if needed. eg: shift_override,user | [optional] [enum: shift_override, user] |
-| **to** | **String**| Start range for shifts | [optional] |
-| **from** | **String**| End range for shifts | [optional] |
+| **include** | **String**| comma separated if needed. eg: shift_override,user. Note: `user` is deprecated, use `assignee` instead. | [optional] [enum: shift_override, user, assignee, shift_shadow] |
+| **from** | **String**| Start range for shifts in ISO-8601 format (e.g., 2025-01-01T00:00:00Z or 2025-01-01T00:00:00+00:00) | [optional] |
+| **to** | **String**| End range for shifts in ISO-8601 format (e.g., 2025-01-01T00:00:00Z or 2025-01-01T00:00:00+00:00) | [optional] |
| **userIds** | [**List<Integer>**](Integer.md)| | [optional] |
| **scheduleIds** | [**List<String>**](String.md)| | [optional] |
+| **pageNumber** | **Integer**| Page number (defaults to 1) | [optional] |
+| **pageSize** | **Integer**| Number of shifts per page (defaults to 50, max 1000) | [optional] |
### Return type
diff --git a/docs/Sla.md b/docs/Sla.md
new file mode 100644
index 00000000..6091ea77
--- /dev/null
+++ b/docs/Sla.md
@@ -0,0 +1,49 @@
+
+
+# Sla
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**slug** | **String** | The slug of the SLA | [optional] |
+|**name** | **String** | The name of the SLA | |
+|**description** | **String** | A description of the SLA | [optional] |
+|**position** | **Integer** | Position of the SLA for ordering | [optional] |
+|**entityType** | [**EntityTypeEnum**](#EntityTypeEnum) | The entity type this SLA applies to | [optional] |
+|**conditionMatchType** | [**ConditionMatchTypeEnum**](#ConditionMatchTypeEnum) | Whether all or any conditions must match | |
+|**managerRoleId** | **UUID** | The ID of the manager incident role. Exactly one of `manager_role_id` or `manager_user_id` must be provided. | [optional] |
+|**managerUserId** | **Integer** | The ID of the manager user. Exactly one of `manager_role_id` or `manager_user_id` must be provided. | [optional] |
+|**assignmentDeadlineDays** | **Integer** | Number of days for the assignment deadline | |
+|**assignmentDeadlineParentStatus** | **String** | The incident parent status that triggers the assignment deadline | |
+|**assignmentDeadlineSubStatusId** | **UUID** | Sub-status for the assignment deadline. Required when custom lifecycle statuses are enabled on the team. | [optional] |
+|**assignmentSkipWeekends** | **Boolean** | Whether to skip weekends when calculating the assignment deadline | [optional] |
+|**completionDeadlineDays** | **Integer** | Number of days for the completion deadline | |
+|**completionDeadlineParentStatus** | **String** | The incident parent status that triggers the completion deadline | |
+|**completionDeadlineSubStatusId** | **UUID** | Sub-status for the completion deadline. Required when custom lifecycle statuses are enabled on the team. | [optional] |
+|**completionSkipWeekends** | **Boolean** | Whether to skip weekends when calculating the completion deadline | [optional] |
+|**conditions** | [**List<SlaConditionsInner>**](SlaConditionsInner.md) | Conditions that determine which incidents this SLA applies to | [optional] |
+|**notificationConfigurations** | [**List<SlaNotificationConfigurationsInner>**](SlaNotificationConfigurationsInner.md) | Notification timing configurations | [optional] |
+|**createdAt** | **String** | Date of creation | |
+|**updatedAt** | **String** | Date of last update | |
+
+
+
+## Enum: EntityTypeEnum
+
+| Name | Value |
+|---- | -----|
+| FOLLOW_UP | "follow_up" |
+
+
+
+## Enum: ConditionMatchTypeEnum
+
+| Name | Value |
+|---- | -----|
+| ALL | "ALL" |
+| ANY | "ANY" |
+
+
+
diff --git a/docs/SlaConditionsInner.md b/docs/SlaConditionsInner.md
new file mode 100644
index 00000000..a5d0b5bc
--- /dev/null
+++ b/docs/SlaConditionsInner.md
@@ -0,0 +1,28 @@
+
+
+# SlaConditionsInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | Unique ID of the condition | [optional] |
+|**position** | **Integer** | The position of the condition | [optional] |
+|**conditionableType** | [**ConditionableTypeEnum**](#ConditionableTypeEnum) | The type of condition | [optional] |
+|**property** | **String** | The property to evaluate (for built-in field conditions) | [optional] |
+|**operator** | **String** | The comparison operator | [optional] |
+|**values** | **List<String>** | The values to compare against | [optional] |
+|**formFieldId** | **UUID** | The ID of the form field (for custom field conditions) | [optional] |
+
+
+
+## Enum: ConditionableTypeEnum
+
+| Name | Value |
+|---- | -----|
+| SLAS_BUILT_IN_FIELD_CONDITION | "SLAs::BuiltInFieldCondition" |
+| SLAS_CUSTOM_FIELD_CONDITION | "SLAs::CustomFieldCondition" |
+
+
+
diff --git a/docs/SlaList.md b/docs/SlaList.md
new file mode 100644
index 00000000..79c37c5b
--- /dev/null
+++ b/docs/SlaList.md
@@ -0,0 +1,15 @@
+
+
+# SlaList
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<SlaResponseData>**](SlaResponseData.md) | | |
+|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
+
+
+
diff --git a/docs/SlaNotificationConfigurationsInner.md b/docs/SlaNotificationConfigurationsInner.md
new file mode 100644
index 00000000..bef53213
--- /dev/null
+++ b/docs/SlaNotificationConfigurationsInner.md
@@ -0,0 +1,27 @@
+
+
+# SlaNotificationConfigurationsInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **UUID** | Unique ID of the notification configuration | [optional] |
+|**offsetType** | [**OffsetTypeEnum**](#OffsetTypeEnum) | When to send the notification relative to the deadline | [optional] |
+|**offsetDays** | **Integer** | Number of days offset from the deadline | [optional] |
+|**createdAt** | **String** | Date of creation | [optional] |
+|**updatedAt** | **String** | Date of last update | [optional] |
+
+
+
+## Enum: OffsetTypeEnum
+
+| Name | Value |
+|---- | -----|
+| BEFORE_DUE | "before_due" |
+| WHEN_DUE | "when_due" |
+| AFTER_DUE | "after_due" |
+
+
+
diff --git a/docs/SlaResponse.md b/docs/SlaResponse.md
new file mode 100644
index 00000000..995317e5
--- /dev/null
+++ b/docs/SlaResponse.md
@@ -0,0 +1,13 @@
+
+
+# SlaResponse
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**SlaResponseData**](SlaResponseData.md) | | |
+
+
+
diff --git a/docs/SlaResponseData.md b/docs/SlaResponseData.md
new file mode 100644
index 00000000..c1c394b7
--- /dev/null
+++ b/docs/SlaResponseData.md
@@ -0,0 +1,23 @@
+
+
+# SlaResponseData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | Unique ID of the SLA | |
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**Sla**](Sla.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| SLAS | "slas" |
+
+
+
diff --git a/docs/SlasApi.md b/docs/SlasApi.md
new file mode 100644
index 00000000..f99a879e
--- /dev/null
+++ b/docs/SlasApi.md
@@ -0,0 +1,373 @@
+# SlasApi
+
+All URIs are relative to *https://api.rootly.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createSLA**](SlasApi.md#createSLA) | **POST** /v1/slas | Creates an SLA |
+| [**deleteSLA**](SlasApi.md#deleteSLA) | **DELETE** /v1/slas/{id} | Delete an SLA |
+| [**getSLA**](SlasApi.md#getSLA) | **GET** /v1/slas/{id} | Retrieves an SLA |
+| [**listSLAs**](SlasApi.md#listSLAs) | **GET** /v1/slas | List SLAs |
+| [**updateSLA**](SlasApi.md#updateSLA) | **PUT** /v1/slas/{id} | Update an SLA |
+
+
+
+# **createSLA**
+> SlaResponse createSLA(newSla)
+
+Creates an SLA
+
+Creates a new SLA from provided data
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.SlasApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ SlasApi apiInstance = new SlasApi(defaultClient);
+ NewSla newSla = new NewSla(); // NewSla |
+ try {
+ SlaResponse result = apiInstance.createSLA(newSla);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling SlasApi#createSLA");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **newSla** | [**NewSla**](NewSla.md)| | |
+
+### Return type
+
+[**SlaResponse**](SlaResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/vnd.api+json
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | SLA created | - |
+| **422** | invalid request | - |
+| **401** | responds with unauthorized for invalid token | - |
+
+
+# **deleteSLA**
+> SlaResponse deleteSLA(id)
+
+Delete an SLA
+
+Delete a specific SLA by id
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.SlasApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ SlasApi apiInstance = new SlasApi(defaultClient);
+ String id = "id_example"; // String |
+ try {
+ SlaResponse result = apiInstance.deleteSLA(id);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling SlasApi#deleteSLA");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| | |
+
+### Return type
+
+[**SlaResponse**](SlaResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | SLA deleted | - |
+| **404** | resource not found for another team | - |
+
+
+# **getSLA**
+> SlaResponse getSLA(id)
+
+Retrieves an SLA
+
+Retrieves a specific SLA by id
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.SlasApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ SlasApi apiInstance = new SlasApi(defaultClient);
+ String id = "id_example"; // String |
+ try {
+ SlaResponse result = apiInstance.getSLA(id);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling SlasApi#getSLA");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| | |
+
+### Return type
+
+[**SlaResponse**](SlaResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | SLA found | - |
+| **404** | resource not found for another team | - |
+
+
+# **listSLAs**
+> SlaList listSLAs(pageNumber, pageSize, filterSearch, filterSlug, filterName, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, sort)
+
+List SLAs
+
+List SLAs
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.SlasApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ SlasApi apiInstance = new SlasApi(defaultClient);
+ Integer pageNumber = 56; // Integer |
+ Integer pageSize = 56; // Integer |
+ String filterSearch = "filterSearch_example"; // String |
+ String filterSlug = "filterSlug_example"; // String |
+ String filterName = "filterName_example"; // String |
+ String filterCreatedAtGt = "filterCreatedAtGt_example"; // String |
+ String filterCreatedAtGte = "filterCreatedAtGte_example"; // String |
+ String filterCreatedAtLt = "filterCreatedAtLt_example"; // String |
+ String filterCreatedAtLte = "filterCreatedAtLte_example"; // String |
+ String sort = "sort_example"; // String |
+ try {
+ SlaList result = apiInstance.listSLAs(pageNumber, pageSize, filterSearch, filterSlug, filterName, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, sort);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling SlasApi#listSLAs");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **pageNumber** | **Integer**| | [optional] |
+| **pageSize** | **Integer**| | [optional] |
+| **filterSearch** | **String**| | [optional] |
+| **filterSlug** | **String**| | [optional] |
+| **filterName** | **String**| | [optional] |
+| **filterCreatedAtGt** | **String**| | [optional] |
+| **filterCreatedAtGte** | **String**| | [optional] |
+| **filterCreatedAtLt** | **String**| | [optional] |
+| **filterCreatedAtLte** | **String**| | [optional] |
+| **sort** | **String**| | [optional] |
+
+### Return type
+
+[**SlaList**](SlaList.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | success | - |
+
+
+# **updateSLA**
+> SlaResponse updateSLA(id, updateSla)
+
+Update an SLA
+
+Update a specific SLA by id
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.SlasApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ SlasApi apiInstance = new SlasApi(defaultClient);
+ String id = "id_example"; // String |
+ UpdateSla updateSla = new UpdateSla(); // UpdateSla |
+ try {
+ SlaResponse result = apiInstance.updateSLA(id, updateSla);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling SlasApi#updateSLA");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| | |
+| **updateSla** | [**UpdateSla**](UpdateSla.md)| | |
+
+### Return type
+
+[**SlaResponse**](SlaResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/vnd.api+json
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | SLA updated | - |
+| **404** | resource not found for another team | - |
+
diff --git a/docs/SnoozeAlert.md b/docs/SnoozeAlert.md
new file mode 100644
index 00000000..b74c8b15
--- /dev/null
+++ b/docs/SnoozeAlert.md
@@ -0,0 +1,13 @@
+
+
+# SnoozeAlert
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**SnoozeAlertData**](SnoozeAlertData.md) | | |
+
+
+
diff --git a/docs/SnoozeAlertData.md b/docs/SnoozeAlertData.md
new file mode 100644
index 00000000..3a25c477
--- /dev/null
+++ b/docs/SnoozeAlertData.md
@@ -0,0 +1,22 @@
+
+
+# SnoozeAlertData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**SnoozeAlertDataAttributes**](SnoozeAlertDataAttributes.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| ALERTS | "alerts" |
+
+
+
diff --git a/docs/SnoozeAlertDataAttributes.md b/docs/SnoozeAlertDataAttributes.md
new file mode 100644
index 00000000..fceeb5cb
--- /dev/null
+++ b/docs/SnoozeAlertDataAttributes.md
@@ -0,0 +1,13 @@
+
+
+# SnoozeAlertDataAttributes
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**delayMinutes** | **Integer** | Number of minutes to snooze the alert for | |
+
+
+
diff --git a/docs/Status.md b/docs/Status.md
new file mode 100644
index 00000000..69f23ab6
--- /dev/null
+++ b/docs/Status.md
@@ -0,0 +1,19 @@
+
+
+# Status
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | | |
+|**slug** | **String** | | [optional] |
+|**description** | **String** | | [optional] |
+|**color** | **String** | | |
+|**enabled** | **Boolean** | | |
+|**createdAt** | **String** | | |
+|**updatedAt** | **String** | | |
+
+
+
diff --git a/docs/StatusList.md b/docs/StatusList.md
new file mode 100644
index 00000000..0e2740d3
--- /dev/null
+++ b/docs/StatusList.md
@@ -0,0 +1,15 @@
+
+
+# StatusList
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<StatusResponseData>**](StatusResponseData.md) | | |
+|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
+
+
+
diff --git a/docs/StatusPage.md b/docs/StatusPage.md
index 367841ae..8c30999d 100644
--- a/docs/StatusPage.md
+++ b/docs/StatusPage.md
@@ -8,6 +8,7 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**title** | **String** | The title of the status page | |
+|**slug** | **String** | The slug of the status page | [optional] |
|**publicTitle** | **String** | The public title of the status page | [optional] |
|**description** | **String** | The description of the status page | [optional] |
|**publicDescription** | **String** | The public description of the status page | [optional] |
@@ -18,8 +19,15 @@
|**showUptimeLastDays** | [**ShowUptimeLastDaysEnum**](#ShowUptimeLastDaysEnum) | Show uptime over x days | [optional] |
|**successMessage** | **String** | Message showing when all components are operational | [optional] |
|**failureMessage** | **String** | Message showing when at least one component is not operational | [optional] |
-|**authenticationEnabled** | **Boolean** | Enable authentication | [optional] |
+|**authenticationMethod** | [**AuthenticationMethodEnum**](#AuthenticationMethodEnum) | Authentication method | [optional] |
+|**authenticationEnabled** | **Boolean** | Enable authentication (deprecated - use authentication_method instead) | [optional] |
|**authenticationPassword** | **String** | Authentication password | [optional] |
+|**samlIdpSsoServiceUrl** | **String** | SAML IdP SSO service URL | [optional] |
+|**samlIdpSloServiceUrl** | **String** | SAML IdP SLO service URL | [optional] |
+|**samlIdpCert** | **String** | SAML IdP certificate | [optional] |
+|**samlIdpCertFingerprint** | **String** | SAML IdP certificate fingerprint | [optional] |
+|**samlNameIdentifierFormat** | [**SamlNameIdentifierFormatEnum**](#SamlNameIdentifierFormatEnum) | SAML name identifier format | [optional] |
+|**sectionOrder** | [**List<SectionOrderEnum>**](#List<SectionOrderEnum>) | Order of sections on the status page | [optional] |
|**websiteUrl** | **String** | Website URL | [optional] |
|**websitePrivacyUrl** | **String** | Website Privacy URL | [optional] |
|**websiteSupportUrl** | **String** | Website Support URL | [optional] |
@@ -29,6 +37,7 @@
|**serviceIds** | **List<String>** | Services attached to the status page | [optional] |
|**functionalityIds** | **List<String>** | Functionalities attached to the status page | [optional] |
|**externalDomainNames** | **List<String>** | External domain names attached to the status page | [optional] |
+|**cnameRecords** | **Map<String, String>** | CNAME records mapping external domain names to their DNS target values. These are populated asynchronously after setting external_domain_names. | [optional] [readonly] |
|**enabled** | **Boolean** | Enabled / Disable the status page | [optional] |
|**createdAt** | **String** | Date of creation | |
|**updatedAt** | **String** | Date of last update | |
@@ -42,8 +51,37 @@
| NUMBER_30 | 30 |
| NUMBER_60 | 60 |
| NUMBER_90 | 90 |
-| NUMBER_180 | 180 |
-| NUMBER_360 | 360 |
+
+
+
+## Enum: AuthenticationMethodEnum
+
+| Name | Value |
+|---- | -----|
+| NONE | "none" |
+| PASSWORD | "password" |
+| SAML | "saml" |
+
+
+
+## Enum: SamlNameIdentifierFormatEnum
+
+| Name | Value |
+|---- | -----|
+| URN_OASIS_NAMES_TC_SAML_1_1_NAMEID_FORMAT_EMAIL_ADDRESS | "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress" |
+| URN_OASIS_NAMES_TC_SAML_2_0_NAMEID_FORMAT_PERSISTENT | "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent" |
+| URN_OASIS_NAMES_TC_SAML_2_0_NAMEID_FORMAT_TRANSIENT | "urn:oasis:names:tc:SAML:2.0:nameid-format:transient" |
+| URN_OASIS_NAMES_TC_SAML_1_1_NAMEID_FORMAT_UNSPECIFIED | "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified" |
+
+
+
+## Enum: List<SectionOrderEnum>
+
+| Name | Value |
+|---- | -----|
+| MAINTENANCE | "maintenance" |
+| SYSTEM_STATUS | "system_status" |
+| INCIDENTS | "incidents" |
diff --git a/docs/StatusPageList.md b/docs/StatusPageList.md
index a2f1755e..b65423ea 100644
--- a/docs/StatusPageList.md
+++ b/docs/StatusPageList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<StatusPageResponseData>**](StatusPageResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/StatusPageTemplate.md b/docs/StatusPageTemplate.md
index 5f548a86..ac4cd96d 100644
--- a/docs/StatusPageTemplate.md
+++ b/docs/StatusPageTemplate.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**statusPageId** | **String** | | |
|**title** | **String** | Title of the template | |
+|**updateTitle** | **String** | Title that will be used for the status page update | [optional] |
|**body** | **String** | Description of the event the template will populate | |
|**updateStatus** | **String** | Status of the event the template will populate | [optional] |
|**kind** | [**KindEnum**](#KindEnum) | The kind of the status page template | [optional] |
diff --git a/docs/StatusPageTemplateList.md b/docs/StatusPageTemplateList.md
index 015079c5..80e52bff 100644
--- a/docs/StatusPageTemplateList.md
+++ b/docs/StatusPageTemplateList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<StatusPageTemplateListDataInner>**](StatusPageTemplateListDataInner.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/StatusPagesApi.md b/docs/StatusPagesApi.md
index 6ff0b8c3..5fedc2c0 100644
--- a/docs/StatusPagesApi.md
+++ b/docs/StatusPagesApi.md
@@ -76,8 +76,8 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **201** | status_page created | - |
-| **422** | invalid request | - |
+| **201** | status page with SAML created | - |
+| **422** | invalid SAML configuration | - |
| **401** | responds with unauthorized for invalid token | - |
@@ -108,7 +108,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
StatusPagesApi apiInstance = new StatusPagesApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
StatusPageResponse result = apiInstance.deleteStatusPage(id);
System.out.println(result);
@@ -127,7 +127,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -176,7 +176,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
StatusPagesApi apiInstance = new StatusPagesApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
StatusPageResponse result = apiInstance.getStatusPage(id);
System.out.println(result);
@@ -195,7 +195,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -331,7 +331,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
StatusPagesApi apiInstance = new StatusPagesApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
UpdateStatusPage updateStatusPage = new UpdateStatusPage(); // UpdateStatusPage |
try {
StatusPageResponse result = apiInstance.updateStatusPage(id, updateStatusPage);
@@ -351,7 +351,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
| **updateStatusPage** | [**UpdateStatusPage**](UpdateStatusPage.md)| | |
### Return type
@@ -370,6 +370,7 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **200** | status_page updated | - |
+| **200** | external_domain_names persisted | - |
+| **422** | invalid section_order | - |
| **404** | resource not found | - |
diff --git a/docs/StatusResponse.md b/docs/StatusResponse.md
new file mode 100644
index 00000000..b9b9a516
--- /dev/null
+++ b/docs/StatusResponse.md
@@ -0,0 +1,13 @@
+
+
+# StatusResponse
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**StatusResponseData**](StatusResponseData.md) | | |
+
+
+
diff --git a/docs/StatusResponseData.md b/docs/StatusResponseData.md
new file mode 100644
index 00000000..a93d96df
--- /dev/null
+++ b/docs/StatusResponseData.md
@@ -0,0 +1,23 @@
+
+
+# StatusResponseData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | Unique ID of the status | |
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**Status**](Status.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| STATUSES | "statuses" |
+
+
+
diff --git a/docs/StatusesApi.md b/docs/StatusesApi.md
new file mode 100644
index 00000000..27b92da5
--- /dev/null
+++ b/docs/StatusesApi.md
@@ -0,0 +1,164 @@
+# StatusesApi
+
+All URIs are relative to *https://api.rootly.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getStatus**](StatusesApi.md#getStatus) | **GET** /v1/statuses/{id} | Retrieves a Status |
+| [**listStatuses**](StatusesApi.md#listStatuses) | **GET** /v1/statuses | List Statuses |
+
+
+
+# **getStatus**
+> StatusResponse getStatus(id)
+
+Retrieves a Status
+
+Retrieves a specific Status by id
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.StatusesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ StatusesApi apiInstance = new StatusesApi(defaultClient);
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
+ try {
+ StatusResponse result = apiInstance.getStatus(id);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling StatusesApi#getStatus");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
+
+### Return type
+
+[**StatusResponse**](StatusResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | status found by slug | - |
+| **404** | resource not found | - |
+
+
+# **listStatuses**
+> StatusList listStatuses(include, pageNumber, pageSize, filterSlug, filterName, filterEnabled, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte)
+
+List Statuses
+
+List Statuses
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.StatusesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ StatusesApi apiInstance = new StatusesApi(defaultClient);
+ String include = "include_example"; // String |
+ Integer pageNumber = 56; // Integer |
+ Integer pageSize = 56; // Integer |
+ String filterSlug = "filterSlug_example"; // String |
+ String filterName = "filterName_example"; // String |
+ Boolean filterEnabled = true; // Boolean |
+ String filterCreatedAtGt = "filterCreatedAtGt_example"; // String |
+ String filterCreatedAtGte = "filterCreatedAtGte_example"; // String |
+ String filterCreatedAtLt = "filterCreatedAtLt_example"; // String |
+ String filterCreatedAtLte = "filterCreatedAtLte_example"; // String |
+ try {
+ StatusList result = apiInstance.listStatuses(include, pageNumber, pageSize, filterSlug, filterName, filterEnabled, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling StatusesApi#listStatuses");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **include** | **String**| | [optional] |
+| **pageNumber** | **Integer**| | [optional] |
+| **pageSize** | **Integer**| | [optional] |
+| **filterSlug** | **String**| | [optional] |
+| **filterName** | **String**| | [optional] |
+| **filterEnabled** | **Boolean**| | [optional] |
+| **filterCreatedAtGt** | **String**| | [optional] |
+| **filterCreatedAtGte** | **String**| | [optional] |
+| **filterCreatedAtLt** | **String**| | [optional] |
+| **filterCreatedAtLte** | **String**| | [optional] |
+
+### Return type
+
+[**StatusList**](StatusList.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | success | - |
+| **401** | responds with unauthorized for invalid token | - |
+
diff --git a/docs/SubStatus.md b/docs/SubStatus.md
index cb4f7bde..2971608b 100644
--- a/docs/SubStatus.md
+++ b/docs/SubStatus.md
@@ -26,8 +26,10 @@
| RESOLVED | "resolved" |
| CLOSED | "closed" |
| CANCELLED | "cancelled" |
+| PLANNING | "planning" |
| SCHEDULED | "scheduled" |
| IN_PROGRESS | "in_progress" |
+| VERIFYING | "verifying" |
| COMPLETED | "completed" |
diff --git a/docs/SubStatusList.md b/docs/SubStatusList.md
index 00c6d9d8..3d24ea15 100644
--- a/docs/SubStatusList.md
+++ b/docs/SubStatusList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<SubStatusResponseData>**](SubStatusResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/SubStatusesApi.md b/docs/SubStatusesApi.md
index eeff7713..51ea09d7 100644
--- a/docs/SubStatusesApi.md
+++ b/docs/SubStatusesApi.md
@@ -108,7 +108,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
SubStatusesApi apiInstance = new SubStatusesApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
SubStatusResponse result = apiInstance.deleteSubStatus(id);
System.out.println(result);
@@ -127,7 +127,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -176,7 +176,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
SubStatusesApi apiInstance = new SubStatusesApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
SubStatusResponse result = apiInstance.getSubStatus(id);
System.out.println(result);
@@ -195,7 +195,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -213,7 +213,7 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **200** | sub_status found | - |
+| **200** | sub_status found by slug | - |
| **404** | resource not found | - |
@@ -329,7 +329,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
SubStatusesApi apiInstance = new SubStatusesApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
UpdateSubStatus updateSubStatus = new UpdateSubStatus(); // UpdateSubStatus |
try {
SubStatusResponse result = apiInstance.updateSubStatus(id, updateSubStatus);
@@ -349,7 +349,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
| **updateSubStatus** | [**UpdateSubStatus**](UpdateSubStatus.md)| | |
### Return type
diff --git a/docs/Team.md b/docs/Team.md
index 1a74c5b0..f7c15e1d 100644
--- a/docs/Team.md
+++ b/docs/Team.md
@@ -29,6 +29,12 @@
|**alertUrgencyId** | **String** | The alert urgency id of the team | [optional] |
|**slackChannels** | [**List<NewEnvironmentDataAttributesSlackChannelsInner>**](NewEnvironmentDataAttributesSlackChannelsInner.md) | Slack Channels associated with this team | [optional] |
|**slackAliases** | [**List<NewEnvironmentDataAttributesSlackAliasesInner>**](NewEnvironmentDataAttributesSlackAliasesInner.md) | Slack Aliases associated with this team | [optional] |
+|**alertBroadcastEnabled** | **Boolean** | Enable alerts to be broadcasted to a specific channel | [optional] |
+|**alertBroadcastChannel** | [**ServiceAlertBroadcastChannel**](ServiceAlertBroadcastChannel.md) | | [optional] |
+|**incidentBroadcastEnabled** | **Boolean** | Enable incidents to be broadcasted to a specific channel | [optional] |
+|**incidentBroadcastChannel** | [**ServiceIncidentBroadcastChannel**](ServiceIncidentBroadcastChannel.md) | | [optional] |
+|**autoAddMembersWhenAttached** | **Boolean** | Auto add members to incident channel when team is attached | [optional] |
+|**properties** | [**List<NewCauseDataAttributesPropertiesInner>**](NewCauseDataAttributesPropertiesInner.md) | Array of property values for this team. | [optional] |
|**createdAt** | **String** | Date of creation | |
|**updatedAt** | **String** | Date of last update | |
diff --git a/docs/TeamList.md b/docs/TeamList.md
index 034b95be..a429281f 100644
--- a/docs/TeamList.md
+++ b/docs/TeamList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<TeamResponseData>**](TeamResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/TeamsApi.md b/docs/TeamsApi.md
index 008669f0..2c3e1db8 100644
--- a/docs/TeamsApi.md
+++ b/docs/TeamsApi.md
@@ -4,14 +4,85 @@ All URIs are relative to *https://api.rootly.com*
| Method | HTTP request | Description |
|------------- | ------------- | -------------|
+| [**createGroupCatalogProperty**](TeamsApi.md#createGroupCatalogProperty) | **POST** /v1/teams/properties | Creates a Catalog Property |
| [**createTeam**](TeamsApi.md#createTeam) | **POST** /v1/teams | Creates a team |
| [**deleteTeam**](TeamsApi.md#deleteTeam) | **DELETE** /v1/teams/{id} | Delete a team |
| [**getTeam**](TeamsApi.md#getTeam) | **GET** /v1/teams/{id} | Retrieves a team |
| [**getTeamIncidentsChart**](TeamsApi.md#getTeamIncidentsChart) | **GET** /v1/teams/{id}/incidents_chart | Get team incidents chart |
+| [**listGroupCatalogProperties**](TeamsApi.md#listGroupCatalogProperties) | **GET** /v1/teams/properties | List Catalog Properties |
| [**listTeams**](TeamsApi.md#listTeams) | **GET** /v1/teams | List teams |
| [**updateTeam**](TeamsApi.md#updateTeam) | **PUT** /v1/teams/{id} | Update a team |
+
+# **createGroupCatalogProperty**
+> CatalogPropertyResponse createGroupCatalogProperty(newCatalogProperty)
+
+Creates a Catalog Property
+
+Creates a new Catalog Property from provided data
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.TeamsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ TeamsApi apiInstance = new TeamsApi(defaultClient);
+ NewCatalogProperty newCatalogProperty = new NewCatalogProperty(); // NewCatalogProperty |
+ try {
+ CatalogPropertyResponse result = apiInstance.createGroupCatalogProperty(newCatalogProperty);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling TeamsApi#createGroupCatalogProperty");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **newCatalogProperty** | [**NewCatalogProperty**](NewCatalogProperty.md)| | |
+
+### Return type
+
+[**CatalogPropertyResponse**](CatalogPropertyResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/vnd.api+json
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | catalog_property created ignores wrong catalog_type attribute | - |
+| **422** | exceeds max fields per catalog | - |
+| **401** | responds with unauthorized for invalid token | - |
+
# **createTeam**
> TeamResponse createTeam(newTeam)
@@ -109,7 +180,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
TeamsApi apiInstance = new TeamsApi(defaultClient);
- String id = "id_example"; // String |
+ GetTeamIdParameter id = new GetTeamIdParameter(); // GetTeamIdParameter |
try {
TeamResponse result = apiInstance.deleteTeam(id);
System.out.println(result);
@@ -128,7 +199,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetTeamIdParameter**](.md)| | |
### Return type
@@ -151,7 +222,7 @@ public class Example {
# **getTeam**
-> TeamResponse getTeam(id)
+> TeamResponse getTeam(id, include)
Retrieves a team
@@ -177,9 +248,10 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
TeamsApi apiInstance = new TeamsApi(defaultClient);
- String id = "id_example"; // String |
+ GetTeamIdParameter id = new GetTeamIdParameter(); // GetTeamIdParameter |
+ String include = "users"; // String | comma separated if needed. eg: users
try {
- TeamResponse result = apiInstance.getTeam(id);
+ TeamResponse result = apiInstance.getTeam(id, include);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling TeamsApi#getTeam");
@@ -196,7 +268,8 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetTeamIdParameter**](.md)| | |
+| **include** | **String**| comma separated if needed. eg: users | [optional] [enum: users, schedules, escalation_policies] |
### Return type
@@ -214,7 +287,7 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **200** | team found | - |
+| **200** | team found by slug | - |
| **404** | resource not found | - |
@@ -287,9 +360,96 @@ public class Example {
| **200** | success | - |
| **404** | resource not found | - |
+
+# **listGroupCatalogProperties**
+> CatalogPropertyList listGroupCatalogProperties(include, sort, pageNumber, pageSize, filterSlug, filterName, filterKind, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte)
+
+List Catalog Properties
+
+List Group Catalog Properties
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.TeamsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ TeamsApi apiInstance = new TeamsApi(defaultClient);
+ String include = "catalog"; // String | comma separated if needed. eg: catalog
+ String sort = "created_at"; // String | comma separated if needed. eg: created_at,updated_at
+ Integer pageNumber = 56; // Integer |
+ Integer pageSize = 56; // Integer |
+ String filterSlug = "filterSlug_example"; // String |
+ String filterName = "filterName_example"; // String |
+ String filterKind = "filterKind_example"; // String |
+ String filterCreatedAtGt = "filterCreatedAtGt_example"; // String |
+ String filterCreatedAtGte = "filterCreatedAtGte_example"; // String |
+ String filterCreatedAtLt = "filterCreatedAtLt_example"; // String |
+ String filterCreatedAtLte = "filterCreatedAtLte_example"; // String |
+ try {
+ CatalogPropertyList result = apiInstance.listGroupCatalogProperties(include, sort, pageNumber, pageSize, filterSlug, filterName, filterKind, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling TeamsApi#listGroupCatalogProperties");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **include** | **String**| comma separated if needed. eg: catalog | [optional] [enum: catalog] |
+| **sort** | **String**| comma separated if needed. eg: created_at,updated_at | [optional] [enum: created_at, -created_at, updated_at, -updated_at, position, -position] |
+| **pageNumber** | **Integer**| | [optional] |
+| **pageSize** | **Integer**| | [optional] |
+| **filterSlug** | **String**| | [optional] |
+| **filterName** | **String**| | [optional] |
+| **filterKind** | **String**| | [optional] |
+| **filterCreatedAtGt** | **String**| | [optional] |
+| **filterCreatedAtGte** | **String**| | [optional] |
+| **filterCreatedAtLt** | **String**| | [optional] |
+| **filterCreatedAtLte** | **String**| | [optional] |
+
+### Return type
+
+[**CatalogPropertyList**](CatalogPropertyList.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | success | - |
+
# **listTeams**
-> TeamList listTeams(include, pageNumber, pageSize, filterSearch, filterSlug, filterName, filterBackstageId, filterCortexId, filterOpslevelId, filterExternalId, filterColor, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, sort)
+> TeamList listTeams(include, pageNumber, pageSize, filterSearch, filterSlug, filterName, filterBackstageId, filterCortexId, filterOpslevelId, filterExternalId, filterColor, filterAlertBroadcastEnabled, filterIncidentBroadcastEnabled, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, sort)
List teams
@@ -315,7 +475,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
TeamsApi apiInstance = new TeamsApi(defaultClient);
- String include = "include_example"; // String |
+ String include = "users"; // String | comma separated if needed. eg: users
Integer pageNumber = 56; // Integer |
Integer pageSize = 56; // Integer |
String filterSearch = "filterSearch_example"; // String |
@@ -326,13 +486,15 @@ public class Example {
String filterOpslevelId = "filterOpslevelId_example"; // String |
String filterExternalId = "filterExternalId_example"; // String |
String filterColor = "filterColor_example"; // String |
+ Boolean filterAlertBroadcastEnabled = true; // Boolean |
+ Boolean filterIncidentBroadcastEnabled = true; // Boolean |
String filterCreatedAtGt = "filterCreatedAtGt_example"; // String |
String filterCreatedAtGte = "filterCreatedAtGte_example"; // String |
String filterCreatedAtLt = "filterCreatedAtLt_example"; // String |
String filterCreatedAtLte = "filterCreatedAtLte_example"; // String |
String sort = "sort_example"; // String |
try {
- TeamList result = apiInstance.listTeams(include, pageNumber, pageSize, filterSearch, filterSlug, filterName, filterBackstageId, filterCortexId, filterOpslevelId, filterExternalId, filterColor, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, sort);
+ TeamList result = apiInstance.listTeams(include, pageNumber, pageSize, filterSearch, filterSlug, filterName, filterBackstageId, filterCortexId, filterOpslevelId, filterExternalId, filterColor, filterAlertBroadcastEnabled, filterIncidentBroadcastEnabled, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, sort);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling TeamsApi#listTeams");
@@ -349,7 +511,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **include** | **String**| | [optional] |
+| **include** | **String**| comma separated if needed. eg: users | [optional] [enum: users, schedules, escalation_policies] |
| **pageNumber** | **Integer**| | [optional] |
| **pageSize** | **Integer**| | [optional] |
| **filterSearch** | **String**| | [optional] |
@@ -360,6 +522,8 @@ public class Example {
| **filterOpslevelId** | **String**| | [optional] |
| **filterExternalId** | **String**| | [optional] |
| **filterColor** | **String**| | [optional] |
+| **filterAlertBroadcastEnabled** | **Boolean**| | [optional] |
+| **filterIncidentBroadcastEnabled** | **Boolean**| | [optional] |
| **filterCreatedAtGt** | **String**| | [optional] |
| **filterCreatedAtGte** | **String**| | [optional] |
| **filterCreatedAtLt** | **String**| | [optional] |
@@ -412,7 +576,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
TeamsApi apiInstance = new TeamsApi(defaultClient);
- String id = "id_example"; // String |
+ GetTeamIdParameter id = new GetTeamIdParameter(); // GetTeamIdParameter |
UpdateTeam updateTeam = new UpdateTeam(); // UpdateTeam |
try {
TeamResponse result = apiInstance.updateTeam(id, updateTeam);
@@ -432,7 +596,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetTeamIdParameter**](.md)| | |
| **updateTeam** | [**UpdateTeam**](UpdateTeam.md)| | |
### Return type
diff --git a/docs/TiptapBlockSchema.md b/docs/TiptapBlockSchema.md
new file mode 100644
index 00000000..3a965ca9
--- /dev/null
+++ b/docs/TiptapBlockSchema.md
@@ -0,0 +1,15 @@
+
+
+# TiptapBlockSchema
+
+TipTap block component schema for post mortem templates
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**followupComponent** | [**TiptapBlockSchemaFollowupComponent**](TiptapBlockSchemaFollowupComponent.md) | | [optional] |
+|**timelineComponent** | [**TiptapBlockSchemaTimelineComponent**](TiptapBlockSchemaTimelineComponent.md) | | [optional] |
+
+
+
diff --git a/docs/TiptapBlockSchemaFollowupComponent.md b/docs/TiptapBlockSchemaFollowupComponent.md
new file mode 100644
index 00000000..ff98b680
--- /dev/null
+++ b/docs/TiptapBlockSchemaFollowupComponent.md
@@ -0,0 +1,25 @@
+
+
+# TiptapBlockSchemaFollowupComponent
+
+Followup component block
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**html** | **String** | HTML representation: <div data-sort=\"due_date\" data-followup-component=\"true\" class=\"followups-node-placeholder\"></div> | |
+|**dataSort** | [**DataSortEnum**](#DataSortEnum) | Sort order for followups. Valid values: due_date, status, priority | [optional] |
+
+
+
+## Enum: DataSortEnum
+
+| Name | Value |
+|---- | -----|
+| DUE_DATE | "due_date" |
+| STATUS | "status" |
+| PRIORITY | "priority" |
+
+
+
diff --git a/docs/TiptapBlockSchemaTimelineComponent.md b/docs/TiptapBlockSchemaTimelineComponent.md
new file mode 100644
index 00000000..70b88343
--- /dev/null
+++ b/docs/TiptapBlockSchemaTimelineComponent.md
@@ -0,0 +1,14 @@
+
+
+# TiptapBlockSchemaTimelineComponent
+
+Timeline component block
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**html** | **String** | HTML representation: <div data-timeline-component=\"true\" class=\"timeline-node-placeholder\"></div> | |
+
+
+
diff --git a/docs/UpdateAlertDataAttributes.md b/docs/UpdateAlertDataAttributes.md
index 14ec1fa6..a1e3e77f 100644
--- a/docs/UpdateAlertDataAttributes.md
+++ b/docs/UpdateAlertDataAttributes.md
@@ -11,9 +11,9 @@
|**source** | [**SourceEnum**](#SourceEnum) | The source of the alert | [optional] |
|**summary** | **String** | The summary of the alert | [optional] |
|**description** | **String** | The description of the alert | [optional] |
-|**serviceIds** | **List<String>** | The Service ID's to attach to the alert | [optional] |
-|**groupIds** | **List<String>** | The Group ID's to attach to the alert | [optional] |
-|**environmentIds** | **List<String>** | The Environment ID's to attach to the alert | [optional] |
+|**serviceIds** | **List<String>** | The Service IDs to attach to the alert | [optional] |
+|**groupIds** | **List<String>** | The Group IDs to attach to the alert | [optional] |
+|**environmentIds** | **List<String>** | The Environment IDs to attach to the alert | [optional] |
|**startedAt** | **OffsetDateTime** | Alert start datetime | [optional] |
|**endedAt** | **OffsetDateTime** | Alert end datetime | [optional] |
|**externalId** | **String** | External ID | [optional] |
@@ -21,6 +21,8 @@
|**alertUrgencyId** | **String** | The ID of the alert urgency | [optional] |
|**labels** | [**List<NewAlertDataAttributesLabelsInner>**](NewAlertDataAttributesLabelsInner.md) | | [optional] |
|**data** | **Object** | Additional data | [optional] |
+|**deduplicationKey** | **String** | Alerts sharing the same deduplication key are treated as a single alert. | [optional] |
+|**alertFieldValuesAttributes** | [**List<NewAlertDataAttributesAlertFieldValuesAttributesInner>**](NewAlertDataAttributesAlertFieldValuesAttributesInner.md) | Custom alert field values to create with the alert | [optional] |
@@ -40,16 +42,19 @@
| ROOTLY | "rootly" |
| MANUAL | "manual" |
| API | "api" |
+| HEARTBEAT | "heartbeat" |
| WEB | "web" |
| SLACK | "slack" |
| EMAIL | "email" |
| WORKFLOW | "workflow" |
| LIVE_CALL_ROUTING | "live_call_routing" |
+| MOBILE | "mobile" |
| PAGERDUTY | "pagerduty" |
| OPSGENIE | "opsgenie" |
| VICTOROPS | "victorops" |
| PAGERTREE | "pagertree" |
| DATADOG | "datadog" |
+| DYNATRACE | "dynatrace" |
| NOBL9 | "nobl9" |
| ZENDESK | "zendesk" |
| ASANA | "asana" |
@@ -65,6 +70,7 @@
| GOOGLE_CLOUD | "google_cloud" |
| GENERIC_WEBHOOK | "generic_webhook" |
| CLOUD_WATCH | "cloud_watch" |
+| AWS_SNS | "aws_sns" |
| AZURE | "azure" |
| SPLUNK | "splunk" |
| CHRONOSPHERE | "chronosphere" |
diff --git a/docs/UpdateAlertEvent.md b/docs/UpdateAlertEvent.md
index 51e18c5e..cac93188 100644
--- a/docs/UpdateAlertEvent.md
+++ b/docs/UpdateAlertEvent.md
@@ -2,6 +2,7 @@
# UpdateAlertEvent
+Update an alert event. Note: Only alert events with kind='note' can be updated. You cannot change the kind field.
## Properties
diff --git a/docs/UpdateAlertField.md b/docs/UpdateAlertField.md
new file mode 100644
index 00000000..28bdf927
--- /dev/null
+++ b/docs/UpdateAlertField.md
@@ -0,0 +1,13 @@
+
+
+# UpdateAlertField
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**UpdateAlertFieldData**](UpdateAlertFieldData.md) | | |
+
+
+
diff --git a/docs/UpdateAlertFieldData.md b/docs/UpdateAlertFieldData.md
new file mode 100644
index 00000000..f37f99e8
--- /dev/null
+++ b/docs/UpdateAlertFieldData.md
@@ -0,0 +1,22 @@
+
+
+# UpdateAlertFieldData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**UpdateAlertFieldDataAttributes**](UpdateAlertFieldDataAttributes.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| ALERT_FIELDS | "alert_fields" |
+
+
+
diff --git a/docs/UpdateAlertFieldDataAttributes.md b/docs/UpdateAlertFieldDataAttributes.md
new file mode 100644
index 00000000..be450b76
--- /dev/null
+++ b/docs/UpdateAlertFieldDataAttributes.md
@@ -0,0 +1,13 @@
+
+
+# UpdateAlertFieldDataAttributes
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | The name of the alert field | [optional] |
+
+
+
diff --git a/docs/UpdateAlertGroupDataAttributes.md b/docs/UpdateAlertGroupDataAttributes.md
index 3ccfa9f5..2ae6fc31 100644
--- a/docs/UpdateAlertGroupDataAttributes.md
+++ b/docs/UpdateAlertGroupDataAttributes.md
@@ -11,10 +11,11 @@
|**description** | **String** | The description of the alert group | [optional] |
|**timeWindow** | **Integer** | The length of time an Alert Group should stay open and accept new alerts | [optional] |
|**targets** | [**List<NewAlertGroupDataAttributesTargetsInner>**](NewAlertGroupDataAttributesTargetsInner.md) | | [optional] |
-|**attributes** | [**List<NewAlertGroupDataAttributesAttributesInner>**](NewAlertGroupDataAttributesAttributesInner.md) | | [optional] |
-|**groupByAlertTitle** | [**GroupByAlertTitleEnum**](#GroupByAlertTitleEnum) | Whether the alerts should be grouped by titles. | [optional] |
-|**groupByAlertUrgency** | [**GroupByAlertUrgencyEnum**](#GroupByAlertUrgencyEnum) | Whether the alerts should be grouped by urgencies. | [optional] |
+|**attributes** | [**List<NewAlertGroupDataAttributesAttributesInner>**](NewAlertGroupDataAttributesAttributesInner.md) | This field is deprecated. Please use the `conditions` field instead, `attributes` will be removed in the future. | [optional] |
+|**groupByAlertTitle** | [**GroupByAlertTitleEnum**](#GroupByAlertTitleEnum) | [DEPRECATED] Whether the alerts should be grouped by titles. This field is deprecated. Please use the `conditions` field with advanced alert grouping instead. | [optional] |
+|**groupByAlertUrgency** | [**GroupByAlertUrgencyEnum**](#GroupByAlertUrgencyEnum) | [DEPRECATED] Whether the alerts should be grouped by urgencies. This field is deprecated. Please use the `conditions` field with advanced alert grouping instead. | [optional] |
|**conditionType** | [**ConditionTypeEnum**](#ConditionTypeEnum) | Group alerts when ANY or ALL of the fields are matching. | [optional] |
+|**conditions** | [**List<NewAlertGroupDataAttributesConditionsInner>**](NewAlertGroupDataAttributesConditionsInner.md) | | [optional] |
diff --git a/docs/UpdateAlertRoute.md b/docs/UpdateAlertRoute.md
new file mode 100644
index 00000000..cdd8bb6f
--- /dev/null
+++ b/docs/UpdateAlertRoute.md
@@ -0,0 +1,13 @@
+
+
+# UpdateAlertRoute
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**UpdateAlertRouteData**](UpdateAlertRouteData.md) | | |
+
+
+
diff --git a/docs/UpdateAlertRouteData.md b/docs/UpdateAlertRouteData.md
new file mode 100644
index 00000000..78333ac1
--- /dev/null
+++ b/docs/UpdateAlertRouteData.md
@@ -0,0 +1,22 @@
+
+
+# UpdateAlertRouteData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**UpdateAlertRouteDataAttributes**](UpdateAlertRouteDataAttributes.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| ALERT_ROUTES | "alert_routes" |
+
+
+
diff --git a/docs/UpdateAlertRouteDataAttributes.md b/docs/UpdateAlertRouteDataAttributes.md
new file mode 100644
index 00000000..a2275c5f
--- /dev/null
+++ b/docs/UpdateAlertRouteDataAttributes.md
@@ -0,0 +1,17 @@
+
+
+# UpdateAlertRouteDataAttributes
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | The name of the alert route | [optional] |
+|**enabled** | **Boolean** | Whether the alert route is enabled | [optional] |
+|**alertsSourceIds** | **List<UUID>** | | [optional] |
+|**owningTeamIds** | **List<UUID>** | | [optional] |
+|**rules** | [**List<NewAlertRouteDataAttributesRulesInner>**](NewAlertRouteDataAttributesRulesInner.md) | | [optional] |
+
+
+
diff --git a/docs/UpdateAlertRoutingRuleDataAttributes.md b/docs/UpdateAlertRoutingRuleDataAttributes.md
index 91f699b6..b68851e5 100644
--- a/docs/UpdateAlertRoutingRuleDataAttributes.md
+++ b/docs/UpdateAlertRoutingRuleDataAttributes.md
@@ -10,6 +10,7 @@
|**name** | **String** | The name of the alert routing rule | [optional] |
|**enabled** | **Boolean** | Whether the alert routing rule is enabled | [optional] |
|**alertsSourceId** | **UUID** | The ID of the alerts source | [optional] |
+|**position** | **Integer** | The position of the alert routing rule for ordering evaluation | [optional] |
|**owningTeamIds** | **List<UUID>** | The IDs of the teams that own the alert routing rule | [optional] |
|**conditionType** | [**ConditionTypeEnum**](#ConditionTypeEnum) | The type of condition for the alert routing rule | [optional] |
|**conditions** | [**List<UpdateAlertRoutingRuleDataAttributesConditionsInner>**](UpdateAlertRoutingRuleDataAttributesConditionsInner.md) | | [optional] |
diff --git a/docs/UpdateAlertRoutingRuleDataAttributesDestination.md b/docs/UpdateAlertRoutingRuleDataAttributesDestination.md
index 82d9d846..6798c56b 100644
--- a/docs/UpdateAlertRoutingRuleDataAttributesDestination.md
+++ b/docs/UpdateAlertRoutingRuleDataAttributesDestination.md
@@ -7,7 +7,7 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
-|**targetType** | [**TargetTypeEnum**](#TargetTypeEnum) | The type of the target | [optional] |
+|**targetType** | [**TargetTypeEnum**](#TargetTypeEnum) | The type of the target. Please contact support if you encounter issues using `Functionality` as a target type. | [optional] |
|**targetId** | **UUID** | The ID of the target | [optional] |
@@ -16,8 +16,9 @@
| Name | Value |
|---- | -----|
-| GROUP | "Group" |
| SERVICE | "Service" |
+| GROUP | "Group" |
+| FUNCTIONALITY | "Functionality" |
| ESCALATION_POLICY | "EscalationPolicy" |
diff --git a/docs/UpdateAlertsSourceDataAttributes.md b/docs/UpdateAlertsSourceDataAttributes.md
index 6c4dd628..4c597a6c 100644
--- a/docs/UpdateAlertsSourceDataAttributes.md
+++ b/docs/UpdateAlertsSourceDataAttributes.md
@@ -10,11 +10,16 @@
|**name** | **String** | The name of the alert source | [optional] |
|**sourceType** | [**SourceTypeEnum**](#SourceTypeEnum) | The alert source type | [optional] |
|**alertUrgencyId** | **String** | ID for the default alert urgency assigned to this alert source | [optional] |
+|**deduplicateAlertsByKey** | **Boolean** | Toggle alert deduplication using deduplication key. If enabled, deduplication_key_kind and deduplication_key_path are required. | [optional] |
+|**deduplicationKeyKind** | [**DeduplicationKeyKindEnum**](#DeduplicationKeyKindEnum) | Kind of deduplication key. | [optional] |
+|**deduplicationKeyPath** | **String** | Path to deduplication key. This is a JSON Path to extract the deduplication key from the request body. | [optional] |
+|**deduplicationKeyRegexp** | **String** | Regular expression to extract key from value found at key path. | [optional] |
|**ownerGroupIds** | **List<String>** | List of team IDs that will own the alert source | [optional] |
|**alertTemplateAttributes** | [**NewAlertsSourceDataAttributesAlertTemplateAttributes**](NewAlertsSourceDataAttributesAlertTemplateAttributes.md) | | [optional] |
|**alertSourceUrgencyRulesAttributes** | [**List<NewAlertsSourceDataAttributesAlertSourceUrgencyRulesAttributesInner>**](NewAlertsSourceDataAttributesAlertSourceUrgencyRulesAttributesInner.md) | List of rules that define the conditions under which the alert urgency will be set automatically based on the alert payload | [optional] |
|**sourceableAttributes** | [**NewAlertsSourceDataAttributesSourceableAttributes**](NewAlertsSourceDataAttributesSourceableAttributes.md) | | [optional] |
|**resolutionRuleAttributes** | [**NewAlertsSourceDataAttributesResolutionRuleAttributes**](NewAlertsSourceDataAttributesResolutionRuleAttributes.md) | | [optional] |
+|**alertSourceFieldsAttributes** | [**List<NewAlertsSourceDataAttributesAlertSourceFieldsAttributesInner>**](NewAlertsSourceDataAttributesAlertSourceFieldsAttributesInner.md) | List of alert fields to be added to the alert source. Note: This attribute requires the alert field feature to be enabled on your account. Contact Rootly customer support if you need assistance with this feature. | [optional] |
@@ -26,12 +31,14 @@
| APP_DYNAMICS | "app_dynamics" |
| CATCHPOINT | "catchpoint" |
| DATADOG | "datadog" |
+| DYNATRACE | "dynatrace" |
| ALERTMANAGER | "alertmanager" |
| GOOGLE_CLOUD | "google_cloud" |
| GRAFANA | "grafana" |
| SENTRY | "sentry" |
| GENERIC_WEBHOOK | "generic_webhook" |
| CLOUD_WATCH | "cloud_watch" |
+| AWS_SNS | "aws_sns" |
| CHECKLY | "checkly" |
| AZURE | "azure" |
| NEW_RELIC | "new_relic" |
@@ -46,3 +53,11 @@
+## Enum: DeduplicationKeyKindEnum
+
+| Name | Value |
+|---- | -----|
+| PAYLOAD | "payload" |
+
+
+
diff --git a/docs/UpdateApiKey.md b/docs/UpdateApiKey.md
new file mode 100644
index 00000000..7a2ca98b
--- /dev/null
+++ b/docs/UpdateApiKey.md
@@ -0,0 +1,13 @@
+
+
+# UpdateApiKey
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**UpdateApiKeyData**](UpdateApiKeyData.md) | | |
+
+
+
diff --git a/docs/UpdateApiKeyData.md b/docs/UpdateApiKeyData.md
new file mode 100644
index 00000000..87d5eaad
--- /dev/null
+++ b/docs/UpdateApiKeyData.md
@@ -0,0 +1,22 @@
+
+
+# UpdateApiKeyData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**UpdateApiKeyDataAttributes**](UpdateApiKeyDataAttributes.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| API_KEYS | "api_keys" |
+
+
+
diff --git a/docs/UpdateApiKeyDataAttributes.md b/docs/UpdateApiKeyDataAttributes.md
new file mode 100644
index 00000000..63318369
--- /dev/null
+++ b/docs/UpdateApiKeyDataAttributes.md
@@ -0,0 +1,15 @@
+
+
+# UpdateApiKeyDataAttributes
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | The name of the API key | [optional] |
+|**description** | **String** | A description of the API key | [optional] |
+|**expiresAt** | **OffsetDateTime** | The expiration date of the API key (ISO 8601) | [optional] |
+
+
+
diff --git a/docs/UpdateCatalogChecklistTemplate.md b/docs/UpdateCatalogChecklistTemplate.md
new file mode 100644
index 00000000..1afbc35c
--- /dev/null
+++ b/docs/UpdateCatalogChecklistTemplate.md
@@ -0,0 +1,13 @@
+
+
+# UpdateCatalogChecklistTemplate
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**UpdateCatalogChecklistTemplateData**](UpdateCatalogChecklistTemplateData.md) | | |
+
+
+
diff --git a/docs/UpdateCatalogChecklistTemplateData.md b/docs/UpdateCatalogChecklistTemplateData.md
new file mode 100644
index 00000000..9aec1852
--- /dev/null
+++ b/docs/UpdateCatalogChecklistTemplateData.md
@@ -0,0 +1,22 @@
+
+
+# UpdateCatalogChecklistTemplateData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**UpdateCatalogChecklistTemplateDataAttributes**](UpdateCatalogChecklistTemplateDataAttributes.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| CATALOG_CHECKLIST_TEMPLATES | "catalog_checklist_templates" |
+
+
+
diff --git a/docs/UpdateCatalogChecklistTemplateDataAttributes.md b/docs/UpdateCatalogChecklistTemplateDataAttributes.md
new file mode 100644
index 00000000..fbde1735
--- /dev/null
+++ b/docs/UpdateCatalogChecklistTemplateDataAttributes.md
@@ -0,0 +1,16 @@
+
+
+# UpdateCatalogChecklistTemplateDataAttributes
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | The name of the checklist template | [optional] |
+|**description** | **String** | The description of the checklist template | [optional] |
+|**fields** | [**List<NewCatalogChecklistTemplateDataAttributesFieldsInner>**](NewCatalogChecklistTemplateDataAttributesFieldsInner.md) | Template fields. Position is determined by array order. Replaces all existing fields. | [optional] |
+|**owners** | [**List<NewCatalogChecklistTemplateDataAttributesOwnersInner>**](NewCatalogChecklistTemplateDataAttributesOwnersInner.md) | Template owners. Replaces all existing owners. | [optional] |
+
+
+
diff --git a/docs/UpdateCatalogEntityDataAttributes.md b/docs/UpdateCatalogEntityDataAttributes.md
index d34d73ba..c032ddae 100644
--- a/docs/UpdateCatalogEntityDataAttributes.md
+++ b/docs/UpdateCatalogEntityDataAttributes.md
@@ -10,6 +10,8 @@
|**name** | **String** | | [optional] |
|**description** | **String** | | [optional] |
|**position** | **Integer** | Default position of the item when displayed in a list. | [optional] |
+|**backstageId** | **String** | The Backstage entity ID this catalog entity is linked to. | [optional] |
+|**properties** | [**List<NewCatalogEntityDataAttributesPropertiesInner>**](NewCatalogEntityDataAttributesPropertiesInner.md) | Array of property values for this catalog entity | [optional] |
diff --git a/docs/UpdateCatalogEntityProperty.md b/docs/UpdateCatalogEntityProperty.md
index c9600f07..66197cd3 100644
--- a/docs/UpdateCatalogEntityProperty.md
+++ b/docs/UpdateCatalogEntityProperty.md
@@ -2,6 +2,7 @@
# UpdateCatalogEntityProperty
+**Deprecated:** This endpoint is deprecated, please use the `fields` attribute on catalog entities or native catalog endpoints (teams, services, functionalities, incident_types, causes, environments) to set field values instead.
## Properties
diff --git a/docs/UpdateCatalogEntityPropertyDataAttributes.md b/docs/UpdateCatalogEntityPropertyDataAttributes.md
index a781160b..efc6261a 100644
--- a/docs/UpdateCatalogEntityPropertyDataAttributes.md
+++ b/docs/UpdateCatalogEntityPropertyDataAttributes.md
@@ -18,6 +18,7 @@
|---- | -----|
| TEXT | "text" |
| CATALOG_ENTITY | "catalog_entity" |
+| SLACK | "slack" |
diff --git a/docs/UpdateCatalogFieldData.md b/docs/UpdateCatalogFieldData.md
index b2717732..a6e50ab7 100644
--- a/docs/UpdateCatalogFieldData.md
+++ b/docs/UpdateCatalogFieldData.md
@@ -16,7 +16,7 @@
| Name | Value |
|---- | -----|
-| CATALOG_FIELDS | "catalog_fields" |
+| CATALOG_PROPERTIES | "catalog_properties" |
diff --git a/docs/UpdateCatalogFieldDataAttributes.md b/docs/UpdateCatalogFieldDataAttributes.md
index 2b13f08a..47048df5 100644
--- a/docs/UpdateCatalogFieldDataAttributes.md
+++ b/docs/UpdateCatalogFieldDataAttributes.md
@@ -8,10 +8,11 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**name** | **String** | | [optional] |
-|**slug** | **String** | | [optional] |
|**kind** | [**KindEnum**](#KindEnum) | | [optional] |
|**kindCatalogId** | **String** | Restricts values to items of specified catalog. | [optional] |
|**position** | **Integer** | Default position of the item when displayed in a list. | [optional] |
+|**required** | **Boolean** | Whether the field is required. | [optional] |
+|**catalogType** | [**CatalogTypeEnum**](#CatalogTypeEnum) | The type of catalog the field belongs to. | [optional] |
@@ -21,6 +22,29 @@
|---- | -----|
| TEXT | "text" |
| REFERENCE | "reference" |
+| BOOLEAN | "boolean" |
+| REFERENCE2 | "reference" |
+| SERVICE | "service" |
+| FUNCTIONALITY | "functionality" |
+| ENVIRONMENT | "environment" |
+| GROUP | "group" |
+| CAUSE | "cause" |
+| INCIDENT_TYPE | "incident_type" |
+| USER | "user" |
+
+
+
+## Enum: CatalogTypeEnum
+
+| Name | Value |
+|---- | -----|
+| CATALOG | "catalog" |
+| CAUSE | "cause" |
+| ENVIRONMENT | "environment" |
+| FUNCTIONALITY | "functionality" |
+| INCIDENT_TYPE | "incident_type" |
+| SERVICE | "service" |
+| TEAM | "team" |
diff --git a/docs/UpdateCatalogProperty.md b/docs/UpdateCatalogProperty.md
new file mode 100644
index 00000000..9d08e98b
--- /dev/null
+++ b/docs/UpdateCatalogProperty.md
@@ -0,0 +1,13 @@
+
+
+# UpdateCatalogProperty
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**UpdateCatalogPropertyData**](UpdateCatalogPropertyData.md) | | |
+
+
+
diff --git a/docs/UpdateCatalogPropertyData.md b/docs/UpdateCatalogPropertyData.md
new file mode 100644
index 00000000..55927c6c
--- /dev/null
+++ b/docs/UpdateCatalogPropertyData.md
@@ -0,0 +1,22 @@
+
+
+# UpdateCatalogPropertyData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**UpdateCatalogPropertyDataAttributes**](UpdateCatalogPropertyDataAttributes.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| CATALOG_PROPERTIES | "catalog_properties" |
+
+
+
diff --git a/docs/UpdateCatalogPropertyDataAttributes.md b/docs/UpdateCatalogPropertyDataAttributes.md
new file mode 100644
index 00000000..7428435f
--- /dev/null
+++ b/docs/UpdateCatalogPropertyDataAttributes.md
@@ -0,0 +1,50 @@
+
+
+# UpdateCatalogPropertyDataAttributes
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | | [optional] |
+|**kind** | [**KindEnum**](#KindEnum) | | [optional] |
+|**kindCatalogId** | **String** | Restricts values to items of specified catalog. | [optional] |
+|**position** | **Integer** | Default position of the item when displayed in a list. | [optional] |
+|**required** | **Boolean** | Whether the property is required. | [optional] |
+|**catalogType** | [**CatalogTypeEnum**](#CatalogTypeEnum) | The type of catalog the property belongs to. | [optional] |
+
+
+
+## Enum: KindEnum
+
+| Name | Value |
+|---- | -----|
+| TEXT | "text" |
+| REFERENCE | "reference" |
+| BOOLEAN | "boolean" |
+| REFERENCE2 | "reference" |
+| SERVICE | "service" |
+| FUNCTIONALITY | "functionality" |
+| ENVIRONMENT | "environment" |
+| GROUP | "group" |
+| CAUSE | "cause" |
+| INCIDENT_TYPE | "incident_type" |
+| USER | "user" |
+
+
+
+## Enum: CatalogTypeEnum
+
+| Name | Value |
+|---- | -----|
+| CATALOG | "catalog" |
+| CAUSE | "cause" |
+| ENVIRONMENT | "environment" |
+| FUNCTIONALITY | "functionality" |
+| INCIDENT_TYPE | "incident_type" |
+| SERVICE | "service" |
+| TEAM | "team" |
+
+
+
diff --git a/docs/UpdateCauseDataAttributes.md b/docs/UpdateCauseDataAttributes.md
index 14177b48..84a26465 100644
--- a/docs/UpdateCauseDataAttributes.md
+++ b/docs/UpdateCauseDataAttributes.md
@@ -10,6 +10,7 @@
|**name** | **String** | The name of the cause | [optional] |
|**description** | **String** | The description of the cause | [optional] |
|**position** | **Integer** | Position of the cause | [optional] |
+|**properties** | [**List<NewCauseDataAttributesPropertiesInner>**](NewCauseDataAttributesPropertiesInner.md) | Array of property values for this cause. | [optional] |
diff --git a/docs/UpdateCommunicationsGroup.md b/docs/UpdateCommunicationsGroup.md
new file mode 100644
index 00000000..01fcdc5d
--- /dev/null
+++ b/docs/UpdateCommunicationsGroup.md
@@ -0,0 +1,13 @@
+
+
+# UpdateCommunicationsGroup
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**UpdateCommunicationsGroupData**](UpdateCommunicationsGroupData.md) | | |
+
+
+
diff --git a/docs/UpdateCommunicationsGroupData.md b/docs/UpdateCommunicationsGroupData.md
new file mode 100644
index 00000000..5a9af9de
--- /dev/null
+++ b/docs/UpdateCommunicationsGroupData.md
@@ -0,0 +1,22 @@
+
+
+# UpdateCommunicationsGroupData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**UpdateCommunicationsGroupDataAttributes**](UpdateCommunicationsGroupDataAttributes.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| COMMUNICATIONS_GROUPS | "communications_groups" |
+
+
+
diff --git a/docs/UpdateCommunicationsGroupDataAttributes.md b/docs/UpdateCommunicationsGroupDataAttributes.md
new file mode 100644
index 00000000..9edb7a05
--- /dev/null
+++ b/docs/UpdateCommunicationsGroupDataAttributes.md
@@ -0,0 +1,32 @@
+
+
+# UpdateCommunicationsGroupDataAttributes
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | The name of the communications group | [optional] |
+|**description** | **String** | The description of the communications group | [optional] |
+|**communicationTypeId** | **String** | The communication type ID | [optional] |
+|**isPrivate** | **Boolean** | Whether the group is private | [optional] |
+|**conditionType** | [**ConditionTypeEnum**](#ConditionTypeEnum) | Condition type | [optional] |
+|**smsChannel** | **Boolean** | SMS channel enabled | [optional] |
+|**emailChannel** | **Boolean** | Email channel enabled | [optional] |
+|**memberIds** | **List<Integer>** | Array of member user IDs | [optional] |
+|**slackChannelIds** | **List<String>** | Array of Slack channel IDs | [optional] |
+|**communicationGroupConditions** | [**List<UpdateCommunicationsGroupDataAttributesCommunicationGroupConditionsInner>**](UpdateCommunicationsGroupDataAttributesCommunicationGroupConditionsInner.md) | Group conditions attributes | [optional] |
+|**communicationExternalGroupMembers** | [**List<UpdateCommunicationsGroupDataAttributesCommunicationExternalGroupMembersInner>**](UpdateCommunicationsGroupDataAttributesCommunicationExternalGroupMembersInner.md) | External group members attributes | [optional] |
+
+
+
+## Enum: ConditionTypeEnum
+
+| Name | Value |
+|---- | -----|
+| ANY | "any" |
+| ALL | "all" |
+
+
+
diff --git a/docs/UpdateCommunicationsGroupDataAttributesCommunicationExternalGroupMembersInner.md b/docs/UpdateCommunicationsGroupDataAttributesCommunicationExternalGroupMembersInner.md
new file mode 100644
index 00000000..8d1e6cea
--- /dev/null
+++ b/docs/UpdateCommunicationsGroupDataAttributesCommunicationExternalGroupMembersInner.md
@@ -0,0 +1,16 @@
+
+
+# UpdateCommunicationsGroupDataAttributesCommunicationExternalGroupMembersInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | ID of the external group member | [optional] |
+|**name** | **String** | Name of the external member | [optional] |
+|**email** | **String** | Email of the external member | [optional] |
+|**phoneNumber** | **String** | Phone number of the external member | [optional] |
+
+
+
diff --git a/docs/UpdateCommunicationsGroupDataAttributesCommunicationGroupConditionsInner.md b/docs/UpdateCommunicationsGroupDataAttributesCommunicationGroupConditionsInner.md
new file mode 100644
index 00000000..ae0bb91d
--- /dev/null
+++ b/docs/UpdateCommunicationsGroupDataAttributesCommunicationGroupConditionsInner.md
@@ -0,0 +1,31 @@
+
+
+# UpdateCommunicationsGroupDataAttributesCommunicationGroupConditionsInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | ID of the condition | [optional] |
+|**propertyType** | [**PropertyTypeEnum**](#PropertyTypeEnum) | Property type | [optional] |
+|**serviceIds** | **List<String>** | Array of service IDs | [optional] |
+|**severityIds** | **List<String>** | Array of severity IDs | [optional] |
+|**functionalityIds** | **List<String>** | Array of functionality IDs | [optional] |
+|**groupIds** | **List<String>** | Array of group IDs | [optional] |
+|**incidentTypeIds** | **List<String>** | Array of incident type IDs | [optional] |
+
+
+
+## Enum: PropertyTypeEnum
+
+| Name | Value |
+|---- | -----|
+| SERVICE | "service" |
+| SEVERITY | "severity" |
+| FUNCTIONALITY | "functionality" |
+| GROUP | "group" |
+| INCIDENT_TYPE | "incident_type" |
+
+
+
diff --git a/docs/UpdateCommunicationsStage.md b/docs/UpdateCommunicationsStage.md
new file mode 100644
index 00000000..b1def285
--- /dev/null
+++ b/docs/UpdateCommunicationsStage.md
@@ -0,0 +1,13 @@
+
+
+# UpdateCommunicationsStage
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**UpdateCommunicationsStageData**](UpdateCommunicationsStageData.md) | | |
+
+
+
diff --git a/docs/UpdateCommunicationsStageData.md b/docs/UpdateCommunicationsStageData.md
new file mode 100644
index 00000000..098e8f68
--- /dev/null
+++ b/docs/UpdateCommunicationsStageData.md
@@ -0,0 +1,22 @@
+
+
+# UpdateCommunicationsStageData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**UpdateCommunicationsStageDataAttributes**](UpdateCommunicationsStageDataAttributes.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| COMMUNICATIONS_STAGES | "communications_stages" |
+
+
+
diff --git a/docs/UpdateCommunicationsStageDataAttributes.md b/docs/UpdateCommunicationsStageDataAttributes.md
new file mode 100644
index 00000000..c2ccc0b1
--- /dev/null
+++ b/docs/UpdateCommunicationsStageDataAttributes.md
@@ -0,0 +1,15 @@
+
+
+# UpdateCommunicationsStageDataAttributes
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | The name of the communications stage | [optional] |
+|**description** | **String** | The description of the communications stage | [optional] |
+|**position** | **Integer** | Position of the communications stage | [optional] |
+
+
+
diff --git a/docs/UpdateCommunicationsTemplate.md b/docs/UpdateCommunicationsTemplate.md
new file mode 100644
index 00000000..85a0598e
--- /dev/null
+++ b/docs/UpdateCommunicationsTemplate.md
@@ -0,0 +1,13 @@
+
+
+# UpdateCommunicationsTemplate
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**UpdateCommunicationsTemplateData**](UpdateCommunicationsTemplateData.md) | | |
+
+
+
diff --git a/docs/UpdateCommunicationsTemplateData.md b/docs/UpdateCommunicationsTemplateData.md
new file mode 100644
index 00000000..19e595ad
--- /dev/null
+++ b/docs/UpdateCommunicationsTemplateData.md
@@ -0,0 +1,22 @@
+
+
+# UpdateCommunicationsTemplateData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**UpdateCommunicationsTemplateDataAttributes**](UpdateCommunicationsTemplateDataAttributes.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| COMMUNICATIONS_TEMPLATES | "communications_templates" |
+
+
+
diff --git a/docs/UpdateCommunicationsTemplateDataAttributes.md b/docs/UpdateCommunicationsTemplateDataAttributes.md
new file mode 100644
index 00000000..84f28e91
--- /dev/null
+++ b/docs/UpdateCommunicationsTemplateDataAttributes.md
@@ -0,0 +1,17 @@
+
+
+# UpdateCommunicationsTemplateDataAttributes
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | The name of the communications template | [optional] |
+|**description** | **String** | The description of the communications template | [optional] |
+|**communicationTypeId** | **String** | The communication type ID | [optional] |
+|**position** | **Integer** | Position of the communications template | [optional] |
+|**communicationTemplateStagesAttributes** | [**List<UpdateCommunicationsTemplateDataAttributesCommunicationTemplateStagesAttributesInner>**](UpdateCommunicationsTemplateDataAttributesCommunicationTemplateStagesAttributesInner.md) | Template stages attributes | [optional] |
+
+
+
diff --git a/docs/UpdateCommunicationsTemplateDataAttributesCommunicationTemplateStagesAttributesInner.md b/docs/UpdateCommunicationsTemplateDataAttributesCommunicationTemplateStagesAttributesInner.md
new file mode 100644
index 00000000..ec1551bf
--- /dev/null
+++ b/docs/UpdateCommunicationsTemplateDataAttributesCommunicationTemplateStagesAttributesInner.md
@@ -0,0 +1,17 @@
+
+
+# UpdateCommunicationsTemplateDataAttributesCommunicationTemplateStagesAttributesInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | ID of the communication template stage | [optional] |
+|**smsContent** | **String** | SMS content for the stage | [optional] |
+|**emailSubject** | **String** | Email subject for the stage | [optional] |
+|**emailBody** | **String** | Email body for the stage | [optional] |
+|**slackContent** | **String** | Slack content for the stage | [optional] |
+
+
+
diff --git a/docs/UpdateCommunicationsType.md b/docs/UpdateCommunicationsType.md
new file mode 100644
index 00000000..50f70055
--- /dev/null
+++ b/docs/UpdateCommunicationsType.md
@@ -0,0 +1,13 @@
+
+
+# UpdateCommunicationsType
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**UpdateCommunicationsTypeData**](UpdateCommunicationsTypeData.md) | | |
+
+
+
diff --git a/docs/UpdateCommunicationsTypeData.md b/docs/UpdateCommunicationsTypeData.md
new file mode 100644
index 00000000..fbed8ce2
--- /dev/null
+++ b/docs/UpdateCommunicationsTypeData.md
@@ -0,0 +1,22 @@
+
+
+# UpdateCommunicationsTypeData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**UpdateCommunicationsTypeDataAttributes**](UpdateCommunicationsTypeDataAttributes.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| COMMUNICATIONS_TYPES | "communications_types" |
+
+
+
diff --git a/docs/UpdateCommunicationsTypeDataAttributes.md b/docs/UpdateCommunicationsTypeDataAttributes.md
new file mode 100644
index 00000000..342ea77c
--- /dev/null
+++ b/docs/UpdateCommunicationsTypeDataAttributes.md
@@ -0,0 +1,16 @@
+
+
+# UpdateCommunicationsTypeDataAttributes
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | The name of the communications type | [optional] |
+|**description** | **String** | The description of the communications type | [optional] |
+|**color** | **String** | The color of the communications type | [optional] |
+|**position** | **Integer** | Position of the communications type | [optional] |
+
+
+
diff --git a/docs/UpdateConfluencePageTaskParams.md b/docs/UpdateConfluencePageTaskParams.md
new file mode 100644
index 00000000..923c2956
--- /dev/null
+++ b/docs/UpdateConfluencePageTaskParams.md
@@ -0,0 +1,27 @@
+
+
+# UpdateConfluencePageTaskParams
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**taskType** | [**TaskTypeEnum**](#TaskTypeEnum) | | [optional] |
+|**integration** | [**CreateConfluencePageTaskParamsIntegration**](CreateConfluencePageTaskParamsIntegration.md) | | [optional] |
+|**fileId** | **String** | The Confluence page ID | |
+|**title** | **String** | The Confluence page title | [optional] |
+|**content** | **String** | The Confluence page content | [optional] |
+|**postMortemTemplateId** | **String** | Retrospective template to use when updating page, if desired | [optional] |
+|**template** | [**UpdateConfluencePageTaskParamsTemplate**](UpdateConfluencePageTaskParamsTemplate.md) | | [optional] |
+
+
+
+## Enum: TaskTypeEnum
+
+| Name | Value |
+|---- | -----|
+| UPDATE_CONFLUENCE_PAGE | "update_confluence_page" |
+
+
+
diff --git a/docs/UpdateConfluencePageTaskParamsTemplate.md b/docs/UpdateConfluencePageTaskParamsTemplate.md
new file mode 100644
index 00000000..05bec9a5
--- /dev/null
+++ b/docs/UpdateConfluencePageTaskParamsTemplate.md
@@ -0,0 +1,15 @@
+
+
+# UpdateConfluencePageTaskParamsTemplate
+
+The Confluence template to use
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | | [optional] |
+|**name** | **String** | | [optional] |
+
+
+
diff --git a/docs/UpdateCustomFieldDataAttributes.md b/docs/UpdateCustomFieldDataAttributes.md
index 1e1f4be3..6549a089 100644
--- a/docs/UpdateCustomFieldDataAttributes.md
+++ b/docs/UpdateCustomFieldDataAttributes.md
@@ -8,7 +8,6 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**label** | **String** | The name of the custom_field | [optional] |
-|**slug** | **String** | The slug of the custom_field | [optional] |
|**description** | **String** | The description of the custom_field | [optional] |
|**shown** | [**List<ShownEnum>**](#List<ShownEnum>) | | [optional] |
|**required** | [**List<RequiredEnum>**](#List<RequiredEnum>) | | [optional] |
diff --git a/docs/UpdateCustomFormDataAttributes.md b/docs/UpdateCustomFormDataAttributes.md
index e6b53c5b..5b6e6df5 100644
--- a/docs/UpdateCustomFormDataAttributes.md
+++ b/docs/UpdateCustomFormDataAttributes.md
@@ -8,7 +8,6 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**name** | **String** | The name of the custom form. | [optional] |
-|**slug** | **String** | The custom form slug. Add this to form_field.shown or form_field.required to associate form fields with custom forms. | [optional] |
|**description** | **String** | | [optional] |
|**enabled** | **Boolean** | | [optional] |
|**command** | **String** | The Slack command used to trigger this form. | [optional] |
diff --git a/docs/UpdateDatadogNotebookTaskParams.md b/docs/UpdateDatadogNotebookTaskParams.md
new file mode 100644
index 00000000..aaa9dfa8
--- /dev/null
+++ b/docs/UpdateDatadogNotebookTaskParams.md
@@ -0,0 +1,39 @@
+
+
+# UpdateDatadogNotebookTaskParams
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**taskType** | [**TaskTypeEnum**](#TaskTypeEnum) | | [optional] |
+|**fileId** | **String** | The Datadog notebook ID | |
+|**title** | **String** | The Datadog notebook title | [optional] |
+|**content** | **String** | The Datadog notebook content | [optional] |
+|**kind** | [**KindEnum**](#KindEnum) | The notebook type | [optional] |
+|**postMortemTemplateId** | **String** | Retrospective template to use when updating notebook, if desired | [optional] |
+|**template** | [**UpdateDatadogNotebookTaskParamsTemplate**](UpdateDatadogNotebookTaskParamsTemplate.md) | | [optional] |
+
+
+
+## Enum: TaskTypeEnum
+
+| Name | Value |
+|---- | -----|
+| UPDATE_DATADOG_NOTEBOOK | "update_datadog_notebook" |
+
+
+
+## Enum: KindEnum
+
+| Name | Value |
+|---- | -----|
+| POSTMORTEM | "postmortem" |
+| RUNBOOK | "runbook" |
+| INVESTIGATION | "investigation" |
+| DOCUMENTATION | "documentation" |
+| REPORT | "report" |
+
+
+
diff --git a/docs/UpdateDatadogNotebookTaskParamsTemplate.md b/docs/UpdateDatadogNotebookTaskParamsTemplate.md
new file mode 100644
index 00000000..696d8fd9
--- /dev/null
+++ b/docs/UpdateDatadogNotebookTaskParamsTemplate.md
@@ -0,0 +1,15 @@
+
+
+# UpdateDatadogNotebookTaskParamsTemplate
+
+The Datadog notebook template to use
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | | [optional] |
+|**name** | **String** | | [optional] |
+
+
+
diff --git a/docs/UpdateDropboxPaperPageTaskParams.md b/docs/UpdateDropboxPaperPageTaskParams.md
new file mode 100644
index 00000000..47fae1fa
--- /dev/null
+++ b/docs/UpdateDropboxPaperPageTaskParams.md
@@ -0,0 +1,25 @@
+
+
+# UpdateDropboxPaperPageTaskParams
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**taskType** | [**TaskTypeEnum**](#TaskTypeEnum) | | [optional] |
+|**fileId** | **String** | The Dropbox Paper document ID | |
+|**title** | **String** | The Dropbox Paper document title | [optional] |
+|**content** | **String** | The Dropbox Paper document content | [optional] |
+|**postMortemTemplateId** | **String** | Retrospective template to use when updating document, if desired | [optional] |
+
+
+
+## Enum: TaskTypeEnum
+
+| Name | Value |
+|---- | -----|
+| UPDATE_DROPBOX_PAPER_PAGE | "update_dropbox_paper_page" |
+
+
+
diff --git a/docs/UpdateEdgeConnector.md b/docs/UpdateEdgeConnector.md
new file mode 100644
index 00000000..e0df5bc5
--- /dev/null
+++ b/docs/UpdateEdgeConnector.md
@@ -0,0 +1,13 @@
+
+
+# UpdateEdgeConnector
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**edgeConnector** | [**UpdateEdgeConnectorRequestDataAttributes**](UpdateEdgeConnectorRequestDataAttributes.md) | | |
+
+
+
diff --git a/docs/UpdateEdgeConnectorAction.md b/docs/UpdateEdgeConnectorAction.md
new file mode 100644
index 00000000..2ce3853d
--- /dev/null
+++ b/docs/UpdateEdgeConnectorAction.md
@@ -0,0 +1,13 @@
+
+
+# UpdateEdgeConnectorAction
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**action** | [**UpdateEdgeConnectorActionRequestAction**](UpdateEdgeConnectorActionRequestAction.md) | | |
+
+
+
diff --git a/docs/UpdateEdgeConnectorActionRequest.md b/docs/UpdateEdgeConnectorActionRequest.md
new file mode 100644
index 00000000..592db923
--- /dev/null
+++ b/docs/UpdateEdgeConnectorActionRequest.md
@@ -0,0 +1,13 @@
+
+
+# UpdateEdgeConnectorActionRequest
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**action** | [**UpdateEdgeConnectorActionRequestAction**](UpdateEdgeConnectorActionRequestAction.md) | | [optional] |
+
+
+
diff --git a/docs/UpdateEdgeConnectorActionRequestAction.md b/docs/UpdateEdgeConnectorActionRequestAction.md
new file mode 100644
index 00000000..3eab1774
--- /dev/null
+++ b/docs/UpdateEdgeConnectorActionRequestAction.md
@@ -0,0 +1,24 @@
+
+
+# UpdateEdgeConnectorActionRequestAction
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | | [optional] |
+|**actionType** | [**ActionTypeEnum**](#ActionTypeEnum) | | [optional] |
+|**metadata** | **Object** | | [optional] |
+
+
+
+## Enum: ActionTypeEnum
+
+| Name | Value |
+|---- | -----|
+| SCRIPT | "script" |
+| HTTP | "http" |
+
+
+
diff --git a/docs/UpdateEdgeConnectorRequest.md b/docs/UpdateEdgeConnectorRequest.md
new file mode 100644
index 00000000..0c598e04
--- /dev/null
+++ b/docs/UpdateEdgeConnectorRequest.md
@@ -0,0 +1,13 @@
+
+
+# UpdateEdgeConnectorRequest
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**UpdateEdgeConnectorRequestData**](UpdateEdgeConnectorRequestData.md) | | [optional] |
+
+
+
diff --git a/docs/UpdateEdgeConnectorRequestData.md b/docs/UpdateEdgeConnectorRequestData.md
new file mode 100644
index 00000000..3954738f
--- /dev/null
+++ b/docs/UpdateEdgeConnectorRequestData.md
@@ -0,0 +1,23 @@
+
+
+# UpdateEdgeConnectorRequestData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | [**TypeEnum**](#TypeEnum) | | [optional] |
+|**id** | **String** | | [optional] |
+|**attributes** | [**UpdateEdgeConnectorRequestDataAttributes**](UpdateEdgeConnectorRequestDataAttributes.md) | | [optional] |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| EDGE_CONNECTORS | "edge_connectors" |
+
+
+
diff --git a/docs/UpdateEdgeConnectorRequestDataAttributes.md b/docs/UpdateEdgeConnectorRequestDataAttributes.md
new file mode 100644
index 00000000..23a8749c
--- /dev/null
+++ b/docs/UpdateEdgeConnectorRequestDataAttributes.md
@@ -0,0 +1,25 @@
+
+
+# UpdateEdgeConnectorRequestDataAttributes
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | | [optional] |
+|**description** | **String** | | [optional] |
+|**status** | [**StatusEnum**](#StatusEnum) | | [optional] |
+|**subscriptions** | **List<String>** | | [optional] |
+
+
+
+## Enum: StatusEnum
+
+| Name | Value |
+|---- | -----|
+| ACTIVE | "active" |
+| PAUSED | "paused" |
+
+
+
diff --git a/docs/UpdateEnvironmentDataAttributes.md b/docs/UpdateEnvironmentDataAttributes.md
index a36acdd8..68fb113d 100644
--- a/docs/UpdateEnvironmentDataAttributes.md
+++ b/docs/UpdateEnvironmentDataAttributes.md
@@ -14,6 +14,7 @@
|**notifyEmails** | **List<String>** | Emails to attach to the environment | [optional] |
|**slackChannels** | [**List<NewEnvironmentDataAttributesSlackChannelsInner>**](NewEnvironmentDataAttributesSlackChannelsInner.md) | Slack Channels associated with this environment | [optional] |
|**slackAliases** | [**List<NewEnvironmentDataAttributesSlackAliasesInner>**](NewEnvironmentDataAttributesSlackAliasesInner.md) | Slack Aliases associated with this environment | [optional] |
+|**properties** | [**List<NewCauseDataAttributesPropertiesInner>**](NewCauseDataAttributesPropertiesInner.md) | Array of property values for this environment. | [optional] |
diff --git a/docs/UpdateEscalationPolicyLevelDataAttributes.md b/docs/UpdateEscalationPolicyLevelDataAttributes.md
index 5fda5398..30bf4813 100644
--- a/docs/UpdateEscalationPolicyLevelDataAttributes.md
+++ b/docs/UpdateEscalationPolicyLevelDataAttributes.md
@@ -7,7 +7,7 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
-|**delay** | **Integer** | Delay before notification targets will be alerted. | [optional] |
+|**delay** | **Integer** | Delay before notifying targets in the next Escalation Level. | [optional] |
|**position** | **Integer** | Position of the escalation policy level | [optional] |
|**escalationPolicyPathId** | **String** | The ID of the dynamic escalation policy path the level will belong to. If nothing is specified it will add the level to your default path. | [optional] |
|**pagingStrategyConfigurationStrategy** | [**PagingStrategyConfigurationStrategyEnum**](#PagingStrategyConfigurationStrategyEnum) | | [optional] |
diff --git a/docs/UpdateEscalationPolicyPathDataAttributes.md b/docs/UpdateEscalationPolicyPathDataAttributes.md
index c1083c00..e3b04a34 100644
--- a/docs/UpdateEscalationPolicyPathDataAttributes.md
+++ b/docs/UpdateEscalationPolicyPathDataAttributes.md
@@ -9,6 +9,9 @@
|------------ | ------------- | ------------- | -------------|
|**name** | **String** | The name of the escalation path | [optional] |
|**notificationType** | [**NotificationTypeEnum**](#NotificationTypeEnum) | Position of the escalation policy level | [optional] |
+|**pathType** | [**PathTypeEnum**](#PathTypeEnum) | The type of escalation path. Cannot be changed after creation. | [optional] |
+|**afterDeferralBehavior** | [**AfterDeferralBehaviorEnum**](#AfterDeferralBehaviorEnum) | What happens after a deferral path finishes. | [optional] |
+|**afterDeferralPathId** | **String** | The escalation path to execute after this deferral path when after_deferral_behavior is execute_path. | [optional] |
|**_default** | **Boolean** | Whether this escalation path is the default path | [optional] |
|**matchMode** | [**MatchModeEnum**](#MatchModeEnum) | How path rules are matched. | [optional] |
|**position** | **Integer** | The position of this path in the paths for this EP. | [optional] |
@@ -16,6 +19,8 @@
|**repeatCount** | **Integer** | The number of times this path will be executed until someone acknowledges the alert | [optional] |
|**initialDelay** | **Integer** | Initial delay for escalation path in minutes. Maximum 1 week (10080). | [optional] |
|**rules** | [**List<UpdateEscalationPolicyPathDataAttributesRulesInner>**](UpdateEscalationPolicyPathDataAttributesRulesInner.md) | Escalation path conditions | [optional] |
+|**timeRestrictionTimeZone** | [**TimeRestrictionTimeZoneEnum**](#TimeRestrictionTimeZoneEnum) | Time zone used for time restrictions. | [optional] |
+|**timeRestrictions** | [**List<UpdateEscalationPolicyPathDataAttributesTimeRestrictionsInner>**](UpdateEscalationPolicyPathDataAttributesTimeRestrictionsInner.md) | If time restrictions are set, alerts will follow this path when they arrive within the specified time ranges and meet the rules. | [optional] |
@@ -28,6 +33,24 @@
+## Enum: PathTypeEnum
+
+| Name | Value |
+|---- | -----|
+| ESCALATION | "escalation" |
+| DEFERRAL | "deferral" |
+
+
+
+## Enum: AfterDeferralBehaviorEnum
+
+| Name | Value |
+|---- | -----|
+| RE_EVALUATE | "re_evaluate" |
+| EXECUTE_PATH | "execute_path" |
+
+
+
## Enum: MatchModeEnum
| Name | Value |
@@ -37,3 +60,314 @@
+## Enum: TimeRestrictionTimeZoneEnum
+
+| Name | Value |
+|---- | -----|
+| INTERNATIONAL_DATE_LINE_WEST | "International Date Line West" |
+| ETC_GMT_12 | "Etc/GMT+12" |
+| AMERICAN_SAMOA | "American Samoa" |
+| PACIFIC_PAGO_PAGO | "Pacific/Pago_Pago" |
+| MIDWAY_ISLAND | "Midway Island" |
+| PACIFIC_MIDWAY | "Pacific/Midway" |
+| HAWAII | "Hawaii" |
+| PACIFIC_HONOLULU | "Pacific/Honolulu" |
+| ALASKA | "Alaska" |
+| AMERICA_JUNEAU | "America/Juneau" |
+| PACIFIC_TIME_US_CANADA_ | "Pacific Time (US & Canada)" |
+| AMERICA_LOS_ANGELES | "America/Los_Angeles" |
+| TIJUANA | "Tijuana" |
+| AMERICA_TIJUANA | "America/Tijuana" |
+| ARIZONA | "Arizona" |
+| AMERICA_PHOENIX | "America/Phoenix" |
+| MAZATLAN | "Mazatlan" |
+| AMERICA_MAZATLAN | "America/Mazatlan" |
+| MOUNTAIN_TIME_US_CANADA_ | "Mountain Time (US & Canada)" |
+| AMERICA_DENVER | "America/Denver" |
+| CENTRAL_AMERICA | "Central America" |
+| AMERICA_GUATEMALA | "America/Guatemala" |
+| CENTRAL_TIME_US_CANADA_ | "Central Time (US & Canada)" |
+| AMERICA_CHICAGO | "America/Chicago" |
+| CHIHUAHUA | "Chihuahua" |
+| AMERICA_CHIHUAHUA | "America/Chihuahua" |
+| GUADALAJARA | "Guadalajara" |
+| AMERICA_MEXICO_CITY | "America/Mexico_City" |
+| MEXICO_CITY | "Mexico City" |
+| AMERICA_MEXICO_CITY2 | "America/Mexico_City" |
+| MONTERREY | "Monterrey" |
+| AMERICA_MONTERREY | "America/Monterrey" |
+| SASKATCHEWAN | "Saskatchewan" |
+| AMERICA_REGINA | "America/Regina" |
+| BOGOTA | "Bogota" |
+| AMERICA_BOGOTA | "America/Bogota" |
+| EASTERN_TIME_US_CANADA_ | "Eastern Time (US & Canada)" |
+| AMERICA_NEW_YORK | "America/New_York" |
+| INDIANA_EAST_ | "Indiana (East)" |
+| AMERICA_INDIANA_INDIANAPOLIS | "America/Indiana/Indianapolis" |
+| LIMA | "Lima" |
+| AMERICA_LIMA | "America/Lima" |
+| QUITO | "Quito" |
+| AMERICA_LIMA2 | "America/Lima" |
+| ATLANTIC_TIME_CANADA_ | "Atlantic Time (Canada)" |
+| AMERICA_HALIFAX | "America/Halifax" |
+| CARACAS | "Caracas" |
+| AMERICA_CARACAS | "America/Caracas" |
+| GEORGETOWN | "Georgetown" |
+| AMERICA_GUYANA | "America/Guyana" |
+| LA_PAZ | "La Paz" |
+| AMERICA_LA_PAZ | "America/La_Paz" |
+| PUERTO_RICO | "Puerto Rico" |
+| AMERICA_PUERTO_RICO | "America/Puerto_Rico" |
+| SANTIAGO | "Santiago" |
+| AMERICA_SANTIAGO | "America/Santiago" |
+| NEWFOUNDLAND | "Newfoundland" |
+| AMERICA_ST_JOHNS | "America/St_Johns" |
+| ASUNCION | "Asuncion" |
+| AMERICA_ASUNCION | "America/Asuncion" |
+| BRASILIA | "Brasilia" |
+| AMERICA_SAO_PAULO | "America/Sao_Paulo" |
+| BUENOS_AIRES | "Buenos Aires" |
+| AMERICA_ARGENTINA_BUENOS_AIRES | "America/Argentina/Buenos_Aires" |
+| MONTEVIDEO | "Montevideo" |
+| AMERICA_MONTEVIDEO | "America/Montevideo" |
+| GREENLAND | "Greenland" |
+| AMERICA_NUUK | "America/Nuuk" |
+| MID_ATLANTIC | "Mid-Atlantic" |
+| ATLANTIC_SOUTH_GEORGIA | "Atlantic/South_Georgia" |
+| AZORES | "Azores" |
+| ATLANTIC_AZORES | "Atlantic/Azores" |
+| CAPE_VERDE_IS_ | "Cape Verde Is." |
+| ATLANTIC_CAPE_VERDE | "Atlantic/Cape_Verde" |
+| EDINBURGH | "Edinburgh" |
+| EUROPE_LONDON | "Europe/London" |
+| LISBON | "Lisbon" |
+| EUROPE_LISBON | "Europe/Lisbon" |
+| LONDON | "London" |
+| EUROPE_LONDON2 | "Europe/London" |
+| MONROVIA | "Monrovia" |
+| AFRICA_MONROVIA | "Africa/Monrovia" |
+| UTC | "UTC" |
+| ETC_UTC | "Etc/UTC" |
+| AMSTERDAM | "Amsterdam" |
+| EUROPE_AMSTERDAM | "Europe/Amsterdam" |
+| BELGRADE | "Belgrade" |
+| EUROPE_BELGRADE | "Europe/Belgrade" |
+| BERLIN | "Berlin" |
+| EUROPE_BERLIN | "Europe/Berlin" |
+| BERN | "Bern" |
+| EUROPE_ZURICH | "Europe/Zurich" |
+| BRATISLAVA | "Bratislava" |
+| EUROPE_BRATISLAVA | "Europe/Bratislava" |
+| BRUSSELS | "Brussels" |
+| EUROPE_BRUSSELS | "Europe/Brussels" |
+| BUDAPEST | "Budapest" |
+| EUROPE_BUDAPEST | "Europe/Budapest" |
+| CASABLANCA | "Casablanca" |
+| AFRICA_CASABLANCA | "Africa/Casablanca" |
+| COPENHAGEN | "Copenhagen" |
+| EUROPE_COPENHAGEN | "Europe/Copenhagen" |
+| DUBLIN | "Dublin" |
+| EUROPE_DUBLIN | "Europe/Dublin" |
+| LJUBLJANA | "Ljubljana" |
+| EUROPE_LJUBLJANA | "Europe/Ljubljana" |
+| MADRID | "Madrid" |
+| EUROPE_MADRID | "Europe/Madrid" |
+| PARIS | "Paris" |
+| EUROPE_PARIS | "Europe/Paris" |
+| PRAGUE | "Prague" |
+| EUROPE_PRAGUE | "Europe/Prague" |
+| ROME | "Rome" |
+| EUROPE_ROME | "Europe/Rome" |
+| SARAJEVO | "Sarajevo" |
+| EUROPE_SARAJEVO | "Europe/Sarajevo" |
+| SKOPJE | "Skopje" |
+| EUROPE_SKOPJE | "Europe/Skopje" |
+| STOCKHOLM | "Stockholm" |
+| EUROPE_STOCKHOLM | "Europe/Stockholm" |
+| VIENNA | "Vienna" |
+| EUROPE_VIENNA | "Europe/Vienna" |
+| WARSAW | "Warsaw" |
+| EUROPE_WARSAW | "Europe/Warsaw" |
+| WEST_CENTRAL_AFRICA | "West Central Africa" |
+| AFRICA_ALGIERS | "Africa/Algiers" |
+| ZAGREB | "Zagreb" |
+| EUROPE_ZAGREB | "Europe/Zagreb" |
+| ZURICH | "Zurich" |
+| EUROPE_ZURICH2 | "Europe/Zurich" |
+| ATHENS | "Athens" |
+| EUROPE_ATHENS | "Europe/Athens" |
+| BUCHAREST | "Bucharest" |
+| EUROPE_BUCHAREST | "Europe/Bucharest" |
+| CAIRO | "Cairo" |
+| AFRICA_CAIRO | "Africa/Cairo" |
+| HARARE | "Harare" |
+| AFRICA_HARARE | "Africa/Harare" |
+| HELSINKI | "Helsinki" |
+| EUROPE_HELSINKI | "Europe/Helsinki" |
+| JERUSALEM | "Jerusalem" |
+| ASIA_JERUSALEM | "Asia/Jerusalem" |
+| KALININGRAD | "Kaliningrad" |
+| EUROPE_KALININGRAD | "Europe/Kaliningrad" |
+| KYIV | "Kyiv" |
+| EUROPE_KIEV | "Europe/Kiev" |
+| PRETORIA | "Pretoria" |
+| AFRICA_JOHANNESBURG | "Africa/Johannesburg" |
+| RIGA | "Riga" |
+| EUROPE_RIGA | "Europe/Riga" |
+| SOFIA | "Sofia" |
+| EUROPE_SOFIA | "Europe/Sofia" |
+| TALLINN | "Tallinn" |
+| EUROPE_TALLINN | "Europe/Tallinn" |
+| VILNIUS | "Vilnius" |
+| EUROPE_VILNIUS | "Europe/Vilnius" |
+| BAGHDAD | "Baghdad" |
+| ASIA_BAGHDAD | "Asia/Baghdad" |
+| ISTANBUL | "Istanbul" |
+| EUROPE_ISTANBUL | "Europe/Istanbul" |
+| KUWAIT | "Kuwait" |
+| ASIA_KUWAIT | "Asia/Kuwait" |
+| MINSK | "Minsk" |
+| EUROPE_MINSK | "Europe/Minsk" |
+| MOSCOW | "Moscow" |
+| EUROPE_MOSCOW | "Europe/Moscow" |
+| NAIROBI | "Nairobi" |
+| AFRICA_NAIROBI | "Africa/Nairobi" |
+| RIYADH | "Riyadh" |
+| ASIA_RIYADH | "Asia/Riyadh" |
+| ST_PETERSBURG | "St. Petersburg" |
+| EUROPE_MOSCOW2 | "Europe/Moscow" |
+| VOLGOGRAD | "Volgograd" |
+| EUROPE_VOLGOGRAD | "Europe/Volgograd" |
+| TEHRAN | "Tehran" |
+| ASIA_TEHRAN | "Asia/Tehran" |
+| ABU_DHABI | "Abu Dhabi" |
+| ASIA_MUSCAT | "Asia/Muscat" |
+| BAKU | "Baku" |
+| ASIA_BAKU | "Asia/Baku" |
+| MUSCAT | "Muscat" |
+| ASIA_MUSCAT2 | "Asia/Muscat" |
+| SAMARA | "Samara" |
+| EUROPE_SAMARA | "Europe/Samara" |
+| TBILISI | "Tbilisi" |
+| ASIA_TBILISI | "Asia/Tbilisi" |
+| YEREVAN | "Yerevan" |
+| ASIA_YEREVAN | "Asia/Yerevan" |
+| KABUL | "Kabul" |
+| ASIA_KABUL | "Asia/Kabul" |
+| ALMATY | "Almaty" |
+| ASIA_ALMATY | "Asia/Almaty" |
+| ASTANA | "Astana" |
+| ASIA_ALMATY2 | "Asia/Almaty" |
+| EKATERINBURG | "Ekaterinburg" |
+| ASIA_YEKATERINBURG | "Asia/Yekaterinburg" |
+| ISLAMABAD | "Islamabad" |
+| ASIA_KARACHI | "Asia/Karachi" |
+| KARACHI | "Karachi" |
+| ASIA_KARACHI2 | "Asia/Karachi" |
+| TASHKENT | "Tashkent" |
+| ASIA_TASHKENT | "Asia/Tashkent" |
+| CHENNAI | "Chennai" |
+| ASIA_KOLKATA | "Asia/Kolkata" |
+| KOLKATA | "Kolkata" |
+| ASIA_KOLKATA2 | "Asia/Kolkata" |
+| MUMBAI | "Mumbai" |
+| ASIA_KOLKATA3 | "Asia/Kolkata" |
+| NEW_DELHI | "New Delhi" |
+| ASIA_KOLKATA4 | "Asia/Kolkata" |
+| SRI_JAYAWARDENEPURA | "Sri Jayawardenepura" |
+| ASIA_COLOMBO | "Asia/Colombo" |
+| KATHMANDU | "Kathmandu" |
+| ASIA_KATHMANDU | "Asia/Kathmandu" |
+| DHAKA | "Dhaka" |
+| ASIA_DHAKA | "Asia/Dhaka" |
+| URUMQI | "Urumqi" |
+| ASIA_URUMQI | "Asia/Urumqi" |
+| RANGOON | "Rangoon" |
+| ASIA_RANGOON | "Asia/Rangoon" |
+| BANGKOK | "Bangkok" |
+| ASIA_BANGKOK | "Asia/Bangkok" |
+| HANOI | "Hanoi" |
+| ASIA_BANGKOK2 | "Asia/Bangkok" |
+| JAKARTA | "Jakarta" |
+| ASIA_JAKARTA | "Asia/Jakarta" |
+| KRASNOYARSK | "Krasnoyarsk" |
+| ASIA_KRASNOYARSK | "Asia/Krasnoyarsk" |
+| NOVOSIBIRSK | "Novosibirsk" |
+| ASIA_NOVOSIBIRSK | "Asia/Novosibirsk" |
+| BEIJING | "Beijing" |
+| ASIA_SHANGHAI | "Asia/Shanghai" |
+| CHONGQING | "Chongqing" |
+| ASIA_CHONGQING | "Asia/Chongqing" |
+| HONG_KONG | "Hong Kong" |
+| ASIA_HONG_KONG | "Asia/Hong_Kong" |
+| IRKUTSK | "Irkutsk" |
+| ASIA_IRKUTSK | "Asia/Irkutsk" |
+| KUALA_LUMPUR | "Kuala Lumpur" |
+| ASIA_KUALA_LUMPUR | "Asia/Kuala_Lumpur" |
+| PERTH | "Perth" |
+| AUSTRALIA_PERTH | "Australia/Perth" |
+| SINGAPORE | "Singapore" |
+| ASIA_SINGAPORE | "Asia/Singapore" |
+| TAIPEI | "Taipei" |
+| ASIA_TAIPEI | "Asia/Taipei" |
+| ULAANBAATAR | "Ulaanbaatar" |
+| ASIA_ULAANBAATAR | "Asia/Ulaanbaatar" |
+| OSAKA | "Osaka" |
+| ASIA_TOKYO | "Asia/Tokyo" |
+| SAPPORO | "Sapporo" |
+| ASIA_TOKYO2 | "Asia/Tokyo" |
+| SEOUL | "Seoul" |
+| ASIA_SEOUL | "Asia/Seoul" |
+| TOKYO | "Tokyo" |
+| ASIA_TOKYO3 | "Asia/Tokyo" |
+| YAKUTSK | "Yakutsk" |
+| ASIA_YAKUTSK | "Asia/Yakutsk" |
+| ADELAIDE | "Adelaide" |
+| AUSTRALIA_ADELAIDE | "Australia/Adelaide" |
+| DARWIN | "Darwin" |
+| AUSTRALIA_DARWIN | "Australia/Darwin" |
+| BRISBANE | "Brisbane" |
+| AUSTRALIA_BRISBANE | "Australia/Brisbane" |
+| CANBERRA | "Canberra" |
+| AUSTRALIA_CANBERRA | "Australia/Canberra" |
+| GUAM | "Guam" |
+| PACIFIC_GUAM | "Pacific/Guam" |
+| HOBART | "Hobart" |
+| AUSTRALIA_HOBART | "Australia/Hobart" |
+| MELBOURNE | "Melbourne" |
+| AUSTRALIA_MELBOURNE | "Australia/Melbourne" |
+| PORT_MORESBY | "Port Moresby" |
+| PACIFIC_PORT_MORESBY | "Pacific/Port_Moresby" |
+| SYDNEY | "Sydney" |
+| AUSTRALIA_SYDNEY | "Australia/Sydney" |
+| VLADIVOSTOK | "Vladivostok" |
+| ASIA_VLADIVOSTOK | "Asia/Vladivostok" |
+| MAGADAN | "Magadan" |
+| ASIA_MAGADAN | "Asia/Magadan" |
+| NEW_CALEDONIA | "New Caledonia" |
+| PACIFIC_NOUMEA | "Pacific/Noumea" |
+| SOLOMON_IS_ | "Solomon Is." |
+| PACIFIC_GUADALCANAL | "Pacific/Guadalcanal" |
+| SREDNEKOLYMSK | "Srednekolymsk" |
+| ASIA_SREDNEKOLYMSK | "Asia/Srednekolymsk" |
+| AUCKLAND | "Auckland" |
+| PACIFIC_AUCKLAND | "Pacific/Auckland" |
+| FIJI | "Fiji" |
+| PACIFIC_FIJI | "Pacific/Fiji" |
+| KAMCHATKA | "Kamchatka" |
+| ASIA_KAMCHATKA | "Asia/Kamchatka" |
+| MARSHALL_IS_ | "Marshall Is." |
+| PACIFIC_MAJURO | "Pacific/Majuro" |
+| WELLINGTON | "Wellington" |
+| PACIFIC_AUCKLAND2 | "Pacific/Auckland" |
+| CHATHAM_IS_ | "Chatham Is." |
+| PACIFIC_CHATHAM | "Pacific/Chatham" |
+| NUKU_ALOFA | "Nuku'alofa" |
+| PACIFIC_TONGATAPU | "Pacific/Tongatapu" |
+| SAMOA | "Samoa" |
+| PACIFIC_APIA | "Pacific/Apia" |
+| TOKELAU_IS_ | "Tokelau Is." |
+| PACIFIC_FAKAOFO | "Pacific/Fakaofo" |
+
+
+
diff --git a/docs/UpdateEscalationPolicyPathDataAttributesRulesInner.md b/docs/UpdateEscalationPolicyPathDataAttributesRulesInner.md
index 4d770409..0b88f708 100644
--- a/docs/UpdateEscalationPolicyPathDataAttributesRulesInner.md
+++ b/docs/UpdateEscalationPolicyPathDataAttributesRulesInner.md
@@ -11,8 +11,14 @@
|**urgencyIds** | **List<String>** | Alert urgency ids for which this escalation path should be used | |
|**withinWorkingHour** | **Boolean** | Whether the escalation path should be used within working hours | |
|**jsonPath** | **String** | JSON path to extract value from payload | |
-|**operator** | [**OperatorEnum**](#OperatorEnum) | How JSON path value should be matched | |
-|**value** | **String** | Value with which JSON path value should be matched | |
+|**operator** | [**OperatorEnum**](#OperatorEnum) | How the alert field value should be matched | |
+|**value** | **String** | Value with which JSON path value should be matched | [optional] |
+|**values** | **List<String>** | Values to match against | [optional] |
+|**fieldableType** | **String** | The type of the fieldable (e.g., AlertField) | |
+|**fieldableId** | **String** | The ID of the alert field | |
+|**serviceIds** | **List<String>** | Service ids for which this escalation path should be used | |
+|**timeZone** | [**TimeZoneEnum**](#TimeZoneEnum) | Time zone for the deferral window | |
+|**timeBlocks** | [**List<NewEscalationPolicyPathDataAttributesRulesInnerOneOf5TimeBlocksInner>**](NewEscalationPolicyPathDataAttributesRulesInnerOneOf5TimeBlocksInner.md) | Time windows during which alerts are deferred | |
@@ -20,7 +26,7 @@
| Name | Value |
|---- | -----|
-| JSON_PATH | "json_path" |
+| DEFERRAL_WINDOW | "deferral_window" |
@@ -30,8 +36,329 @@
|---- | -----|
| IS | "is" |
| IS_NOT | "is_not" |
+| IS_ONE_OF | "is_one_of" |
+| IS_NOT_ONE_OF | "is_not_one_of" |
| CONTAINS | "contains" |
| DOES_NOT_CONTAIN | "does_not_contain" |
+| IS_EMPTY | "is_empty" |
+| IS_NOT_EMPTY | "is_not_empty" |
+| CONTAINS_KEY | "contains_key" |
+| DOES_NOT_CONTAIN_KEY | "does_not_contain_key" |
+| STARTS_WITH | "starts_with" |
+| DOES_NOT_START_WITH | "does_not_start_with" |
+| MATCHES | "matches" |
+| DOES_NOT_MATCH | "does_not_match" |
+
+
+
+## Enum: TimeZoneEnum
+
+| Name | Value |
+|---- | -----|
+| INTERNATIONAL_DATE_LINE_WEST | "International Date Line West" |
+| ETC_GMT_12 | "Etc/GMT+12" |
+| AMERICAN_SAMOA | "American Samoa" |
+| PACIFIC_PAGO_PAGO | "Pacific/Pago_Pago" |
+| MIDWAY_ISLAND | "Midway Island" |
+| PACIFIC_MIDWAY | "Pacific/Midway" |
+| HAWAII | "Hawaii" |
+| PACIFIC_HONOLULU | "Pacific/Honolulu" |
+| ALASKA | "Alaska" |
+| AMERICA_JUNEAU | "America/Juneau" |
+| PACIFIC_TIME_US_CANADA_ | "Pacific Time (US & Canada)" |
+| AMERICA_LOS_ANGELES | "America/Los_Angeles" |
+| TIJUANA | "Tijuana" |
+| AMERICA_TIJUANA | "America/Tijuana" |
+| ARIZONA | "Arizona" |
+| AMERICA_PHOENIX | "America/Phoenix" |
+| MAZATLAN | "Mazatlan" |
+| AMERICA_MAZATLAN | "America/Mazatlan" |
+| MOUNTAIN_TIME_US_CANADA_ | "Mountain Time (US & Canada)" |
+| AMERICA_DENVER | "America/Denver" |
+| CENTRAL_AMERICA | "Central America" |
+| AMERICA_GUATEMALA | "America/Guatemala" |
+| CENTRAL_TIME_US_CANADA_ | "Central Time (US & Canada)" |
+| AMERICA_CHICAGO | "America/Chicago" |
+| CHIHUAHUA | "Chihuahua" |
+| AMERICA_CHIHUAHUA | "America/Chihuahua" |
+| GUADALAJARA | "Guadalajara" |
+| AMERICA_MEXICO_CITY | "America/Mexico_City" |
+| MEXICO_CITY | "Mexico City" |
+| AMERICA_MEXICO_CITY2 | "America/Mexico_City" |
+| MONTERREY | "Monterrey" |
+| AMERICA_MONTERREY | "America/Monterrey" |
+| SASKATCHEWAN | "Saskatchewan" |
+| AMERICA_REGINA | "America/Regina" |
+| BOGOTA | "Bogota" |
+| AMERICA_BOGOTA | "America/Bogota" |
+| EASTERN_TIME_US_CANADA_ | "Eastern Time (US & Canada)" |
+| AMERICA_NEW_YORK | "America/New_York" |
+| INDIANA_EAST_ | "Indiana (East)" |
+| AMERICA_INDIANA_INDIANAPOLIS | "America/Indiana/Indianapolis" |
+| LIMA | "Lima" |
+| AMERICA_LIMA | "America/Lima" |
+| QUITO | "Quito" |
+| AMERICA_LIMA2 | "America/Lima" |
+| ATLANTIC_TIME_CANADA_ | "Atlantic Time (Canada)" |
+| AMERICA_HALIFAX | "America/Halifax" |
+| CARACAS | "Caracas" |
+| AMERICA_CARACAS | "America/Caracas" |
+| GEORGETOWN | "Georgetown" |
+| AMERICA_GUYANA | "America/Guyana" |
+| LA_PAZ | "La Paz" |
+| AMERICA_LA_PAZ | "America/La_Paz" |
+| PUERTO_RICO | "Puerto Rico" |
+| AMERICA_PUERTO_RICO | "America/Puerto_Rico" |
+| SANTIAGO | "Santiago" |
+| AMERICA_SANTIAGO | "America/Santiago" |
+| NEWFOUNDLAND | "Newfoundland" |
+| AMERICA_ST_JOHNS | "America/St_Johns" |
+| ASUNCION | "Asuncion" |
+| AMERICA_ASUNCION | "America/Asuncion" |
+| BRASILIA | "Brasilia" |
+| AMERICA_SAO_PAULO | "America/Sao_Paulo" |
+| BUENOS_AIRES | "Buenos Aires" |
+| AMERICA_ARGENTINA_BUENOS_AIRES | "America/Argentina/Buenos_Aires" |
+| MONTEVIDEO | "Montevideo" |
+| AMERICA_MONTEVIDEO | "America/Montevideo" |
+| GREENLAND | "Greenland" |
+| AMERICA_NUUK | "America/Nuuk" |
+| MID_ATLANTIC | "Mid-Atlantic" |
+| ATLANTIC_SOUTH_GEORGIA | "Atlantic/South_Georgia" |
+| AZORES | "Azores" |
+| ATLANTIC_AZORES | "Atlantic/Azores" |
+| CAPE_VERDE_IS_ | "Cape Verde Is." |
+| ATLANTIC_CAPE_VERDE | "Atlantic/Cape_Verde" |
+| EDINBURGH | "Edinburgh" |
+| EUROPE_LONDON | "Europe/London" |
+| LISBON | "Lisbon" |
+| EUROPE_LISBON | "Europe/Lisbon" |
+| LONDON | "London" |
+| EUROPE_LONDON2 | "Europe/London" |
+| MONROVIA | "Monrovia" |
+| AFRICA_MONROVIA | "Africa/Monrovia" |
+| UTC | "UTC" |
+| ETC_UTC | "Etc/UTC" |
+| AMSTERDAM | "Amsterdam" |
+| EUROPE_AMSTERDAM | "Europe/Amsterdam" |
+| BELGRADE | "Belgrade" |
+| EUROPE_BELGRADE | "Europe/Belgrade" |
+| BERLIN | "Berlin" |
+| EUROPE_BERLIN | "Europe/Berlin" |
+| BERN | "Bern" |
+| EUROPE_ZURICH | "Europe/Zurich" |
+| BRATISLAVA | "Bratislava" |
+| EUROPE_BRATISLAVA | "Europe/Bratislava" |
+| BRUSSELS | "Brussels" |
+| EUROPE_BRUSSELS | "Europe/Brussels" |
+| BUDAPEST | "Budapest" |
+| EUROPE_BUDAPEST | "Europe/Budapest" |
+| CASABLANCA | "Casablanca" |
+| AFRICA_CASABLANCA | "Africa/Casablanca" |
+| COPENHAGEN | "Copenhagen" |
+| EUROPE_COPENHAGEN | "Europe/Copenhagen" |
+| DUBLIN | "Dublin" |
+| EUROPE_DUBLIN | "Europe/Dublin" |
+| LJUBLJANA | "Ljubljana" |
+| EUROPE_LJUBLJANA | "Europe/Ljubljana" |
+| MADRID | "Madrid" |
+| EUROPE_MADRID | "Europe/Madrid" |
+| PARIS | "Paris" |
+| EUROPE_PARIS | "Europe/Paris" |
+| PRAGUE | "Prague" |
+| EUROPE_PRAGUE | "Europe/Prague" |
+| ROME | "Rome" |
+| EUROPE_ROME | "Europe/Rome" |
+| SARAJEVO | "Sarajevo" |
+| EUROPE_SARAJEVO | "Europe/Sarajevo" |
+| SKOPJE | "Skopje" |
+| EUROPE_SKOPJE | "Europe/Skopje" |
+| STOCKHOLM | "Stockholm" |
+| EUROPE_STOCKHOLM | "Europe/Stockholm" |
+| VIENNA | "Vienna" |
+| EUROPE_VIENNA | "Europe/Vienna" |
+| WARSAW | "Warsaw" |
+| EUROPE_WARSAW | "Europe/Warsaw" |
+| WEST_CENTRAL_AFRICA | "West Central Africa" |
+| AFRICA_ALGIERS | "Africa/Algiers" |
+| ZAGREB | "Zagreb" |
+| EUROPE_ZAGREB | "Europe/Zagreb" |
+| ZURICH | "Zurich" |
+| EUROPE_ZURICH2 | "Europe/Zurich" |
+| ATHENS | "Athens" |
+| EUROPE_ATHENS | "Europe/Athens" |
+| BUCHAREST | "Bucharest" |
+| EUROPE_BUCHAREST | "Europe/Bucharest" |
+| CAIRO | "Cairo" |
+| AFRICA_CAIRO | "Africa/Cairo" |
+| HARARE | "Harare" |
+| AFRICA_HARARE | "Africa/Harare" |
+| HELSINKI | "Helsinki" |
+| EUROPE_HELSINKI | "Europe/Helsinki" |
+| JERUSALEM | "Jerusalem" |
+| ASIA_JERUSALEM | "Asia/Jerusalem" |
+| KALININGRAD | "Kaliningrad" |
+| EUROPE_KALININGRAD | "Europe/Kaliningrad" |
+| KYIV | "Kyiv" |
+| EUROPE_KIEV | "Europe/Kiev" |
+| PRETORIA | "Pretoria" |
+| AFRICA_JOHANNESBURG | "Africa/Johannesburg" |
+| RIGA | "Riga" |
+| EUROPE_RIGA | "Europe/Riga" |
+| SOFIA | "Sofia" |
+| EUROPE_SOFIA | "Europe/Sofia" |
+| TALLINN | "Tallinn" |
+| EUROPE_TALLINN | "Europe/Tallinn" |
+| VILNIUS | "Vilnius" |
+| EUROPE_VILNIUS | "Europe/Vilnius" |
+| BAGHDAD | "Baghdad" |
+| ASIA_BAGHDAD | "Asia/Baghdad" |
+| ISTANBUL | "Istanbul" |
+| EUROPE_ISTANBUL | "Europe/Istanbul" |
+| KUWAIT | "Kuwait" |
+| ASIA_KUWAIT | "Asia/Kuwait" |
+| MINSK | "Minsk" |
+| EUROPE_MINSK | "Europe/Minsk" |
+| MOSCOW | "Moscow" |
+| EUROPE_MOSCOW | "Europe/Moscow" |
+| NAIROBI | "Nairobi" |
+| AFRICA_NAIROBI | "Africa/Nairobi" |
+| RIYADH | "Riyadh" |
+| ASIA_RIYADH | "Asia/Riyadh" |
+| ST_PETERSBURG | "St. Petersburg" |
+| EUROPE_MOSCOW2 | "Europe/Moscow" |
+| VOLGOGRAD | "Volgograd" |
+| EUROPE_VOLGOGRAD | "Europe/Volgograd" |
+| TEHRAN | "Tehran" |
+| ASIA_TEHRAN | "Asia/Tehran" |
+| ABU_DHABI | "Abu Dhabi" |
+| ASIA_MUSCAT | "Asia/Muscat" |
+| BAKU | "Baku" |
+| ASIA_BAKU | "Asia/Baku" |
+| MUSCAT | "Muscat" |
+| ASIA_MUSCAT2 | "Asia/Muscat" |
+| SAMARA | "Samara" |
+| EUROPE_SAMARA | "Europe/Samara" |
+| TBILISI | "Tbilisi" |
+| ASIA_TBILISI | "Asia/Tbilisi" |
+| YEREVAN | "Yerevan" |
+| ASIA_YEREVAN | "Asia/Yerevan" |
+| KABUL | "Kabul" |
+| ASIA_KABUL | "Asia/Kabul" |
+| ALMATY | "Almaty" |
+| ASIA_ALMATY | "Asia/Almaty" |
+| ASTANA | "Astana" |
+| ASIA_ALMATY2 | "Asia/Almaty" |
+| EKATERINBURG | "Ekaterinburg" |
+| ASIA_YEKATERINBURG | "Asia/Yekaterinburg" |
+| ISLAMABAD | "Islamabad" |
+| ASIA_KARACHI | "Asia/Karachi" |
+| KARACHI | "Karachi" |
+| ASIA_KARACHI2 | "Asia/Karachi" |
+| TASHKENT | "Tashkent" |
+| ASIA_TASHKENT | "Asia/Tashkent" |
+| CHENNAI | "Chennai" |
+| ASIA_KOLKATA | "Asia/Kolkata" |
+| KOLKATA | "Kolkata" |
+| ASIA_KOLKATA2 | "Asia/Kolkata" |
+| MUMBAI | "Mumbai" |
+| ASIA_KOLKATA3 | "Asia/Kolkata" |
+| NEW_DELHI | "New Delhi" |
+| ASIA_KOLKATA4 | "Asia/Kolkata" |
+| SRI_JAYAWARDENEPURA | "Sri Jayawardenepura" |
+| ASIA_COLOMBO | "Asia/Colombo" |
+| KATHMANDU | "Kathmandu" |
+| ASIA_KATHMANDU | "Asia/Kathmandu" |
+| DHAKA | "Dhaka" |
+| ASIA_DHAKA | "Asia/Dhaka" |
+| URUMQI | "Urumqi" |
+| ASIA_URUMQI | "Asia/Urumqi" |
+| RANGOON | "Rangoon" |
+| ASIA_RANGOON | "Asia/Rangoon" |
+| BANGKOK | "Bangkok" |
+| ASIA_BANGKOK | "Asia/Bangkok" |
+| HANOI | "Hanoi" |
+| ASIA_BANGKOK2 | "Asia/Bangkok" |
+| JAKARTA | "Jakarta" |
+| ASIA_JAKARTA | "Asia/Jakarta" |
+| KRASNOYARSK | "Krasnoyarsk" |
+| ASIA_KRASNOYARSK | "Asia/Krasnoyarsk" |
+| NOVOSIBIRSK | "Novosibirsk" |
+| ASIA_NOVOSIBIRSK | "Asia/Novosibirsk" |
+| BEIJING | "Beijing" |
+| ASIA_SHANGHAI | "Asia/Shanghai" |
+| CHONGQING | "Chongqing" |
+| ASIA_CHONGQING | "Asia/Chongqing" |
+| HONG_KONG | "Hong Kong" |
+| ASIA_HONG_KONG | "Asia/Hong_Kong" |
+| IRKUTSK | "Irkutsk" |
+| ASIA_IRKUTSK | "Asia/Irkutsk" |
+| KUALA_LUMPUR | "Kuala Lumpur" |
+| ASIA_KUALA_LUMPUR | "Asia/Kuala_Lumpur" |
+| PERTH | "Perth" |
+| AUSTRALIA_PERTH | "Australia/Perth" |
+| SINGAPORE | "Singapore" |
+| ASIA_SINGAPORE | "Asia/Singapore" |
+| TAIPEI | "Taipei" |
+| ASIA_TAIPEI | "Asia/Taipei" |
+| ULAANBAATAR | "Ulaanbaatar" |
+| ASIA_ULAANBAATAR | "Asia/Ulaanbaatar" |
+| OSAKA | "Osaka" |
+| ASIA_TOKYO | "Asia/Tokyo" |
+| SAPPORO | "Sapporo" |
+| ASIA_TOKYO2 | "Asia/Tokyo" |
+| SEOUL | "Seoul" |
+| ASIA_SEOUL | "Asia/Seoul" |
+| TOKYO | "Tokyo" |
+| ASIA_TOKYO3 | "Asia/Tokyo" |
+| YAKUTSK | "Yakutsk" |
+| ASIA_YAKUTSK | "Asia/Yakutsk" |
+| ADELAIDE | "Adelaide" |
+| AUSTRALIA_ADELAIDE | "Australia/Adelaide" |
+| DARWIN | "Darwin" |
+| AUSTRALIA_DARWIN | "Australia/Darwin" |
+| BRISBANE | "Brisbane" |
+| AUSTRALIA_BRISBANE | "Australia/Brisbane" |
+| CANBERRA | "Canberra" |
+| AUSTRALIA_CANBERRA | "Australia/Canberra" |
+| GUAM | "Guam" |
+| PACIFIC_GUAM | "Pacific/Guam" |
+| HOBART | "Hobart" |
+| AUSTRALIA_HOBART | "Australia/Hobart" |
+| MELBOURNE | "Melbourne" |
+| AUSTRALIA_MELBOURNE | "Australia/Melbourne" |
+| PORT_MORESBY | "Port Moresby" |
+| PACIFIC_PORT_MORESBY | "Pacific/Port_Moresby" |
+| SYDNEY | "Sydney" |
+| AUSTRALIA_SYDNEY | "Australia/Sydney" |
+| VLADIVOSTOK | "Vladivostok" |
+| ASIA_VLADIVOSTOK | "Asia/Vladivostok" |
+| MAGADAN | "Magadan" |
+| ASIA_MAGADAN | "Asia/Magadan" |
+| NEW_CALEDONIA | "New Caledonia" |
+| PACIFIC_NOUMEA | "Pacific/Noumea" |
+| SOLOMON_IS_ | "Solomon Is." |
+| PACIFIC_GUADALCANAL | "Pacific/Guadalcanal" |
+| SREDNEKOLYMSK | "Srednekolymsk" |
+| ASIA_SREDNEKOLYMSK | "Asia/Srednekolymsk" |
+| AUCKLAND | "Auckland" |
+| PACIFIC_AUCKLAND | "Pacific/Auckland" |
+| FIJI | "Fiji" |
+| PACIFIC_FIJI | "Pacific/Fiji" |
+| KAMCHATKA | "Kamchatka" |
+| ASIA_KAMCHATKA | "Asia/Kamchatka" |
+| MARSHALL_IS_ | "Marshall Is." |
+| PACIFIC_MAJURO | "Pacific/Majuro" |
+| WELLINGTON | "Wellington" |
+| PACIFIC_AUCKLAND2 | "Pacific/Auckland" |
+| CHATHAM_IS_ | "Chatham Is." |
+| PACIFIC_CHATHAM | "Pacific/Chatham" |
+| NUKU_ALOFA | "Nuku'alofa" |
+| PACIFIC_TONGATAPU | "Pacific/Tongatapu" |
+| SAMOA | "Samoa" |
+| PACIFIC_APIA | "Pacific/Apia" |
+| TOKELAU_IS_ | "Tokelau Is." |
+| PACIFIC_FAKAOFO | "Pacific/Fakaofo" |
diff --git a/docs/UpdateEscalationPolicyPathDataAttributesTimeRestrictionsInner.md b/docs/UpdateEscalationPolicyPathDataAttributesTimeRestrictionsInner.md
new file mode 100644
index 00000000..2bbfec6a
--- /dev/null
+++ b/docs/UpdateEscalationPolicyPathDataAttributesTimeRestrictionsInner.md
@@ -0,0 +1,44 @@
+
+
+# UpdateEscalationPolicyPathDataAttributesTimeRestrictionsInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**startDay** | [**StartDayEnum**](#StartDayEnum) | | [optional] |
+|**startTime** | **String** | Formatted as HH:MM | [optional] |
+|**endDay** | [**EndDayEnum**](#EndDayEnum) | | [optional] |
+|**endTime** | **String** | Formatted as HH:MM | [optional] |
+
+
+
+## Enum: StartDayEnum
+
+| Name | Value |
+|---- | -----|
+| MONDAY | "monday" |
+| TUESDAY | "tuesday" |
+| WEDNESDAY | "wednesday" |
+| THURSDAY | "thursday" |
+| FRIDAY | "friday" |
+| SATURDAY | "saturday" |
+| SUNDAY | "sunday" |
+
+
+
+## Enum: EndDayEnum
+
+| Name | Value |
+|---- | -----|
+| MONDAY | "monday" |
+| TUESDAY | "tuesday" |
+| WEDNESDAY | "wednesday" |
+| THURSDAY | "thursday" |
+| FRIDAY | "friday" |
+| SATURDAY | "saturday" |
+| SUNDAY | "sunday" |
+
+
+
diff --git a/docs/UpdateFormFieldDataAttributes.md b/docs/UpdateFormFieldDataAttributes.md
index 7506766f..7379567f 100644
--- a/docs/UpdateFormFieldDataAttributes.md
+++ b/docs/UpdateFormFieldDataAttributes.md
@@ -18,6 +18,7 @@
|**showOnIncidentDetails** | **Boolean** | Whether the form field is shown on the incident details panel | [optional] |
|**enabled** | **Boolean** | Whether the form field is enabled | [optional] |
|**defaultValues** | **List<String>** | | [optional] |
+|**autoSetByCatalogPropertyId** | **String** | Catalog property ID to auto-set this form field. Only reference-kind catalog properties are supported. | [optional] |
@@ -53,6 +54,7 @@
| MITIGATED_AT | "mitigated_at" |
| RESOLVED_AT | "resolved_at" |
| CLOSED_AT | "closed_at" |
+| CUSTOM_SUB_STATUS | "custom_sub_status" |
| MANUAL_STARTING_DATETIME_FIELD | "manual_starting_datetime_field" |
@@ -84,6 +86,9 @@
| FUNCTIONALITY | "functionality" |
| USER | "user" |
| CATALOG_ENTITY | "catalog_entity" |
+| ENVIRONMENT | "environment" |
+| CAUSE | "cause" |
+| INCIDENT_TYPE | "incident_type" |
diff --git a/docs/UpdateFormFieldOptionDataAttributes.md b/docs/UpdateFormFieldOptionDataAttributes.md
index 5103f77b..90171fd1 100644
--- a/docs/UpdateFormFieldOptionDataAttributes.md
+++ b/docs/UpdateFormFieldOptionDataAttributes.md
@@ -7,10 +7,10 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
-|**value** | **String** | The value of the form_field_option | [optional] |
-|**color** | **String** | The hex color of the form_field_option | [optional] |
+|**value** | **String** | The value of the form field option | [optional] |
+|**color** | **String** | The hex color of the form field option | [optional] |
|**_default** | **Boolean** | | [optional] |
-|**position** | **Integer** | The position of the form_field_option | [optional] |
+|**position** | **Integer** | The position of the form field option | [optional] |
diff --git a/docs/UpdateFormFieldPlacementConditionDataAttributes.md b/docs/UpdateFormFieldPlacementConditionDataAttributes.md
index e650c734..5c4c13de 100644
--- a/docs/UpdateFormFieldPlacementConditionDataAttributes.md
+++ b/docs/UpdateFormFieldPlacementConditionDataAttributes.md
@@ -29,6 +29,7 @@
| Name | Value |
|---- | -----|
| EQUAL | "equal" |
+| NOT_EQUAL | "not_equal" |
| IS_SET | "is_set" |
| IS_NOT_SET | "is_not_set" |
diff --git a/docs/UpdateFormFieldPlacementDataAttributes.md b/docs/UpdateFormFieldPlacementDataAttributes.md
index 2ec7eb8a..9a325749 100644
--- a/docs/UpdateFormFieldPlacementDataAttributes.md
+++ b/docs/UpdateFormFieldPlacementDataAttributes.md
@@ -13,6 +13,7 @@
|**required** | **Boolean** | Whether the field is unconditionally required on this form. | [optional] |
|**requiredOperator** | [**RequiredOperatorEnum**](#RequiredOperatorEnum) | Logical operator when evaluating multiple form_field_placement_conditions with conditioned=required | [optional] |
|**placementOperator** | [**PlacementOperatorEnum**](#PlacementOperatorEnum) | Logical operator when evaluating multiple form_field_placement_conditions with conditioned=placement | [optional] |
+|**nonEditable** | **Boolean** | Whether the field is read-only and cannot be edited by users. | [optional] |
diff --git a/docs/UpdateFunctionalityDataAttributes.md b/docs/UpdateFunctionalityDataAttributes.md
index b8c99956..70e9de40 100644
--- a/docs/UpdateFunctionalityDataAttributes.md
+++ b/docs/UpdateFunctionalityDataAttributes.md
@@ -22,10 +22,12 @@
|**serviceNowCiSysId** | **String** | The Service Now CI sys id associated to this functionality | [optional] |
|**environmentIds** | **List<String>** | Environments associated with this functionality | [optional] |
|**serviceIds** | **List<String>** | Services associated with this functionality | [optional] |
-|**ownersGroupIds** | **List<String>** | Owner Teams associated with this functionality | [optional] |
-|**ownersUserIds** | **List<Integer>** | Owner Users associated with this functionality | [optional] |
+|**ownerGroupIds** | **List<String>** | Owner Teams associated with this functionality | [optional] |
+|**ownerUserIds** | **List<Integer>** | Owner Users associated with this functionality | [optional] |
+|**escalationPolicyId** | **String** | The escalation policy id of the functionality | [optional] |
|**slackChannels** | [**List<NewEnvironmentDataAttributesSlackChannelsInner>**](NewEnvironmentDataAttributesSlackChannelsInner.md) | Slack Channels associated with this functionality | [optional] |
|**slackAliases** | [**List<NewEnvironmentDataAttributesSlackAliasesInner>**](NewEnvironmentDataAttributesSlackAliasesInner.md) | Slack Aliases associated with this functionality | [optional] |
+|**properties** | [**List<NewCauseDataAttributesPropertiesInner>**](NewCauseDataAttributesPropertiesInner.md) | Array of property values for this functionality. | [optional] |
diff --git a/docs/UpdateGithubIssueTaskParams.md b/docs/UpdateGithubIssueTaskParams.md
index 5ade195d..900f03a4 100644
--- a/docs/UpdateGithubIssueTaskParams.md
+++ b/docs/UpdateGithubIssueTaskParams.md
@@ -9,8 +9,12 @@
|------------ | ------------- | ------------- | -------------|
|**taskType** | [**TaskTypeEnum**](#TaskTypeEnum) | | [optional] |
|**issueId** | **String** | The issue id | |
+|**repository** | [**UpdateGithubIssueTaskParamsRepository**](UpdateGithubIssueTaskParamsRepository.md) | | [optional] |
|**title** | **String** | The issue title | [optional] |
|**body** | **String** | The issue body | [optional] |
+|**labels** | [**List<AddActionItemTaskParamsPostToSlackChannelsInner>**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | The issue labels | [optional] |
+|**labelsMode** | [**LabelsModeEnum**](#LabelsModeEnum) | How to apply labels. 'replace' (default) overwrites all existing labels. 'append' adds to existing labels without removing them. | [optional] |
+|**issueType** | [**CreateGithubIssueTaskParamsIssueType**](CreateGithubIssueTaskParamsIssueType.md) | | [optional] |
|**completion** | [**AddActionItemTaskParamsPostToSlackChannelsInner**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | |
@@ -23,3 +27,12 @@
+## Enum: LabelsModeEnum
+
+| Name | Value |
+|---- | -----|
+| REPLACE | "replace" |
+| APPEND | "append" |
+
+
+
diff --git a/docs/UpdateGithubIssueTaskParamsRepository.md b/docs/UpdateGithubIssueTaskParamsRepository.md
new file mode 100644
index 00000000..b1f4b81e
--- /dev/null
+++ b/docs/UpdateGithubIssueTaskParamsRepository.md
@@ -0,0 +1,15 @@
+
+
+# UpdateGithubIssueTaskParamsRepository
+
+The repository (used for loading labels and issue types)
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | | [optional] |
+|**name** | **String** | | [optional] |
+
+
+
diff --git a/docs/UpdateHeartbeatDataAttributes.md b/docs/UpdateHeartbeatDataAttributes.md
index 535d7647..34fd2e5f 100644
--- a/docs/UpdateHeartbeatDataAttributes.md
+++ b/docs/UpdateHeartbeatDataAttributes.md
@@ -10,11 +10,12 @@
|**name** | **String** | The name of the heartbeat | [optional] |
|**description** | **String** | The description of the heartbeat | [optional] |
|**alertSummary** | **String** | Summary of alerts triggered when heartbeat expires. | [optional] |
+|**alertDescription** | **String** | Description of alerts triggered when heartbeat expires. | [optional] |
|**alertUrgencyId** | **String** | Urgency of alerts triggered when heartbeat expires. | [optional] |
|**interval** | **Integer** | | [optional] |
|**intervalUnit** | [**IntervalUnitEnum**](#IntervalUnitEnum) | | [optional] |
|**notificationTargetId** | **String** | | [optional] |
-|**notificationTargetType** | [**NotificationTargetTypeEnum**](#NotificationTargetTypeEnum) | | [optional] |
+|**notificationTargetType** | [**NotificationTargetTypeEnum**](#NotificationTargetTypeEnum) | The type of the notification target. Please contact support if you encounter issues using `Functionality` as a target type. | [optional] |
|**enabled** | **Boolean** | Whether to trigger alerts when heartbeat is expired. | [optional] |
@@ -23,9 +24,9 @@
| Name | Value |
|---- | -----|
-| SECONDS | "seconds" |
| MINUTES | "minutes" |
| HOURS | "hours" |
+| DAYS | "days" |
@@ -37,6 +38,7 @@
| GROUP | "Group" |
| SERVICE | "Service" |
| ESCALATION_POLICY | "EscalationPolicy" |
+| FUNCTIONALITY | "Functionality" |
diff --git a/docs/UpdateIncidentActionItemDataAttributes.md b/docs/UpdateIncidentActionItemDataAttributes.md
index 7581ae1e..12974fed 100644
--- a/docs/UpdateIncidentActionItemDataAttributes.md
+++ b/docs/UpdateIncidentActionItemDataAttributes.md
@@ -16,6 +16,7 @@
|**status** | [**StatusEnum**](#StatusEnum) | The status of the action item | [optional] |
|**dueDate** | **String** | The due date of the action item | [optional] |
|**jiraIssueId** | **String** | The Jira issue ID. | [optional] |
+|**jiraIssueKey** | **String** | The Jira issue key. | [optional] |
|**jiraIssueUrl** | **String** | The Jira issue URL. | [optional] |
diff --git a/docs/UpdateIncidentDataAttributes.md b/docs/UpdateIncidentDataAttributes.md
index 8905fe3b..6d37b384 100644
--- a/docs/UpdateIncidentDataAttributes.md
+++ b/docs/UpdateIncidentDataAttributes.md
@@ -15,16 +15,25 @@
|**status** | [**StatusEnum**](#StatusEnum) | The status of the incident | [optional] |
|**_private** | **Boolean** | Convert the incident as private. Once an incident is updated as private it cannot be undone | [optional] |
|**severityId** | **String** | The Severity ID to attach to the incident | [optional] |
-|**environmentIds** | **List<String>** | The Environment ID's to attach to the incident | [optional] |
-|**incidentTypeIds** | **List<String>** | The Incident Type ID's to attach to the incident | [optional] |
-|**serviceIds** | **List<String>** | The Service ID's to attach to the incident | [optional] |
-|**functionalityIds** | **List<String>** | The Functionality ID's to attach to the incident | [optional] |
-|**groupIds** | **List<String>** | The Team ID's to attach to the incident | [optional] |
-|**causeIds** | **List<String>** | The Cause ID's to attach to the incident | [optional] |
+|**publicTitle** | **String** | The public title of the incident | [optional] |
+|**alertIds** | **List<String>** | The Alert IDs to attach to the incident | [optional] |
+|**environmentIds** | **List<String>** | The Environment IDs to attach to the incident | [optional] |
+|**incidentTypeIds** | **List<String>** | The Incident Type IDs to attach to the incident | [optional] |
+|**serviceIds** | **List<String>** | The Service IDs to attach to the incident | [optional] |
+|**functionalityIds** | **List<String>** | The Functionality IDs to attach to the incident | [optional] |
+|**mutedServiceIds** | **List<String>** | The Service IDs to mute alerts for during maintenance. Alerts for these services will still be triggered and attached to the incident, but won't page responders. | [optional] |
+|**groupIds** | **List<String>** | The Team IDs to attach to the incident | [optional] |
+|**causeIds** | **List<String>** | The Cause IDs to attach to the incident | [optional] |
|**labels** | **Object** | Labels to attach to the incidents. eg: {\"platform\":\"osx\", \"version\": \"1.29\"} | [optional] |
|**slackChannelId** | **String** | Slack channel id | [optional] |
|**slackChannelName** | **String** | Slack channel name | [optional] |
|**slackChannelUrl** | **String** | Slack channel url | [optional] |
+|**slackChannelArchived** | **Boolean** | Whether the Slack channel is archived | [optional] |
+|**googleDriveParentId** | **String** | Google Drive parent folder ID | [optional] |
+|**googleDriveUrl** | **String** | Google Drive URL | [optional] |
+|**jiraIssueKey** | **String** | Jira issue key | [optional] |
+|**jiraIssueId** | **String** | Jira issue ID | [optional] |
+|**jiraIssueUrl** | **String** | Jira issue URL | [optional] |
|**scheduledFor** | **String** | Date of when the maintenance begins | [optional] |
|**scheduledUntil** | **String** | Date of when the maintenance ends | [optional] |
|**inTriageAt** | **String** | Date of triage | [optional] |
@@ -33,7 +42,11 @@
|**acknowledgedAt** | **String** | Date of acknowledgment | [optional] |
|**mitigatedAt** | **String** | Date of mitigation | [optional] |
|**resolvedAt** | **String** | Date of resolution | [optional] |
+|**closedAt** | **String** | Date of closure | [optional] |
|**cancelledAt** | **String** | Date of cancellation | [optional] |
+|**mitigationMessage** | **String** | How was the incident mitigated? | [optional] |
+|**resolutionMessage** | **String** | How was the incident resolved? | [optional] |
+|**cancellationMessage** | **String** | Why was the incident cancelled? | [optional] |
@@ -49,6 +62,7 @@
| NORMAL_SUB | "normal_sub" |
| BACKFILLED | "backfilled" |
| SCHEDULED | "scheduled" |
+| SCHEDULED_SUB | "scheduled_sub" |
diff --git a/docs/UpdateIncidentFormFieldSelectionDataAttributes.md b/docs/UpdateIncidentFormFieldSelectionDataAttributes.md
index 376bb6fd..52b1bebf 100644
--- a/docs/UpdateIncidentFormFieldSelectionDataAttributes.md
+++ b/docs/UpdateIncidentFormFieldSelectionDataAttributes.md
@@ -14,6 +14,9 @@
|**selectedServiceIds** | **List<String>** | | [optional] |
|**selectedFunctionalityIds** | **List<String>** | | [optional] |
|**selectedUserIds** | **List<Integer>** | | [optional] |
+|**selectedEnvironmentIds** | **List<String>** | | [optional] |
+|**selectedCauseIds** | **List<String>** | | [optional] |
+|**selectedIncidentTypeIds** | **List<String>** | | [optional] |
diff --git a/docs/UpdateIncidentPermissionSetDataAttributes.md b/docs/UpdateIncidentPermissionSetDataAttributes.md
index 5a473251..0927f2f4 100644
--- a/docs/UpdateIncidentPermissionSetDataAttributes.md
+++ b/docs/UpdateIncidentPermissionSetDataAttributes.md
@@ -8,7 +8,6 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**name** | **String** | The incident permission set name. | [optional] |
-|**slug** | **String** | The incident permission set slug. | [optional] |
|**description** | **String** | The incident permission set description. | [optional] |
|**privateIncidentPermissions** | [**List<PrivateIncidentPermissionsEnum>**](#List<PrivateIncidentPermissionsEnum>) | | [optional] |
|**publicIncidentPermissions** | [**List<PublicIncidentPermissionsEnum>**](#List<PublicIncidentPermissionsEnum>) | | [optional] |
diff --git a/docs/UpdateIncidentPostMortemDataAttributes.md b/docs/UpdateIncidentPostMortemDataAttributes.md
index 3bb1e2f4..ea90372c 100644
--- a/docs/UpdateIncidentPostMortemDataAttributes.md
+++ b/docs/UpdateIncidentPostMortemDataAttributes.md
@@ -22,7 +22,7 @@
|**showGroupsImpacted** | **Boolean** | Show groups impacted of the incident retrospective | [optional] |
|**showAlertsAttached** | **Boolean** | Show alerts attached to the incident | [optional] |
|**showActionItems** | **Boolean** | Show action items (follow-ups) in the incident retrospective | [optional] |
-|**causeIds** | **List<String>** | The Cause ID's to attach to the incident retrospective | [optional] |
+|**causeIds** | **List<String>** | The Cause IDs to attach to the incident retrospective | [optional] |
diff --git a/docs/UpdateIncidentStatusPageEventDataAttributes.md b/docs/UpdateIncidentStatusPageEventDataAttributes.md
index a4b6da2a..e1f4ab2c 100644
--- a/docs/UpdateIncidentStatusPageEventDataAttributes.md
+++ b/docs/UpdateIncidentStatusPageEventDataAttributes.md
@@ -25,7 +25,6 @@
| RESOLVED | "resolved" |
| SCHEDULED | "scheduled" |
| IN_PROGRESS | "in_progress" |
-| VERIFYING | "verifying" |
| COMPLETED | "completed" |
diff --git a/docs/UpdateIncidentTaskParams.md b/docs/UpdateIncidentTaskParams.md
index 3c57a909..38d55cec 100644
--- a/docs/UpdateIncidentTaskParams.md
+++ b/docs/UpdateIncidentTaskParams.md
@@ -15,17 +15,17 @@
|**status** | **String** | | [optional] |
|**severityId** | **String** | | [optional] |
|**incidentTypeIds** | **List<String>** | | [optional] |
-|**serviceIds** | **List<String>** | | [optional] |
-|**functionalityIds** | **List<String>** | | [optional] |
+|**serviceIds** | **List<String>** | Array of service UUIDs | [optional] |
+|**functionalityIds** | **List<String>** | Array of functionality UUIDs | [optional] |
|**environmentIds** | **List<String>** | | [optional] |
-|**groupIds** | **List<String>** | | [optional] |
+|**groupIds** | **List<String>** | Array of group/team UUIDs | [optional] |
|**startedAt** | **String** | | [optional] |
|**detectedAt** | **String** | | [optional] |
|**acknowledgedAt** | **String** | | [optional] |
|**mitigatedAt** | **String** | | [optional] |
|**resolvedAt** | **String** | | [optional] |
|**_private** | **Boolean** | | [optional] |
-|**customFieldsMapping** | **String** | Custom field mappings. Can contain liquid markup and need to be valid JSON | [optional] |
+|**customFieldsMapping** | **String** | Custom field mappings. Can contain liquid markup and need to be valid JSON. Use 'services', 'functionalities', or 'groups' keys with arrays of names/slugs for name/slug lookup | [optional] |
diff --git a/docs/UpdateIncidentTypeDataAttributes.md b/docs/UpdateIncidentTypeDataAttributes.md
index 6306317c..158358b5 100644
--- a/docs/UpdateIncidentTypeDataAttributes.md
+++ b/docs/UpdateIncidentTypeDataAttributes.md
@@ -14,6 +14,7 @@
|**notifyEmails** | **List<String>** | Emails to attach to the incident type | [optional] |
|**slackChannels** | [**List<NewEnvironmentDataAttributesSlackChannelsInner>**](NewEnvironmentDataAttributesSlackChannelsInner.md) | Slack Channels associated with this incident type | [optional] |
|**slackAliases** | [**List<NewEnvironmentDataAttributesSlackAliasesInner>**](NewEnvironmentDataAttributesSlackAliasesInner.md) | Slack Aliases associated with this incident type | [optional] |
+|**properties** | [**List<NewCauseDataAttributesPropertiesInner>**](NewCauseDataAttributesPropertiesInner.md) | Array of property values for this incident type. | [optional] |
diff --git a/docs/UpdateJiraIssueTaskParams.md b/docs/UpdateJiraIssueTaskParams.md
index 64642061..bf699f00 100644
--- a/docs/UpdateJiraIssueTaskParams.md
+++ b/docs/UpdateJiraIssueTaskParams.md
@@ -8,6 +8,7 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**taskType** | [**TaskTypeEnum**](#TaskTypeEnum) | | [optional] |
+|**integration** | [**CreateJiraIssueTaskParamsIntegration**](CreateJiraIssueTaskParamsIntegration.md) | | [optional] |
|**issueId** | **String** | The issue id | |
|**title** | **String** | The issue title | [optional] |
|**description** | **String** | The issue description | [optional] |
diff --git a/docs/UpdateLinearIssueTaskParams.md b/docs/UpdateLinearIssueTaskParams.md
index d780c8e9..1d465968 100644
--- a/docs/UpdateLinearIssueTaskParams.md
+++ b/docs/UpdateLinearIssueTaskParams.md
@@ -11,7 +11,7 @@
|**issueId** | **String** | The issue id | |
|**title** | **String** | The issue title | [optional] |
|**description** | **String** | The issue description | [optional] |
-|**state** | [**CreateLinearIssueTaskParamsState**](CreateLinearIssueTaskParamsState.md) | | [optional] |
+|**state** | [**UpdateLinearIssueTaskParamsState**](UpdateLinearIssueTaskParamsState.md) | | [optional] |
|**project** | [**CreateLinearIssueTaskParamsProject**](CreateLinearIssueTaskParamsProject.md) | | [optional] |
|**labels** | [**List<AddActionItemTaskParamsPostToSlackChannelsInner>**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | [optional] |
|**priority** | [**CreateJiraIssueTaskParamsPriority**](CreateJiraIssueTaskParamsPriority.md) | | [optional] |
diff --git a/docs/UpdateLinearIssueTaskParamsState.md b/docs/UpdateLinearIssueTaskParamsState.md
new file mode 100644
index 00000000..e8d3aa06
--- /dev/null
+++ b/docs/UpdateLinearIssueTaskParamsState.md
@@ -0,0 +1,15 @@
+
+
+# UpdateLinearIssueTaskParamsState
+
+The state id and display name
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | | [optional] |
+|**name** | **String** | | [optional] |
+
+
+
diff --git a/docs/UpdateLiveCallRouterDataAttributes.md b/docs/UpdateLiveCallRouterDataAttributes.md
index df204461..ace792c2 100644
--- a/docs/UpdateLiveCallRouterDataAttributes.md
+++ b/docs/UpdateLiveCallRouterDataAttributes.md
@@ -14,12 +14,15 @@
|**phoneType** | [**PhoneTypeEnum**](#PhoneTypeEnum) | The phone type of the live_call_router | [optional] |
|**voicemailGreeting** | **String** | The voicemail greeting of the live_call_router | [optional] |
|**callerGreeting** | **String** | The caller greeting message of the live_call_router | [optional] |
-|**waitingMusicUrl** | **String** | The waiting music URL of the live_call_router | [optional] |
+|**waitingMusicUrl** | [**WaitingMusicUrlEnum**](#WaitingMusicUrlEnum) | The waiting music URL of the live_call_router | [optional] |
|**sentToVoicemailDelay** | **Integer** | The delay (seconds) after which the caller in redirected to voicemail | [optional] |
|**shouldRedirectToVoicemailOnNoAnswer** | **Boolean** | This prompts the caller to choose voicemail or connect live | [optional] |
|**escalationLevelDelayInSeconds** | **Integer** | This overrides the delay (seconds) in escalation levels | [optional] |
|**shouldAutoResolveAlertOnCallEnd** | **Boolean** | This overrides the delay (seconds) in escalation levels | [optional] |
|**alertUrgencyId** | **String** | This is used in escalation paths to determine who to page | [optional] |
+|**callingTreeEnabled** | **Boolean** | Whether the live call router is configured as a phone tree, requiring callers to press a key before being connected | [optional] |
+|**callingTreePrompt** | **String** | The audio instructions callers will hear when they call this number, prompting them to select from available options to route their call | [optional] |
+|**pagingTargets** | [**List<NewLiveCallRouterDataAttributesPagingTargetsInner>**](NewLiveCallRouterDataAttributesPagingTargetsInner.md) | Paging targets that callers can select from when this live call router is configured as a phone tree. | [optional] |
|**escalationPolicyTriggerParams** | [**UpdateLiveCallRouterDataAttributesEscalationPolicyTriggerParams**](UpdateLiveCallRouterDataAttributesEscalationPolicyTriggerParams.md) | | [optional] |
@@ -37,11 +40,14 @@
| Name | Value |
|---- | -----|
-| US | "US" |
-| GB | "GB" |
-| NZ | "NZ" |
-| CA | "CA" |
| AU | "AU" |
+| CA | "CA" |
+| DE | "DE" |
+| NL | "NL" |
+| NZ | "NZ" |
+| SE | "SE" |
+| GB | "GB" |
+| US | "US" |
@@ -51,6 +57,21 @@
|---- | -----|
| LOCAL | "local" |
| TOLL_FREE | "toll_free" |
+| MOBILE | "mobile" |
+
+
+
+## Enum: WaitingMusicUrlEnum
+
+| Name | Value |
+|---- | -----|
+| HTTPS_STORAGE_ROOTLY_COM_TWILIO_VOICEMAIL_CLOCKWORK_WALTZ_MP3 | "https://storage.rootly.com/twilio/voicemail/ClockworkWaltz.mp3" |
+| HTTPS_STORAGE_ROOTLY_COM_TWILIO_VOICEMAIL_ITH_BRAHMS_116_4_MP3 | "https://storage.rootly.com/twilio/voicemail/ith_brahms-116-4.mp3" |
+| HTTPS_STORAGE_ROOTLY_COM_TWILIO_VOICEMAIL_MELLOTRONIAC___FLIGHT_OF_YOUNG_HEARTS_FLUTE_MP3 | "https://storage.rootly.com/twilio/voicemail/Mellotroniac_-_Flight_Of_Young_Hearts_Flute.mp3" |
+| HTTPS_STORAGE_ROOTLY_COM_TWILIO_VOICEMAIL_BUSY_STRINGS_MP3 | "https://storage.rootly.com/twilio/voicemail/BusyStrings.mp3" |
+| HTTPS_STORAGE_ROOTLY_COM_TWILIO_VOICEMAIL_OLD_DOG___ENDLESS_GOODBYE__28INSTR_29_MP3 | "https://storage.rootly.com/twilio/voicemail/oldDog_-_endless_goodbye_%28instr.%29.mp3" |
+| HTTPS_STORAGE_ROOTLY_COM_TWILIO_VOICEMAIL_MARKOVICHAMP_BORGHESTRAL_MP3 | "https://storage.rootly.com/twilio/voicemail/MARKOVICHAMP-Borghestral.mp3" |
+| HTTPS_STORAGE_ROOTLY_COM_TWILIO_VOICEMAIL_ITH_CHOPIN_15_2_MP3 | "https://storage.rootly.com/twilio/voicemail/ith_chopin-15-2.mp3" |
diff --git a/docs/UpdateLiveCallRouterDataAttributesEscalationPolicyTriggerParams.md b/docs/UpdateLiveCallRouterDataAttributesEscalationPolicyTriggerParams.md
index 42cde610..5e059682 100644
--- a/docs/UpdateLiveCallRouterDataAttributesEscalationPolicyTriggerParams.md
+++ b/docs/UpdateLiveCallRouterDataAttributesEscalationPolicyTriggerParams.md
@@ -8,7 +8,7 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**id** | **String** | The ID of notification target | |
-|**type** | [**TypeEnum**](#TypeEnum) | The type of the notification target | |
+|**type** | [**TypeEnum**](#TypeEnum) | The type of the notification target. Please contact support if you encounter issues using `Functionality` as a target type. | |
@@ -19,6 +19,7 @@
| SERVICE | "Service" |
| GROUP | "Group" |
| ESCALATION_POLICY | "EscalationPolicy" |
+| FUNCTIONALITY | "Functionality" |
diff --git a/docs/UpdateNotionPageTaskParams.md b/docs/UpdateNotionPageTaskParams.md
index a30a8b06..9713b823 100644
--- a/docs/UpdateNotionPageTaskParams.md
+++ b/docs/UpdateNotionPageTaskParams.md
@@ -11,6 +11,7 @@
|**fileId** | **String** | The Notion page ID | |
|**title** | **String** | The Notion page title | [optional] |
|**postMortemTemplateId** | **String** | Retrospective template to use when creating page task, if desired | [optional] |
+|**content** | **String** | Custom page content with liquid templating support. When provided, only this content will be rendered (no default sections) | [optional] |
|**showTimelineAsTable** | **Boolean** | | [optional] |
|**showActionItemsAsTable** | **Boolean** | | [optional] |
diff --git a/docs/UpdateOnCallPayReport.md b/docs/UpdateOnCallPayReport.md
new file mode 100644
index 00000000..168929cf
--- /dev/null
+++ b/docs/UpdateOnCallPayReport.md
@@ -0,0 +1,13 @@
+
+
+# UpdateOnCallPayReport
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**UpdateOnCallPayReportData**](UpdateOnCallPayReportData.md) | | |
+
+
+
diff --git a/docs/UpdateOnCallPayReportData.md b/docs/UpdateOnCallPayReportData.md
new file mode 100644
index 00000000..f1580b97
--- /dev/null
+++ b/docs/UpdateOnCallPayReportData.md
@@ -0,0 +1,22 @@
+
+
+# UpdateOnCallPayReportData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**UpdateOnCallPayReportDataAttributes**](UpdateOnCallPayReportDataAttributes.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| ON_CALL_PAY_REPORTS | "on_call_pay_reports" |
+
+
+
diff --git a/docs/UpdateOnCallPayReportDataAttributes.md b/docs/UpdateOnCallPayReportDataAttributes.md
new file mode 100644
index 00000000..fa107179
--- /dev/null
+++ b/docs/UpdateOnCallPayReportDataAttributes.md
@@ -0,0 +1,15 @@
+
+
+# UpdateOnCallPayReportDataAttributes
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**startDate** | **LocalDate** | The start date for the report period. | [optional] |
+|**endDate** | **LocalDate** | The end date for the report period. | [optional] |
+|**scheduleIds** | **List<String>** | List of schedule UUIDs to scope the report. | [optional] |
+
+
+
diff --git a/docs/UpdateOnCallRoleDataAttributes.md b/docs/UpdateOnCallRoleDataAttributes.md
index e2838a05..ba7f0551 100644
--- a/docs/UpdateOnCallRoleDataAttributes.md
+++ b/docs/UpdateOnCallRoleDataAttributes.md
@@ -8,10 +8,14 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**name** | **String** | The role name. | [optional] |
-|**slug** | **String** | The role slug. | [optional] |
|**systemRole** | [**List<SystemRoleEnum>**](#List<SystemRoleEnum>) | The kind of role (user and custom type roles are only editable) | [optional] |
|**alertSourcesPermissions** | [**List<AlertSourcesPermissionsEnum>**](#List<AlertSourcesPermissionsEnum>) | | [optional] |
|**alertUrgencyPermissions** | [**List<AlertUrgencyPermissionsEnum>**](#List<AlertUrgencyPermissionsEnum>) | | [optional] |
+|**alertFieldsPermissions** | [**List<AlertFieldsPermissionsEnum>**](#List<AlertFieldsPermissionsEnum>) | | [optional] |
+|**alertGroupsPermissions** | [**List<AlertGroupsPermissionsEnum>**](#List<AlertGroupsPermissionsEnum>) | | [optional] |
+|**alertRoutingRulesPermissions** | [**List<AlertRoutingRulesPermissionsEnum>**](#List<AlertRoutingRulesPermissionsEnum>) | | [optional] |
+|**onCallReadinessReportPermissions** | [**List<OnCallReadinessReportPermissionsEnum>**](#List<OnCallReadinessReportPermissionsEnum>) | | [optional] |
+|**onCallRolesPermissions** | [**List<OnCallRolesPermissionsEnum>**](#List<OnCallRolesPermissionsEnum>) | | [optional] |
|**alertsPermissions** | [**List<AlertsPermissionsEnum>**](#List<AlertsPermissionsEnum>) | | [optional] |
|**apiKeysPermissions** | [**List<ApiKeysPermissionsEnum>**](#List<ApiKeysPermissionsEnum>) | | [optional] |
|**auditsPermissions** | [**List<AuditsPermissionsEnum>**](#List<AuditsPermissionsEnum>) | | [optional] |
@@ -37,6 +41,7 @@
| ADMIN | "admin" |
| USER | "user" |
| CUSTOM | "custom" |
+| OBSERVER | "observer" |
| NO_ACCESS | "no_access" |
@@ -46,6 +51,7 @@
| Name | Value |
|---- | -----|
| CREATE | "create" |
+| READ | "read" |
| UPDATE | "update" |
| DELETE | "delete" |
@@ -62,6 +68,58 @@
+## Enum: List<AlertFieldsPermissionsEnum>
+
+| Name | Value |
+|---- | -----|
+| CREATE | "create" |
+| READ | "read" |
+| UPDATE | "update" |
+| DELETE | "delete" |
+
+
+
+## Enum: List<AlertGroupsPermissionsEnum>
+
+| Name | Value |
+|---- | -----|
+| CREATE | "create" |
+| READ | "read" |
+| UPDATE | "update" |
+| DELETE | "delete" |
+
+
+
+## Enum: List<AlertRoutingRulesPermissionsEnum>
+
+| Name | Value |
+|---- | -----|
+| CREATE | "create" |
+| READ | "read" |
+| UPDATE | "update" |
+| DELETE | "delete" |
+
+
+
+## Enum: List<OnCallReadinessReportPermissionsEnum>
+
+| Name | Value |
+|---- | -----|
+| READ | "read" |
+
+
+
+## Enum: List<OnCallRolesPermissionsEnum>
+
+| Name | Value |
+|---- | -----|
+| CREATE | "create" |
+| READ | "read" |
+| UPDATE | "update" |
+| DELETE | "delete" |
+
+
+
## Enum: List<AlertsPermissionsEnum>
| Name | Value |
@@ -69,6 +127,7 @@
| CREATE | "create" |
| UPDATE | "update" |
| READ | "read" |
+| DELETE | "delete" |
diff --git a/docs/UpdateOpsgenieIncidentTaskParams.md b/docs/UpdateOpsgenieIncidentTaskParams.md
index 6a4e7a6b..f46a8c4b 100644
--- a/docs/UpdateOpsgenieIncidentTaskParams.md
+++ b/docs/UpdateOpsgenieIncidentTaskParams.md
@@ -45,6 +45,7 @@
| P4 | "P4" |
| P5 | "P5" |
| AUTO | "auto" |
+| EMPTY | "" |
diff --git a/docs/UpdatePlaybookDataAttributes.md b/docs/UpdatePlaybookDataAttributes.md
index c9587a64..02b058a8 100644
--- a/docs/UpdatePlaybookDataAttributes.md
+++ b/docs/UpdatePlaybookDataAttributes.md
@@ -10,12 +10,12 @@
|**title** | **String** | The title of the playbook | [optional] |
|**summary** | **String** | The summary of the playbook | [optional] |
|**externalUrl** | **String** | The external url of the playbook | [optional] |
-|**severityIds** | **List<String>** | The Severity ID's to attach to the incident | [optional] |
-|**environmentIds** | **List<String>** | The Environment ID's to attach to the incident | [optional] |
-|**serviceIds** | **List<String>** | The Service ID's to attach to the incident | [optional] |
-|**functionalityIds** | **List<String>** | The Functionality ID's to attach to the incident | [optional] |
-|**groupIds** | **List<String>** | The Team ID's to attach to the incident | [optional] |
-|**incidentTypeIds** | **List<String>** | The Incident Type ID's to attach to the incident | [optional] |
+|**severityIds** | **List<String>** | The Severity IDs to attach to the incident | [optional] |
+|**environmentIds** | **List<String>** | The Environment IDs to attach to the incident | [optional] |
+|**serviceIds** | **List<String>** | The Service IDs to attach to the incident | [optional] |
+|**functionalityIds** | **List<String>** | The Functionality IDs to attach to the incident | [optional] |
+|**groupIds** | **List<String>** | The Team IDs to attach to the incident | [optional] |
+|**incidentTypeIds** | **List<String>** | The Incident Type IDs to attach to the incident | [optional] |
diff --git a/docs/UpdatePostMortemTemplateDataAttributes.md b/docs/UpdatePostMortemTemplateDataAttributes.md
index 20c2ef16..cf249e4b 100644
--- a/docs/UpdatePostMortemTemplateDataAttributes.md
+++ b/docs/UpdatePostMortemTemplateDataAttributes.md
@@ -9,7 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**name** | **String** | The name of the postmortem template | [optional] |
|**_default** | **Boolean** | Default selected template when editing a postmortem | [optional] |
-|**content** | **String** | The postmortem template. Liquid syntax is supported | [optional] |
+|**content** | **String** | The postmortem template. Supports TipTap blocks (followup and timeline components), Liquid syntax, and HTML. Will be sanitized and applied to both content and content_html fields. | [optional] |
|**format** | [**FormatEnum**](#FormatEnum) | The format of the input | [optional] |
diff --git a/docs/UpdatePulseDataAttributes.md b/docs/UpdatePulseDataAttributes.md
index d635f7e9..9b2ed9ec 100644
--- a/docs/UpdatePulseDataAttributes.md
+++ b/docs/UpdatePulseDataAttributes.md
@@ -9,12 +9,12 @@
|------------ | ------------- | ------------- | -------------|
|**source** | **String** | The source of the pulse (eg: k8s) | [optional] |
|**summary** | **String** | The summary of the pulse | [optional] |
-|**serviceIds** | **List<String>** | The Service ID's to attach to the pulse | [optional] |
-|**environmentIds** | **List<String>** | The Environment ID's to attach to the pulse | [optional] |
+|**serviceIds** | **List<String>** | The Service IDs to attach to the pulse | [optional] |
+|**environmentIds** | **List<String>** | The Environment IDs to attach to the pulse | [optional] |
|**startedAt** | **OffsetDateTime** | Pulse start datetime | [optional] |
|**endedAt** | **OffsetDateTime** | Pulse end datetime | [optional] |
|**externalUrl** | **String** | The external url of the pulse | [optional] |
-|**labels** | [**List<NewAlertDataAttributesLabelsInner>**](NewAlertDataAttributesLabelsInner.md) | | [optional] |
+|**labels** | [**List<NewPulseDataAttributesLabelsInner>**](NewPulseDataAttributesLabelsInner.md) | | [optional] |
|**refs** | [**List<NewPulseDataAttributesRefsInner>**](NewPulseDataAttributesRefsInner.md) | | [optional] |
|**data** | **Object** | Additional data | [optional] |
diff --git a/docs/UpdateQuipPageTaskParams.md b/docs/UpdateQuipPageTaskParams.md
new file mode 100644
index 00000000..0b581559
--- /dev/null
+++ b/docs/UpdateQuipPageTaskParams.md
@@ -0,0 +1,26 @@
+
+
+# UpdateQuipPageTaskParams
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**taskType** | [**TaskTypeEnum**](#TaskTypeEnum) | | [optional] |
+|**fileId** | **String** | The Quip page ID | |
+|**title** | **String** | The Quip page title | [optional] |
+|**content** | **String** | The Quip page content | [optional] |
+|**postMortemTemplateId** | **String** | Retrospective template to use when updating page, if desired | [optional] |
+|**templateId** | **String** | The Quip file ID to use as a template | [optional] |
+
+
+
+## Enum: TaskTypeEnum
+
+| Name | Value |
+|---- | -----|
+| UPDATE_QUIP_PAGE | "update_quip_page" |
+
+
+
diff --git a/docs/UpdateRetrospectiveConfigurationDataAttributes.md b/docs/UpdateRetrospectiveConfigurationDataAttributes.md
index 75642a03..ceb1723f 100644
--- a/docs/UpdateRetrospectiveConfigurationDataAttributes.md
+++ b/docs/UpdateRetrospectiveConfigurationDataAttributes.md
@@ -7,9 +7,9 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
-|**severityIds** | **List<String>** | The Severity ID's to attach to the retrospective configuration | [optional] |
-|**groupIds** | **List<String>** | The Team ID's to attach to the retrospective configuration | [optional] |
-|**incidentTypeIds** | **List<String>** | The Incident Type ID's to attach to the retrospective configuration | [optional] |
+|**severityIds** | **List<String>** | The Severity IDs to attach to the retrospective configuration | [optional] |
+|**groupIds** | **List<String>** | The Team IDs to attach to the retrospective configuration | [optional] |
+|**incidentTypeIds** | **List<String>** | The Incident Type IDs to attach to the retrospective configuration | [optional] |
diff --git a/docs/UpdateRoleDataAttributes.md b/docs/UpdateRoleDataAttributes.md
index 402cda98..06005181 100644
--- a/docs/UpdateRoleDataAttributes.md
+++ b/docs/UpdateRoleDataAttributes.md
@@ -8,8 +8,9 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**name** | **String** | The role name. | [optional] |
-|**slug** | **String** | The role slug. | [optional] |
|**incidentPermissionSetId** | **String** | Associated incident permissions set. | [optional] |
+|**isDeletable** | **Boolean** | Whether the role can be deleted. | [optional] |
+|**isEditable** | **Boolean** | Whether the role can be edited. | [optional] |
|**apiKeysPermissions** | [**List<ApiKeysPermissionsEnum>**](#List<ApiKeysPermissionsEnum>) | | [optional] |
|**auditsPermissions** | [**List<AuditsPermissionsEnum>**](#List<AuditsPermissionsEnum>) | | [optional] |
|**billingPermissions** | [**List<BillingPermissionsEnum>**](#List<BillingPermissionsEnum>) | | [optional] |
@@ -34,6 +35,13 @@
|**statusPagesPermissions** | [**List<StatusPagesPermissionsEnum>**](#List<StatusPagesPermissionsEnum>) | | [optional] |
|**webhooksPermissions** | [**List<WebhooksPermissionsEnum>**](#List<WebhooksPermissionsEnum>) | | [optional] |
|**workflowsPermissions** | [**List<WorkflowsPermissionsEnum>**](#List<WorkflowsPermissionsEnum>) | | [optional] |
+|**catalogsPermissions** | [**List<CatalogsPermissionsEnum>**](#List<CatalogsPermissionsEnum>) | | [optional] |
+|**subStatusesPermissions** | [**List<SubStatusesPermissionsEnum>**](#List<SubStatusesPermissionsEnum>) | | [optional] |
+|**edgeConnectorPermissions** | [**List<EdgeConnectorPermissionsEnum>**](#List<EdgeConnectorPermissionsEnum>) | | [optional] |
+|**slasPermissions** | [**List<SlasPermissionsEnum>**](#List<SlasPermissionsEnum>) | | [optional] |
+|**pagingPermissions** | [**List<PagingPermissionsEnum>**](#List<PagingPermissionsEnum>) | | [optional] |
+|**incidentCommunicationPermissions** | [**List<IncidentCommunicationPermissionsEnum>**](#List<IncidentCommunicationPermissionsEnum>) | | [optional] |
+|**communicationPermissions** | [**List<CommunicationPermissionsEnum>**](#List<CommunicationPermissionsEnum>) | | [optional] |
@@ -301,3 +309,81 @@
+## Enum: List<CatalogsPermissionsEnum>
+
+| Name | Value |
+|---- | -----|
+| CREATE | "create" |
+| READ | "read" |
+| UPDATE | "update" |
+| DELETE | "delete" |
+
+
+
+## Enum: List<SubStatusesPermissionsEnum>
+
+| Name | Value |
+|---- | -----|
+| CREATE | "create" |
+| READ | "read" |
+| UPDATE | "update" |
+| DELETE | "delete" |
+
+
+
+## Enum: List<EdgeConnectorPermissionsEnum>
+
+| Name | Value |
+|---- | -----|
+| CREATE | "create" |
+| READ | "read" |
+| UPDATE | "update" |
+| DELETE | "delete" |
+
+
+
+## Enum: List<SlasPermissionsEnum>
+
+| Name | Value |
+|---- | -----|
+| CREATE | "create" |
+| READ | "read" |
+| UPDATE | "update" |
+| DELETE | "delete" |
+
+
+
+## Enum: List<PagingPermissionsEnum>
+
+| Name | Value |
+|---- | -----|
+| CREATE | "create" |
+| READ | "read" |
+| UPDATE | "update" |
+| DELETE | "delete" |
+
+
+
+## Enum: List<IncidentCommunicationPermissionsEnum>
+
+| Name | Value |
+|---- | -----|
+| CREATE | "create" |
+| READ | "read" |
+| UPDATE | "update" |
+| DELETE | "delete" |
+| SEND | "send" |
+
+
+
+## Enum: List<CommunicationPermissionsEnum>
+
+| Name | Value |
+|---- | -----|
+| CREATE | "create" |
+| READ | "read" |
+| UPDATE | "update" |
+| DELETE | "delete" |
+
+
+
diff --git a/docs/UpdateScheduleDataAttributes.md b/docs/UpdateScheduleDataAttributes.md
index 5ab0e5e5..6f05c2db 100644
--- a/docs/UpdateScheduleDataAttributes.md
+++ b/docs/UpdateScheduleDataAttributes.md
@@ -11,8 +11,11 @@
|**description** | **String** | The description of the schedule | [optional] |
|**allTimeCoverage** | **Boolean** | 24/7 coverage of the schedule | [optional] |
|**slackUserGroup** | [**NewScheduleDataAttributesSlackUserGroup**](NewScheduleDataAttributesSlackUserGroup.md) | | [optional] |
+|**slackChannel** | [**NewScheduleDataAttributesSlackChannel**](NewScheduleDataAttributesSlackChannel.md) | | [optional] |
|**ownerGroupIds** | **List<String>** | Owning teams. | [optional] |
|**ownerUserId** | **Integer** | ID of the owner of the schedule | [optional] |
+|**shiftStartNotificationsEnabled** | **Boolean** | Whether shift-start notifications are enabled | [optional] |
+|**shiftUpdateNotificationsEnabled** | **Boolean** | Whether shift-update notifications are enabled | [optional] |
diff --git a/docs/UpdateScheduleRotationDataAttributes.md b/docs/UpdateScheduleRotationDataAttributes.md
index f9aadaf7..b45b86a3 100644
--- a/docs/UpdateScheduleRotationDataAttributes.md
+++ b/docs/UpdateScheduleRotationDataAttributes.md
@@ -16,6 +16,9 @@
|**activeTimeAttributes** | [**List<NewScheduleRotationDataAttributesActiveTimeAttributesInner>**](NewScheduleRotationDataAttributesActiveTimeAttributesInner.md) | Schedule rotation's active times | [optional] |
|**timeZone** | **String** | A valid IANA time zone name. | [optional] |
|**scheduleRotationableAttributes** | [**NewScheduleRotationDataAttributesScheduleRotationableAttributes**](NewScheduleRotationDataAttributesScheduleRotationableAttributes.md) | | [optional] |
+|**startTime** | **OffsetDateTime** | RFC3339 date-time when rotation starts. Shifts will only be created after this time. | [optional] |
+|**endTime** | **OffsetDateTime** | RFC3339 date-time when rotation ends. Shifts will only be created before this time. | [optional] |
+|**scheduleRotationMembers** | [**List<NewScheduleRotationDataAttributesScheduleRotationMembersInner>**](NewScheduleRotationDataAttributesScheduleRotationMembersInner.md) | You can only update schedule rotation members if your account has schedule nesting feature enabled | [optional] |
diff --git a/docs/UpdateServiceDataAttributes.md b/docs/UpdateServiceDataAttributes.md
index 87a1eaa9..b3f35eb9 100644
--- a/docs/UpdateServiceDataAttributes.md
+++ b/docs/UpdateServiceDataAttributes.md
@@ -25,12 +25,19 @@
|**gitlabRepositoryBranch** | **String** | The GitLab repository branch associated to this service. eg: main | [optional] |
|**environmentIds** | **List<String>** | Environments associated with this service | [optional] |
|**serviceIds** | **List<String>** | Services dependent on this service | [optional] |
-|**ownersGroupIds** | **List<String>** | Owner Teams associated with this service | [optional] |
-|**ownersUserIds** | **List<Integer>** | Owner Users associated with this service | [optional] |
+|**ownerGroupIds** | **List<String>** | Owner Teams associated with this service | [optional] |
+|**ownerUserIds** | **List<Integer>** | Owner Users associated with this service | [optional] |
|**alertsEmailEnabled** | **Boolean** | Enable alerts through email | [optional] |
|**alertUrgencyId** | **String** | The alert urgency id of the service | [optional] |
+|**escalationPolicyId** | **String** | The escalation policy id of the service | [optional] |
+|**kubernetesDeploymentName** | **String** | The Kubernetes deployment name associated to this service. eg: namespace/deployment-name | [optional] |
|**slackChannels** | [**List<NewEnvironmentDataAttributesSlackChannelsInner>**](NewEnvironmentDataAttributesSlackChannelsInner.md) | Slack Channels associated with this service | [optional] |
|**slackAliases** | [**List<NewEnvironmentDataAttributesSlackAliasesInner>**](NewEnvironmentDataAttributesSlackAliasesInner.md) | Slack Aliases associated with this service | [optional] |
+|**alertBroadcastEnabled** | **Boolean** | Enable alerts to be broadcasted to a specific channel | [optional] |
+|**alertBroadcastChannel** | [**NewServiceDataAttributesAlertBroadcastChannel**](NewServiceDataAttributesAlertBroadcastChannel.md) | | [optional] |
+|**incidentBroadcastEnabled** | **Boolean** | Enable incidents to be broadcasted to a specific channel | [optional] |
+|**incidentBroadcastChannel** | [**NewServiceDataAttributesIncidentBroadcastChannel**](NewServiceDataAttributesIncidentBroadcastChannel.md) | | [optional] |
+|**properties** | [**List<NewCauseDataAttributesPropertiesInner>**](NewCauseDataAttributesPropertiesInner.md) | Array of property values for this service. | [optional] |
diff --git a/docs/UpdateSharepointPageTaskParams.md b/docs/UpdateSharepointPageTaskParams.md
new file mode 100644
index 00000000..11c4d6bb
--- /dev/null
+++ b/docs/UpdateSharepointPageTaskParams.md
@@ -0,0 +1,25 @@
+
+
+# UpdateSharepointPageTaskParams
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**taskType** | [**TaskTypeEnum**](#TaskTypeEnum) | | [optional] |
+|**fileId** | **String** | The SharePoint file ID | |
+|**title** | **String** | The SharePoint document title | [optional] |
+|**content** | **String** | The SharePoint document content | [optional] |
+|**postMortemTemplateId** | **String** | Retrospective template to use when updating document, if desired | [optional] |
+
+
+
+## Enum: TaskTypeEnum
+
+| Name | Value |
+|---- | -----|
+| UPDATE_SHAREPOINT_PAGE | "update_sharepoint_page" |
+
+
+
diff --git a/docs/UpdateSla.md b/docs/UpdateSla.md
new file mode 100644
index 00000000..a6568546
--- /dev/null
+++ b/docs/UpdateSla.md
@@ -0,0 +1,13 @@
+
+
+# UpdateSla
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**UpdateSlaData**](UpdateSlaData.md) | | |
+
+
+
diff --git a/docs/UpdateSlaData.md b/docs/UpdateSlaData.md
new file mode 100644
index 00000000..4c00f861
--- /dev/null
+++ b/docs/UpdateSlaData.md
@@ -0,0 +1,22 @@
+
+
+# UpdateSlaData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**UpdateSlaDataAttributes**](UpdateSlaDataAttributes.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| SLAS | "slas" |
+
+
+
diff --git a/docs/UpdateSlaDataAttributes.md b/docs/UpdateSlaDataAttributes.md
new file mode 100644
index 00000000..d9131a26
--- /dev/null
+++ b/docs/UpdateSlaDataAttributes.md
@@ -0,0 +1,97 @@
+
+
+# UpdateSlaDataAttributes
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** | The name of the SLA | [optional] |
+|**description** | **String** | A description of the SLA | [optional] |
+|**position** | **Integer** | Position of the SLA for ordering | [optional] |
+|**conditionMatchType** | [**ConditionMatchTypeEnum**](#ConditionMatchTypeEnum) | Whether all or any conditions must match | [optional] |
+|**managerRoleId** | **UUID** | The ID of the incident role responsible for this SLA. Exactly one of `manager_role_id` or `manager_user_id` must be provided. | [optional] |
+|**managerUserId** | **Integer** | The ID of the user responsible for this SLA. Exactly one of `manager_role_id` or `manager_user_id` must be provided. | [optional] |
+|**assignmentDeadlineDays** | [**AssignmentDeadlineDaysEnum**](#AssignmentDeadlineDaysEnum) | Number of days for the assignment deadline | [optional] |
+|**assignmentDeadlineParentStatus** | [**AssignmentDeadlineParentStatusEnum**](#AssignmentDeadlineParentStatusEnum) | The incident parent status that triggers the assignment deadline | [optional] |
+|**assignmentDeadlineSubStatusId** | **UUID** | Sub-status for the assignment deadline. Required when custom lifecycle statuses are enabled on the team. | [optional] |
+|**assignmentSkipWeekends** | **Boolean** | Whether to skip weekends when calculating the assignment deadline | [optional] |
+|**completionDeadlineDays** | [**CompletionDeadlineDaysEnum**](#CompletionDeadlineDaysEnum) | Number of days for the completion deadline | [optional] |
+|**completionDeadlineParentStatus** | [**CompletionDeadlineParentStatusEnum**](#CompletionDeadlineParentStatusEnum) | The incident parent status that triggers the completion deadline | [optional] |
+|**completionDeadlineSubStatusId** | **UUID** | Sub-status for the completion deadline. Required when custom lifecycle statuses are enabled on the team. | [optional] |
+|**completionSkipWeekends** | **Boolean** | Whether to skip weekends when calculating the completion deadline | [optional] |
+|**conditions** | [**List<NewSlaDataAttributesConditionsInner>**](NewSlaDataAttributesConditionsInner.md) | Conditions that determine which incidents this SLA applies to. Replaces all existing conditions. | [optional] |
+|**notificationConfigurations** | [**List<NewSlaDataAttributesNotificationConfigurationsInner>**](NewSlaDataAttributesNotificationConfigurationsInner.md) | Notification timing configurations. Replaces all existing configurations. | [optional] |
+
+
+
+## Enum: ConditionMatchTypeEnum
+
+| Name | Value |
+|---- | -----|
+| ALL | "ALL" |
+| ANY | "ANY" |
+
+
+
+## Enum: AssignmentDeadlineDaysEnum
+
+| Name | Value |
+|---- | -----|
+| NUMBER_1 | 1 |
+| NUMBER_2 | 2 |
+| NUMBER_3 | 3 |
+| NUMBER_4 | 4 |
+| NUMBER_5 | 5 |
+| NUMBER_6 | 6 |
+| NUMBER_7 | 7 |
+| NUMBER_14 | 14 |
+| NUMBER_21 | 21 |
+| NUMBER_30 | 30 |
+
+
+
+## Enum: AssignmentDeadlineParentStatusEnum
+
+| Name | Value |
+|---- | -----|
+| IN_TRIAGE | "in_triage" |
+| STARTED | "started" |
+| MITIGATED | "mitigated" |
+| RESOLVED | "resolved" |
+| CLOSED | "closed" |
+| CANCELLED | "cancelled" |
+
+
+
+## Enum: CompletionDeadlineDaysEnum
+
+| Name | Value |
+|---- | -----|
+| NUMBER_1 | 1 |
+| NUMBER_2 | 2 |
+| NUMBER_3 | 3 |
+| NUMBER_4 | 4 |
+| NUMBER_5 | 5 |
+| NUMBER_6 | 6 |
+| NUMBER_7 | 7 |
+| NUMBER_14 | 14 |
+| NUMBER_21 | 21 |
+| NUMBER_30 | 30 |
+
+
+
+## Enum: CompletionDeadlineParentStatusEnum
+
+| Name | Value |
+|---- | -----|
+| IN_TRIAGE | "in_triage" |
+| STARTED | "started" |
+| MITIGATED | "mitigated" |
+| RESOLVED | "resolved" |
+| CLOSED | "closed" |
+| CANCELLED | "cancelled" |
+
+
+
diff --git a/docs/UpdateStatusPageDataAttributes.md b/docs/UpdateStatusPageDataAttributes.md
index 7abd0faf..1d1baa84 100644
--- a/docs/UpdateStatusPageDataAttributes.md
+++ b/docs/UpdateStatusPageDataAttributes.md
@@ -18,8 +18,15 @@
|**showUptimeLastDays** | [**ShowUptimeLastDaysEnum**](#ShowUptimeLastDaysEnum) | Show uptime over x days | [optional] |
|**successMessage** | **String** | Message showing when all components are operational | [optional] |
|**failureMessage** | **String** | Message showing when at least one component is not operational | [optional] |
-|**authenticationEnabled** | **Boolean** | Enable authentication | [optional] |
+|**authenticationMethod** | [**AuthenticationMethodEnum**](#AuthenticationMethodEnum) | Authentication method | [optional] |
+|**authenticationEnabled** | **Boolean** | Enable authentication (deprecated - use authentication_method instead) | [optional] |
|**authenticationPassword** | **String** | Authentication password | [optional] |
+|**samlIdpSsoServiceUrl** | **String** | SAML IdP SSO service URL | [optional] |
+|**samlIdpSloServiceUrl** | **String** | SAML IdP SLO service URL | [optional] |
+|**samlIdpCert** | **String** | SAML IdP certificate | [optional] |
+|**samlNameIdentifierFormat** | [**SamlNameIdentifierFormatEnum**](#SamlNameIdentifierFormatEnum) | SAML name identifier format | [optional] |
+|**sectionOrder** | [**List<SectionOrderEnum>**](#List<SectionOrderEnum>) | Order of sections on the status page | [optional] |
+|**externalDomainNames** | **List<String>** | External domain names attached to the status page | [optional] |
|**websiteUrl** | **String** | Website URL | [optional] |
|**websitePrivacyUrl** | **String** | Website Privacy URL | [optional] |
|**websiteSupportUrl** | **String** | Website Support URL | [optional] |
@@ -39,8 +46,37 @@
| NUMBER_30 | 30 |
| NUMBER_60 | 60 |
| NUMBER_90 | 90 |
-| NUMBER_180 | 180 |
-| NUMBER_360 | 360 |
+
+
+
+## Enum: AuthenticationMethodEnum
+
+| Name | Value |
+|---- | -----|
+| NONE | "none" |
+| PASSWORD | "password" |
+| SAML | "saml" |
+
+
+
+## Enum: SamlNameIdentifierFormatEnum
+
+| Name | Value |
+|---- | -----|
+| URN_OASIS_NAMES_TC_SAML_1_1_NAMEID_FORMAT_EMAIL_ADDRESS | "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress" |
+| URN_OASIS_NAMES_TC_SAML_2_0_NAMEID_FORMAT_PERSISTENT | "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent" |
+| URN_OASIS_NAMES_TC_SAML_2_0_NAMEID_FORMAT_TRANSIENT | "urn:oasis:names:tc:SAML:2.0:nameid-format:transient" |
+| URN_OASIS_NAMES_TC_SAML_1_1_NAMEID_FORMAT_UNSPECIFIED | "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified" |
+
+
+
+## Enum: List<SectionOrderEnum>
+
+| Name | Value |
+|---- | -----|
+| MAINTENANCE | "maintenance" |
+| SYSTEM_STATUS | "system_status" |
+| INCIDENTS | "incidents" |
diff --git a/docs/UpdateStatusPageTemplateDataAttributes.md b/docs/UpdateStatusPageTemplateDataAttributes.md
index f4ed0a36..739aa9bc 100644
--- a/docs/UpdateStatusPageTemplateDataAttributes.md
+++ b/docs/UpdateStatusPageTemplateDataAttributes.md
@@ -8,6 +8,7 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**title** | **String** | Title of the template | |
+|**updateTitle** | **String** | Title that will be used for the status page update | [optional] |
|**body** | **String** | Description of the event the template will populate | |
|**updateStatus** | [**UpdateStatusEnum**](#UpdateStatusEnum) | Status of the event the template will populate | [optional] |
|**kind** | [**KindEnum**](#KindEnum) | The kind of the status page template | [optional] |
@@ -27,7 +28,6 @@
| RESOLVED | "resolved" |
| SCHEDULED | "scheduled" |
| IN_PROGRESS | "in_progress" |
-| VERIFYING | "verifying" |
| COMPLETED | "completed" |
diff --git a/docs/UpdateSubStatusDataAttributes.md b/docs/UpdateSubStatusDataAttributes.md
index 0c04e1de..2c046066 100644
--- a/docs/UpdateSubStatusDataAttributes.md
+++ b/docs/UpdateSubStatusDataAttributes.md
@@ -8,7 +8,6 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**name** | **String** | | [optional] |
-|**slug** | **String** | | [optional] |
|**description** | **String** | | [optional] |
|**position** | **Integer** | | [optional] |
diff --git a/docs/UpdateTeamDataAttributes.md b/docs/UpdateTeamDataAttributes.md
index 24936b42..4c03aaa8 100644
--- a/docs/UpdateTeamDataAttributes.md
+++ b/docs/UpdateTeamDataAttributes.md
@@ -27,6 +27,12 @@
|**alertUrgencyId** | **String** | The alert urgency id of the team | [optional] |
|**slackChannels** | [**List<NewEnvironmentDataAttributesSlackChannelsInner>**](NewEnvironmentDataAttributesSlackChannelsInner.md) | Slack Channels associated with this team | [optional] |
|**slackAliases** | [**List<NewEnvironmentDataAttributesSlackAliasesInner>**](NewEnvironmentDataAttributesSlackAliasesInner.md) | Slack Aliases associated with this team | [optional] |
+|**alertBroadcastEnabled** | **Boolean** | Enable alerts to be broadcasted to a specific channel | [optional] |
+|**alertBroadcastChannel** | [**NewServiceDataAttributesAlertBroadcastChannel**](NewServiceDataAttributesAlertBroadcastChannel.md) | | [optional] |
+|**incidentBroadcastEnabled** | **Boolean** | Enable incidents to be broadcasted to a specific channel | [optional] |
+|**incidentBroadcastChannel** | [**NewServiceDataAttributesIncidentBroadcastChannel**](NewServiceDataAttributesIncidentBroadcastChannel.md) | | [optional] |
+|**autoAddMembersWhenAttached** | **Boolean** | Auto add members to incident channel when team is attached | [optional] |
+|**properties** | [**List<NewCauseDataAttributesPropertiesInner>**](NewCauseDataAttributesPropertiesInner.md) | Array of property values for this team. | [optional] |
diff --git a/docs/UpdateUserEmailAddress.md b/docs/UpdateUserEmailAddress.md
new file mode 100644
index 00000000..550c4b79
--- /dev/null
+++ b/docs/UpdateUserEmailAddress.md
@@ -0,0 +1,13 @@
+
+
+# UpdateUserEmailAddress
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**UpdateUserEmailAddressData**](UpdateUserEmailAddressData.md) | | |
+
+
+
diff --git a/docs/UpdateUserEmailAddressData.md b/docs/UpdateUserEmailAddressData.md
new file mode 100644
index 00000000..99465c32
--- /dev/null
+++ b/docs/UpdateUserEmailAddressData.md
@@ -0,0 +1,22 @@
+
+
+# UpdateUserEmailAddressData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**UpdateUserEmailAddressDataAttributes**](UpdateUserEmailAddressDataAttributes.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| USER_EMAIL_ADDRESSES | "user_email_addresses" |
+
+
+
diff --git a/docs/UpdateUserEmailAddressDataAttributes.md b/docs/UpdateUserEmailAddressDataAttributes.md
new file mode 100644
index 00000000..9ae45cc8
--- /dev/null
+++ b/docs/UpdateUserEmailAddressDataAttributes.md
@@ -0,0 +1,13 @@
+
+
+# UpdateUserEmailAddressDataAttributes
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**email** | **String** | Email address | [optional] |
+
+
+
diff --git a/docs/UpdateUserNotificationRuleDataAttributes.md b/docs/UpdateUserNotificationRuleDataAttributes.md
index e8adbd0c..e1a538ea 100644
--- a/docs/UpdateUserNotificationRuleDataAttributes.md
+++ b/docs/UpdateUserNotificationRuleDataAttributes.md
@@ -26,6 +26,7 @@
| CALL | "call" |
| DEVICE | "device" |
| NON_CRITICAL_DEVICE | "non_critical_device" |
+| SLACK | "slack" |
diff --git a/docs/UpdateUserPhoneNumber.md b/docs/UpdateUserPhoneNumber.md
new file mode 100644
index 00000000..736f38c7
--- /dev/null
+++ b/docs/UpdateUserPhoneNumber.md
@@ -0,0 +1,13 @@
+
+
+# UpdateUserPhoneNumber
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**UpdateUserPhoneNumberData**](UpdateUserPhoneNumberData.md) | | |
+
+
+
diff --git a/docs/UpdateUserPhoneNumberData.md b/docs/UpdateUserPhoneNumberData.md
new file mode 100644
index 00000000..bf789a3b
--- /dev/null
+++ b/docs/UpdateUserPhoneNumberData.md
@@ -0,0 +1,22 @@
+
+
+# UpdateUserPhoneNumberData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**UpdateUserPhoneNumberDataAttributes**](UpdateUserPhoneNumberDataAttributes.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| USER_PHONE_NUMBERS | "user_phone_numbers" |
+
+
+
diff --git a/docs/UpdateUserPhoneNumberDataAttributes.md b/docs/UpdateUserPhoneNumberDataAttributes.md
new file mode 100644
index 00000000..509ce0a1
--- /dev/null
+++ b/docs/UpdateUserPhoneNumberDataAttributes.md
@@ -0,0 +1,13 @@
+
+
+# UpdateUserPhoneNumberDataAttributes
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**phone** | **String** | Phone number in international format | [optional] |
+
+
+
diff --git a/docs/UpdateWebhooksEndpointDataAttributes.md b/docs/UpdateWebhooksEndpointDataAttributes.md
index 43f9ac65..eb87a87e 100644
--- a/docs/UpdateWebhooksEndpointDataAttributes.md
+++ b/docs/UpdateWebhooksEndpointDataAttributes.md
@@ -46,6 +46,7 @@
| GENIUS_WORKFLOW_RUN_COMPLETED | "genius_workflow_run.completed" |
| GENIUS_WORKFLOW_RUN_FAILED | "genius_workflow_run.failed" |
| GENIUS_WORKFLOW_RUN_CANCELED | "genius_workflow_run.canceled" |
+| AUDIT_LOG_CREATED | "audit_log.created" |
diff --git a/docs/UpdateWorkflowCustomFieldSelectionDataAttributes.md b/docs/UpdateWorkflowCustomFieldSelectionDataAttributes.md
index ffe308a6..29079ce6 100644
--- a/docs/UpdateWorkflowCustomFieldSelectionDataAttributes.md
+++ b/docs/UpdateWorkflowCustomFieldSelectionDataAttributes.md
@@ -18,6 +18,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
diff --git a/docs/UpdateWorkflowDataAttributes.md b/docs/UpdateWorkflowDataAttributes.md
index d17170d0..cb064623 100644
--- a/docs/UpdateWorkflowDataAttributes.md
+++ b/docs/UpdateWorkflowDataAttributes.md
@@ -8,7 +8,6 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**name** | **String** | The title of the workflow | [optional] |
-|**slug** | **String** | The slug of the workflow | [optional] |
|**description** | **String** | The description of the workflow | [optional] |
|**command** | **String** | Workflow command | [optional] |
|**commandFeedbackEnabled** | **Boolean** | This will notify you back when the workflow is starting | [optional] |
diff --git a/docs/UpdateWorkflowFormFieldConditionDataAttributes.md b/docs/UpdateWorkflowFormFieldConditionDataAttributes.md
index 70c872f1..002ed19e 100644
--- a/docs/UpdateWorkflowFormFieldConditionDataAttributes.md
+++ b/docs/UpdateWorkflowFormFieldConditionDataAttributes.md
@@ -15,6 +15,9 @@
|**selectedOptionIds** | **List<String>** | | [optional] |
|**selectedServiceIds** | **List<String>** | | [optional] |
|**selectedUserIds** | **List<Integer>** | | [optional] |
+|**selectedCauseIds** | **List<String>** | | [optional] |
+|**selectedEnvironmentIds** | **List<String>** | | [optional] |
+|**selectedIncidentTypeIds** | **List<String>** | | [optional] |
@@ -23,6 +26,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
diff --git a/docs/UpdateWorkflowTaskDataAttributesTaskParams.md b/docs/UpdateWorkflowTaskDataAttributesTaskParams.md
index 49d98e9d..5e54599b 100644
--- a/docs/UpdateWorkflowTaskDataAttributesTaskParams.md
+++ b/docs/UpdateWorkflowTaskDataAttributesTaskParams.md
@@ -21,11 +21,11 @@
|**postToIncidentTimeline** | **Boolean** | | [optional] |
|**customFieldsMapping** | **String** | Custom field mappings. Can contain liquid markup and need to be valid JSON | [optional] |
|**postToSlackChannels** | [**List<AddActionItemTaskParamsPostToSlackChannelsInner>**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | [optional] |
-|**groupIds** | **List<String>** | | [optional] |
+|**groupIds** | **List<String>** | Array of group/team UUIDs | [optional] |
|**playbookId** | **String** | The playbook id if tab is of an incident playbook | [optional] |
|**channel** | [**AddActionItemTaskParamsPostToSlackChannelsInner**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | |
|**title** | **String** | The task title | |
-|**link** | **String** | The tab link. Required if not a playbook tab | [optional] |
+|**link** | **String** | The tab link | |
|**emoji** | **String** | The bookmark emoji | [optional] |
|**groupId** | **String** | The team id | |
|**event** | **String** | Incident event description | |
@@ -68,17 +68,19 @@
|**integration** | [**CreateJiraIssueTaskParamsIntegration**](CreateJiraIssueTaskParamsIntegration.md) | | [optional] |
|**space** | [**AddActionItemTaskParamsPostToSlackChannelsInner**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | |
|**ancestor** | [**AddActionItemTaskParamsPostToSlackChannelsInner**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | [optional] |
-|**template** | [**CreateIncidentPostmortemTaskParamsTemplate**](CreateIncidentPostmortemTaskParamsTemplate.md) | | [optional] |
-|**postMortemTemplateId** | **String** | Retrospective template to use when creating page task, if desired | [optional] |
+|**template** | [**UpdateDatadogNotebookTaskParamsTemplate**](UpdateDatadogNotebookTaskParamsTemplate.md) | | [optional] |
+|**postMortemTemplateId** | **String** | Retrospective template to use when updating notebook, if desired | [optional] |
|**markPostMortemAsPublished** | **Boolean** | | [optional] |
|**subtitle** | **String** | The Coda page subtitle | [optional] |
|**folderId** | **String** | The Coda folder id | [optional] |
+|**doc** | [**CreateCodaPageTaskParamsDoc**](CreateCodaPageTaskParamsDoc.md) | | [optional] |
|**namespace** | [**AddActionItemTaskParamsPostToSlackChannelsInner**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | [optional] |
|**parentFolder** | [**AddActionItemTaskParamsPostToSlackChannelsInner**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | [optional] |
|**body** | **String** | The issue body | |
-|**repository** | [**AddActionItemTaskParamsPostToSlackChannelsInner**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | |
-|**issueType** | [**IssueTypeEnum**](#IssueTypeEnum) | The issue type | |
+|**repository** | [**UpdateGithubIssueTaskParamsRepository**](UpdateGithubIssueTaskParamsRepository.md) | | |
|**labels** | **List<String>** | | [optional] |
+|**issueType** | [**IssueTypeEnum**](#IssueTypeEnum) | The issue type | |
+|**parentIssueNumber** | **String** | The parent issue number for sub-issue linking | [optional] |
|**calendar** | [**AddActionItemTaskParamsPostToSlackChannelsInner**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | |
|**attendees** | **List<String>** | Emails of attendees | [optional] |
|**timeZone** | **String** | A valid IANA time zone name. | [optional] |
@@ -86,13 +88,14 @@
|**timeOfMeeting** | **String** | Time of meeting in format HH:MM | |
|**meetingDuration** | **String** | Meeting duration in format like '1 hour', '30 minutes' | |
|**excludeWeekends** | **Boolean** | | [optional] |
+|**enableOnlineMeeting** | **Boolean** | Enable Microsoft Teams online meeting | [optional] |
|**calendarId** | **String** | | [optional] |
|**sendUpdates** | **Boolean** | Send an email to the attendees notifying them of the event | [optional] |
|**canGuestsModifyEvent** | **Boolean** | | [optional] |
|**canGuestsSeeOtherGuests** | **Boolean** | | [optional] |
|**canGuestsInviteOthers** | **Boolean** | | [optional] |
|**conferenceSolutionKey** | [**ConferenceSolutionKeyEnum**](#ConferenceSolutionKeyEnum) | [DEPRECATED] Sets the video conference type attached to the meeting | [optional] |
-|**fileId** | **String** | The Notion page ID | |
+|**fileId** | **String** | The Datadog notebook ID | |
|**templateId** | **String** | The Quip file ID to use as a template | [optional] |
|**docId** | **String** | The Coda doc id | [optional] |
|**pageId** | **String** | The Coda page id | |
@@ -107,13 +110,14 @@
|**value** | **String** | | |
|**parentFolderId** | **String** | The parent folder id | [optional] |
|**recordMeeting** | **Boolean** | Rootly AI will record the meeting and automatically generate a transcript and summary from your meeting | [optional] |
+|**recordingMode** | [**RecordingModeEnum**](#RecordingModeEnum) | The video layout for the bot's recording (e.g. speaker_view, gallery_view, gallery_view_v2, audio_only) | [optional] |
|**subject** | **String** | The ticket subject | |
|**conferenceCallInfo** | [**ConferenceCallInfoEnum**](#ConferenceCallInfoEnum) | | [optional] |
|**passwordRequired** | **Boolean** | | [optional] |
|**severityId** | **String** | | [optional] |
|**incidentTypeIds** | **List<String>** | | [optional] |
-|**serviceIds** | **List<String>** | | [optional] |
-|**functionalityIds** | **List<String>** | | [optional] |
+|**serviceIds** | **List<String>** | Array of service UUIDs | [optional] |
+|**functionalityIds** | **List<String>** | Array of functionality UUIDs | [optional] |
|**environmentIds** | **List<String>** | | [optional] |
|**_private** | **Boolean** | | [optional] |
|**incidentId** | **String** | The incident id | |
@@ -122,14 +126,19 @@
|**updatePayload** | **String** | Update payload. Can contain liquid markup and need to be valid JSON | [optional] |
|**parentIssueId** | **String** | The parent issue | |
|**subtaskIssueType** | [**CreateJiraIssueTaskParamsIssueType**](CreateJiraIssueTaskParamsIssueType.md) | | |
-|**state** | [**CreateLinearIssueTaskParamsState**](CreateLinearIssueTaskParamsState.md) | | |
+|**state** | [**UpdateLinearIssueTaskParamsState**](UpdateLinearIssueTaskParamsState.md) | | |
|**project** | [**CreateLinearIssueTaskParamsProject**](CreateLinearIssueTaskParamsProject.md) | | [optional] |
|**issueId** | **String** | The issue id | |
+|**topic** | **String** | | |
+|**chatType** | [**ChatTypeEnum**](#ChatTypeEnum) | Type of chat to create | [optional] |
+|**members** | [**List<CreateMicrosoftTeamsChatTaskParamsMembersInner>**](CreateMicrosoftTeamsChatTaskParamsMembersInner.md) | Array of members to include in the chat | |
+|**chat** | [**AddActionItemTaskParamsPostToSlackChannelsInner**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | |
|**emails** | **String** | Comma separated list of emails to invite | |
|**parentPage** | [**CreateNotionPageTaskParamsParentPage**](CreateNotionPageTaskParamsParentPage.md) | | |
|**showTimelineAsTable** | **Boolean** | | [optional] |
|**showActionItemsAsTable** | **Boolean** | | [optional] |
|**text** | **String** | The message text | |
+|**chats** | [**List<AddActionItemTaskParamsPostToSlackChannelsInner>**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | |
|**attachments** | **String** | Support liquid markup. Needs to be a valid JSON string after liquid is parsed | |
|**archivation** | [**CreateTrelloCardTaskParamsArchivation**](CreateTrelloCardTaskParamsArchivation.md) | | |
|**group** | [**Object**](Object.md) | The group id and display name | [optional] |
@@ -137,7 +146,6 @@
|**parentStoryId** | **String** | The parent story | |
|**board** | [**CreateTrelloCardTaskParamsBoard**](CreateTrelloCardTaskParamsBoard.md) | | |
|**_list** | [**CreateTrelloCardTaskParamsList**](CreateTrelloCardTaskParamsList.md) | | |
-|**topic** | **String** | | |
|**password** | **String** | The meeting password | [optional] |
|**comment** | **String** | The ticket comment | [optional] |
|**tags** | **String** | The ticket tags | [optional] |
@@ -173,7 +181,8 @@
|**details** | **String** | Details payload. Can contain liquid markup and need to be valid JSON | [optional] |
|**alertId** | **String** | Opsgenie Alert ID | |
|**opsgenieIncidentId** | **String** | The Opsgenie incident ID, this can also be a Rootly incident variable ex. {{ incident.opsgenie_incident_id }} | |
-|**alertUrgencyId** | **String** | Alert urgency ID | [optional] |
+|**functionalityTarget** | [**AddActionItemTaskParamsPostToSlackChannelsInner**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | [optional] |
+|**alertUrgencyId** | **String** | Alert urgency ID | |
|**escalationNote** | **String** | | [optional] |
|**escalationPolicies** | [**List<Object>**](Object.md) | | [optional] |
|**createNewIncidentOnConflict** | **Boolean** | Rootly only supports linking to a single PagerDuty incident. If this feature is disabled Rootly will add responders from any additional pages to the existing PagerDuty incident that is linked to the Rootly incident. If enabled, Rootly will create a new PagerDuty incident that is not linked to any Rootly incidents | [optional] |
@@ -214,6 +223,7 @@
|**tableName** | **String** | The table name | |
|**recordId** | **String** | The record id | |
|**taskId** | **String** | The task id | |
+|**labelsMode** | [**LabelsModeEnum**](#LabelsModeEnum) | How to apply labels. 'replace' (default) overwrites all existing labels. 'append' adds to existing labels without removing them. | [optional] |
|**startedAt** | **String** | | [optional] |
|**detectedAt** | **String** | | [optional] |
|**acknowledgedAt** | **String** | | [optional] |
@@ -230,8 +240,14 @@
|**workflow** | [**AddActionItemTaskParamsPostToSlackChannelsInner**](AddActionItemTaskParamsPostToSlackChannelsInner.md) | | |
|**checkWorkflowConditions** | **Boolean** | | [optional] |
|**blocks** | **String** | Support liquid markup. Needs to be a valid JSON string after liquid is parsed | |
-|**model** | [**GeniusCreateWatsonxChatCompletionTaskParamsModel**](GeniusCreateWatsonxChatCompletionTaskParamsModel.md) | | |
-|**prompt** | **String** | The prompt to send to WatsonX | |
+|**model** | [**CreateAnthropicChatCompletionTaskParamsModel**](CreateAnthropicChatCompletionTaskParamsModel.md) | | |
+|**systemPrompt** | **String** | The system prompt to send to Anthropic (optional) | [optional] |
+|**prompt** | **String** | The prompt to send to Anthropic | |
+|**temperature** | **BigDecimal** | Sampling temperature (0.0-1.5). Higher values make output more random. | [optional] |
+|**maxTokens** | **Integer** | Maximum number of tokens to generate | [optional] |
+|**topP** | **BigDecimal** | Nucleus sampling parameter (0.0-1.0) | [optional] |
+|**reasoningEffort** | [**ReasoningEffortEnum**](#ReasoningEffortEnum) | Constrains effort on reasoning for GPT-5 and o-series models | [optional] |
+|**reasoningSummary** | [**ReasoningSummaryEnum**](#ReasoningSummaryEnum) | Summary of the reasoning performed by the model for GPT-5 and o-series models | [optional] |
|**projectId** | **String** | | |
@@ -240,7 +256,7 @@
| Name | Value |
|---- | -----|
-| GENIUS_CREATE_WATSONX_CHAT_COMPLETION_TASK | "genius_create_watsonx_chat_completion_task" |
+| CREATE_ANTHROPIC_CHAT_COMPLETION_TASK | "create_anthropic_chat_completion_task" |
@@ -344,6 +360,17 @@
+## Enum: RecordingModeEnum
+
+| Name | Value |
+|---- | -----|
+| SPEAKER_VIEW | "speaker_view" |
+| GALLERY_VIEW | "gallery_view" |
+| GALLERY_VIEW_V2 | "gallery_view_v2" |
+| AUDIO_ONLY | "audio_only" |
+
+
+
## Enum: ConferenceCallInfoEnum
| Name | Value |
@@ -355,6 +382,15 @@
+## Enum: ChatTypeEnum
+
+| Name | Value |
+|---- | -----|
+| GROUP | "group" |
+| ONE_ON_ONE | "oneOnOne" |
+
+
+
## Enum: AutoRecordingEnum
| Name | Value |
@@ -445,3 +481,33 @@
+## Enum: LabelsModeEnum
+
+| Name | Value |
+|---- | -----|
+| REPLACE | "replace" |
+| APPEND | "append" |
+
+
+
+## Enum: ReasoningEffortEnum
+
+| Name | Value |
+|---- | -----|
+| MINIMAL | "minimal" |
+| LOW | "low" |
+| MEDIUM | "medium" |
+| HIGH | "high" |
+
+
+
+## Enum: ReasoningSummaryEnum
+
+| Name | Value |
+|---- | -----|
+| AUTO | "auto" |
+| CONCISE | "concise" |
+| DETAILED | "detailed" |
+
+
+
diff --git a/docs/UserEmailAddress.md b/docs/UserEmailAddress.md
new file mode 100644
index 00000000..09301624
--- /dev/null
+++ b/docs/UserEmailAddress.md
@@ -0,0 +1,17 @@
+
+
+# UserEmailAddress
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**userId** | **Integer** | | [optional] |
+|**email** | **String** | Email address | [optional] |
+|**primary** | **Boolean** | Whether this is the primary email address | [optional] |
+|**createdAt** | **String** | Date of creation | [optional] |
+|**updatedAt** | **String** | Date of last update | [optional] |
+
+
+
diff --git a/docs/UserEmailAddressList.md b/docs/UserEmailAddressList.md
new file mode 100644
index 00000000..59ca97ba
--- /dev/null
+++ b/docs/UserEmailAddressList.md
@@ -0,0 +1,15 @@
+
+
+# UserEmailAddressList
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<UserEmailAddressResponseData>**](UserEmailAddressResponseData.md) | | |
+|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
+
+
+
diff --git a/docs/UserEmailAddressResponse.md b/docs/UserEmailAddressResponse.md
new file mode 100644
index 00000000..02c2b150
--- /dev/null
+++ b/docs/UserEmailAddressResponse.md
@@ -0,0 +1,13 @@
+
+
+# UserEmailAddressResponse
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**UserEmailAddressResponseData**](UserEmailAddressResponseData.md) | | |
+
+
+
diff --git a/docs/UserEmailAddressResponseData.md b/docs/UserEmailAddressResponseData.md
new file mode 100644
index 00000000..58d7a6d4
--- /dev/null
+++ b/docs/UserEmailAddressResponseData.md
@@ -0,0 +1,23 @@
+
+
+# UserEmailAddressResponseData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | Unique ID of the email address | |
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**UserEmailAddress**](UserEmailAddress.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| USER_EMAIL_ADDRESSES | "user_email_addresses" |
+
+
+
diff --git a/docs/UserEmailAddressesApi.md b/docs/UserEmailAddressesApi.md
new file mode 100644
index 00000000..cf6148bf
--- /dev/null
+++ b/docs/UserEmailAddressesApi.md
@@ -0,0 +1,506 @@
+# UserEmailAddressesApi
+
+All URIs are relative to *https://api.rootly.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createUserEmailAddress**](UserEmailAddressesApi.md#createUserEmailAddress) | **POST** /v1/users/{user_id}/email_addresses | Creates a user email address |
+| [**deleteUserEmailAddress**](UserEmailAddressesApi.md#deleteUserEmailAddress) | **DELETE** /v1/email_addresses/{id} | Delete user email address |
+| [**getUserEmailAddresses**](UserEmailAddressesApi.md#getUserEmailAddresses) | **GET** /v1/users/{user_id}/email_addresses | Retrieves user email addresses |
+| [**resendUserEmailAddressVerification**](UserEmailAddressesApi.md#resendUserEmailAddressVerification) | **POST** /v1/email_addresses/{id}/resend_verification | Resends verification email |
+| [**showUserEmailAddress**](UserEmailAddressesApi.md#showUserEmailAddress) | **GET** /v1/email_addresses/{id} | Show user email address |
+| [**updateUserEmailAddress**](UserEmailAddressesApi.md#updateUserEmailAddress) | **PUT** /v1/email_addresses/{id} | Update user email address |
+| [**verifyUserEmailAddress**](UserEmailAddressesApi.md#verifyUserEmailAddress) | **POST** /v1/email_addresses/{id}/verify | Verifies an email address with token |
+
+
+
+# **createUserEmailAddress**
+> UserEmailAddressResponse createUserEmailAddress(userId, newUserEmailAddress)
+
+Creates a user email address
+
+Creates a new user email address from provided data
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.UserEmailAddressesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ UserEmailAddressesApi apiInstance = new UserEmailAddressesApi(defaultClient);
+ String userId = "userId_example"; // String |
+ NewUserEmailAddress newUserEmailAddress = new NewUserEmailAddress(); // NewUserEmailAddress |
+ try {
+ UserEmailAddressResponse result = apiInstance.createUserEmailAddress(userId, newUserEmailAddress);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling UserEmailAddressesApi#createUserEmailAddress");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **userId** | **String**| | |
+| **newUserEmailAddress** | [**NewUserEmailAddress**](NewUserEmailAddress.md)| | |
+
+### Return type
+
+[**UserEmailAddressResponse**](UserEmailAddressResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/vnd.api+json
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | user_email_address created | - |
+| **401** | responds with unauthorized for invalid token | - |
+| **404** | responds with not found when accessing other user's resources | - |
+| **422** | invalid request | - |
+
+
+# **deleteUserEmailAddress**
+> UserEmailAddressResponse deleteUserEmailAddress(id)
+
+Delete user email address
+
+Deletes a user email address
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.UserEmailAddressesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ UserEmailAddressesApi apiInstance = new UserEmailAddressesApi(defaultClient);
+ String id = "id_example"; // String |
+ try {
+ UserEmailAddressResponse result = apiInstance.deleteUserEmailAddress(id);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling UserEmailAddressesApi#deleteUserEmailAddress");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| | |
+
+### Return type
+
+[**UserEmailAddressResponse**](UserEmailAddressResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | user_email_address deleted | - |
+| **401** | responds with unauthorized for invalid token | - |
+| **404** | responds with not found when accessing other user's resources | - |
+
+
+# **getUserEmailAddresses**
+> UserEmailAddressList getUserEmailAddresses(userId)
+
+Retrieves user email addresses
+
+Retrieves all email addresses for the specified user
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.UserEmailAddressesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ UserEmailAddressesApi apiInstance = new UserEmailAddressesApi(defaultClient);
+ String userId = "userId_example"; // String |
+ try {
+ UserEmailAddressList result = apiInstance.getUserEmailAddresses(userId);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling UserEmailAddressesApi#getUserEmailAddresses");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **userId** | **String**| | |
+
+### Return type
+
+[**UserEmailAddressList**](UserEmailAddressList.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | user_email_addresses found | - |
+| **401** | responds with unauthorized for invalid token | - |
+| **404** | responds with not found when accessing other user's resources | - |
+
+
+# **resendUserEmailAddressVerification**
+> UserEmailAddressResponse resendUserEmailAddressVerification(id)
+
+Resends verification email
+
+Resends verification email for an email address
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.UserEmailAddressesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ UserEmailAddressesApi apiInstance = new UserEmailAddressesApi(defaultClient);
+ String id = "id_example"; // String |
+ try {
+ UserEmailAddressResponse result = apiInstance.resendUserEmailAddressVerification(id);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling UserEmailAddressesApi#resendUserEmailAddressVerification");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| | |
+
+### Return type
+
+[**UserEmailAddressResponse**](UserEmailAddressResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | verification email sent successfully | - |
+| **422** | email address already verified | - |
+| **404** | email address not found | - |
+
+
+# **showUserEmailAddress**
+> UserEmailAddressResponse showUserEmailAddress(id)
+
+Show user email address
+
+Retrieves a specific user email address
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.UserEmailAddressesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ UserEmailAddressesApi apiInstance = new UserEmailAddressesApi(defaultClient);
+ String id = "id_example"; // String |
+ try {
+ UserEmailAddressResponse result = apiInstance.showUserEmailAddress(id);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling UserEmailAddressesApi#showUserEmailAddress");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| | |
+
+### Return type
+
+[**UserEmailAddressResponse**](UserEmailAddressResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | user_email_address found | - |
+| **401** | responds with unauthorized for invalid token | - |
+| **404** | responds with not found when accessing other user's resources | - |
+
+
+# **updateUserEmailAddress**
+> UserEmailAddressResponse updateUserEmailAddress(id, updateUserEmailAddress)
+
+Update user email address
+
+Updates a user email address
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.UserEmailAddressesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ UserEmailAddressesApi apiInstance = new UserEmailAddressesApi(defaultClient);
+ String id = "id_example"; // String |
+ UpdateUserEmailAddress updateUserEmailAddress = new UpdateUserEmailAddress(); // UpdateUserEmailAddress |
+ try {
+ UserEmailAddressResponse result = apiInstance.updateUserEmailAddress(id, updateUserEmailAddress);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling UserEmailAddressesApi#updateUserEmailAddress");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| | |
+| **updateUserEmailAddress** | [**UpdateUserEmailAddress**](UpdateUserEmailAddress.md)| | |
+
+### Return type
+
+[**UserEmailAddressResponse**](UserEmailAddressResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/vnd.api+json
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | user_email_address updated | - |
+| **401** | responds with unauthorized for invalid token | - |
+| **404** | responds with not found when accessing other user's resources | - |
+| **422** | invalid request | - |
+
+
+# **verifyUserEmailAddress**
+> UserEmailAddressResponse verifyUserEmailAddress(id, token)
+
+Verifies an email address with token
+
+Verifies an email address using a verification token
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.UserEmailAddressesApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ UserEmailAddressesApi apiInstance = new UserEmailAddressesApi(defaultClient);
+ String id = "id_example"; // String |
+ String token = "token_example"; // String |
+ try {
+ UserEmailAddressResponse result = apiInstance.verifyUserEmailAddress(id, token);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling UserEmailAddressesApi#verifyUserEmailAddress");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| | |
+| **token** | **String**| | |
+
+### Return type
+
+[**UserEmailAddressResponse**](UserEmailAddressResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | email address verified successfully | - |
+| **422** | invalid or expired token | - |
+| **404** | email address not found | - |
+
diff --git a/docs/UserFlatResponse.md b/docs/UserFlatResponse.md
new file mode 100644
index 00000000..76ac745c
--- /dev/null
+++ b/docs/UserFlatResponse.md
@@ -0,0 +1,22 @@
+
+
+# UserFlatResponse
+
+Flat user object as returned by serializer
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **Integer** | User ID | |
+|**email** | **String** | User email | |
+|**firstName** | **String** | User first name | [optional] |
+|**lastName** | **String** | User last name | [optional] |
+|**fullName** | **String** | User full name | [optional] |
+|**fullNameWithTeam** | **String** | User full name with team | [optional] |
+|**timeZone** | **String** | User time zone | [optional] |
+|**createdAt** | **String** | User creation timestamp | |
+|**updatedAt** | **String** | User last update timestamp | |
+
+
+
diff --git a/docs/UserList.md b/docs/UserList.md
index 4ef8e237..f43f7826 100644
--- a/docs/UserList.md
+++ b/docs/UserList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<UserResponseData>**](UserResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/UserNotificationRule.md b/docs/UserNotificationRule.md
index 249d253e..04219246 100644
--- a/docs/UserNotificationRule.md
+++ b/docs/UserNotificationRule.md
@@ -15,6 +15,7 @@
|**userSmsNumberId** | **String** | User sms number to which notification to be sent | [optional] |
|**userDeviceId** | **String** | User device to which notification to be sent | [optional] |
|**enabledContactTypes** | [**List<EnabledContactTypesEnum>**](#List<EnabledContactTypesEnum>) | Contact types for which notification needs to be enabled | [optional] |
+|**notificationType** | [**NotificationTypeEnum**](#NotificationTypeEnum) | Type of notification rule (audible or quiet). Audible notifications use sound/vibration to alert users, while quiet notifications are silent. | [optional] |
|**createdAt** | **String** | Date of creation | [optional] |
|**updatedAt** | **String** | Date of last update | [optional] |
@@ -29,6 +30,16 @@
| CALL | "call" |
| DEVICE | "device" |
| NON_CRITICAL_DEVICE | "non_critical_device" |
+| SLACK | "slack" |
+
+
+
+## Enum: NotificationTypeEnum
+
+| Name | Value |
+|---- | -----|
+| AUDIBLE | "audible" |
+| QUIET | "quiet" |
diff --git a/docs/UserNotificationRuleList.md b/docs/UserNotificationRuleList.md
index 3fc6eae6..18a6db87 100644
--- a/docs/UserNotificationRuleList.md
+++ b/docs/UserNotificationRuleList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<UserNotificationRuleResponseData>**](UserNotificationRuleResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/UserPhoneNumber.md b/docs/UserPhoneNumber.md
new file mode 100644
index 00000000..de35e52f
--- /dev/null
+++ b/docs/UserPhoneNumber.md
@@ -0,0 +1,19 @@
+
+
+# UserPhoneNumber
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**userId** | **Integer** | | [optional] |
+|**phone** | **String** | Phone number in international format | [optional] |
+|**primary** | **Boolean** | Whether this is the primary phone number | [optional] |
+|**verifiedAt** | **OffsetDateTime** | Date when phone number was verified | [optional] |
+|**verificationAttemptsToday** | **Integer** | Number of verification attempts made today | [optional] |
+|**createdAt** | **String** | Date of creation | [optional] |
+|**updatedAt** | **String** | Date of last update | [optional] |
+
+
+
diff --git a/docs/UserPhoneNumberList.md b/docs/UserPhoneNumberList.md
new file mode 100644
index 00000000..7d328adb
--- /dev/null
+++ b/docs/UserPhoneNumberList.md
@@ -0,0 +1,15 @@
+
+
+# UserPhoneNumberList
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**List<UserPhoneNumberResponseData>**](UserPhoneNumberResponseData.md) | | |
+|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
+
+
+
diff --git a/docs/UserPhoneNumberResponse.md b/docs/UserPhoneNumberResponse.md
new file mode 100644
index 00000000..770b3b66
--- /dev/null
+++ b/docs/UserPhoneNumberResponse.md
@@ -0,0 +1,13 @@
+
+
+# UserPhoneNumberResponse
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**UserPhoneNumberResponseData**](UserPhoneNumberResponseData.md) | | |
+
+
+
diff --git a/docs/UserPhoneNumberResponseData.md b/docs/UserPhoneNumberResponseData.md
new file mode 100644
index 00000000..e1c39c9f
--- /dev/null
+++ b/docs/UserPhoneNumberResponseData.md
@@ -0,0 +1,23 @@
+
+
+# UserPhoneNumberResponseData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** | Unique ID of the phone number | |
+|**type** | [**TypeEnum**](#TypeEnum) | | |
+|**attributes** | [**UserPhoneNumber**](UserPhoneNumber.md) | | |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| USER_PHONE_NUMBERS | "user_phone_numbers" |
+
+
+
diff --git a/docs/UserPhoneNumbersApi.md b/docs/UserPhoneNumbersApi.md
new file mode 100644
index 00000000..727aa946
--- /dev/null
+++ b/docs/UserPhoneNumbersApi.md
@@ -0,0 +1,365 @@
+# UserPhoneNumbersApi
+
+All URIs are relative to *https://api.rootly.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createUserPhoneNumber**](UserPhoneNumbersApi.md#createUserPhoneNumber) | **POST** /v1/users/{user_id}/phone_numbers | Creates a user phone number |
+| [**deleteUserPhoneNumber**](UserPhoneNumbersApi.md#deleteUserPhoneNumber) | **DELETE** /v1/phone_numbers/{id} | Delete user phone number |
+| [**getUserPhoneNumbers**](UserPhoneNumbersApi.md#getUserPhoneNumbers) | **GET** /v1/users/{user_id}/phone_numbers | Retrieves user phone numbers |
+| [**showUserPhoneNumber**](UserPhoneNumbersApi.md#showUserPhoneNumber) | **GET** /v1/phone_numbers/{id} | Show user phone number |
+| [**updateUserPhoneNumber**](UserPhoneNumbersApi.md#updateUserPhoneNumber) | **PUT** /v1/phone_numbers/{id} | Update user phone number |
+
+
+
+# **createUserPhoneNumber**
+> UserPhoneNumberResponse createUserPhoneNumber(userId, newUserPhoneNumber)
+
+Creates a user phone number
+
+Creates a new user phone number from provided data
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.UserPhoneNumbersApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ UserPhoneNumbersApi apiInstance = new UserPhoneNumbersApi(defaultClient);
+ String userId = "userId_example"; // String |
+ NewUserPhoneNumber newUserPhoneNumber = new NewUserPhoneNumber(); // NewUserPhoneNumber |
+ try {
+ UserPhoneNumberResponse result = apiInstance.createUserPhoneNumber(userId, newUserPhoneNumber);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling UserPhoneNumbersApi#createUserPhoneNumber");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **userId** | **String**| | |
+| **newUserPhoneNumber** | [**NewUserPhoneNumber**](NewUserPhoneNumber.md)| | |
+
+### Return type
+
+[**UserPhoneNumberResponse**](UserPhoneNumberResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/vnd.api+json
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | user_phone_number created | - |
+| **422** | invalid request | - |
+| **401** | responds with unauthorized for invalid token | - |
+| **404** | resource not found | - |
+
+
+# **deleteUserPhoneNumber**
+> UserPhoneNumberResponse deleteUserPhoneNumber(id)
+
+Delete user phone number
+
+Deletes a user phone number
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.UserPhoneNumbersApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ UserPhoneNumbersApi apiInstance = new UserPhoneNumbersApi(defaultClient);
+ String id = "id_example"; // String |
+ try {
+ UserPhoneNumberResponse result = apiInstance.deleteUserPhoneNumber(id);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling UserPhoneNumbersApi#deleteUserPhoneNumber");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| | |
+
+### Return type
+
+[**UserPhoneNumberResponse**](UserPhoneNumberResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | user_phone_number deleted | - |
+| **401** | responds with unauthorized for invalid token | - |
+| **404** | resource not found | - |
+| **422** | cannot delete phone number used by notification rule | - |
+
+
+# **getUserPhoneNumbers**
+> UserPhoneNumberList getUserPhoneNumbers(userId)
+
+Retrieves user phone numbers
+
+Retrieves all phone numbers for the specified user
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.UserPhoneNumbersApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ UserPhoneNumbersApi apiInstance = new UserPhoneNumbersApi(defaultClient);
+ String userId = "userId_example"; // String |
+ try {
+ UserPhoneNumberList result = apiInstance.getUserPhoneNumbers(userId);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling UserPhoneNumbersApi#getUserPhoneNumbers");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **userId** | **String**| | |
+
+### Return type
+
+[**UserPhoneNumberList**](UserPhoneNumberList.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | user_phone_numbers found | - |
+| **401** | responds with unauthorized for invalid token | - |
+| **404** | resource not found | - |
+
+
+# **showUserPhoneNumber**
+> UserPhoneNumberResponse showUserPhoneNumber(id)
+
+Show user phone number
+
+Retrieves a specific user phone number
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.UserPhoneNumbersApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ UserPhoneNumbersApi apiInstance = new UserPhoneNumbersApi(defaultClient);
+ String id = "id_example"; // String |
+ try {
+ UserPhoneNumberResponse result = apiInstance.showUserPhoneNumber(id);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling UserPhoneNumbersApi#showUserPhoneNumber");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| | |
+
+### Return type
+
+[**UserPhoneNumberResponse**](UserPhoneNumberResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | user_phone_number found | - |
+| **401** | responds with unauthorized for invalid token | - |
+| **404** | resource not found | - |
+
+
+# **updateUserPhoneNumber**
+> UserPhoneNumberResponse updateUserPhoneNumber(id, updateUserPhoneNumber)
+
+Update user phone number
+
+Updates a user phone number
+
+### Example
+```java
+// Import classes:
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.Configuration;
+import com.rootly.client.auth.*;
+import com.rootly.client.models.*;
+import com.rootly.client.api.UserPhoneNumbersApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("https://api.rootly.com");
+
+ // Configure HTTP bearer authorization: bearer_auth
+ HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
+ bearer_auth.setBearerToken("BEARER TOKEN");
+
+ UserPhoneNumbersApi apiInstance = new UserPhoneNumbersApi(defaultClient);
+ String id = "id_example"; // String |
+ UpdateUserPhoneNumber updateUserPhoneNumber = new UpdateUserPhoneNumber(); // UpdateUserPhoneNumber |
+ try {
+ UserPhoneNumberResponse result = apiInstance.updateUserPhoneNumber(id, updateUserPhoneNumber);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling UserPhoneNumbersApi#updateUserPhoneNumber");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | **String**| | |
+| **updateUserPhoneNumber** | [**UpdateUserPhoneNumber**](UpdateUserPhoneNumber.md)| | |
+
+### Return type
+
+[**UserPhoneNumberResponse**](UserPhoneNumberResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/vnd.api+json
+ - **Accept**: application/vnd.api+json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | user_phone_number updated and verification status reset | - |
+| **422** | invalid request | - |
+| **401** | responds with unauthorized for invalid token | - |
+| **404** | resource not found | - |
+
diff --git a/docs/UsersApi.md b/docs/UsersApi.md
index dc4e0d7c..d5efde9c 100644
--- a/docs/UsersApi.md
+++ b/docs/UsersApi.md
@@ -192,7 +192,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **id** | **String**| | |
-| **include** | **String**| comma separated if needed. eg: email_addresses,phone_numbers | [optional] [enum: email_addresses, phone_numbers, devices, role, on_call_role] |
+| **include** | **String**| comma separated if needed. eg: email_addresses,phone_numbers | [optional] [enum: email_addresses, phone_numbers, devices, role, on_call_role, teams, schedules, notification_rules] |
### Return type
@@ -210,7 +210,7 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **200** | user found | - |
+| **200** | schedules include only returns schedules from the current team | - |
| **404** | resource not found | - |
@@ -278,7 +278,7 @@ public class Example {
| **filterCreatedAtLt** | **String**| | [optional] |
| **filterCreatedAtLte** | **String**| | [optional] |
| **sort** | **String**| comma separated if needed. eg: created_at,updated_at | [optional] [enum: created_at, -created_at, updated_at, -updated_at] |
-| **include** | **String**| comma separated if needed. eg: email_addresses,phone_numbers | [optional] [enum: email_addresses, phone_numbers, devices, role, on_call_role] |
+| **include** | **String**| comma separated if needed. eg: email_addresses,phone_numbers | [optional] [enum: email_addresses, phone_numbers, devices, role, on_call_role, teams, schedules, notification_rules] |
### Return type
diff --git a/docs/VerifyPhoneNumberRequest.md b/docs/VerifyPhoneNumberRequest.md
new file mode 100644
index 00000000..f2d194bf
--- /dev/null
+++ b/docs/VerifyPhoneNumberRequest.md
@@ -0,0 +1,13 @@
+
+
+# VerifyPhoneNumberRequest
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**code** | **String** | 6-digit verification code | |
+
+
+
diff --git a/docs/WebhooksDeliveryList.md b/docs/WebhooksDeliveryList.md
index ace1b1e6..357d22b6 100644
--- a/docs/WebhooksDeliveryList.md
+++ b/docs/WebhooksDeliveryList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<WebhooksDeliveryResponseData>**](WebhooksDeliveryResponseData.md) | | |
|**links** | [**Links**](Links.md) | | [optional] |
+|**meta** | [**Meta**](Meta.md) | | [optional] |
diff --git a/docs/WebhooksEndpoint.md b/docs/WebhooksEndpoint.md
index 8ff4bb0b..a14b620e 100644
--- a/docs/WebhooksEndpoint.md
+++ b/docs/WebhooksEndpoint.md
@@ -8,7 +8,7 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**name** | **String** | The name of the endpoint | |
-|**slug** | **String** | The slug of the endpoint | |
+|**slug** | **String** | The slug of the endpoint | [optional] |
|**url** | **String** | The URL of the endpoint. | |
|**eventTypes** | [**List<EventTypesEnum>**](#List<EventTypesEnum>) | | |
|**secret** | **String** | The webhook signing secret used to verify webhook requests. | |
@@ -51,6 +51,7 @@
| GENIUS_WORKFLOW_RUN_COMPLETED | "genius_workflow_run.completed" |
| GENIUS_WORKFLOW_RUN_FAILED | "genius_workflow_run.failed" |
| GENIUS_WORKFLOW_RUN_CANCELED | "genius_workflow_run.canceled" |
+| AUDIT_LOG_CREATED | "audit_log.created" |
diff --git a/docs/WebhooksEndpointList.md b/docs/WebhooksEndpointList.md
index b4961295..28822b11 100644
--- a/docs/WebhooksEndpointList.md
+++ b/docs/WebhooksEndpointList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<WebhooksEndpointResponseData>**](WebhooksEndpointResponseData.md) | | |
|**links** | [**Links**](Links.md) | | [optional] |
+|**meta** | [**Meta**](Meta.md) | | [optional] |
diff --git a/docs/WebhooksEndpointsApi.md b/docs/WebhooksEndpointsApi.md
index 4cb1cb0e..735859a7 100644
--- a/docs/WebhooksEndpointsApi.md
+++ b/docs/WebhooksEndpointsApi.md
@@ -146,7 +146,7 @@ public class Example {
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | webhooks_endpoint deleted | - |
-| **404** | resource not found | - |
+| **404** | hidden endpoint not accessible | - |
# **getWebhooksEndpoint**
@@ -214,7 +214,7 @@ public class Example {
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | webhooks_endpoint found | - |
-| **404** | resource not found | - |
+| **404** | hidden endpoint not accessible | - |
# **listWebhooksEndpoints**
@@ -289,7 +289,7 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **200** | success | - |
+| **200** | excludes hidden endpoints from listing | - |
# **updateWebhooksEndpoint**
@@ -359,5 +359,5 @@ public class Example {
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | webhooks_endpoint updated | - |
-| **404** | resource not found | - |
+| **404** | hidden endpoint not accessible | - |
diff --git a/docs/WorkflowCustomFieldSelection.md b/docs/WorkflowCustomFieldSelection.md
index 3a9725b4..794ba958 100644
--- a/docs/WorkflowCustomFieldSelection.md
+++ b/docs/WorkflowCustomFieldSelection.md
@@ -20,6 +20,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
diff --git a/docs/WorkflowCustomFieldSelectionList.md b/docs/WorkflowCustomFieldSelectionList.md
index 03504e83..f9931ea8 100644
--- a/docs/WorkflowCustomFieldSelectionList.md
+++ b/docs/WorkflowCustomFieldSelectionList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<WorkflowCustomFieldSelectionResponseData>**](WorkflowCustomFieldSelectionResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/WorkflowFormFieldCondition.md b/docs/WorkflowFormFieldCondition.md
index 6560019b..d74d1874 100644
--- a/docs/WorkflowFormFieldCondition.md
+++ b/docs/WorkflowFormFieldCondition.md
@@ -17,6 +17,9 @@
|**selectedOptionIds** | **List<String>** | | |
|**selectedServiceIds** | **List<String>** | | [optional] |
|**selectedUserIds** | **List<Integer>** | | |
+|**selectedCauseIds** | **List<String>** | | [optional] |
+|**selectedEnvironmentIds** | **List<String>** | | [optional] |
+|**selectedIncidentTypeIds** | **List<String>** | | [optional] |
@@ -25,6 +28,7 @@
| Name | Value |
|---- | -----|
| IS | "IS" |
+| IS_NOT | "IS NOT" |
| ANY | "ANY" |
| CONTAINS | "CONTAINS" |
| CONTAINS_ALL | "CONTAINS_ALL" |
diff --git a/docs/WorkflowFormFieldConditionList.md b/docs/WorkflowFormFieldConditionList.md
index 586a5102..236fa120 100644
--- a/docs/WorkflowFormFieldConditionList.md
+++ b/docs/WorkflowFormFieldConditionList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<WorkflowFormFieldConditionResponseData>**](WorkflowFormFieldConditionResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/WorkflowFormFieldConditionsApi.md b/docs/WorkflowFormFieldConditionsApi.md
index 30b03552..691fd95e 100644
--- a/docs/WorkflowFormFieldConditionsApi.md
+++ b/docs/WorkflowFormFieldConditionsApi.md
@@ -78,7 +78,7 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **201** | workflow_form_field_condition created | - |
+| **201** | workflow_form_field_condition created with environment ids for non-environment form field | - |
| **401** | responds with unauthorized for invalid token | - |
@@ -214,7 +214,7 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **200** | workflow_form_field_condition found | - |
+| **200** | includes native field ids | - |
| **404** | resource not found | - |
diff --git a/docs/WorkflowGroupList.md b/docs/WorkflowGroupList.md
index b7ac4aaa..74906550 100644
--- a/docs/WorkflowGroupList.md
+++ b/docs/WorkflowGroupList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<WorkflowGroupResponseData>**](WorkflowGroupResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/WorkflowList.md b/docs/WorkflowList.md
index e377ccbf..025cdbbb 100644
--- a/docs/WorkflowList.md
+++ b/docs/WorkflowList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<WorkflowResponseData>**](WorkflowResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/WorkflowRunsApi.md b/docs/WorkflowRunsApi.md
index 518c4108..0bfd0aeb 100644
--- a/docs/WorkflowRunsApi.md
+++ b/docs/WorkflowRunsApi.md
@@ -158,5 +158,5 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **200** | success | - |
+| **200** | success with date filters using gte with timezone | - |
diff --git a/docs/WorkflowRunsList.md b/docs/WorkflowRunsList.md
index 1cd4dd46..d29743fc 100644
--- a/docs/WorkflowRunsList.md
+++ b/docs/WorkflowRunsList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<WorkflowRunResponseData>**](WorkflowRunResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/WorkflowTaskList.md b/docs/WorkflowTaskList.md
index 2aa99678..61005503 100644
--- a/docs/WorkflowTaskList.md
+++ b/docs/WorkflowTaskList.md
@@ -9,6 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<WorkflowTaskResponseData>**](WorkflowTaskResponseData.md) | | |
|**links** | [**Links**](Links.md) | | |
+|**meta** | [**Meta**](Meta.md) | | |
diff --git a/docs/WorkflowsApi.md b/docs/WorkflowsApi.md
index b9b38f7c..2020fab0 100644
--- a/docs/WorkflowsApi.md
+++ b/docs/WorkflowsApi.md
@@ -76,7 +76,7 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **201** | admins can set 'locked' while creating a workflow | - |
+| **201** | ignores alert field conditions in create request | - |
| **401** | responds with unauthorized for invalid token | - |
| **403** | non-admins can't set 'locked' while creating a workflow | - |
@@ -108,7 +108,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
WorkflowsApi apiInstance = new WorkflowsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
try {
WorkflowResponse result = apiInstance.deleteWorkflow(id);
System.out.println(result);
@@ -127,7 +127,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
### Return type
@@ -176,8 +176,8 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
WorkflowsApi apiInstance = new WorkflowsApi(defaultClient);
- String id = "id_example"; // String |
- String include = "form_field_conditions"; // String | comma separated if needed. eg: form_field_conditions,genius_tasks
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
+ String include = "form_field_conditions"; // String | comma separated if needed. eg: form_field_conditions,alert_field_conditions
try {
WorkflowResponse result = apiInstance.getWorkflow(id, include);
System.out.println(result);
@@ -196,8 +196,8 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
-| **include** | **String**| comma separated if needed. eg: form_field_conditions,genius_tasks | [optional] [enum: form_field_conditions, genius_tasks, genius_workflow_runs] |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
+| **include** | **String**| comma separated if needed. eg: form_field_conditions,alert_field_conditions | [optional] [enum: form_field_conditions, alert_field_conditions, genius_tasks, genius_workflow_runs] |
### Return type
@@ -215,7 +215,7 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **200** | workflow found | - |
+| **200** | does not serialize alert field conditions | - |
| **404** | resource not found | - |
@@ -246,7 +246,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
WorkflowsApi apiInstance = new WorkflowsApi(defaultClient);
- String include = "form_field_conditions"; // String | comma separated if needed. eg: form_field_conditions,genius_tasks
+ String include = "form_field_conditions"; // String | comma separated if needed. eg: form_field_conditions,alert_field_conditions
String sort = "created_at"; // String | comma separated if needed. eg: created_at,updated_at
Integer pageNumber = 56; // Integer |
Integer pageSize = 56; // Integer |
@@ -275,7 +275,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **include** | **String**| comma separated if needed. eg: form_field_conditions,genius_tasks | [optional] [enum: form_field_conditions, genius_tasks, genius_workflow_runs] |
+| **include** | **String**| comma separated if needed. eg: form_field_conditions,alert_field_conditions | [optional] [enum: form_field_conditions, alert_field_conditions, genius_tasks, genius_workflow_runs] |
| **sort** | **String**| comma separated if needed. eg: created_at,updated_at | [optional] [enum: created_at, -created_at, updated_at, -updated_at, position, -position] |
| **pageNumber** | **Integer**| | [optional] |
| **pageSize** | **Integer**| | [optional] |
@@ -333,7 +333,7 @@ public class Example {
bearer_auth.setBearerToken("BEARER TOKEN");
WorkflowsApi apiInstance = new WorkflowsApi(defaultClient);
- String id = "id_example"; // String |
+ GetAlertFieldIdParameter id = new GetAlertFieldIdParameter(); // GetAlertFieldIdParameter |
UpdateWorkflow updateWorkflow = new UpdateWorkflow(); // UpdateWorkflow |
try {
WorkflowResponse result = apiInstance.updateWorkflow(id, updateWorkflow);
@@ -353,7 +353,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
-| **id** | **String**| | |
+| **id** | [**GetAlertFieldIdParameter**](.md)| | |
| **updateWorkflow** | [**UpdateWorkflow**](UpdateWorkflow.md)| | |
### Return type
@@ -372,7 +372,7 @@ public class Example {
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **200** | admin can update 'locked' attribute | - |
+| **200** | preserves repeat_condition_* fields when omitted from PATCH payload | - |
| **404** | non-admin can't update locked workflow | - |
| **403** | non-admin can't update 'locked' attribute | - |
diff --git a/pom.xml b/pom.xml
index 139c93ef..5deab841 100644
--- a/pom.xml
+++ b/pom.xml
@@ -327,7 +327,7 @@
4.12.0
2.10.1
3.17.0
- 0.2.6
+ 0.2.10
1.3.5
2.0.2
5.10.3
diff --git a/src/main/java/com/rootly/client/ApiCallback.java b/src/main/java/com/rootly/client/ApiCallback.java
index 3fcfd15d..af9286e3 100644
--- a/src/main/java/com/rootly/client/ApiCallback.java
+++ b/src/main/java/com/rootly/client/ApiCallback.java
@@ -1,6 +1,6 @@
/*
* Rootly API v1
- * # How to generate an API Key? - **Organization dropdown** > **Organization Settings** > **API Keys** # JSON:API Specification Rootly is using **JSON:API** (https://jsonapi.org) specification: - JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests. - JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. - JSON:API requires use of the JSON:API media type (**application/vnd.api+json**) for exchanging data. # Authentication and Requests We use standard HTTP Authentication over HTTPS to authorize your requests. ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents ```
# Rate limiting - There is a default limit of approximately **3000** **GET** calls **per API key** every **60 seconds**. The limit is calculated over a **60-second sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - There is a default limit of approximately **3000** **PUT**, **POST**, **PATCH** or **DELETE** calls **per API key** every **60 seconds**. The limit is calculated over a **60-second sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - The response to the API call will return 429 HTTP status code - Request Limit Exceeded and Rootly will not ingest the event. - Additional headers will be returned giving you information about the limit: - **RateLimit-Limit** - The maximum number of requests that the consumer is permitted to make. - **RateLimit-Remaining** - The number of requests remaining in the current rate limit window. - **RateLimit-Reset** - The time at which the current rate limit window resets in UTC epoch seconds. # Pagination - Pagination is supported for all endpoints that return a collection of items. - Pagination is controlled by the **page** query parameter ## Example ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10 ```
+ * # How to generate an API Key? - **Organization dropdown** > **Organization Settings** > **API Keys** # JSON:API Specification Rootly is using **JSON:API** (https://jsonapi.org) specification: - JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests. - JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. - JSON:API requires use of the JSON:API media type (**application/vnd.api+json**) for exchanging data. # Authentication and Requests We use standard HTTP Authentication over HTTPS to authorize your requests. ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents ```
# Rate limiting - There is a default limit of **5** **GET**, **HEAD**, and **OPTIONS** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - There is a default limit of **3** **POST**, **PUT**, **PATCH** or **DELETE** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - When rate limits are exceeded, the API will return a **429 Too Many Requests** HTTP status code with the response: `{\"error\": \"Rate limit exceeded. Try again later.\"}` - **X-RateLimit headers** are included in every API response, providing real-time rate limit information: - **X-RateLimit-Limit** - The maximum number of requests permitted and the time window (e.g., \"1000, 1000;window=3600\" for 1000 requests per hour) - **X-RateLimit-Remaining** - The number of requests remaining in the current rate limit window - **X-RateLimit-Used** - The number of requests already made in the current window - **X-RateLimit-Reset** - The time at which the current rate limit window resets, in UTC epoch seconds # Pagination - Pagination is supported for all endpoints that return a collection of items. - Pagination is controlled by the **page** query parameter ## Example ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10 ```
*
* The version of the OpenAPI document: v1
*
diff --git a/src/main/java/com/rootly/client/ApiClient.java b/src/main/java/com/rootly/client/ApiClient.java
index 11d0f83b..9163c64b 100644
--- a/src/main/java/com/rootly/client/ApiClient.java
+++ b/src/main/java/com/rootly/client/ApiClient.java
@@ -1,6 +1,6 @@
/*
* Rootly API v1
- * # How to generate an API Key? - **Organization dropdown** > **Organization Settings** > **API Keys** # JSON:API Specification Rootly is using **JSON:API** (https://jsonapi.org) specification: - JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests. - JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. - JSON:API requires use of the JSON:API media type (**application/vnd.api+json**) for exchanging data. # Authentication and Requests We use standard HTTP Authentication over HTTPS to authorize your requests. ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents ```
# Rate limiting - There is a default limit of approximately **3000** **GET** calls **per API key** every **60 seconds**. The limit is calculated over a **60-second sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - There is a default limit of approximately **3000** **PUT**, **POST**, **PATCH** or **DELETE** calls **per API key** every **60 seconds**. The limit is calculated over a **60-second sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - The response to the API call will return 429 HTTP status code - Request Limit Exceeded and Rootly will not ingest the event. - Additional headers will be returned giving you information about the limit: - **RateLimit-Limit** - The maximum number of requests that the consumer is permitted to make. - **RateLimit-Remaining** - The number of requests remaining in the current rate limit window. - **RateLimit-Reset** - The time at which the current rate limit window resets in UTC epoch seconds. # Pagination - Pagination is supported for all endpoints that return a collection of items. - Pagination is controlled by the **page** query parameter ## Example ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10 ```
+ * # How to generate an API Key? - **Organization dropdown** > **Organization Settings** > **API Keys** # JSON:API Specification Rootly is using **JSON:API** (https://jsonapi.org) specification: - JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests. - JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. - JSON:API requires use of the JSON:API media type (**application/vnd.api+json**) for exchanging data. # Authentication and Requests We use standard HTTP Authentication over HTTPS to authorize your requests. ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents ```
# Rate limiting - There is a default limit of **5** **GET**, **HEAD**, and **OPTIONS** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - There is a default limit of **3** **POST**, **PUT**, **PATCH** or **DELETE** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - When rate limits are exceeded, the API will return a **429 Too Many Requests** HTTP status code with the response: `{\"error\": \"Rate limit exceeded. Try again later.\"}` - **X-RateLimit headers** are included in every API response, providing real-time rate limit information: - **X-RateLimit-Limit** - The maximum number of requests permitted and the time window (e.g., \"1000, 1000;window=3600\" for 1000 requests per hour) - **X-RateLimit-Remaining** - The number of requests remaining in the current rate limit window - **X-RateLimit-Used** - The number of requests already made in the current window - **X-RateLimit-Reset** - The time at which the current rate limit window resets, in UTC epoch seconds # Pagination - Pagination is supported for all endpoints that return a collection of items. - Pagination is controlled by the **page** query parameter ## Example ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10 ```
*
* The version of the OpenAPI document: v1
*
diff --git a/src/main/java/com/rootly/client/ApiException.java b/src/main/java/com/rootly/client/ApiException.java
index 7a3f78f3..db868eb6 100644
--- a/src/main/java/com/rootly/client/ApiException.java
+++ b/src/main/java/com/rootly/client/ApiException.java
@@ -1,6 +1,6 @@
/*
* Rootly API v1
- * # How to generate an API Key? - **Organization dropdown** > **Organization Settings** > **API Keys** # JSON:API Specification Rootly is using **JSON:API** (https://jsonapi.org) specification: - JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests. - JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. - JSON:API requires use of the JSON:API media type (**application/vnd.api+json**) for exchanging data. # Authentication and Requests We use standard HTTP Authentication over HTTPS to authorize your requests. ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents ```
# Rate limiting - There is a default limit of approximately **3000** **GET** calls **per API key** every **60 seconds**. The limit is calculated over a **60-second sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - There is a default limit of approximately **3000** **PUT**, **POST**, **PATCH** or **DELETE** calls **per API key** every **60 seconds**. The limit is calculated over a **60-second sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - The response to the API call will return 429 HTTP status code - Request Limit Exceeded and Rootly will not ingest the event. - Additional headers will be returned giving you information about the limit: - **RateLimit-Limit** - The maximum number of requests that the consumer is permitted to make. - **RateLimit-Remaining** - The number of requests remaining in the current rate limit window. - **RateLimit-Reset** - The time at which the current rate limit window resets in UTC epoch seconds. # Pagination - Pagination is supported for all endpoints that return a collection of items. - Pagination is controlled by the **page** query parameter ## Example ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10 ```
+ * # How to generate an API Key? - **Organization dropdown** > **Organization Settings** > **API Keys** # JSON:API Specification Rootly is using **JSON:API** (https://jsonapi.org) specification: - JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests. - JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. - JSON:API requires use of the JSON:API media type (**application/vnd.api+json**) for exchanging data. # Authentication and Requests We use standard HTTP Authentication over HTTPS to authorize your requests. ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents ```
# Rate limiting - There is a default limit of **5** **GET**, **HEAD**, and **OPTIONS** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - There is a default limit of **3** **POST**, **PUT**, **PATCH** or **DELETE** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - When rate limits are exceeded, the API will return a **429 Too Many Requests** HTTP status code with the response: `{\"error\": \"Rate limit exceeded. Try again later.\"}` - **X-RateLimit headers** are included in every API response, providing real-time rate limit information: - **X-RateLimit-Limit** - The maximum number of requests permitted and the time window (e.g., \"1000, 1000;window=3600\" for 1000 requests per hour) - **X-RateLimit-Remaining** - The number of requests remaining in the current rate limit window - **X-RateLimit-Used** - The number of requests already made in the current window - **X-RateLimit-Reset** - The time at which the current rate limit window resets, in UTC epoch seconds # Pagination - Pagination is supported for all endpoints that return a collection of items. - Pagination is controlled by the **page** query parameter ## Example ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10 ```
*
* The version of the OpenAPI document: v1
*
@@ -21,7 +21,7 @@
* ApiException class.
*/
@SuppressWarnings("serial")
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2025-05-22T07:13:31.203496-07:00[America/Los_Angeles]", comments = "Generator version: 7.13.0")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2026-05-07T08:36:28.586343560Z[Etc/UTC]", comments = "Generator version: 7.13.0")
public class ApiException extends Exception {
private static final long serialVersionUID = 1L;
diff --git a/src/main/java/com/rootly/client/ApiResponse.java b/src/main/java/com/rootly/client/ApiResponse.java
index 4b83741b..4452c684 100644
--- a/src/main/java/com/rootly/client/ApiResponse.java
+++ b/src/main/java/com/rootly/client/ApiResponse.java
@@ -1,6 +1,6 @@
/*
* Rootly API v1
- * # How to generate an API Key? - **Organization dropdown** > **Organization Settings** > **API Keys** # JSON:API Specification Rootly is using **JSON:API** (https://jsonapi.org) specification: - JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests. - JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. - JSON:API requires use of the JSON:API media type (**application/vnd.api+json**) for exchanging data. # Authentication and Requests We use standard HTTP Authentication over HTTPS to authorize your requests. ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents ```
# Rate limiting - There is a default limit of approximately **3000** **GET** calls **per API key** every **60 seconds**. The limit is calculated over a **60-second sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - There is a default limit of approximately **3000** **PUT**, **POST**, **PATCH** or **DELETE** calls **per API key** every **60 seconds**. The limit is calculated over a **60-second sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - The response to the API call will return 429 HTTP status code - Request Limit Exceeded and Rootly will not ingest the event. - Additional headers will be returned giving you information about the limit: - **RateLimit-Limit** - The maximum number of requests that the consumer is permitted to make. - **RateLimit-Remaining** - The number of requests remaining in the current rate limit window. - **RateLimit-Reset** - The time at which the current rate limit window resets in UTC epoch seconds. # Pagination - Pagination is supported for all endpoints that return a collection of items. - Pagination is controlled by the **page** query parameter ## Example ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10 ```
+ * # How to generate an API Key? - **Organization dropdown** > **Organization Settings** > **API Keys** # JSON:API Specification Rootly is using **JSON:API** (https://jsonapi.org) specification: - JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests. - JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. - JSON:API requires use of the JSON:API media type (**application/vnd.api+json**) for exchanging data. # Authentication and Requests We use standard HTTP Authentication over HTTPS to authorize your requests. ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents ```
# Rate limiting - There is a default limit of **5** **GET**, **HEAD**, and **OPTIONS** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - There is a default limit of **3** **POST**, **PUT**, **PATCH** or **DELETE** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - When rate limits are exceeded, the API will return a **429 Too Many Requests** HTTP status code with the response: `{\"error\": \"Rate limit exceeded. Try again later.\"}` - **X-RateLimit headers** are included in every API response, providing real-time rate limit information: - **X-RateLimit-Limit** - The maximum number of requests permitted and the time window (e.g., \"1000, 1000;window=3600\" for 1000 requests per hour) - **X-RateLimit-Remaining** - The number of requests remaining in the current rate limit window - **X-RateLimit-Used** - The number of requests already made in the current window - **X-RateLimit-Reset** - The time at which the current rate limit window resets, in UTC epoch seconds # Pagination - Pagination is supported for all endpoints that return a collection of items. - Pagination is controlled by the **page** query parameter ## Example ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10 ```
*
* The version of the OpenAPI document: v1
*
diff --git a/src/main/java/com/rootly/client/Configuration.java b/src/main/java/com/rootly/client/Configuration.java
index 57fcabf1..bc93e821 100644
--- a/src/main/java/com/rootly/client/Configuration.java
+++ b/src/main/java/com/rootly/client/Configuration.java
@@ -1,6 +1,6 @@
/*
* Rootly API v1
- * # How to generate an API Key? - **Organization dropdown** > **Organization Settings** > **API Keys** # JSON:API Specification Rootly is using **JSON:API** (https://jsonapi.org) specification: - JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests. - JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. - JSON:API requires use of the JSON:API media type (**application/vnd.api+json**) for exchanging data. # Authentication and Requests We use standard HTTP Authentication over HTTPS to authorize your requests. ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents ```
# Rate limiting - There is a default limit of approximately **3000** **GET** calls **per API key** every **60 seconds**. The limit is calculated over a **60-second sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - There is a default limit of approximately **3000** **PUT**, **POST**, **PATCH** or **DELETE** calls **per API key** every **60 seconds**. The limit is calculated over a **60-second sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - The response to the API call will return 429 HTTP status code - Request Limit Exceeded and Rootly will not ingest the event. - Additional headers will be returned giving you information about the limit: - **RateLimit-Limit** - The maximum number of requests that the consumer is permitted to make. - **RateLimit-Remaining** - The number of requests remaining in the current rate limit window. - **RateLimit-Reset** - The time at which the current rate limit window resets in UTC epoch seconds. # Pagination - Pagination is supported for all endpoints that return a collection of items. - Pagination is controlled by the **page** query parameter ## Example ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10 ```
+ * # How to generate an API Key? - **Organization dropdown** > **Organization Settings** > **API Keys** # JSON:API Specification Rootly is using **JSON:API** (https://jsonapi.org) specification: - JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests. - JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. - JSON:API requires use of the JSON:API media type (**application/vnd.api+json**) for exchanging data. # Authentication and Requests We use standard HTTP Authentication over HTTPS to authorize your requests. ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents ```
# Rate limiting - There is a default limit of **5** **GET**, **HEAD**, and **OPTIONS** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - There is a default limit of **3** **POST**, **PUT**, **PATCH** or **DELETE** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - When rate limits are exceeded, the API will return a **429 Too Many Requests** HTTP status code with the response: `{\"error\": \"Rate limit exceeded. Try again later.\"}` - **X-RateLimit headers** are included in every API response, providing real-time rate limit information: - **X-RateLimit-Limit** - The maximum number of requests permitted and the time window (e.g., \"1000, 1000;window=3600\" for 1000 requests per hour) - **X-RateLimit-Remaining** - The number of requests remaining in the current rate limit window - **X-RateLimit-Used** - The number of requests already made in the current window - **X-RateLimit-Reset** - The time at which the current rate limit window resets, in UTC epoch seconds # Pagination - Pagination is supported for all endpoints that return a collection of items. - Pagination is controlled by the **page** query parameter ## Example ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10 ```
*
* The version of the OpenAPI document: v1
*
@@ -17,7 +17,7 @@
import java.util.concurrent.atomic.AtomicReference;
import java.util.function.Supplier;
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2025-05-22T07:13:31.203496-07:00[America/Los_Angeles]", comments = "Generator version: 7.13.0")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2026-05-07T08:36:28.586343560Z[Etc/UTC]", comments = "Generator version: 7.13.0")
public class Configuration {
public static final String VERSION = "v1";
diff --git a/src/main/java/com/rootly/client/GzipRequestInterceptor.java b/src/main/java/com/rootly/client/GzipRequestInterceptor.java
index 656f5904..4d318f31 100644
--- a/src/main/java/com/rootly/client/GzipRequestInterceptor.java
+++ b/src/main/java/com/rootly/client/GzipRequestInterceptor.java
@@ -1,6 +1,6 @@
/*
* Rootly API v1
- * # How to generate an API Key? - **Organization dropdown** > **Organization Settings** > **API Keys** # JSON:API Specification Rootly is using **JSON:API** (https://jsonapi.org) specification: - JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests. - JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. - JSON:API requires use of the JSON:API media type (**application/vnd.api+json**) for exchanging data. # Authentication and Requests We use standard HTTP Authentication over HTTPS to authorize your requests. ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents ```
# Rate limiting - There is a default limit of approximately **3000** **GET** calls **per API key** every **60 seconds**. The limit is calculated over a **60-second sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - There is a default limit of approximately **3000** **PUT**, **POST**, **PATCH** or **DELETE** calls **per API key** every **60 seconds**. The limit is calculated over a **60-second sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - The response to the API call will return 429 HTTP status code - Request Limit Exceeded and Rootly will not ingest the event. - Additional headers will be returned giving you information about the limit: - **RateLimit-Limit** - The maximum number of requests that the consumer is permitted to make. - **RateLimit-Remaining** - The number of requests remaining in the current rate limit window. - **RateLimit-Reset** - The time at which the current rate limit window resets in UTC epoch seconds. # Pagination - Pagination is supported for all endpoints that return a collection of items. - Pagination is controlled by the **page** query parameter ## Example ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10 ```
+ * # How to generate an API Key? - **Organization dropdown** > **Organization Settings** > **API Keys** # JSON:API Specification Rootly is using **JSON:API** (https://jsonapi.org) specification: - JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests. - JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. - JSON:API requires use of the JSON:API media type (**application/vnd.api+json**) for exchanging data. # Authentication and Requests We use standard HTTP Authentication over HTTPS to authorize your requests. ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents ```
# Rate limiting - There is a default limit of **5** **GET**, **HEAD**, and **OPTIONS** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - There is a default limit of **3** **POST**, **PUT**, **PATCH** or **DELETE** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - When rate limits are exceeded, the API will return a **429 Too Many Requests** HTTP status code with the response: `{\"error\": \"Rate limit exceeded. Try again later.\"}` - **X-RateLimit headers** are included in every API response, providing real-time rate limit information: - **X-RateLimit-Limit** - The maximum number of requests permitted and the time window (e.g., \"1000, 1000;window=3600\" for 1000 requests per hour) - **X-RateLimit-Remaining** - The number of requests remaining in the current rate limit window - **X-RateLimit-Used** - The number of requests already made in the current window - **X-RateLimit-Reset** - The time at which the current rate limit window resets, in UTC epoch seconds # Pagination - Pagination is supported for all endpoints that return a collection of items. - Pagination is controlled by the **page** query parameter ## Example ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10 ```
*
* The version of the OpenAPI document: v1
*
diff --git a/src/main/java/com/rootly/client/JSON.java b/src/main/java/com/rootly/client/JSON.java
index 6ef1aa08..914b77d7 100644
--- a/src/main/java/com/rootly/client/JSON.java
+++ b/src/main/java/com/rootly/client/JSON.java
@@ -1,6 +1,6 @@
/*
* Rootly API v1
- * # How to generate an API Key? - **Organization dropdown** > **Organization Settings** > **API Keys** # JSON:API Specification Rootly is using **JSON:API** (https://jsonapi.org) specification: - JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests. - JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. - JSON:API requires use of the JSON:API media type (**application/vnd.api+json**) for exchanging data. # Authentication and Requests We use standard HTTP Authentication over HTTPS to authorize your requests. ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents ```
# Rate limiting - There is a default limit of approximately **3000** **GET** calls **per API key** every **60 seconds**. The limit is calculated over a **60-second sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - There is a default limit of approximately **3000** **PUT**, **POST**, **PATCH** or **DELETE** calls **per API key** every **60 seconds**. The limit is calculated over a **60-second sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - The response to the API call will return 429 HTTP status code - Request Limit Exceeded and Rootly will not ingest the event. - Additional headers will be returned giving you information about the limit: - **RateLimit-Limit** - The maximum number of requests that the consumer is permitted to make. - **RateLimit-Remaining** - The number of requests remaining in the current rate limit window. - **RateLimit-Reset** - The time at which the current rate limit window resets in UTC epoch seconds. # Pagination - Pagination is supported for all endpoints that return a collection of items. - Pagination is controlled by the **page** query parameter ## Example ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10 ```
+ * # How to generate an API Key? - **Organization dropdown** > **Organization Settings** > **API Keys** # JSON:API Specification Rootly is using **JSON:API** (https://jsonapi.org) specification: - JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests. - JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. - JSON:API requires use of the JSON:API media type (**application/vnd.api+json**) for exchanging data. # Authentication and Requests We use standard HTTP Authentication over HTTPS to authorize your requests. ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents ```
# Rate limiting - There is a default limit of **5** **GET**, **HEAD**, and **OPTIONS** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - There is a default limit of **3** **POST**, **PUT**, **PATCH** or **DELETE** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - When rate limits are exceeded, the API will return a **429 Too Many Requests** HTTP status code with the response: `{\"error\": \"Rate limit exceeded. Try again later.\"}` - **X-RateLimit headers** are included in every API response, providing real-time rate limit information: - **X-RateLimit-Limit** - The maximum number of requests permitted and the time window (e.g., \"1000, 1000;window=3600\" for 1000 requests per hour) - **X-RateLimit-Remaining** - The number of requests remaining in the current rate limit window - **X-RateLimit-Used** - The number of requests already made in the current window - **X-RateLimit-Reset** - The time at which the current rate limit window resets, in UTC epoch seconds # Pagination - Pagination is supported for all endpoints that return a collection of items. - Pagination is controlled by the **page** query parameter ## Example ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10 ```
*
* The version of the OpenAPI document: v1
*
@@ -100,6 +100,7 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AddActionItemTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AddActionItemTaskParamsAssignedToUser.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AddActionItemTaskParamsPostToSlackChannelsInner.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AddMicrosoftTeamsChatTabTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AddMicrosoftTeamsTabTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AddRoleTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AddRoleTaskParamsAssignedToUser.CustomTypeAdapterFactory());
@@ -114,20 +115,39 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AlertEventList.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AlertEventResponse.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AlertEventResponseData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AlertField.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AlertFieldList.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AlertFieldListDataInner.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AlertFieldResponse.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AlertFieldResponseData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AlertGroup.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AlertGroupConditionsInner.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AlertGroupConditionsInnerValuesInner.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AlertGroupList.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AlertGroupResponse.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AlertGroupResponseData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AlertList.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AlertResponse.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AlertResponseData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AlertRoute.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AlertRouteList.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AlertRouteResponse.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AlertRouteResponseData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AlertRoutingRule.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AlertRoutingRuleCondition.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AlertRoutingRuleConditionGroup.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AlertRoutingRuleConditionGroupsInner.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AlertRoutingRuleConditionGroupsInnerConditionsInner.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AlertRoutingRuleConditionsInner.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AlertRoutingRuleDestination.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AlertRoutingRuleList.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AlertRoutingRuleResponse.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AlertRoutingRuleResponseData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AlertRoutingRuleTarget.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AlertTriggerParams.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AlertTriggerParamsAlertFieldConditionsInner.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AlertTriggerParamsAlertPayloadConditions.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AlertTriggerParamsAlertPayloadConditionsConditionsInner.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AlertUrgency.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AlertUrgencyList.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AlertUrgencyResponse.CustomTypeAdapterFactory());
@@ -136,6 +156,13 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AlertsSourceList.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AlertsSourceResponse.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AlertsSourceResponseData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.ApiKey.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.ApiKeyList.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.ApiKeyResponse.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.ApiKeyResponseData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.ApiKeyWithTokenResponse.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.ApiKeyWithTokenResponseData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.ApiKeyWithTokenResponseDataAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.ArchiveMicrosoftTeamsChannelsTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.ArchiveSlackChannelsTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AssignRoleToUser.CustomTypeAdapterFactory());
@@ -156,12 +183,29 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AutoAssignRolePagerdutyTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AutoAssignRoleRootlyTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.AutoAssignRoleVictorOpsTaskParams.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.BuiltinField.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CallPeopleTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CancelIncident.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CancelIncidentData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CancelIncidentDataAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.Catalog.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CatalogChecklistTemplate.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CatalogChecklistTemplateFieldsInner.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CatalogChecklistTemplateList.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CatalogChecklistTemplateOwnersInner.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CatalogChecklistTemplateResponse.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CatalogChecklistTemplateResponseData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CatalogEntity.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CatalogEntityChecklist.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CatalogEntityChecklistChecklistFieldsInner.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CatalogEntityChecklistChecklistFieldsInnerData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CatalogEntityChecklistChecklistFieldsInnerDataAttributes.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CatalogEntityChecklistChecklistOwnersInner.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CatalogEntityChecklistChecklistOwnersInnerData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CatalogEntityChecklistChecklistOwnersInnerDataAttributes.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CatalogEntityChecklistList.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CatalogEntityChecklistResponse.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CatalogEntityChecklistResponseData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CatalogEntityList.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CatalogEntityProperty.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CatalogEntityPropertyList.CustomTypeAdapterFactory());
@@ -174,6 +218,10 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CatalogFieldResponse.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CatalogFieldResponseData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CatalogList.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CatalogProperty.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CatalogPropertyList.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CatalogPropertyResponse.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CatalogPropertyResponseData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CatalogResponse.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CatalogResponseData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.Cause.CustomTypeAdapterFactory());
@@ -181,22 +229,58 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CauseResponse.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CauseResponseData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.ChangeSlackChannelPrivacyTaskParams.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CommunicationsGroup.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CommunicationsGroupCommunicationExternalGroupMembersInner.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CommunicationsGroupResponse.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CommunicationsGroupResponseData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CommunicationsGroupsResponse.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CommunicationsStage.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CommunicationsStageResponse.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CommunicationsStageResponseData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CommunicationsStagesResponse.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CommunicationsTemplate.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CommunicationsTemplateCommunicationTemplateStagesInner.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CommunicationsTemplateCommunicationTemplateStagesInnerData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CommunicationsTemplateCommunicationTemplateStagesInnerDataAttributes.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CommunicationsTemplateCommunicationTemplateStagesInnerDataAttributesCommunicationStage.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CommunicationsTemplateCommunicationTemplateStagesInnerDataAttributesCommunicationTemplate.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CommunicationsTemplateCommunicationType.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CommunicationsTemplateResponse.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CommunicationsTemplateResponseData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CommunicationsTemplatesResponse.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CommunicationsType.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CommunicationsTypeResponse.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CommunicationsTypeResponseData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CommunicationsTypesResponse.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateAirtableTableRecordTaskParams.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateAnthropicChatCompletionTaskParams.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateAnthropicChatCompletionTaskParamsModel.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateAsanaSubtaskTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateAsanaTaskTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateClickupTaskTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateCodaPageTaskParams.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateCodaPageTaskParamsDoc.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateCodaPageTaskParamsTemplate.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateConfluencePageTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateConfluencePageTaskParamsIntegration.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateDatadogNotebookTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateDropboxPaperPageTaskParams.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateEdgeConnectorActionRequest.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateEdgeConnectorActionRequestAction.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateEdgeConnectorActionRequestActionMetadata.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateEdgeConnectorActionRequestActionMetadataParametersInner.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateEdgeConnectorRequest.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateEdgeConnectorRequestData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateEdgeConnectorRequestDataAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateGithubIssueTaskParams.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateGithubIssueTaskParamsIssueType.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateGitlabIssueTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateGoToMeetingTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateGoogleCalendarEventTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateGoogleDocsPageTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateGoogleDocsPermissionsTaskParams.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateGoogleGeminiChatCompletionTaskParams.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateGoogleGeminiChatCompletionTaskParamsModel.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateGoogleMeetingTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateIncidentPostmortemTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateIncidentPostmortemTaskParamsTemplate.CustomTypeAdapterFactory());
@@ -207,6 +291,7 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateJiraIssueTaskParamsPriority.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateJiraIssueTaskParamsStatus.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateJiraSubtaskTaskParams.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateJsmopsAlertTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateLinearIssueCommentTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateLinearIssueTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateLinearIssueTaskParamsProject.CustomTypeAdapterFactory());
@@ -214,10 +299,16 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateLinearIssueTaskParamsTeam.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateLinearSubtaskIssueTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateMicrosoftTeamsChannelTaskParams.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateMicrosoftTeamsChatTaskParams.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateMicrosoftTeamsChatTaskParamsMembersInner.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateMicrosoftTeamsMeetingTaskParams.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateMistralChatCompletionTaskParams.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateMistralChatCompletionTaskParamsModel.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateMotionTaskTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateNotionPageTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateNotionPageTaskParamsParentPage.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateOpenaiChatCompletionTaskParams.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateOpenaiChatCompletionTaskParamsModel.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateOpsgenieAlertTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateOutlookEventTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreatePagerdutyStatusUpdateTaskParams.CustomTypeAdapterFactory());
@@ -229,10 +320,13 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateShortcutStoryTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateShortcutTaskTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateSlackChannelTaskParams.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateSubIncidentTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateTrelloCardTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateTrelloCardTaskParamsArchivation.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateTrelloCardTaskParamsBoard.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateTrelloCardTaskParamsList.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateWatsonxChatCompletionTaskParams.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateWatsonxChatCompletionTaskParamsModel.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateWebexMeetingTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateZendeskJiraLinkTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.CreateZendeskTicketTaskParams.CustomTypeAdapterFactory());
@@ -257,15 +351,28 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.DashboardPanelResponseData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.DashboardResponse.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.DashboardResponseData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.DeleteAlertRoute200Response.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.DeleteAlertRoute200ResponseData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.DeleteAlertRoute200ResponseDataAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.DuplicateIncident.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.DuplicateIncidentData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.DuplicateIncidentDataAttributes.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.EdgeConnector.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.EdgeConnectorAction.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.EdgeConnectorActionData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.EdgeConnectorActionDataAttributes.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.EdgeConnectorActionDataAttributesParametersInner.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.EdgeConnectorData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.EdgeConnectorDataAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.Environment.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.EnvironmentList.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.EnvironmentResponse.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.EnvironmentResponseData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.ErrorsList.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.ErrorsListErrorsInner.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.EscalateAlert.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.EscalateAlertData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.EscalateAlertDataAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.EscalationPolicy.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.EscalationPolicyLevel.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.EscalationPolicyLevelList.CustomTypeAdapterFactory());
@@ -278,8 +385,6 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.EscalationPolicyPathListDataInner.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.EscalationPolicyPathResponse.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.EscalationPolicyPathResponseData.CustomTypeAdapterFactory());
- gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.EscalationPolicyPathRulesInner.CustomTypeAdapterFactory());
- gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.EscalationPolicyPathRulesInnerAnyOf.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.EscalationPolicyResponse.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.EscalationPolicyResponseData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.FormField.CustomTypeAdapterFactory());
@@ -314,15 +419,13 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.FunctionalityList.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.FunctionalityResponse.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.FunctionalityResponseData.CustomTypeAdapterFactory());
- gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.GeniusCreateOpenaiChatCompletionTaskParams.CustomTypeAdapterFactory());
- gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.GeniusCreateOpenaiChatCompletionTaskParamsModel.CustomTypeAdapterFactory());
- gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.GeniusCreateWatsonxChatCompletionTaskParams.CustomTypeAdapterFactory());
- gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.GeniusCreateWatsonxChatCompletionTaskParamsModel.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.GetAlertFieldIdParameter.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.GetAlertsTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.GetGithubCommitsTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.GetGitlabCommitsTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.GetPulsesTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.GetPulsesTaskParamsParentMessageThreadTask.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.GetTeamIdParameter.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.Heartbeat.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.HeartbeatList.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.HeartbeatResponse.CustomTypeAdapterFactory());
@@ -402,6 +505,7 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.IncidentTypeList.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.IncidentTypeResponse.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.IncidentTypeResponseData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.IncidentZoomMeetingGlobalDialInNumbersInner.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.InviteToMicrosoftTeamsChannelTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.InviteToSlackChannelOpsgenieTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.InviteToSlackChannelPagerdutyTaskParams.CustomTypeAdapterFactory());
@@ -416,56 +520,101 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.LiveCallRouterList.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.LiveCallRouterResponse.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.LiveCallRouterResponseData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.MeetingRecording.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.MeetingRecordingList.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.MeetingRecordingListDataInner.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.Meta.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.MitigateIncident.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.MitigateIncidentData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.MitigateIncidentDataAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAlert.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAlertData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAlertDataAttributes.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAlertDataAttributesAlertFieldValuesAttributesInner.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAlertDataAttributesLabelsInner.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAlertDataAttributesLabelsInnerValue.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAlertEvent.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAlertEventData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAlertEventDataAttributes.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAlertField.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAlertFieldData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAlertFieldDataAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAlertGroup.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAlertGroupData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAlertGroupDataAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAlertGroupDataAttributesAttributesInner.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAlertGroupDataAttributesConditionsInner.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAlertGroupDataAttributesTargetsInner.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAlertRoute.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAlertRouteData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAlertRouteDataAttributes.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAlertRouteDataAttributesRulesInner.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAlertRouteDataAttributesRulesInnerConditionGroupsInner.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAlertRouteDataAttributesRulesInnerConditionGroupsInnerConditionsInner.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAlertRouteDataAttributesRulesInnerDestinationsInner.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAlertRoutingRule.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAlertRoutingRuleData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAlertRoutingRuleDataAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAlertRoutingRuleDataAttributesConditionsInner.CustomTypeAdapterFactory());
- gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAlertRoutingRuleDataAttributesDestination.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAlertUrgency.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAlertUrgencyData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAlertUrgencyDataAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAlertsSource.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAlertsSourceData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAlertsSourceDataAttributes.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAlertsSourceDataAttributesAlertSourceFieldsAttributesInner.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAlertsSourceDataAttributesAlertSourceUrgencyRulesAttributesInner.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAlertsSourceDataAttributesAlertTemplateAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAlertsSourceDataAttributesResolutionRuleAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAlertsSourceDataAttributesResolutionRuleAttributesConditionsAttributesInner.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAlertsSourceDataAttributesSourceableAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAlertsSourceDataAttributesSourceableAttributesFieldMappingsAttributesInner.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewApiKey.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewApiKeyData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewApiKeyDataAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAuthorization.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAuthorizationData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewAuthorizationDataAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewCatalog.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewCatalogChecklistTemplate.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewCatalogChecklistTemplateData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewCatalogChecklistTemplateDataAttributes.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewCatalogChecklistTemplateDataAttributesFieldsInner.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewCatalogChecklistTemplateDataAttributesOwnersInner.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewCatalogData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewCatalogDataAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewCatalogEntity.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewCatalogEntityData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewCatalogEntityDataAttributes.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewCatalogEntityDataAttributesPropertiesInner.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewCatalogEntityProperty.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewCatalogEntityPropertyData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewCatalogEntityPropertyDataAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewCatalogField.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewCatalogFieldData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewCatalogFieldDataAttributes.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewCatalogProperty.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewCatalogPropertyData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewCatalogPropertyDataAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewCause.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewCauseData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewCauseDataAttributes.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewCauseDataAttributesPropertiesInner.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewCommunicationsGroup.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewCommunicationsGroupData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewCommunicationsGroupDataAttributes.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewCommunicationsGroupDataAttributesCommunicationExternalGroupMembersInner.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewCommunicationsGroupDataAttributesCommunicationGroupConditionsInner.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewCommunicationsStage.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewCommunicationsStageData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewCommunicationsStageDataAttributes.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewCommunicationsTemplate.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewCommunicationsTemplateData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewCommunicationsTemplateDataAttributes.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewCommunicationsTemplateDataAttributesCommunicationTemplateStagesAttributesInner.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewCommunicationsType.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewCommunicationsTypeData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewCommunicationsTypeDataAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewCustomField.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewCustomFieldData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewCustomFieldDataAttributes.CustomTypeAdapterFactory());
@@ -487,8 +636,15 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewDashboardPanelDataAttributesParamsDatasetsInnerAggregate.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewDashboardPanelDataAttributesParamsDatasetsInnerFilterInner.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewDashboardPanelDataAttributesParamsDatasetsInnerFilterInnerRulesInner.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewDashboardPanelDataAttributesParamsDatasetsInnerGroupBy.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewDashboardPanelDataAttributesParamsDatasetsInnerGroupByOneOf.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewDashboardPanelDataAttributesParamsLegend.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewDashboardPanelDataAttributesPosition.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewEdgeConnector.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewEdgeConnectorAction.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewEdgeConnectorActionAction.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewEdgeConnectorActionActionMetadata.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewEdgeConnectorEdgeConnector.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewEnvironment.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewEnvironmentData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewEnvironmentDataAttributes.CustomTypeAdapterFactory());
@@ -506,9 +662,14 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewEscalationPolicyPathData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewEscalationPolicyPathDataAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewEscalationPolicyPathDataAttributesRulesInner.CustomTypeAdapterFactory());
- gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewEscalationPolicyPathDataAttributesRulesInnerAnyOf.CustomTypeAdapterFactory());
- gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewEscalationPolicyPathDataAttributesRulesInnerAnyOf1.CustomTypeAdapterFactory());
- gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewEscalationPolicyPathDataAttributesRulesInnerAnyOf2.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewEscalationPolicyPathDataAttributesRulesInnerOneOf.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewEscalationPolicyPathDataAttributesRulesInnerOneOf1.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewEscalationPolicyPathDataAttributesRulesInnerOneOf2.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewEscalationPolicyPathDataAttributesRulesInnerOneOf3.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewEscalationPolicyPathDataAttributesRulesInnerOneOf4.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewEscalationPolicyPathDataAttributesRulesInnerOneOf5.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewEscalationPolicyPathDataAttributesRulesInnerOneOf5TimeBlocksInner.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewEscalationPolicyPathDataAttributesTimeRestrictionsInner.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewFormField.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewFormFieldData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewFormFieldDataAttributes.CustomTypeAdapterFactory());
@@ -589,6 +750,10 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewLiveCallRouterData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewLiveCallRouterDataAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewLiveCallRouterDataAttributesEscalationPolicyTriggerParams.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewLiveCallRouterDataAttributesPagingTargetsInner.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewOnCallPayReport.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewOnCallPayReportData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewOnCallPayReportDataAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewOnCallRole.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewOnCallRoleData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewOnCallRoleDataAttributes.CustomTypeAdapterFactory());
@@ -610,6 +775,7 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewPulse.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewPulseData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewPulseDataAttributes.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewPulseDataAttributesLabelsInner.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewPulseDataAttributesRefsInner.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewRetrospectiveProcess.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewRetrospectiveProcessData.CustomTypeAdapterFactory());
@@ -633,6 +799,7 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewSchedule.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewScheduleData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewScheduleDataAttributes.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewScheduleDataAttributesSlackChannel.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewScheduleDataAttributesSlackUserGroup.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewScheduleRotation.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewScheduleRotationActiveDay.CustomTypeAdapterFactory());
@@ -642,6 +809,7 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewScheduleRotationData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewScheduleRotationDataAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewScheduleRotationDataAttributesActiveTimeAttributesInner.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewScheduleRotationDataAttributesScheduleRotationMembersInner.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewScheduleRotationDataAttributesScheduleRotationableAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewScheduleRotationDataAttributesScheduleRotationableAttributesOneOf.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewScheduleRotationDataAttributesScheduleRotationableAttributesOneOf1.CustomTypeAdapterFactory());
@@ -656,9 +824,16 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewService.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewServiceData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewServiceDataAttributes.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewServiceDataAttributesAlertBroadcastChannel.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewServiceDataAttributesIncidentBroadcastChannel.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewSeverity.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewSeverityData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewSeverityDataAttributes.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewSla.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewSlaData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewSlaDataAttributes.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewSlaDataAttributesConditionsInner.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewSlaDataAttributesNotificationConfigurationsInner.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewStatusPage.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewStatusPageData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewStatusPageDataAttributes.CustomTypeAdapterFactory());
@@ -671,9 +846,15 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewTeam.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewTeamData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewTeamDataAttributes.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewUserEmailAddress.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewUserEmailAddressData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewUserEmailAddressDataAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewUserNotificationRule.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewUserNotificationRuleData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewUserNotificationRuleDataAttributes.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewUserPhoneNumber.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewUserPhoneNumberData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewUserPhoneNumberDataAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewWebhooksEndpoint.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewWebhooksEndpointData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewWebhooksEndpointDataAttributes.CustomTypeAdapterFactory());
@@ -703,6 +884,10 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewWorkflowTaskData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewWorkflowTaskDataAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.NewWorkflowTaskDataAttributesTaskParams.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.OnCallPayReport.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.OnCallPayReportList.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.OnCallPayReportResponse.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.OnCallPayReportResponseData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.OnCallRole.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.OnCallRoleList.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.OnCallRoleRelationship.CustomTypeAdapterFactory());
@@ -718,10 +903,19 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.OverrideShiftList.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.OverrideShiftResponse.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.OverrideShiftResponseData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.PageJsmopsOnCallRespondersTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.PageOpsgenieOnCallRespondersTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.PagePagerdutyOnCallRespondersTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.PageRootlyOnCallRespondersTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.PageVictorOpsOnCallRespondersTaskParams.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.PatchAlertRoute.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.PatchAlertRouteData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.PatchAlertRouteDataAttributes.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.PatchAlertRouteDataAttributesRulesInner.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.PatchAlertRouteDataAttributesRulesInnerConditionGroupsInner.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.PatchAlertRouteDataAttributesRulesInnerConditionGroupsInnerConditionsInner.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.PatchAlertRouteDataAttributesRulesInnerDestinationsInner.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.PhoneVerificationResponse.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.Playbook.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.PlaybookList.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.PlaybookResponse.CustomTypeAdapterFactory());
@@ -785,6 +979,9 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.RoleRelationshipData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.RoleResponse.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.RoleResponseData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.RotateApiKey.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.RotateApiKeyData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.RotateApiKeyDataAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.RunCommandHerokuTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.Schedule.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.ScheduleList.CustomTypeAdapterFactory());
@@ -804,6 +1001,7 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.ScheduleRotationUserList.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.ScheduleRotationUserListDataInner.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.ScheduleRotationUserResponse.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.ScheduleSlackChannel.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.ScheduleSlackUserGroup.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.Secret.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.SecretList.CustomTypeAdapterFactory());
@@ -812,12 +1010,15 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.SendDashboardReportTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.SendEmailTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.SendMicrosoftTeamsBlocksTaskParams.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.SendMicrosoftTeamsChatMessageTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.SendMicrosoftTeamsMessageTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.SendSlackBlocksTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.SendSlackMessageTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.SendSmsTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.SendWhatsappMessageTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.Service.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.ServiceAlertBroadcastChannel.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.ServiceIncidentBroadcastChannel.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.ServiceList.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.ServiceResponse.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.ServiceResponseData.CustomTypeAdapterFactory());
@@ -831,11 +1032,29 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.ShiftOverride.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.ShiftOverrideResponse.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.ShiftOverrideResponseData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.ShiftRelationships.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.ShiftRelationshipsAssignee.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.ShiftRelationshipsAssigneeData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.ShiftRelationshipsShiftOverride.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.ShiftRelationshipsShiftOverrideData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.ShiftRelationshipsUser.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.ShiftRelationshipsUserData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.SimpleTriggerParams.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.Sla.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.SlaConditionsInner.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.SlaList.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.SlaNotificationConfigurationsInner.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.SlaResponse.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.SlaResponseData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.SnapshotDatadogGraphTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.SnapshotGrafanaDashboardTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.SnapshotLookerLookTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.SnapshotNewRelicGraphTaskParams.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.SnoozeAlert.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.SnoozeAlertData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.SnoozeAlertDataAttributes.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.Status.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.StatusList.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.StatusPage.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.StatusPageList.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.StatusPageResponse.CustomTypeAdapterFactory());
@@ -845,6 +1064,8 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.StatusPageTemplateListDataInner.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.StatusPageTemplateResponse.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.StatusPageTemplateResponseData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.StatusResponse.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.StatusResponseData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.SubStatus.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.SubStatusList.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.SubStatusResponse.CustomTypeAdapterFactory());
@@ -853,6 +1074,9 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.TeamList.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.TeamResponse.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.TeamResponseData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.TiptapBlockSchema.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.TiptapBlockSchemaFollowupComponent.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.TiptapBlockSchemaTimelineComponent.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.TriggerWorkflowTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.TweetTwitterMessageTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UnassignRoleFromUser.CustomTypeAdapterFactory());
@@ -866,9 +1090,15 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateAlertEvent.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateAlertEventData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateAlertEventDataAttributes.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateAlertField.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateAlertFieldData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateAlertFieldDataAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateAlertGroup.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateAlertGroupData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateAlertGroupDataAttributes.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateAlertRoute.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateAlertRouteData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateAlertRouteDataAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateAlertRoutingRule.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateAlertRoutingRuleData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateAlertRoutingRuleDataAttributes.CustomTypeAdapterFactory());
@@ -880,12 +1110,18 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateAlertsSource.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateAlertsSourceData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateAlertsSourceDataAttributes.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateApiKey.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateApiKeyData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateApiKeyDataAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateAsanaTaskTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateAttachedAlertsTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateAuthorization.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateAuthorizationData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateAuthorizationDataAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateCatalog.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateCatalogChecklistTemplate.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateCatalogChecklistTemplateData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateCatalogChecklistTemplateDataAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateCatalogData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateCatalogDataAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateCatalogEntity.CustomTypeAdapterFactory());
@@ -897,11 +1133,31 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateCatalogField.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateCatalogFieldData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateCatalogFieldDataAttributes.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateCatalogProperty.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateCatalogPropertyData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateCatalogPropertyDataAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateCause.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateCauseData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateCauseDataAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateClickupTaskTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateCodaPageTaskParams.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateCommunicationsGroup.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateCommunicationsGroupData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateCommunicationsGroupDataAttributes.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateCommunicationsGroupDataAttributesCommunicationExternalGroupMembersInner.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateCommunicationsGroupDataAttributesCommunicationGroupConditionsInner.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateCommunicationsStage.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateCommunicationsStageData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateCommunicationsStageDataAttributes.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateCommunicationsTemplate.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateCommunicationsTemplateData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateCommunicationsTemplateDataAttributes.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateCommunicationsTemplateDataAttributesCommunicationTemplateStagesAttributesInner.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateCommunicationsType.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateCommunicationsTypeData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateCommunicationsTypeDataAttributes.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateConfluencePageTaskParams.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateConfluencePageTaskParamsTemplate.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateCustomField.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateCustomFieldData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateCustomFieldDataAttributes.CustomTypeAdapterFactory());
@@ -917,6 +1173,16 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateDashboardPanel.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateDashboardPanelData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateDashboardPanelDataAttributes.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateDatadogNotebookTaskParams.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateDatadogNotebookTaskParamsTemplate.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateDropboxPaperPageTaskParams.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateEdgeConnector.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateEdgeConnectorAction.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateEdgeConnectorActionRequest.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateEdgeConnectorActionRequestAction.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateEdgeConnectorRequest.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateEdgeConnectorRequestData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateEdgeConnectorRequestDataAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateEnvironment.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateEnvironmentData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateEnvironmentDataAttributes.CustomTypeAdapterFactory());
@@ -931,6 +1197,7 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateEscalationPolicyPathData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateEscalationPolicyPathDataAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateEscalationPolicyPathDataAttributesRulesInner.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateEscalationPolicyPathDataAttributesTimeRestrictionsInner.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateFormField.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateFormFieldData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateFormFieldDataAttributes.CustomTypeAdapterFactory());
@@ -956,6 +1223,7 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateFunctionalityData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateFunctionalityDataAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateGithubIssueTaskParams.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateGithubIssueTaskParamsRepository.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateGitlabIssueTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateGoogleCalendarEventTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateGoogleDocsPageTaskParams.CustomTypeAdapterFactory());
@@ -1022,12 +1290,16 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateIncidentTypeDataAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateJiraIssueTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateLinearIssueTaskParams.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateLinearIssueTaskParamsState.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateLiveCallRouter.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateLiveCallRouterData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateLiveCallRouterDataAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateLiveCallRouterDataAttributesEscalationPolicyTriggerParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateMotionTaskTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateNotionPageTaskParams.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateOnCallPayReport.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateOnCallPayReportData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateOnCallPayReportDataAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateOnCallRole.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateOnCallRoleData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateOnCallRoleDataAttributes.CustomTypeAdapterFactory());
@@ -1053,6 +1325,7 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdatePulse.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdatePulseData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdatePulseDataAttributes.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateQuipPageTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateRetrospectiveConfiguration.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateRetrospectiveConfigurationData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateRetrospectiveConfigurationDataAttributes.CustomTypeAdapterFactory());
@@ -1093,8 +1366,12 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateSeverity.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateSeverityData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateSeverityDataAttributes.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateSharepointPageTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateShortcutStoryTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateShortcutTaskTaskParams.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateSla.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateSlaData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateSlaDataAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateSlackChannelTopicTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateStatusPage.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateStatusPageData.CustomTypeAdapterFactory());
@@ -1113,9 +1390,15 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateUser.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateUserData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateUserDataAttributes.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateUserEmailAddress.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateUserEmailAddressData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateUserEmailAddressDataAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateUserNotificationRule.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateUserNotificationRuleData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateUserNotificationRuleDataAttributes.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateUserPhoneNumber.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateUserPhoneNumberData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateUserPhoneNumberDataAttributes.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateVictorOpsIncidentTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateWebhooksEndpoint.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateWebhooksEndpointData.CustomTypeAdapterFactory());
@@ -1138,14 +1421,24 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateWorkflowTaskDataAttributesTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UpdateZendeskTicketTaskParams.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.User.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UserEmailAddress.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UserEmailAddressList.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UserEmailAddressResponse.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UserEmailAddressResponseData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UserFlatResponse.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UserList.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UserNotificationRule.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UserNotificationRuleList.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UserNotificationRuleResponse.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UserNotificationRuleResponseData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UserPhoneNumber.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UserPhoneNumberList.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UserPhoneNumberResponse.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UserPhoneNumberResponseData.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UserRelationships.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UserResponse.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.UserResponseData.CustomTypeAdapterFactory());
+ gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.VerifyPhoneNumberRequest.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.WebhooksDelivery.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.WebhooksDeliveryList.CustomTypeAdapterFactory());
gsonBuilder.registerTypeAdapterFactory(new com.rootly.client.model.WebhooksDeliveryResponse.CustomTypeAdapterFactory());
diff --git a/src/main/java/com/rootly/client/Pair.java b/src/main/java/com/rootly/client/Pair.java
index 1a78fece..3f76e217 100644
--- a/src/main/java/com/rootly/client/Pair.java
+++ b/src/main/java/com/rootly/client/Pair.java
@@ -1,6 +1,6 @@
/*
* Rootly API v1
- * # How to generate an API Key? - **Organization dropdown** > **Organization Settings** > **API Keys** # JSON:API Specification Rootly is using **JSON:API** (https://jsonapi.org) specification: - JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests. - JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. - JSON:API requires use of the JSON:API media type (**application/vnd.api+json**) for exchanging data. # Authentication and Requests We use standard HTTP Authentication over HTTPS to authorize your requests. ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents ```
# Rate limiting - There is a default limit of approximately **3000** **GET** calls **per API key** every **60 seconds**. The limit is calculated over a **60-second sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - There is a default limit of approximately **3000** **PUT**, **POST**, **PATCH** or **DELETE** calls **per API key** every **60 seconds**. The limit is calculated over a **60-second sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - The response to the API call will return 429 HTTP status code - Request Limit Exceeded and Rootly will not ingest the event. - Additional headers will be returned giving you information about the limit: - **RateLimit-Limit** - The maximum number of requests that the consumer is permitted to make. - **RateLimit-Remaining** - The number of requests remaining in the current rate limit window. - **RateLimit-Reset** - The time at which the current rate limit window resets in UTC epoch seconds. # Pagination - Pagination is supported for all endpoints that return a collection of items. - Pagination is controlled by the **page** query parameter ## Example ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10 ```
+ * # How to generate an API Key? - **Organization dropdown** > **Organization Settings** > **API Keys** # JSON:API Specification Rootly is using **JSON:API** (https://jsonapi.org) specification: - JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests. - JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. - JSON:API requires use of the JSON:API media type (**application/vnd.api+json**) for exchanging data. # Authentication and Requests We use standard HTTP Authentication over HTTPS to authorize your requests. ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents ```
# Rate limiting - There is a default limit of **5** **GET**, **HEAD**, and **OPTIONS** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - There is a default limit of **3** **POST**, **PUT**, **PATCH** or **DELETE** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - When rate limits are exceeded, the API will return a **429 Too Many Requests** HTTP status code with the response: `{\"error\": \"Rate limit exceeded. Try again later.\"}` - **X-RateLimit headers** are included in every API response, providing real-time rate limit information: - **X-RateLimit-Limit** - The maximum number of requests permitted and the time window (e.g., \"1000, 1000;window=3600\" for 1000 requests per hour) - **X-RateLimit-Remaining** - The number of requests remaining in the current rate limit window - **X-RateLimit-Used** - The number of requests already made in the current window - **X-RateLimit-Reset** - The time at which the current rate limit window resets, in UTC epoch seconds # Pagination - Pagination is supported for all endpoints that return a collection of items. - Pagination is controlled by the **page** query parameter ## Example ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10 ```
*
* The version of the OpenAPI document: v1
*
@@ -13,7 +13,7 @@
package com.rootly.client;
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2025-05-22T07:13:31.203496-07:00[America/Los_Angeles]", comments = "Generator version: 7.13.0")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2026-05-07T08:36:28.586343560Z[Etc/UTC]", comments = "Generator version: 7.13.0")
public class Pair {
private String name = "";
private String value = "";
diff --git a/src/main/java/com/rootly/client/ProgressRequestBody.java b/src/main/java/com/rootly/client/ProgressRequestBody.java
index 097a31a7..9a2d3e98 100644
--- a/src/main/java/com/rootly/client/ProgressRequestBody.java
+++ b/src/main/java/com/rootly/client/ProgressRequestBody.java
@@ -1,6 +1,6 @@
/*
* Rootly API v1
- * # How to generate an API Key? - **Organization dropdown** > **Organization Settings** > **API Keys** # JSON:API Specification Rootly is using **JSON:API** (https://jsonapi.org) specification: - JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests. - JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. - JSON:API requires use of the JSON:API media type (**application/vnd.api+json**) for exchanging data. # Authentication and Requests We use standard HTTP Authentication over HTTPS to authorize your requests. ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents ```
# Rate limiting - There is a default limit of approximately **3000** **GET** calls **per API key** every **60 seconds**. The limit is calculated over a **60-second sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - There is a default limit of approximately **3000** **PUT**, **POST**, **PATCH** or **DELETE** calls **per API key** every **60 seconds**. The limit is calculated over a **60-second sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - The response to the API call will return 429 HTTP status code - Request Limit Exceeded and Rootly will not ingest the event. - Additional headers will be returned giving you information about the limit: - **RateLimit-Limit** - The maximum number of requests that the consumer is permitted to make. - **RateLimit-Remaining** - The number of requests remaining in the current rate limit window. - **RateLimit-Reset** - The time at which the current rate limit window resets in UTC epoch seconds. # Pagination - Pagination is supported for all endpoints that return a collection of items. - Pagination is controlled by the **page** query parameter ## Example ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10 ```
+ * # How to generate an API Key? - **Organization dropdown** > **Organization Settings** > **API Keys** # JSON:API Specification Rootly is using **JSON:API** (https://jsonapi.org) specification: - JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests. - JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. - JSON:API requires use of the JSON:API media type (**application/vnd.api+json**) for exchanging data. # Authentication and Requests We use standard HTTP Authentication over HTTPS to authorize your requests. ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents ```
# Rate limiting - There is a default limit of **5** **GET**, **HEAD**, and **OPTIONS** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - There is a default limit of **3** **POST**, **PUT**, **PATCH** or **DELETE** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - When rate limits are exceeded, the API will return a **429 Too Many Requests** HTTP status code with the response: `{\"error\": \"Rate limit exceeded. Try again later.\"}` - **X-RateLimit headers** are included in every API response, providing real-time rate limit information: - **X-RateLimit-Limit** - The maximum number of requests permitted and the time window (e.g., \"1000, 1000;window=3600\" for 1000 requests per hour) - **X-RateLimit-Remaining** - The number of requests remaining in the current rate limit window - **X-RateLimit-Used** - The number of requests already made in the current window - **X-RateLimit-Reset** - The time at which the current rate limit window resets, in UTC epoch seconds # Pagination - Pagination is supported for all endpoints that return a collection of items. - Pagination is controlled by the **page** query parameter ## Example ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10 ```
*
* The version of the OpenAPI document: v1
*
diff --git a/src/main/java/com/rootly/client/ProgressResponseBody.java b/src/main/java/com/rootly/client/ProgressResponseBody.java
index e8dd5cae..1688c921 100644
--- a/src/main/java/com/rootly/client/ProgressResponseBody.java
+++ b/src/main/java/com/rootly/client/ProgressResponseBody.java
@@ -1,6 +1,6 @@
/*
* Rootly API v1
- * # How to generate an API Key? - **Organization dropdown** > **Organization Settings** > **API Keys** # JSON:API Specification Rootly is using **JSON:API** (https://jsonapi.org) specification: - JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests. - JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. - JSON:API requires use of the JSON:API media type (**application/vnd.api+json**) for exchanging data. # Authentication and Requests We use standard HTTP Authentication over HTTPS to authorize your requests. ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents ```
# Rate limiting - There is a default limit of approximately **3000** **GET** calls **per API key** every **60 seconds**. The limit is calculated over a **60-second sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - There is a default limit of approximately **3000** **PUT**, **POST**, **PATCH** or **DELETE** calls **per API key** every **60 seconds**. The limit is calculated over a **60-second sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - The response to the API call will return 429 HTTP status code - Request Limit Exceeded and Rootly will not ingest the event. - Additional headers will be returned giving you information about the limit: - **RateLimit-Limit** - The maximum number of requests that the consumer is permitted to make. - **RateLimit-Remaining** - The number of requests remaining in the current rate limit window. - **RateLimit-Reset** - The time at which the current rate limit window resets in UTC epoch seconds. # Pagination - Pagination is supported for all endpoints that return a collection of items. - Pagination is controlled by the **page** query parameter ## Example ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10 ```
+ * # How to generate an API Key? - **Organization dropdown** > **Organization Settings** > **API Keys** # JSON:API Specification Rootly is using **JSON:API** (https://jsonapi.org) specification: - JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests. - JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. - JSON:API requires use of the JSON:API media type (**application/vnd.api+json**) for exchanging data. # Authentication and Requests We use standard HTTP Authentication over HTTPS to authorize your requests. ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents ```
# Rate limiting - There is a default limit of **5** **GET**, **HEAD**, and **OPTIONS** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - There is a default limit of **3** **POST**, **PUT**, **PATCH** or **DELETE** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - When rate limits are exceeded, the API will return a **429 Too Many Requests** HTTP status code with the response: `{\"error\": \"Rate limit exceeded. Try again later.\"}` - **X-RateLimit headers** are included in every API response, providing real-time rate limit information: - **X-RateLimit-Limit** - The maximum number of requests permitted and the time window (e.g., \"1000, 1000;window=3600\" for 1000 requests per hour) - **X-RateLimit-Remaining** - The number of requests remaining in the current rate limit window - **X-RateLimit-Used** - The number of requests already made in the current window - **X-RateLimit-Reset** - The time at which the current rate limit window resets, in UTC epoch seconds # Pagination - Pagination is supported for all endpoints that return a collection of items. - Pagination is controlled by the **page** query parameter ## Example ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10 ```
*
* The version of the OpenAPI document: v1
*
diff --git a/src/main/java/com/rootly/client/ServerConfiguration.java b/src/main/java/com/rootly/client/ServerConfiguration.java
index faace7e5..fc4846e7 100644
--- a/src/main/java/com/rootly/client/ServerConfiguration.java
+++ b/src/main/java/com/rootly/client/ServerConfiguration.java
@@ -1,6 +1,6 @@
/*
* Rootly API v1
- * # How to generate an API Key? - **Organization dropdown** > **Organization Settings** > **API Keys** # JSON:API Specification Rootly is using **JSON:API** (https://jsonapi.org) specification: - JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests. - JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. - JSON:API requires use of the JSON:API media type (**application/vnd.api+json**) for exchanging data. # Authentication and Requests We use standard HTTP Authentication over HTTPS to authorize your requests. ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents ```
# Rate limiting - There is a default limit of approximately **3000** **GET** calls **per API key** every **60 seconds**. The limit is calculated over a **60-second sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - There is a default limit of approximately **3000** **PUT**, **POST**, **PATCH** or **DELETE** calls **per API key** every **60 seconds**. The limit is calculated over a **60-second sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - The response to the API call will return 429 HTTP status code - Request Limit Exceeded and Rootly will not ingest the event. - Additional headers will be returned giving you information about the limit: - **RateLimit-Limit** - The maximum number of requests that the consumer is permitted to make. - **RateLimit-Remaining** - The number of requests remaining in the current rate limit window. - **RateLimit-Reset** - The time at which the current rate limit window resets in UTC epoch seconds. # Pagination - Pagination is supported for all endpoints that return a collection of items. - Pagination is controlled by the **page** query parameter ## Example ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10 ```
+ * # How to generate an API Key? - **Organization dropdown** > **Organization Settings** > **API Keys** # JSON:API Specification Rootly is using **JSON:API** (https://jsonapi.org) specification: - JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests. - JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. - JSON:API requires use of the JSON:API media type (**application/vnd.api+json**) for exchanging data. # Authentication and Requests We use standard HTTP Authentication over HTTPS to authorize your requests. ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents ```
# Rate limiting - There is a default limit of **5** **GET**, **HEAD**, and **OPTIONS** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - There is a default limit of **3** **POST**, **PUT**, **PATCH** or **DELETE** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - When rate limits are exceeded, the API will return a **429 Too Many Requests** HTTP status code with the response: `{\"error\": \"Rate limit exceeded. Try again later.\"}` - **X-RateLimit headers** are included in every API response, providing real-time rate limit information: - **X-RateLimit-Limit** - The maximum number of requests permitted and the time window (e.g., \"1000, 1000;window=3600\" for 1000 requests per hour) - **X-RateLimit-Remaining** - The number of requests remaining in the current rate limit window - **X-RateLimit-Used** - The number of requests already made in the current window - **X-RateLimit-Reset** - The time at which the current rate limit window resets, in UTC epoch seconds # Pagination - Pagination is supported for all endpoints that return a collection of items. - Pagination is controlled by the **page** query parameter ## Example ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10 ```
*
* The version of the OpenAPI document: v1
*
@@ -18,7 +18,7 @@
/**
* Representing a Server configuration.
*/
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2025-05-22T07:13:31.203496-07:00[America/Los_Angeles]", comments = "Generator version: 7.13.0")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2026-05-07T08:36:28.586343560Z[Etc/UTC]", comments = "Generator version: 7.13.0")
public class ServerConfiguration {
public String URL;
public String description;
diff --git a/src/main/java/com/rootly/client/ServerVariable.java b/src/main/java/com/rootly/client/ServerVariable.java
index 78ac2878..3d584b6b 100644
--- a/src/main/java/com/rootly/client/ServerVariable.java
+++ b/src/main/java/com/rootly/client/ServerVariable.java
@@ -1,6 +1,6 @@
/*
* Rootly API v1
- * # How to generate an API Key? - **Organization dropdown** > **Organization Settings** > **API Keys** # JSON:API Specification Rootly is using **JSON:API** (https://jsonapi.org) specification: - JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests. - JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. - JSON:API requires use of the JSON:API media type (**application/vnd.api+json**) for exchanging data. # Authentication and Requests We use standard HTTP Authentication over HTTPS to authorize your requests. ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents ```
# Rate limiting - There is a default limit of approximately **3000** **GET** calls **per API key** every **60 seconds**. The limit is calculated over a **60-second sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - There is a default limit of approximately **3000** **PUT**, **POST**, **PATCH** or **DELETE** calls **per API key** every **60 seconds**. The limit is calculated over a **60-second sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - The response to the API call will return 429 HTTP status code - Request Limit Exceeded and Rootly will not ingest the event. - Additional headers will be returned giving you information about the limit: - **RateLimit-Limit** - The maximum number of requests that the consumer is permitted to make. - **RateLimit-Remaining** - The number of requests remaining in the current rate limit window. - **RateLimit-Reset** - The time at which the current rate limit window resets in UTC epoch seconds. # Pagination - Pagination is supported for all endpoints that return a collection of items. - Pagination is controlled by the **page** query parameter ## Example ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10 ```
+ * # How to generate an API Key? - **Organization dropdown** > **Organization Settings** > **API Keys** # JSON:API Specification Rootly is using **JSON:API** (https://jsonapi.org) specification: - JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests. - JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. - JSON:API requires use of the JSON:API media type (**application/vnd.api+json**) for exchanging data. # Authentication and Requests We use standard HTTP Authentication over HTTPS to authorize your requests. ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents ```
# Rate limiting - There is a default limit of **5** **GET**, **HEAD**, and **OPTIONS** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - There is a default limit of **3** **POST**, **PUT**, **PATCH** or **DELETE** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - When rate limits are exceeded, the API will return a **429 Too Many Requests** HTTP status code with the response: `{\"error\": \"Rate limit exceeded. Try again later.\"}` - **X-RateLimit headers** are included in every API response, providing real-time rate limit information: - **X-RateLimit-Limit** - The maximum number of requests permitted and the time window (e.g., \"1000, 1000;window=3600\" for 1000 requests per hour) - **X-RateLimit-Remaining** - The number of requests remaining in the current rate limit window - **X-RateLimit-Used** - The number of requests already made in the current window - **X-RateLimit-Reset** - The time at which the current rate limit window resets, in UTC epoch seconds # Pagination - Pagination is supported for all endpoints that return a collection of items. - Pagination is controlled by the **page** query parameter ## Example ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10 ```
*
* The version of the OpenAPI document: v1
*
@@ -18,7 +18,7 @@
/**
* Representing a Server Variable for server URL template substitution.
*/
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2025-05-22T07:13:31.203496-07:00[America/Los_Angeles]", comments = "Generator version: 7.13.0")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2026-05-07T08:36:28.586343560Z[Etc/UTC]", comments = "Generator version: 7.13.0")
public class ServerVariable {
public String description;
public String defaultValue;
diff --git a/src/main/java/com/rootly/client/StringUtil.java b/src/main/java/com/rootly/client/StringUtil.java
index 5baa198c..b4ae7edf 100644
--- a/src/main/java/com/rootly/client/StringUtil.java
+++ b/src/main/java/com/rootly/client/StringUtil.java
@@ -1,6 +1,6 @@
/*
* Rootly API v1
- * # How to generate an API Key? - **Organization dropdown** > **Organization Settings** > **API Keys** # JSON:API Specification Rootly is using **JSON:API** (https://jsonapi.org) specification: - JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests. - JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. - JSON:API requires use of the JSON:API media type (**application/vnd.api+json**) for exchanging data. # Authentication and Requests We use standard HTTP Authentication over HTTPS to authorize your requests. ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents ```
# Rate limiting - There is a default limit of approximately **3000** **GET** calls **per API key** every **60 seconds**. The limit is calculated over a **60-second sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - There is a default limit of approximately **3000** **PUT**, **POST**, **PATCH** or **DELETE** calls **per API key** every **60 seconds**. The limit is calculated over a **60-second sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - The response to the API call will return 429 HTTP status code - Request Limit Exceeded and Rootly will not ingest the event. - Additional headers will be returned giving you information about the limit: - **RateLimit-Limit** - The maximum number of requests that the consumer is permitted to make. - **RateLimit-Remaining** - The number of requests remaining in the current rate limit window. - **RateLimit-Reset** - The time at which the current rate limit window resets in UTC epoch seconds. # Pagination - Pagination is supported for all endpoints that return a collection of items. - Pagination is controlled by the **page** query parameter ## Example ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10 ```
+ * # How to generate an API Key? - **Organization dropdown** > **Organization Settings** > **API Keys** # JSON:API Specification Rootly is using **JSON:API** (https://jsonapi.org) specification: - JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests. - JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. - JSON:API requires use of the JSON:API media type (**application/vnd.api+json**) for exchanging data. # Authentication and Requests We use standard HTTP Authentication over HTTPS to authorize your requests. ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents ```
# Rate limiting - There is a default limit of **5** **GET**, **HEAD**, and **OPTIONS** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - There is a default limit of **3** **POST**, **PUT**, **PATCH** or **DELETE** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - When rate limits are exceeded, the API will return a **429 Too Many Requests** HTTP status code with the response: `{\"error\": \"Rate limit exceeded. Try again later.\"}` - **X-RateLimit headers** are included in every API response, providing real-time rate limit information: - **X-RateLimit-Limit** - The maximum number of requests permitted and the time window (e.g., \"1000, 1000;window=3600\" for 1000 requests per hour) - **X-RateLimit-Remaining** - The number of requests remaining in the current rate limit window - **X-RateLimit-Used** - The number of requests already made in the current window - **X-RateLimit-Reset** - The time at which the current rate limit window resets, in UTC epoch seconds # Pagination - Pagination is supported for all endpoints that return a collection of items. - Pagination is controlled by the **page** query parameter ## Example ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10 ```
*
* The version of the OpenAPI document: v1
*
@@ -16,7 +16,7 @@
import java.util.Collection;
import java.util.Iterator;
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2025-05-22T07:13:31.203496-07:00[America/Los_Angeles]", comments = "Generator version: 7.13.0")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2026-05-07T08:36:28.586343560Z[Etc/UTC]", comments = "Generator version: 7.13.0")
public class StringUtil {
/**
* Check if the given array contains the given value (with case-insensitive comparison).
diff --git a/src/main/java/com/rootly/client/api/AlertEventsApi.java b/src/main/java/com/rootly/client/api/AlertEventsApi.java
index dade958c..cb96adab 100644
--- a/src/main/java/com/rootly/client/api/AlertEventsApi.java
+++ b/src/main/java/com/rootly/client/api/AlertEventsApi.java
@@ -1,6 +1,6 @@
/*
* Rootly API v1
- * # How to generate an API Key? - **Organization dropdown** > **Organization Settings** > **API Keys** # JSON:API Specification Rootly is using **JSON:API** (https://jsonapi.org) specification: - JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests. - JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. - JSON:API requires use of the JSON:API media type (**application/vnd.api+json**) for exchanging data. # Authentication and Requests We use standard HTTP Authentication over HTTPS to authorize your requests. ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents ```
# Rate limiting - There is a default limit of approximately **3000** **GET** calls **per API key** every **60 seconds**. The limit is calculated over a **60-second sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - There is a default limit of approximately **3000** **PUT**, **POST**, **PATCH** or **DELETE** calls **per API key** every **60 seconds**. The limit is calculated over a **60-second sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - The response to the API call will return 429 HTTP status code - Request Limit Exceeded and Rootly will not ingest the event. - Additional headers will be returned giving you information about the limit: - **RateLimit-Limit** - The maximum number of requests that the consumer is permitted to make. - **RateLimit-Remaining** - The number of requests remaining in the current rate limit window. - **RateLimit-Reset** - The time at which the current rate limit window resets in UTC epoch seconds. # Pagination - Pagination is supported for all endpoints that return a collection of items. - Pagination is controlled by the **page** query parameter ## Example ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10 ```
+ * # How to generate an API Key? - **Organization dropdown** > **Organization Settings** > **API Keys** # JSON:API Specification Rootly is using **JSON:API** (https://jsonapi.org) specification: - JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests. - JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. - JSON:API requires use of the JSON:API media type (**application/vnd.api+json**) for exchanging data. # Authentication and Requests We use standard HTTP Authentication over HTTPS to authorize your requests. ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents ```
# Rate limiting - There is a default limit of **5** **GET**, **HEAD**, and **OPTIONS** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - There is a default limit of **3** **POST**, **PUT**, **PATCH** or **DELETE** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - When rate limits are exceeded, the API will return a **429 Too Many Requests** HTTP status code with the response: `{\"error\": \"Rate limit exceeded. Try again later.\"}` - **X-RateLimit headers** are included in every API response, providing real-time rate limit information: - **X-RateLimit-Limit** - The maximum number of requests permitted and the time window (e.g., \"1000, 1000;window=3600\" for 1000 requests per hour) - **X-RateLimit-Remaining** - The number of requests remaining in the current rate limit window - **X-RateLimit-Used** - The number of requests already made in the current window - **X-RateLimit-Reset** - The time at which the current rate limit window resets, in UTC epoch seconds # Pagination - Pagination is supported for all endpoints that return a collection of items. - Pagination is controlled by the **page** query parameter ## Example ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10 ```
*
* The version of the OpenAPI document: v1
*
@@ -284,7 +284,7 @@ private okhttp3.Call deleteAlertEventValidateBeforeCall(@javax.annotation.Nonnul
/**
* Delete alert event
- * Deletes a specific alert event
+ * Deletes a specific alert event. Only alert events with kind 'note' (user-created notes) can be deleted. System-generated events are immutable to maintain audit trail integrity.
* @param id (required)
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
@@ -301,7 +301,7 @@ public void deleteAlertEvent(@javax.annotation.Nonnull String id) throws ApiExce
/**
* Delete alert event
- * Deletes a specific alert event
+ * Deletes a specific alert event. Only alert events with kind 'note' (user-created notes) can be deleted. System-generated events are immutable to maintain audit trail integrity.
* @param id (required)
* @return ApiResponse<Void>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -320,7 +320,7 @@ public ApiResponse deleteAlertEventWithHttpInfo(@javax.annotation.Nonnull
/**
* Delete alert event (asynchronously)
- * Deletes a specific alert event
+ * Deletes a specific alert event. Only alert events with kind 'note' (user-created notes) can be deleted. System-generated events are immutable to maintain audit trail integrity.
* @param id (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
@@ -711,7 +711,7 @@ private okhttp3.Call updateAlertEventValidateBeforeCall(@javax.annotation.Nonnul
/**
* Update alert event
- * Updates a specific alert event
+ * Updates a specific alert event. Only alert events with kind 'note' (user-created notes) can be updated. System-generated events are immutable to maintain audit trail integrity.
* @param id (required)
* @param updateAlertEvent (optional)
* @return AlertEventResponse
@@ -731,7 +731,7 @@ public AlertEventResponse updateAlertEvent(@javax.annotation.Nonnull String id,
/**
* Update alert event
- * Updates a specific alert event
+ * Updates a specific alert event. Only alert events with kind 'note' (user-created notes) can be updated. System-generated events are immutable to maintain audit trail integrity.
* @param id (required)
* @param updateAlertEvent (optional)
* @return ApiResponse<AlertEventResponse>
@@ -752,7 +752,7 @@ public ApiResponse updateAlertEventWithHttpInfo(@javax.annot
/**
* Update alert event (asynchronously)
- * Updates a specific alert event
+ * Updates a specific alert event. Only alert events with kind 'note' (user-created notes) can be updated. System-generated events are immutable to maintain audit trail integrity.
* @param id (required)
* @param updateAlertEvent (optional)
* @param _callback The callback to be executed when the API call finishes
diff --git a/src/main/java/com/rootly/client/api/AlertFieldsApi.java b/src/main/java/com/rootly/client/api/AlertFieldsApi.java
new file mode 100644
index 00000000..a011cd13
--- /dev/null
+++ b/src/main/java/com/rootly/client/api/AlertFieldsApi.java
@@ -0,0 +1,827 @@
+/*
+ * Rootly API v1
+ * # How to generate an API Key? - **Organization dropdown** > **Organization Settings** > **API Keys** # JSON:API Specification Rootly is using **JSON:API** (https://jsonapi.org) specification: - JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests. - JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. - JSON:API requires use of the JSON:API media type (**application/vnd.api+json**) for exchanging data. # Authentication and Requests We use standard HTTP Authentication over HTTPS to authorize your requests. ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents ```
# Rate limiting - There is a default limit of **5** **GET**, **HEAD**, and **OPTIONS** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - There is a default limit of **3** **POST**, **PUT**, **PATCH** or **DELETE** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - When rate limits are exceeded, the API will return a **429 Too Many Requests** HTTP status code with the response: `{\"error\": \"Rate limit exceeded. Try again later.\"}` - **X-RateLimit headers** are included in every API response, providing real-time rate limit information: - **X-RateLimit-Limit** - The maximum number of requests permitted and the time window (e.g., \"1000, 1000;window=3600\" for 1000 requests per hour) - **X-RateLimit-Remaining** - The number of requests remaining in the current rate limit window - **X-RateLimit-Used** - The number of requests already made in the current window - **X-RateLimit-Reset** - The time at which the current rate limit window resets, in UTC epoch seconds # Pagination - Pagination is supported for all endpoints that return a collection of items. - Pagination is controlled by the **page** query parameter ## Example ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10 ```
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+package com.rootly.client.api;
+
+import com.rootly.client.ApiCallback;
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.ApiResponse;
+import com.rootly.client.Configuration;
+import com.rootly.client.Pair;
+import com.rootly.client.ProgressRequestBody;
+import com.rootly.client.ProgressResponseBody;
+
+import com.google.gson.reflect.TypeToken;
+
+import java.io.IOException;
+
+
+import com.rootly.client.model.AlertFieldList;
+import com.rootly.client.model.AlertFieldResponse;
+import com.rootly.client.model.ErrorsList;
+import com.rootly.client.model.GetAlertFieldIdParameter;
+import com.rootly.client.model.NewAlertField;
+import com.rootly.client.model.UpdateAlertField;
+
+import java.lang.reflect.Type;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+public class AlertFieldsApi {
+ private ApiClient localVarApiClient;
+ private int localHostIndex;
+ private String localCustomBaseUrl;
+
+ public AlertFieldsApi() {
+ this(Configuration.getDefaultApiClient());
+ }
+
+ public AlertFieldsApi(ApiClient apiClient) {
+ this.localVarApiClient = apiClient;
+ }
+
+ public ApiClient getApiClient() {
+ return localVarApiClient;
+ }
+
+ public void setApiClient(ApiClient apiClient) {
+ this.localVarApiClient = apiClient;
+ }
+
+ public int getHostIndex() {
+ return localHostIndex;
+ }
+
+ public void setHostIndex(int hostIndex) {
+ this.localHostIndex = hostIndex;
+ }
+
+ public String getCustomBaseUrl() {
+ return localCustomBaseUrl;
+ }
+
+ public void setCustomBaseUrl(String customBaseUrl) {
+ this.localCustomBaseUrl = customBaseUrl;
+ }
+
+ /**
+ * Build call for createAlertField
+ * @param newAlertField (required)
+ * @param _callback Callback for upload/download progress
+ * @return Call to execute
+ * @throws ApiException If fail to serialize the request body object
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 201 | alert field created | - |
+ | 422 | invalid request | - |
+ | 401 | responds with unauthorized for invalid token | - |
+
+ */
+ public okhttp3.Call createAlertFieldCall(@javax.annotation.Nonnull NewAlertField newAlertField, final ApiCallback _callback) throws ApiException {
+ String basePath = null;
+ // Operation Servers
+ String[] localBasePaths = new String[] { };
+
+ // Determine Base Path to Use
+ if (localCustomBaseUrl != null){
+ basePath = localCustomBaseUrl;
+ } else if ( localBasePaths.length > 0 ) {
+ basePath = localBasePaths[localHostIndex];
+ } else {
+ basePath = null;
+ }
+
+ Object localVarPostBody = newAlertField;
+
+ // create path and map variables
+ String localVarPath = "/v1/alert_fields";
+
+ List localVarQueryParams = new ArrayList();
+ List localVarCollectionQueryParams = new ArrayList();
+ Map localVarHeaderParams = new HashMap();
+ Map localVarCookieParams = new HashMap();
+ Map localVarFormParams = new HashMap();
+
+ final String[] localVarAccepts = {
+ "application/vnd.api+json"
+ };
+ final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
+ if (localVarAccept != null) {
+ localVarHeaderParams.put("Accept", localVarAccept);
+ }
+
+ final String[] localVarContentTypes = {
+ "application/vnd.api+json"
+ };
+ final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
+ if (localVarContentType != null) {
+ localVarHeaderParams.put("Content-Type", localVarContentType);
+ }
+
+ String[] localVarAuthNames = new String[] { "bearer_auth" };
+ return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
+ }
+
+ @SuppressWarnings("rawtypes")
+ private okhttp3.Call createAlertFieldValidateBeforeCall(@javax.annotation.Nonnull NewAlertField newAlertField, final ApiCallback _callback) throws ApiException {
+ // verify the required parameter 'newAlertField' is set
+ if (newAlertField == null) {
+ throw new ApiException("Missing the required parameter 'newAlertField' when calling createAlertField(Async)");
+ }
+
+ return createAlertFieldCall(newAlertField, _callback);
+
+ }
+
+ /**
+ * Creates an alert field
+ * Creates a new alert field from provided data
+ * @param newAlertField (required)
+ * @return AlertFieldResponse
+ * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 201 | alert field created | - |
+ | 422 | invalid request | - |
+ | 401 | responds with unauthorized for invalid token | - |
+
+ */
+ public AlertFieldResponse createAlertField(@javax.annotation.Nonnull NewAlertField newAlertField) throws ApiException {
+ ApiResponse localVarResp = createAlertFieldWithHttpInfo(newAlertField);
+ return localVarResp.getData();
+ }
+
+ /**
+ * Creates an alert field
+ * Creates a new alert field from provided data
+ * @param newAlertField (required)
+ * @return ApiResponse<AlertFieldResponse>
+ * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 201 | alert field created | - |
+ | 422 | invalid request | - |
+ | 401 | responds with unauthorized for invalid token | - |
+
+ */
+ public ApiResponse createAlertFieldWithHttpInfo(@javax.annotation.Nonnull NewAlertField newAlertField) throws ApiException {
+ okhttp3.Call localVarCall = createAlertFieldValidateBeforeCall(newAlertField, null);
+ Type localVarReturnType = new TypeToken(){}.getType();
+ return localVarApiClient.execute(localVarCall, localVarReturnType);
+ }
+
+ /**
+ * Creates an alert field (asynchronously)
+ * Creates a new alert field from provided data
+ * @param newAlertField (required)
+ * @param _callback The callback to be executed when the API call finishes
+ * @return The request call
+ * @throws ApiException If fail to process the API call, e.g. serializing the request body object
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 201 | alert field created | - |
+ | 422 | invalid request | - |
+ | 401 | responds with unauthorized for invalid token | - |
+
+ */
+ public okhttp3.Call createAlertFieldAsync(@javax.annotation.Nonnull NewAlertField newAlertField, final ApiCallback _callback) throws ApiException {
+
+ okhttp3.Call localVarCall = createAlertFieldValidateBeforeCall(newAlertField, _callback);
+ Type localVarReturnType = new TypeToken(){}.getType();
+ localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
+ return localVarCall;
+ }
+ /**
+ * Build call for deleteAlertField
+ * @param id (required)
+ * @param _callback Callback for upload/download progress
+ * @return Call to execute
+ * @throws ApiException If fail to serialize the request body object
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 200 | custom alert field deleted successfully | - |
+ | 422 | cannot delete alert field referenced by escalation path field rules | - |
+ | 404 | resource not found | - |
+
+ */
+ public okhttp3.Call deleteAlertFieldCall(@javax.annotation.Nonnull GetAlertFieldIdParameter id, final ApiCallback _callback) throws ApiException {
+ String basePath = null;
+ // Operation Servers
+ String[] localBasePaths = new String[] { };
+
+ // Determine Base Path to Use
+ if (localCustomBaseUrl != null){
+ basePath = localCustomBaseUrl;
+ } else if ( localBasePaths.length > 0 ) {
+ basePath = localBasePaths[localHostIndex];
+ } else {
+ basePath = null;
+ }
+
+ Object localVarPostBody = null;
+
+ // create path and map variables
+ String localVarPath = "/v1/alert_fields/{id}"
+ .replace("{" + "id" + "}", localVarApiClient.escapeString(id.toString()));
+
+ List localVarQueryParams = new ArrayList();
+ List localVarCollectionQueryParams = new ArrayList();
+ Map localVarHeaderParams = new HashMap();
+ Map localVarCookieParams = new HashMap();
+ Map localVarFormParams = new HashMap();
+
+ final String[] localVarAccepts = {
+ "application/vnd.api+json"
+ };
+ final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
+ if (localVarAccept != null) {
+ localVarHeaderParams.put("Accept", localVarAccept);
+ }
+
+ final String[] localVarContentTypes = {
+ };
+ final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
+ if (localVarContentType != null) {
+ localVarHeaderParams.put("Content-Type", localVarContentType);
+ }
+
+ String[] localVarAuthNames = new String[] { "bearer_auth" };
+ return localVarApiClient.buildCall(basePath, localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
+ }
+
+ @SuppressWarnings("rawtypes")
+ private okhttp3.Call deleteAlertFieldValidateBeforeCall(@javax.annotation.Nonnull GetAlertFieldIdParameter id, final ApiCallback _callback) throws ApiException {
+ // verify the required parameter 'id' is set
+ if (id == null) {
+ throw new ApiException("Missing the required parameter 'id' when calling deleteAlertField(Async)");
+ }
+
+ return deleteAlertFieldCall(id, _callback);
+
+ }
+
+ /**
+ * Delete an alert field
+ * Delete a specific alert field by id
+ * @param id (required)
+ * @return AlertFieldResponse
+ * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 200 | custom alert field deleted successfully | - |
+ | 422 | cannot delete alert field referenced by escalation path field rules | - |
+ | 404 | resource not found | - |
+
+ */
+ public AlertFieldResponse deleteAlertField(@javax.annotation.Nonnull GetAlertFieldIdParameter id) throws ApiException {
+ ApiResponse localVarResp = deleteAlertFieldWithHttpInfo(id);
+ return localVarResp.getData();
+ }
+
+ /**
+ * Delete an alert field
+ * Delete a specific alert field by id
+ * @param id (required)
+ * @return ApiResponse<AlertFieldResponse>
+ * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 200 | custom alert field deleted successfully | - |
+ | 422 | cannot delete alert field referenced by escalation path field rules | - |
+ | 404 | resource not found | - |
+
+ */
+ public ApiResponse deleteAlertFieldWithHttpInfo(@javax.annotation.Nonnull GetAlertFieldIdParameter id) throws ApiException {
+ okhttp3.Call localVarCall = deleteAlertFieldValidateBeforeCall(id, null);
+ Type localVarReturnType = new TypeToken(){}.getType();
+ return localVarApiClient.execute(localVarCall, localVarReturnType);
+ }
+
+ /**
+ * Delete an alert field (asynchronously)
+ * Delete a specific alert field by id
+ * @param id (required)
+ * @param _callback The callback to be executed when the API call finishes
+ * @return The request call
+ * @throws ApiException If fail to process the API call, e.g. serializing the request body object
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 200 | custom alert field deleted successfully | - |
+ | 422 | cannot delete alert field referenced by escalation path field rules | - |
+ | 404 | resource not found | - |
+
+ */
+ public okhttp3.Call deleteAlertFieldAsync(@javax.annotation.Nonnull GetAlertFieldIdParameter id, final ApiCallback _callback) throws ApiException {
+
+ okhttp3.Call localVarCall = deleteAlertFieldValidateBeforeCall(id, _callback);
+ Type localVarReturnType = new TypeToken(){}.getType();
+ localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
+ return localVarCall;
+ }
+ /**
+ * Build call for getAlertField
+ * @param id (required)
+ * @param _callback Callback for upload/download progress
+ * @return Call to execute
+ * @throws ApiException If fail to serialize the request body object
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 200 | alert_field found by slug | - |
+ | 404 | resource not found | - |
+
+ */
+ public okhttp3.Call getAlertFieldCall(@javax.annotation.Nonnull GetAlertFieldIdParameter id, final ApiCallback _callback) throws ApiException {
+ String basePath = null;
+ // Operation Servers
+ String[] localBasePaths = new String[] { };
+
+ // Determine Base Path to Use
+ if (localCustomBaseUrl != null){
+ basePath = localCustomBaseUrl;
+ } else if ( localBasePaths.length > 0 ) {
+ basePath = localBasePaths[localHostIndex];
+ } else {
+ basePath = null;
+ }
+
+ Object localVarPostBody = null;
+
+ // create path and map variables
+ String localVarPath = "/v1/alert_fields/{id}"
+ .replace("{" + "id" + "}", localVarApiClient.escapeString(id.toString()));
+
+ List localVarQueryParams = new ArrayList();
+ List localVarCollectionQueryParams = new ArrayList();
+ Map localVarHeaderParams = new HashMap();
+ Map localVarCookieParams = new HashMap();
+ Map localVarFormParams = new HashMap();
+
+ final String[] localVarAccepts = {
+ "application/vnd.api+json"
+ };
+ final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
+ if (localVarAccept != null) {
+ localVarHeaderParams.put("Accept", localVarAccept);
+ }
+
+ final String[] localVarContentTypes = {
+ };
+ final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
+ if (localVarContentType != null) {
+ localVarHeaderParams.put("Content-Type", localVarContentType);
+ }
+
+ String[] localVarAuthNames = new String[] { "bearer_auth" };
+ return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
+ }
+
+ @SuppressWarnings("rawtypes")
+ private okhttp3.Call getAlertFieldValidateBeforeCall(@javax.annotation.Nonnull GetAlertFieldIdParameter id, final ApiCallback _callback) throws ApiException {
+ // verify the required parameter 'id' is set
+ if (id == null) {
+ throw new ApiException("Missing the required parameter 'id' when calling getAlertField(Async)");
+ }
+
+ return getAlertFieldCall(id, _callback);
+
+ }
+
+ /**
+ * Retrieves an alert field
+ * Retrieves a specific alert field by id
+ * @param id (required)
+ * @return AlertFieldResponse
+ * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 200 | alert_field found by slug | - |
+ | 404 | resource not found | - |
+
+ */
+ public AlertFieldResponse getAlertField(@javax.annotation.Nonnull GetAlertFieldIdParameter id) throws ApiException {
+ ApiResponse localVarResp = getAlertFieldWithHttpInfo(id);
+ return localVarResp.getData();
+ }
+
+ /**
+ * Retrieves an alert field
+ * Retrieves a specific alert field by id
+ * @param id (required)
+ * @return ApiResponse<AlertFieldResponse>
+ * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 200 | alert_field found by slug | - |
+ | 404 | resource not found | - |
+
+ */
+ public ApiResponse getAlertFieldWithHttpInfo(@javax.annotation.Nonnull GetAlertFieldIdParameter id) throws ApiException {
+ okhttp3.Call localVarCall = getAlertFieldValidateBeforeCall(id, null);
+ Type localVarReturnType = new TypeToken(){}.getType();
+ return localVarApiClient.execute(localVarCall, localVarReturnType);
+ }
+
+ /**
+ * Retrieves an alert field (asynchronously)
+ * Retrieves a specific alert field by id
+ * @param id (required)
+ * @param _callback The callback to be executed when the API call finishes
+ * @return The request call
+ * @throws ApiException If fail to process the API call, e.g. serializing the request body object
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 200 | alert_field found by slug | - |
+ | 404 | resource not found | - |
+
+ */
+ public okhttp3.Call getAlertFieldAsync(@javax.annotation.Nonnull GetAlertFieldIdParameter id, final ApiCallback _callback) throws ApiException {
+
+ okhttp3.Call localVarCall = getAlertFieldValidateBeforeCall(id, _callback);
+ Type localVarReturnType = new TypeToken(){}.getType();
+ localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
+ return localVarCall;
+ }
+ /**
+ * Build call for listAlertFields
+ * @param include (optional)
+ * @param pageNumber (optional)
+ * @param pageSize (optional)
+ * @param filterSearch (optional)
+ * @param filterName (optional)
+ * @param filterKind (optional)
+ * @param filterCreatedAtGt (optional)
+ * @param filterCreatedAtGte (optional)
+ * @param filterCreatedAtLt (optional)
+ * @param filterCreatedAtLte (optional)
+ * @param sort (optional)
+ * @param _callback Callback for upload/download progress
+ * @return Call to execute
+ * @throws ApiException If fail to serialize the request body object
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 200 | success | - |
+
+ */
+ public okhttp3.Call listAlertFieldsCall(@javax.annotation.Nullable String include, @javax.annotation.Nullable Integer pageNumber, @javax.annotation.Nullable Integer pageSize, @javax.annotation.Nullable String filterSearch, @javax.annotation.Nullable String filterName, @javax.annotation.Nullable String filterKind, @javax.annotation.Nullable String filterCreatedAtGt, @javax.annotation.Nullable String filterCreatedAtGte, @javax.annotation.Nullable String filterCreatedAtLt, @javax.annotation.Nullable String filterCreatedAtLte, @javax.annotation.Nullable String sort, final ApiCallback _callback) throws ApiException {
+ String basePath = null;
+ // Operation Servers
+ String[] localBasePaths = new String[] { };
+
+ // Determine Base Path to Use
+ if (localCustomBaseUrl != null){
+ basePath = localCustomBaseUrl;
+ } else if ( localBasePaths.length > 0 ) {
+ basePath = localBasePaths[localHostIndex];
+ } else {
+ basePath = null;
+ }
+
+ Object localVarPostBody = null;
+
+ // create path and map variables
+ String localVarPath = "/v1/alert_fields";
+
+ List localVarQueryParams = new ArrayList();
+ List localVarCollectionQueryParams = new ArrayList();
+ Map localVarHeaderParams = new HashMap();
+ Map localVarCookieParams = new HashMap();
+ Map localVarFormParams = new HashMap();
+
+ if (include != null) {
+ localVarQueryParams.addAll(localVarApiClient.parameterToPair("include", include));
+ }
+
+ if (pageNumber != null) {
+ localVarQueryParams.addAll(localVarApiClient.parameterToPair("page[number]", pageNumber));
+ }
+
+ if (pageSize != null) {
+ localVarQueryParams.addAll(localVarApiClient.parameterToPair("page[size]", pageSize));
+ }
+
+ if (filterSearch != null) {
+ localVarQueryParams.addAll(localVarApiClient.parameterToPair("filter[search]", filterSearch));
+ }
+
+ if (filterName != null) {
+ localVarQueryParams.addAll(localVarApiClient.parameterToPair("filter[name]", filterName));
+ }
+
+ if (filterKind != null) {
+ localVarQueryParams.addAll(localVarApiClient.parameterToPair("filter[kind]", filterKind));
+ }
+
+ if (filterCreatedAtGt != null) {
+ localVarQueryParams.addAll(localVarApiClient.parameterToPair("filter[created_at][gt]", filterCreatedAtGt));
+ }
+
+ if (filterCreatedAtGte != null) {
+ localVarQueryParams.addAll(localVarApiClient.parameterToPair("filter[created_at][gte]", filterCreatedAtGte));
+ }
+
+ if (filterCreatedAtLt != null) {
+ localVarQueryParams.addAll(localVarApiClient.parameterToPair("filter[created_at][lt]", filterCreatedAtLt));
+ }
+
+ if (filterCreatedAtLte != null) {
+ localVarQueryParams.addAll(localVarApiClient.parameterToPair("filter[created_at][lte]", filterCreatedAtLte));
+ }
+
+ if (sort != null) {
+ localVarQueryParams.addAll(localVarApiClient.parameterToPair("sort", sort));
+ }
+
+ final String[] localVarAccepts = {
+ "application/vnd.api+json"
+ };
+ final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
+ if (localVarAccept != null) {
+ localVarHeaderParams.put("Accept", localVarAccept);
+ }
+
+ final String[] localVarContentTypes = {
+ };
+ final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
+ if (localVarContentType != null) {
+ localVarHeaderParams.put("Content-Type", localVarContentType);
+ }
+
+ String[] localVarAuthNames = new String[] { "bearer_auth" };
+ return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
+ }
+
+ @SuppressWarnings("rawtypes")
+ private okhttp3.Call listAlertFieldsValidateBeforeCall(@javax.annotation.Nullable String include, @javax.annotation.Nullable Integer pageNumber, @javax.annotation.Nullable Integer pageSize, @javax.annotation.Nullable String filterSearch, @javax.annotation.Nullable String filterName, @javax.annotation.Nullable String filterKind, @javax.annotation.Nullable String filterCreatedAtGt, @javax.annotation.Nullable String filterCreatedAtGte, @javax.annotation.Nullable String filterCreatedAtLt, @javax.annotation.Nullable String filterCreatedAtLte, @javax.annotation.Nullable String sort, final ApiCallback _callback) throws ApiException {
+ return listAlertFieldsCall(include, pageNumber, pageSize, filterSearch, filterName, filterKind, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, sort, _callback);
+
+ }
+
+ /**
+ * List alert fields
+ * List alert fields
+ * @param include (optional)
+ * @param pageNumber (optional)
+ * @param pageSize (optional)
+ * @param filterSearch (optional)
+ * @param filterName (optional)
+ * @param filterKind (optional)
+ * @param filterCreatedAtGt (optional)
+ * @param filterCreatedAtGte (optional)
+ * @param filterCreatedAtLt (optional)
+ * @param filterCreatedAtLte (optional)
+ * @param sort (optional)
+ * @return AlertFieldList
+ * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 200 | success | - |
+
+ */
+ public AlertFieldList listAlertFields(@javax.annotation.Nullable String include, @javax.annotation.Nullable Integer pageNumber, @javax.annotation.Nullable Integer pageSize, @javax.annotation.Nullable String filterSearch, @javax.annotation.Nullable String filterName, @javax.annotation.Nullable String filterKind, @javax.annotation.Nullable String filterCreatedAtGt, @javax.annotation.Nullable String filterCreatedAtGte, @javax.annotation.Nullable String filterCreatedAtLt, @javax.annotation.Nullable String filterCreatedAtLte, @javax.annotation.Nullable String sort) throws ApiException {
+ ApiResponse localVarResp = listAlertFieldsWithHttpInfo(include, pageNumber, pageSize, filterSearch, filterName, filterKind, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, sort);
+ return localVarResp.getData();
+ }
+
+ /**
+ * List alert fields
+ * List alert fields
+ * @param include (optional)
+ * @param pageNumber (optional)
+ * @param pageSize (optional)
+ * @param filterSearch (optional)
+ * @param filterName (optional)
+ * @param filterKind (optional)
+ * @param filterCreatedAtGt (optional)
+ * @param filterCreatedAtGte (optional)
+ * @param filterCreatedAtLt (optional)
+ * @param filterCreatedAtLte (optional)
+ * @param sort (optional)
+ * @return ApiResponse<AlertFieldList>
+ * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 200 | success | - |
+
+ */
+ public ApiResponse listAlertFieldsWithHttpInfo(@javax.annotation.Nullable String include, @javax.annotation.Nullable Integer pageNumber, @javax.annotation.Nullable Integer pageSize, @javax.annotation.Nullable String filterSearch, @javax.annotation.Nullable String filterName, @javax.annotation.Nullable String filterKind, @javax.annotation.Nullable String filterCreatedAtGt, @javax.annotation.Nullable String filterCreatedAtGte, @javax.annotation.Nullable String filterCreatedAtLt, @javax.annotation.Nullable String filterCreatedAtLte, @javax.annotation.Nullable String sort) throws ApiException {
+ okhttp3.Call localVarCall = listAlertFieldsValidateBeforeCall(include, pageNumber, pageSize, filterSearch, filterName, filterKind, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, sort, null);
+ Type localVarReturnType = new TypeToken(){}.getType();
+ return localVarApiClient.execute(localVarCall, localVarReturnType);
+ }
+
+ /**
+ * List alert fields (asynchronously)
+ * List alert fields
+ * @param include (optional)
+ * @param pageNumber (optional)
+ * @param pageSize (optional)
+ * @param filterSearch (optional)
+ * @param filterName (optional)
+ * @param filterKind (optional)
+ * @param filterCreatedAtGt (optional)
+ * @param filterCreatedAtGte (optional)
+ * @param filterCreatedAtLt (optional)
+ * @param filterCreatedAtLte (optional)
+ * @param sort (optional)
+ * @param _callback The callback to be executed when the API call finishes
+ * @return The request call
+ * @throws ApiException If fail to process the API call, e.g. serializing the request body object
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 200 | success | - |
+
+ */
+ public okhttp3.Call listAlertFieldsAsync(@javax.annotation.Nullable String include, @javax.annotation.Nullable Integer pageNumber, @javax.annotation.Nullable Integer pageSize, @javax.annotation.Nullable String filterSearch, @javax.annotation.Nullable String filterName, @javax.annotation.Nullable String filterKind, @javax.annotation.Nullable String filterCreatedAtGt, @javax.annotation.Nullable String filterCreatedAtGte, @javax.annotation.Nullable String filterCreatedAtLt, @javax.annotation.Nullable String filterCreatedAtLte, @javax.annotation.Nullable String sort, final ApiCallback _callback) throws ApiException {
+
+ okhttp3.Call localVarCall = listAlertFieldsValidateBeforeCall(include, pageNumber, pageSize, filterSearch, filterName, filterKind, filterCreatedAtGt, filterCreatedAtGte, filterCreatedAtLt, filterCreatedAtLte, sort, _callback);
+ Type localVarReturnType = new TypeToken(){}.getType();
+ localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
+ return localVarCall;
+ }
+ /**
+ * Build call for updateAlertField
+ * @param id (required)
+ * @param updateAlertField (required)
+ * @param _callback Callback for upload/download progress
+ * @return Call to execute
+ * @throws ApiException If fail to serialize the request body object
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 200 | alert field updated | - |
+ | 404 | resource not found | - |
+
+ */
+ public okhttp3.Call updateAlertFieldCall(@javax.annotation.Nonnull GetAlertFieldIdParameter id, @javax.annotation.Nonnull UpdateAlertField updateAlertField, final ApiCallback _callback) throws ApiException {
+ String basePath = null;
+ // Operation Servers
+ String[] localBasePaths = new String[] { };
+
+ // Determine Base Path to Use
+ if (localCustomBaseUrl != null){
+ basePath = localCustomBaseUrl;
+ } else if ( localBasePaths.length > 0 ) {
+ basePath = localBasePaths[localHostIndex];
+ } else {
+ basePath = null;
+ }
+
+ Object localVarPostBody = updateAlertField;
+
+ // create path and map variables
+ String localVarPath = "/v1/alert_fields/{id}"
+ .replace("{" + "id" + "}", localVarApiClient.escapeString(id.toString()));
+
+ List localVarQueryParams = new ArrayList();
+ List localVarCollectionQueryParams = new ArrayList();
+ Map localVarHeaderParams = new HashMap();
+ Map localVarCookieParams = new HashMap();
+ Map localVarFormParams = new HashMap();
+
+ final String[] localVarAccepts = {
+ "application/vnd.api+json"
+ };
+ final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
+ if (localVarAccept != null) {
+ localVarHeaderParams.put("Accept", localVarAccept);
+ }
+
+ final String[] localVarContentTypes = {
+ "application/vnd.api+json"
+ };
+ final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
+ if (localVarContentType != null) {
+ localVarHeaderParams.put("Content-Type", localVarContentType);
+ }
+
+ String[] localVarAuthNames = new String[] { "bearer_auth" };
+ return localVarApiClient.buildCall(basePath, localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
+ }
+
+ @SuppressWarnings("rawtypes")
+ private okhttp3.Call updateAlertFieldValidateBeforeCall(@javax.annotation.Nonnull GetAlertFieldIdParameter id, @javax.annotation.Nonnull UpdateAlertField updateAlertField, final ApiCallback _callback) throws ApiException {
+ // verify the required parameter 'id' is set
+ if (id == null) {
+ throw new ApiException("Missing the required parameter 'id' when calling updateAlertField(Async)");
+ }
+
+ // verify the required parameter 'updateAlertField' is set
+ if (updateAlertField == null) {
+ throw new ApiException("Missing the required parameter 'updateAlertField' when calling updateAlertField(Async)");
+ }
+
+ return updateAlertFieldCall(id, updateAlertField, _callback);
+
+ }
+
+ /**
+ * Update an alert field
+ * Update a specific alert field by id
+ * @param id (required)
+ * @param updateAlertField (required)
+ * @return AlertFieldResponse
+ * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 200 | alert field updated | - |
+ | 404 | resource not found | - |
+
+ */
+ public AlertFieldResponse updateAlertField(@javax.annotation.Nonnull GetAlertFieldIdParameter id, @javax.annotation.Nonnull UpdateAlertField updateAlertField) throws ApiException {
+ ApiResponse localVarResp = updateAlertFieldWithHttpInfo(id, updateAlertField);
+ return localVarResp.getData();
+ }
+
+ /**
+ * Update an alert field
+ * Update a specific alert field by id
+ * @param id (required)
+ * @param updateAlertField (required)
+ * @return ApiResponse<AlertFieldResponse>
+ * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 200 | alert field updated | - |
+ | 404 | resource not found | - |
+
+ */
+ public ApiResponse updateAlertFieldWithHttpInfo(@javax.annotation.Nonnull GetAlertFieldIdParameter id, @javax.annotation.Nonnull UpdateAlertField updateAlertField) throws ApiException {
+ okhttp3.Call localVarCall = updateAlertFieldValidateBeforeCall(id, updateAlertField, null);
+ Type localVarReturnType = new TypeToken(){}.getType();
+ return localVarApiClient.execute(localVarCall, localVarReturnType);
+ }
+
+ /**
+ * Update an alert field (asynchronously)
+ * Update a specific alert field by id
+ * @param id (required)
+ * @param updateAlertField (required)
+ * @param _callback The callback to be executed when the API call finishes
+ * @return The request call
+ * @throws ApiException If fail to process the API call, e.g. serializing the request body object
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 200 | alert field updated | - |
+ | 404 | resource not found | - |
+
+ */
+ public okhttp3.Call updateAlertFieldAsync(@javax.annotation.Nonnull GetAlertFieldIdParameter id, @javax.annotation.Nonnull UpdateAlertField updateAlertField, final ApiCallback _callback) throws ApiException {
+
+ okhttp3.Call localVarCall = updateAlertFieldValidateBeforeCall(id, updateAlertField, _callback);
+ Type localVarReturnType = new TypeToken(){}.getType();
+ localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
+ return localVarCall;
+ }
+}
diff --git a/src/main/java/com/rootly/client/api/AlertGroupsApi.java b/src/main/java/com/rootly/client/api/AlertGroupsApi.java
index 78438851..86eed1c3 100644
--- a/src/main/java/com/rootly/client/api/AlertGroupsApi.java
+++ b/src/main/java/com/rootly/client/api/AlertGroupsApi.java
@@ -1,6 +1,6 @@
/*
* Rootly API v1
- * # How to generate an API Key? - **Organization dropdown** > **Organization Settings** > **API Keys** # JSON:API Specification Rootly is using **JSON:API** (https://jsonapi.org) specification: - JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests. - JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. - JSON:API requires use of the JSON:API media type (**application/vnd.api+json**) for exchanging data. # Authentication and Requests We use standard HTTP Authentication over HTTPS to authorize your requests. ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents ```
# Rate limiting - There is a default limit of approximately **3000** **GET** calls **per API key** every **60 seconds**. The limit is calculated over a **60-second sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - There is a default limit of approximately **3000** **PUT**, **POST**, **PATCH** or **DELETE** calls **per API key** every **60 seconds**. The limit is calculated over a **60-second sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - The response to the API call will return 429 HTTP status code - Request Limit Exceeded and Rootly will not ingest the event. - Additional headers will be returned giving you information about the limit: - **RateLimit-Limit** - The maximum number of requests that the consumer is permitted to make. - **RateLimit-Remaining** - The number of requests remaining in the current rate limit window. - **RateLimit-Reset** - The time at which the current rate limit window resets in UTC epoch seconds. # Pagination - Pagination is supported for all endpoints that return a collection of items. - Pagination is controlled by the **page** query parameter ## Example ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10 ```
+ * # How to generate an API Key? - **Organization dropdown** > **Organization Settings** > **API Keys** # JSON:API Specification Rootly is using **JSON:API** (https://jsonapi.org) specification: - JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests. - JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. - JSON:API requires use of the JSON:API media type (**application/vnd.api+json**) for exchanging data. # Authentication and Requests We use standard HTTP Authentication over HTTPS to authorize your requests. ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents ```
# Rate limiting - There is a default limit of **5** **GET**, **HEAD**, and **OPTIONS** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - There is a default limit of **3** **POST**, **PUT**, **PATCH** or **DELETE** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - When rate limits are exceeded, the API will return a **429 Too Many Requests** HTTP status code with the response: `{\"error\": \"Rate limit exceeded. Try again later.\"}` - **X-RateLimit headers** are included in every API response, providing real-time rate limit information: - **X-RateLimit-Limit** - The maximum number of requests permitted and the time window (e.g., \"1000, 1000;window=3600\" for 1000 requests per hour) - **X-RateLimit-Remaining** - The number of requests remaining in the current rate limit window - **X-RateLimit-Used** - The number of requests already made in the current window - **X-RateLimit-Reset** - The time at which the current rate limit window resets, in UTC epoch seconds # Pagination - Pagination is supported for all endpoints that return a collection of items. - Pagination is controlled by the **page** query parameter ## Example ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10 ```
*
* The version of the OpenAPI document: v1
*
@@ -30,6 +30,7 @@
import com.rootly.client.model.AlertGroupList;
import com.rootly.client.model.AlertGroupResponse;
import com.rootly.client.model.ErrorsList;
+import com.rootly.client.model.GetAlertFieldIdParameter;
import com.rootly.client.model.NewAlertGroup;
import com.rootly.client.model.UpdateAlertGroup;
@@ -86,7 +87,7 @@ public void setCustomBaseUrl(String customBaseUrl) {
Response Details
| Status Code | Description | Response Headers |
- | 201 | alert group created | - |
+ | 201 | alert group created with conditions | - |
| 422 | invalid request | - |
| 401 | responds with unauthorized for invalid token | - |
@@ -149,7 +150,7 @@ private okhttp3.Call createAlertGroupValidateBeforeCall(@javax.annotation.Nonnul
/**
* Creates an alert group
- * Creates a new alert group
+ * Creates a new alert group. **Note**: For enhanced functionality and future compatibility, consider using the advanced alert grouping with `conditions` field instead of the legacy `group_by_alert_title`, `group_by_alert_urgency`, and `attributes` fields.
* @param newAlertGroup (required)
* @return AlertGroupResponse
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -157,7 +158,7 @@ private okhttp3.Call createAlertGroupValidateBeforeCall(@javax.annotation.Nonnul
Response Details
| Status Code | Description | Response Headers |
- | 201 | alert group created | - |
+ | 201 | alert group created with conditions | - |
| 422 | invalid request | - |
| 401 | responds with unauthorized for invalid token | - |
@@ -169,7 +170,7 @@ public AlertGroupResponse createAlertGroup(@javax.annotation.Nonnull NewAlertGro
/**
* Creates an alert group
- * Creates a new alert group
+ * Creates a new alert group. **Note**: For enhanced functionality and future compatibility, consider using the advanced alert grouping with `conditions` field instead of the legacy `group_by_alert_title`, `group_by_alert_urgency`, and `attributes` fields.
* @param newAlertGroup (required)
* @return ApiResponse<AlertGroupResponse>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -177,7 +178,7 @@ public AlertGroupResponse createAlertGroup(@javax.annotation.Nonnull NewAlertGro
Response Details
| Status Code | Description | Response Headers |
- | 201 | alert group created | - |
+ | 201 | alert group created with conditions | - |
| 422 | invalid request | - |
| 401 | responds with unauthorized for invalid token | - |
@@ -190,7 +191,7 @@ public ApiResponse createAlertGroupWithHttpInfo(@javax.annot
/**
* Creates an alert group (asynchronously)
- * Creates a new alert group
+ * Creates a new alert group. **Note**: For enhanced functionality and future compatibility, consider using the advanced alert grouping with `conditions` field instead of the legacy `group_by_alert_title`, `group_by_alert_urgency`, and `attributes` fields.
* @param newAlertGroup (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
@@ -199,7 +200,7 @@ public ApiResponse createAlertGroupWithHttpInfo(@javax.annot
Response Details
| Status Code | Description | Response Headers |
- | 201 | alert group created | - |
+ | 201 | alert group created with conditions | - |
| 422 | invalid request | - |
| 401 | responds with unauthorized for invalid token | - |
@@ -225,7 +226,7 @@ public okhttp3.Call createAlertGroupAsync(@javax.annotation.Nonnull NewAlertGrou
| 404 | resource not found | - |
*/
- public okhttp3.Call deleteAlertGroupCall(@javax.annotation.Nonnull String id, final ApiCallback _callback) throws ApiException {
+ public okhttp3.Call deleteAlertGroupCall(@javax.annotation.Nonnull GetAlertFieldIdParameter id, final ApiCallback _callback) throws ApiException {
String basePath = null;
// Operation Servers
String[] localBasePaths = new String[] { };
@@ -271,7 +272,7 @@ public okhttp3.Call deleteAlertGroupCall(@javax.annotation.Nonnull String id, fi
}
@SuppressWarnings("rawtypes")
- private okhttp3.Call deleteAlertGroupValidateBeforeCall(@javax.annotation.Nonnull String id, final ApiCallback _callback) throws ApiException {
+ private okhttp3.Call deleteAlertGroupValidateBeforeCall(@javax.annotation.Nonnull GetAlertFieldIdParameter id, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException("Missing the required parameter 'id' when calling deleteAlertGroup(Async)");
@@ -295,7 +296,7 @@ private okhttp3.Call deleteAlertGroupValidateBeforeCall(@javax.annotation.Nonnul
| 404 | resource not found | - |
*/
- public AlertGroupResponse deleteAlertGroup(@javax.annotation.Nonnull String id) throws ApiException {
+ public AlertGroupResponse deleteAlertGroup(@javax.annotation.Nonnull GetAlertFieldIdParameter id) throws ApiException {
ApiResponse localVarResp = deleteAlertGroupWithHttpInfo(id);
return localVarResp.getData();
}
@@ -314,7 +315,7 @@ public AlertGroupResponse deleteAlertGroup(@javax.annotation.Nonnull String id)
| 404 | resource not found | - |
*/
- public ApiResponse deleteAlertGroupWithHttpInfo(@javax.annotation.Nonnull String id) throws ApiException {
+ public ApiResponse deleteAlertGroupWithHttpInfo(@javax.annotation.Nonnull GetAlertFieldIdParameter id) throws ApiException {
okhttp3.Call localVarCall = deleteAlertGroupValidateBeforeCall(id, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
@@ -335,7 +336,7 @@ public ApiResponse deleteAlertGroupWithHttpInfo(@javax.annot
| 404 | resource not found | - |
*/
- public okhttp3.Call deleteAlertGroupAsync(@javax.annotation.Nonnull String id, final ApiCallback _callback) throws ApiException {
+ public okhttp3.Call deleteAlertGroupAsync(@javax.annotation.Nonnull GetAlertFieldIdParameter id, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = deleteAlertGroupValidateBeforeCall(id, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
@@ -352,11 +353,11 @@ public okhttp3.Call deleteAlertGroupAsync(@javax.annotation.Nonnull String id, f
Response Details
| Status Code | Description | Response Headers |
- | 200 | alert group found | - |
+ | 200 | alert_group found by slug | - |
| 404 | resource not found | - |
*/
- public okhttp3.Call getAlertGroupCall(@javax.annotation.Nonnull String id, final ApiCallback _callback) throws ApiException {
+ public okhttp3.Call getAlertGroupCall(@javax.annotation.Nonnull GetAlertFieldIdParameter id, final ApiCallback _callback) throws ApiException {
String basePath = null;
// Operation Servers
String[] localBasePaths = new String[] { };
@@ -402,7 +403,7 @@ public okhttp3.Call getAlertGroupCall(@javax.annotation.Nonnull String id, final
}
@SuppressWarnings("rawtypes")
- private okhttp3.Call getAlertGroupValidateBeforeCall(@javax.annotation.Nonnull String id, final ApiCallback _callback) throws ApiException {
+ private okhttp3.Call getAlertGroupValidateBeforeCall(@javax.annotation.Nonnull GetAlertFieldIdParameter id, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException("Missing the required parameter 'id' when calling getAlertGroup(Async)");
@@ -422,11 +423,11 @@ private okhttp3.Call getAlertGroupValidateBeforeCall(@javax.annotation.Nonnull S
Response Details
| Status Code | Description | Response Headers |
- | 200 | alert group found | - |
+ | 200 | alert_group found by slug | - |
| 404 | resource not found | - |
*/
- public AlertGroupResponse getAlertGroup(@javax.annotation.Nonnull String id) throws ApiException {
+ public AlertGroupResponse getAlertGroup(@javax.annotation.Nonnull GetAlertFieldIdParameter id) throws ApiException {
ApiResponse localVarResp = getAlertGroupWithHttpInfo(id);
return localVarResp.getData();
}
@@ -441,11 +442,11 @@ public AlertGroupResponse getAlertGroup(@javax.annotation.Nonnull String id) thr
Response Details
| Status Code | Description | Response Headers |
- | 200 | alert group found | - |
+ | 200 | alert_group found by slug | - |
| 404 | resource not found | - |
*/
- public ApiResponse getAlertGroupWithHttpInfo(@javax.annotation.Nonnull String id) throws ApiException {
+ public ApiResponse getAlertGroupWithHttpInfo(@javax.annotation.Nonnull GetAlertFieldIdParameter id) throws ApiException {
okhttp3.Call localVarCall = getAlertGroupValidateBeforeCall(id, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
@@ -462,11 +463,11 @@ public ApiResponse getAlertGroupWithHttpInfo(@javax.annotati
Response Details
| Status Code | Description | Response Headers |
- | 200 | alert group found | - |
+ | 200 | alert_group found by slug | - |
| 404 | resource not found | - |
*/
- public okhttp3.Call getAlertGroupAsync(@javax.annotation.Nonnull String id, final ApiCallback _callback) throws ApiException {
+ public okhttp3.Call getAlertGroupAsync(@javax.annotation.Nonnull GetAlertFieldIdParameter id, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getAlertGroupValidateBeforeCall(id, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
@@ -609,11 +610,11 @@ public okhttp3.Call listAlertGroupsAsync(@javax.annotation.Nullable String inclu
Response Details
| Status Code | Description | Response Headers |
- | 200 | alert group updated | - |
+ | 200 | alert group updated with conditions | - |
| 404 | resource not found | - |
*/
- public okhttp3.Call updateAlertGroupCall(@javax.annotation.Nonnull String id, @javax.annotation.Nonnull UpdateAlertGroup updateAlertGroup, final ApiCallback _callback) throws ApiException {
+ public okhttp3.Call updateAlertGroupCall(@javax.annotation.Nonnull GetAlertFieldIdParameter id, @javax.annotation.Nonnull UpdateAlertGroup updateAlertGroup, final ApiCallback _callback) throws ApiException {
String basePath = null;
// Operation Servers
String[] localBasePaths = new String[] { };
@@ -660,7 +661,7 @@ public okhttp3.Call updateAlertGroupCall(@javax.annotation.Nonnull String id, @j
}
@SuppressWarnings("rawtypes")
- private okhttp3.Call updateAlertGroupValidateBeforeCall(@javax.annotation.Nonnull String id, @javax.annotation.Nonnull UpdateAlertGroup updateAlertGroup, final ApiCallback _callback) throws ApiException {
+ private okhttp3.Call updateAlertGroupValidateBeforeCall(@javax.annotation.Nonnull GetAlertFieldIdParameter id, @javax.annotation.Nonnull UpdateAlertGroup updateAlertGroup, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException("Missing the required parameter 'id' when calling updateAlertGroup(Async)");
@@ -677,7 +678,7 @@ private okhttp3.Call updateAlertGroupValidateBeforeCall(@javax.annotation.Nonnul
/**
* Update an alert group
- * Update a specific alert group by id
+ * Update a specific alert group by id. **Note**: For enhanced functionality and future compatibility, consider using the advanced alert grouping with `conditions` field instead of the legacy `group_by_alert_title`, `group_by_alert_urgency`, and `attributes` fields.
* @param id (required)
* @param updateAlertGroup (required)
* @return AlertGroupResponse
@@ -686,18 +687,18 @@ private okhttp3.Call updateAlertGroupValidateBeforeCall(@javax.annotation.Nonnul
Response Details
| Status Code | Description | Response Headers |
- | 200 | alert group updated | - |
+ | 200 | alert group updated with conditions | - |
| 404 | resource not found | - |
*/
- public AlertGroupResponse updateAlertGroup(@javax.annotation.Nonnull String id, @javax.annotation.Nonnull UpdateAlertGroup updateAlertGroup) throws ApiException {
+ public AlertGroupResponse updateAlertGroup(@javax.annotation.Nonnull GetAlertFieldIdParameter id, @javax.annotation.Nonnull UpdateAlertGroup updateAlertGroup) throws ApiException {
ApiResponse localVarResp = updateAlertGroupWithHttpInfo(id, updateAlertGroup);
return localVarResp.getData();
}
/**
* Update an alert group
- * Update a specific alert group by id
+ * Update a specific alert group by id. **Note**: For enhanced functionality and future compatibility, consider using the advanced alert grouping with `conditions` field instead of the legacy `group_by_alert_title`, `group_by_alert_urgency`, and `attributes` fields.
* @param id (required)
* @param updateAlertGroup (required)
* @return ApiResponse<AlertGroupResponse>
@@ -706,11 +707,11 @@ public AlertGroupResponse updateAlertGroup(@javax.annotation.Nonnull String id,
Response Details
| Status Code | Description | Response Headers |
- | 200 | alert group updated | - |
+ | 200 | alert group updated with conditions | - |
| 404 | resource not found | - |
*/
- public ApiResponse updateAlertGroupWithHttpInfo(@javax.annotation.Nonnull String id, @javax.annotation.Nonnull UpdateAlertGroup updateAlertGroup) throws ApiException {
+ public ApiResponse updateAlertGroupWithHttpInfo(@javax.annotation.Nonnull GetAlertFieldIdParameter id, @javax.annotation.Nonnull UpdateAlertGroup updateAlertGroup) throws ApiException {
okhttp3.Call localVarCall = updateAlertGroupValidateBeforeCall(id, updateAlertGroup, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
@@ -718,7 +719,7 @@ public ApiResponse updateAlertGroupWithHttpInfo(@javax.annot
/**
* Update an alert group (asynchronously)
- * Update a specific alert group by id
+ * Update a specific alert group by id. **Note**: For enhanced functionality and future compatibility, consider using the advanced alert grouping with `conditions` field instead of the legacy `group_by_alert_title`, `group_by_alert_urgency`, and `attributes` fields.
* @param id (required)
* @param updateAlertGroup (required)
* @param _callback The callback to be executed when the API call finishes
@@ -728,11 +729,11 @@ public ApiResponse updateAlertGroupWithHttpInfo(@javax.annot
Response Details
| Status Code | Description | Response Headers |
- | 200 | alert group updated | - |
+ | 200 | alert group updated with conditions | - |
| 404 | resource not found | - |
*/
- public okhttp3.Call updateAlertGroupAsync(@javax.annotation.Nonnull String id, @javax.annotation.Nonnull UpdateAlertGroup updateAlertGroup, final ApiCallback _callback) throws ApiException {
+ public okhttp3.Call updateAlertGroupAsync(@javax.annotation.Nonnull GetAlertFieldIdParameter id, @javax.annotation.Nonnull UpdateAlertGroup updateAlertGroup, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = updateAlertGroupValidateBeforeCall(id, updateAlertGroup, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
diff --git a/src/main/java/com/rootly/client/api/AlertRoutesApi.java b/src/main/java/com/rootly/client/api/AlertRoutesApi.java
new file mode 100644
index 00000000..20a4bb20
--- /dev/null
+++ b/src/main/java/com/rootly/client/api/AlertRoutesApi.java
@@ -0,0 +1,945 @@
+/*
+ * Rootly API v1
+ * # How to generate an API Key? - **Organization dropdown** > **Organization Settings** > **API Keys** # JSON:API Specification Rootly is using **JSON:API** (https://jsonapi.org) specification: - JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests. - JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. - JSON:API requires use of the JSON:API media type (**application/vnd.api+json**) for exchanging data. # Authentication and Requests We use standard HTTP Authentication over HTTPS to authorize your requests. ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents ```
# Rate limiting - There is a default limit of **5** **GET**, **HEAD**, and **OPTIONS** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - There is a default limit of **3** **POST**, **PUT**, **PATCH** or **DELETE** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - When rate limits are exceeded, the API will return a **429 Too Many Requests** HTTP status code with the response: `{\"error\": \"Rate limit exceeded. Try again later.\"}` - **X-RateLimit headers** are included in every API response, providing real-time rate limit information: - **X-RateLimit-Limit** - The maximum number of requests permitted and the time window (e.g., \"1000, 1000;window=3600\" for 1000 requests per hour) - **X-RateLimit-Remaining** - The number of requests remaining in the current rate limit window - **X-RateLimit-Used** - The number of requests already made in the current window - **X-RateLimit-Reset** - The time at which the current rate limit window resets, in UTC epoch seconds # Pagination - Pagination is supported for all endpoints that return a collection of items. - Pagination is controlled by the **page** query parameter ## Example ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10 ```
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+package com.rootly.client.api;
+
+import com.rootly.client.ApiCallback;
+import com.rootly.client.ApiClient;
+import com.rootly.client.ApiException;
+import com.rootly.client.ApiResponse;
+import com.rootly.client.Configuration;
+import com.rootly.client.Pair;
+import com.rootly.client.ProgressRequestBody;
+import com.rootly.client.ProgressResponseBody;
+
+import com.google.gson.reflect.TypeToken;
+
+import java.io.IOException;
+
+
+import com.rootly.client.model.AlertRouteList;
+import com.rootly.client.model.AlertRouteResponse;
+import com.rootly.client.model.DeleteAlertRoute200Response;
+import com.rootly.client.model.ErrorsList;
+import com.rootly.client.model.NewAlertRoute;
+import com.rootly.client.model.PatchAlertRoute;
+import com.rootly.client.model.UpdateAlertRoute;
+
+import java.lang.reflect.Type;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+public class AlertRoutesApi {
+ private ApiClient localVarApiClient;
+ private int localHostIndex;
+ private String localCustomBaseUrl;
+
+ public AlertRoutesApi() {
+ this(Configuration.getDefaultApiClient());
+ }
+
+ public AlertRoutesApi(ApiClient apiClient) {
+ this.localVarApiClient = apiClient;
+ }
+
+ public ApiClient getApiClient() {
+ return localVarApiClient;
+ }
+
+ public void setApiClient(ApiClient apiClient) {
+ this.localVarApiClient = apiClient;
+ }
+
+ public int getHostIndex() {
+ return localHostIndex;
+ }
+
+ public void setHostIndex(int hostIndex) {
+ this.localHostIndex = hostIndex;
+ }
+
+ public String getCustomBaseUrl() {
+ return localCustomBaseUrl;
+ }
+
+ public void setCustomBaseUrl(String customBaseUrl) {
+ this.localCustomBaseUrl = customBaseUrl;
+ }
+
+ /**
+ * Build call for createAlertRoute
+ * @param newAlertRoute (required)
+ * @param _callback Callback for upload/download progress
+ * @return Call to execute
+ * @throws ApiException If fail to serialize the request body object
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 201 | unknown attribute filtered out gracefully | - |
+ | 422 | create: raises error when multiple fallback rules are present | - |
+ | 401 | unauthorized | - |
+
+ */
+ public okhttp3.Call createAlertRouteCall(@javax.annotation.Nonnull NewAlertRoute newAlertRoute, final ApiCallback _callback) throws ApiException {
+ String basePath = null;
+ // Operation Servers
+ String[] localBasePaths = new String[] { };
+
+ // Determine Base Path to Use
+ if (localCustomBaseUrl != null){
+ basePath = localCustomBaseUrl;
+ } else if ( localBasePaths.length > 0 ) {
+ basePath = localBasePaths[localHostIndex];
+ } else {
+ basePath = null;
+ }
+
+ Object localVarPostBody = newAlertRoute;
+
+ // create path and map variables
+ String localVarPath = "/v1/alert_routes";
+
+ List localVarQueryParams = new ArrayList();
+ List localVarCollectionQueryParams = new ArrayList();
+ Map localVarHeaderParams = new HashMap();
+ Map localVarCookieParams = new HashMap();
+ Map localVarFormParams = new HashMap();
+
+ final String[] localVarAccepts = {
+ "application/vnd.api+json"
+ };
+ final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
+ if (localVarAccept != null) {
+ localVarHeaderParams.put("Accept", localVarAccept);
+ }
+
+ final String[] localVarContentTypes = {
+ "application/vnd.api+json"
+ };
+ final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
+ if (localVarContentType != null) {
+ localVarHeaderParams.put("Content-Type", localVarContentType);
+ }
+
+ String[] localVarAuthNames = new String[] { "bearer_auth" };
+ return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
+ }
+
+ @SuppressWarnings("rawtypes")
+ private okhttp3.Call createAlertRouteValidateBeforeCall(@javax.annotation.Nonnull NewAlertRoute newAlertRoute, final ApiCallback _callback) throws ApiException {
+ // verify the required parameter 'newAlertRoute' is set
+ if (newAlertRoute == null) {
+ throw new ApiException("Missing the required parameter 'newAlertRoute' when calling createAlertRoute(Async)");
+ }
+
+ return createAlertRouteCall(newAlertRoute, _callback);
+
+ }
+
+ /**
+ * Creates an alert route
+ * Creates a new alert route from provided data. **Note: This endpoint requires access to Advanced Alert Routing. If you're unsure whether you have access to this feature, please contact Rootly customer support.** ## Asynchronous Rule Creation For organizations with large numbers of routing rules, Rootly supports asynchronous rule processing to improve performance. When enabled, rule creation happens in the background. **Important**: When async processing is enabled, the rules list in the API response will not be up-to-date immediately after creation. You should refetch the alert route after a few minutes to get the updated rules. If you experience slow operations when managing alert routes with many rules, contact Rootly customer support to enable asynchronous rule processing for your organization.
+ * @param newAlertRoute (required)
+ * @return AlertRouteResponse
+ * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 201 | unknown attribute filtered out gracefully | - |
+ | 422 | create: raises error when multiple fallback rules are present | - |
+ | 401 | unauthorized | - |
+
+ */
+ public AlertRouteResponse createAlertRoute(@javax.annotation.Nonnull NewAlertRoute newAlertRoute) throws ApiException {
+ ApiResponse localVarResp = createAlertRouteWithHttpInfo(newAlertRoute);
+ return localVarResp.getData();
+ }
+
+ /**
+ * Creates an alert route
+ * Creates a new alert route from provided data. **Note: This endpoint requires access to Advanced Alert Routing. If you're unsure whether you have access to this feature, please contact Rootly customer support.** ## Asynchronous Rule Creation For organizations with large numbers of routing rules, Rootly supports asynchronous rule processing to improve performance. When enabled, rule creation happens in the background. **Important**: When async processing is enabled, the rules list in the API response will not be up-to-date immediately after creation. You should refetch the alert route after a few minutes to get the updated rules. If you experience slow operations when managing alert routes with many rules, contact Rootly customer support to enable asynchronous rule processing for your organization.
+ * @param newAlertRoute (required)
+ * @return ApiResponse<AlertRouteResponse>
+ * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 201 | unknown attribute filtered out gracefully | - |
+ | 422 | create: raises error when multiple fallback rules are present | - |
+ | 401 | unauthorized | - |
+
+ */
+ public ApiResponse createAlertRouteWithHttpInfo(@javax.annotation.Nonnull NewAlertRoute newAlertRoute) throws ApiException {
+ okhttp3.Call localVarCall = createAlertRouteValidateBeforeCall(newAlertRoute, null);
+ Type localVarReturnType = new TypeToken(){}.getType();
+ return localVarApiClient.execute(localVarCall, localVarReturnType);
+ }
+
+ /**
+ * Creates an alert route (asynchronously)
+ * Creates a new alert route from provided data. **Note: This endpoint requires access to Advanced Alert Routing. If you're unsure whether you have access to this feature, please contact Rootly customer support.** ## Asynchronous Rule Creation For organizations with large numbers of routing rules, Rootly supports asynchronous rule processing to improve performance. When enabled, rule creation happens in the background. **Important**: When async processing is enabled, the rules list in the API response will not be up-to-date immediately after creation. You should refetch the alert route after a few minutes to get the updated rules. If you experience slow operations when managing alert routes with many rules, contact Rootly customer support to enable asynchronous rule processing for your organization.
+ * @param newAlertRoute (required)
+ * @param _callback The callback to be executed when the API call finishes
+ * @return The request call
+ * @throws ApiException If fail to process the API call, e.g. serializing the request body object
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 201 | unknown attribute filtered out gracefully | - |
+ | 422 | create: raises error when multiple fallback rules are present | - |
+ | 401 | unauthorized | - |
+
+ */
+ public okhttp3.Call createAlertRouteAsync(@javax.annotation.Nonnull NewAlertRoute newAlertRoute, final ApiCallback _callback) throws ApiException {
+
+ okhttp3.Call localVarCall = createAlertRouteValidateBeforeCall(newAlertRoute, _callback);
+ Type localVarReturnType = new TypeToken(){}.getType();
+ localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
+ return localVarCall;
+ }
+ /**
+ * Build call for deleteAlertRoute
+ * @param id (required)
+ * @param _callback Callback for upload/download progress
+ * @return Call to execute
+ * @throws ApiException If fail to serialize the request body object
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 200 | alert route deleted | - |
+ | 404 | cross-team access denied | - |
+ | 422 | destroy failed | - |
+ | 401 | unauthorized | - |
+
+ */
+ public okhttp3.Call deleteAlertRouteCall(@javax.annotation.Nonnull String id, final ApiCallback _callback) throws ApiException {
+ String basePath = null;
+ // Operation Servers
+ String[] localBasePaths = new String[] { };
+
+ // Determine Base Path to Use
+ if (localCustomBaseUrl != null){
+ basePath = localCustomBaseUrl;
+ } else if ( localBasePaths.length > 0 ) {
+ basePath = localBasePaths[localHostIndex];
+ } else {
+ basePath = null;
+ }
+
+ Object localVarPostBody = null;
+
+ // create path and map variables
+ String localVarPath = "/v1/alert_routes/{id}"
+ .replace("{" + "id" + "}", localVarApiClient.escapeString(id.toString()));
+
+ List localVarQueryParams = new ArrayList();
+ List localVarCollectionQueryParams = new ArrayList();
+ Map localVarHeaderParams = new HashMap();
+ Map localVarCookieParams = new HashMap();
+ Map localVarFormParams = new HashMap();
+
+ final String[] localVarAccepts = {
+ "application/vnd.api+json"
+ };
+ final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
+ if (localVarAccept != null) {
+ localVarHeaderParams.put("Accept", localVarAccept);
+ }
+
+ final String[] localVarContentTypes = {
+ };
+ final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
+ if (localVarContentType != null) {
+ localVarHeaderParams.put("Content-Type", localVarContentType);
+ }
+
+ String[] localVarAuthNames = new String[] { "bearer_auth" };
+ return localVarApiClient.buildCall(basePath, localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
+ }
+
+ @SuppressWarnings("rawtypes")
+ private okhttp3.Call deleteAlertRouteValidateBeforeCall(@javax.annotation.Nonnull String id, final ApiCallback _callback) throws ApiException {
+ // verify the required parameter 'id' is set
+ if (id == null) {
+ throw new ApiException("Missing the required parameter 'id' when calling deleteAlertRoute(Async)");
+ }
+
+ return deleteAlertRouteCall(id, _callback);
+
+ }
+
+ /**
+ * Delete an alert route
+ * Delete a specific alert route by id. **Note: This endpoint requires access to Advanced Alert Routing. If you're unsure whether you have access to this feature, please contact Rootly customer support.**
+ * @param id (required)
+ * @return DeleteAlertRoute200Response
+ * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 200 | alert route deleted | - |
+ | 404 | cross-team access denied | - |
+ | 422 | destroy failed | - |
+ | 401 | unauthorized | - |
+
+ */
+ public DeleteAlertRoute200Response deleteAlertRoute(@javax.annotation.Nonnull String id) throws ApiException {
+ ApiResponse localVarResp = deleteAlertRouteWithHttpInfo(id);
+ return localVarResp.getData();
+ }
+
+ /**
+ * Delete an alert route
+ * Delete a specific alert route by id. **Note: This endpoint requires access to Advanced Alert Routing. If you're unsure whether you have access to this feature, please contact Rootly customer support.**
+ * @param id (required)
+ * @return ApiResponse<DeleteAlertRoute200Response>
+ * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 200 | alert route deleted | - |
+ | 404 | cross-team access denied | - |
+ | 422 | destroy failed | - |
+ | 401 | unauthorized | - |
+
+ */
+ public ApiResponse deleteAlertRouteWithHttpInfo(@javax.annotation.Nonnull String id) throws ApiException {
+ okhttp3.Call localVarCall = deleteAlertRouteValidateBeforeCall(id, null);
+ Type localVarReturnType = new TypeToken(){}.getType();
+ return localVarApiClient.execute(localVarCall, localVarReturnType);
+ }
+
+ /**
+ * Delete an alert route (asynchronously)
+ * Delete a specific alert route by id. **Note: This endpoint requires access to Advanced Alert Routing. If you're unsure whether you have access to this feature, please contact Rootly customer support.**
+ * @param id (required)
+ * @param _callback The callback to be executed when the API call finishes
+ * @return The request call
+ * @throws ApiException If fail to process the API call, e.g. serializing the request body object
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 200 | alert route deleted | - |
+ | 404 | cross-team access denied | - |
+ | 422 | destroy failed | - |
+ | 401 | unauthorized | - |
+
+ */
+ public okhttp3.Call deleteAlertRouteAsync(@javax.annotation.Nonnull String id, final ApiCallback _callback) throws ApiException {
+
+ okhttp3.Call localVarCall = deleteAlertRouteValidateBeforeCall(id, _callback);
+ Type localVarReturnType = new TypeToken(){}.getType();
+ localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
+ return localVarCall;
+ }
+ /**
+ * Build call for getAlertRoute
+ * @param id (required)
+ * @param _callback Callback for upload/download progress
+ * @return Call to execute
+ * @throws ApiException If fail to serialize the request body object
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 200 | alert route found | - |
+ | 404 | cross-team access denied | - |
+ | 401 | unauthorized | - |
+
+ */
+ public okhttp3.Call getAlertRouteCall(@javax.annotation.Nonnull String id, final ApiCallback _callback) throws ApiException {
+ String basePath = null;
+ // Operation Servers
+ String[] localBasePaths = new String[] { };
+
+ // Determine Base Path to Use
+ if (localCustomBaseUrl != null){
+ basePath = localCustomBaseUrl;
+ } else if ( localBasePaths.length > 0 ) {
+ basePath = localBasePaths[localHostIndex];
+ } else {
+ basePath = null;
+ }
+
+ Object localVarPostBody = null;
+
+ // create path and map variables
+ String localVarPath = "/v1/alert_routes/{id}"
+ .replace("{" + "id" + "}", localVarApiClient.escapeString(id.toString()));
+
+ List localVarQueryParams = new ArrayList();
+ List localVarCollectionQueryParams = new ArrayList();
+ Map localVarHeaderParams = new HashMap();
+ Map localVarCookieParams = new HashMap();
+ Map localVarFormParams = new HashMap();
+
+ final String[] localVarAccepts = {
+ "application/vnd.api+json"
+ };
+ final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
+ if (localVarAccept != null) {
+ localVarHeaderParams.put("Accept", localVarAccept);
+ }
+
+ final String[] localVarContentTypes = {
+ };
+ final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
+ if (localVarContentType != null) {
+ localVarHeaderParams.put("Content-Type", localVarContentType);
+ }
+
+ String[] localVarAuthNames = new String[] { "bearer_auth" };
+ return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
+ }
+
+ @SuppressWarnings("rawtypes")
+ private okhttp3.Call getAlertRouteValidateBeforeCall(@javax.annotation.Nonnull String id, final ApiCallback _callback) throws ApiException {
+ // verify the required parameter 'id' is set
+ if (id == null) {
+ throw new ApiException("Missing the required parameter 'id' when calling getAlertRoute(Async)");
+ }
+
+ return getAlertRouteCall(id, _callback);
+
+ }
+
+ /**
+ * Get an alert route
+ * Get a specific alert route by id. **Note: This endpoint requires access to Advanced Alert Routing. If you're unsure whether you have access to this feature, please contact Rootly customer support.** ## Optional Parameters - **show_nested_ids** (query parameter): When set to `true`, the response will include IDs for all nested resources (destinations, condition_groups, conditions). This is useful when you need to reference these nested resources for updates or deletions via PATCH requests. Example: `GET /v1/alert_routes/{id}?show_nested_ids=true`
+ * @param id (required)
+ * @return AlertRouteResponse
+ * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 200 | alert route found | - |
+ | 404 | cross-team access denied | - |
+ | 401 | unauthorized | - |
+
+ */
+ public AlertRouteResponse getAlertRoute(@javax.annotation.Nonnull String id) throws ApiException {
+ ApiResponse localVarResp = getAlertRouteWithHttpInfo(id);
+ return localVarResp.getData();
+ }
+
+ /**
+ * Get an alert route
+ * Get a specific alert route by id. **Note: This endpoint requires access to Advanced Alert Routing. If you're unsure whether you have access to this feature, please contact Rootly customer support.** ## Optional Parameters - **show_nested_ids** (query parameter): When set to `true`, the response will include IDs for all nested resources (destinations, condition_groups, conditions). This is useful when you need to reference these nested resources for updates or deletions via PATCH requests. Example: `GET /v1/alert_routes/{id}?show_nested_ids=true`
+ * @param id (required)
+ * @return ApiResponse<AlertRouteResponse>
+ * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 200 | alert route found | - |
+ | 404 | cross-team access denied | - |
+ | 401 | unauthorized | - |
+
+ */
+ public ApiResponse getAlertRouteWithHttpInfo(@javax.annotation.Nonnull String id) throws ApiException {
+ okhttp3.Call localVarCall = getAlertRouteValidateBeforeCall(id, null);
+ Type localVarReturnType = new TypeToken(){}.getType();
+ return localVarApiClient.execute(localVarCall, localVarReturnType);
+ }
+
+ /**
+ * Get an alert route (asynchronously)
+ * Get a specific alert route by id. **Note: This endpoint requires access to Advanced Alert Routing. If you're unsure whether you have access to this feature, please contact Rootly customer support.** ## Optional Parameters - **show_nested_ids** (query parameter): When set to `true`, the response will include IDs for all nested resources (destinations, condition_groups, conditions). This is useful when you need to reference these nested resources for updates or deletions via PATCH requests. Example: `GET /v1/alert_routes/{id}?show_nested_ids=true`
+ * @param id (required)
+ * @param _callback The callback to be executed when the API call finishes
+ * @return The request call
+ * @throws ApiException If fail to process the API call, e.g. serializing the request body object
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 200 | alert route found | - |
+ | 404 | cross-team access denied | - |
+ | 401 | unauthorized | - |
+
+ */
+ public okhttp3.Call getAlertRouteAsync(@javax.annotation.Nonnull String id, final ApiCallback _callback) throws ApiException {
+
+ okhttp3.Call localVarCall = getAlertRouteValidateBeforeCall(id, _callback);
+ Type localVarReturnType = new TypeToken(){}.getType();
+ localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
+ return localVarCall;
+ }
+ /**
+ * Build call for listAlertRoutes
+ * @param pageNumber (optional)
+ * @param pageSize (optional)
+ * @param filterSearch (optional)
+ * @param filterName (optional)
+ * @param sort (optional)
+ * @param _callback Callback for upload/download progress
+ * @return Call to execute
+ * @throws ApiException If fail to serialize the request body object
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 200 | alert routes filtered by search | - |
+ | 401 | unauthorized | - |
+
+ */
+ public okhttp3.Call listAlertRoutesCall(@javax.annotation.Nullable Integer pageNumber, @javax.annotation.Nullable Integer pageSize, @javax.annotation.Nullable String filterSearch, @javax.annotation.Nullable String filterName, @javax.annotation.Nullable String sort, final ApiCallback _callback) throws ApiException {
+ String basePath = null;
+ // Operation Servers
+ String[] localBasePaths = new String[] { };
+
+ // Determine Base Path to Use
+ if (localCustomBaseUrl != null){
+ basePath = localCustomBaseUrl;
+ } else if ( localBasePaths.length > 0 ) {
+ basePath = localBasePaths[localHostIndex];
+ } else {
+ basePath = null;
+ }
+
+ Object localVarPostBody = null;
+
+ // create path and map variables
+ String localVarPath = "/v1/alert_routes";
+
+ List localVarQueryParams = new ArrayList();
+ List localVarCollectionQueryParams = new ArrayList();
+ Map localVarHeaderParams = new HashMap();
+ Map localVarCookieParams = new HashMap();
+ Map localVarFormParams = new HashMap();
+
+ if (pageNumber != null) {
+ localVarQueryParams.addAll(localVarApiClient.parameterToPair("page[number]", pageNumber));
+ }
+
+ if (pageSize != null) {
+ localVarQueryParams.addAll(localVarApiClient.parameterToPair("page[size]", pageSize));
+ }
+
+ if (filterSearch != null) {
+ localVarQueryParams.addAll(localVarApiClient.parameterToPair("filter[search]", filterSearch));
+ }
+
+ if (filterName != null) {
+ localVarQueryParams.addAll(localVarApiClient.parameterToPair("filter[name]", filterName));
+ }
+
+ if (sort != null) {
+ localVarQueryParams.addAll(localVarApiClient.parameterToPair("sort", sort));
+ }
+
+ final String[] localVarAccepts = {
+ "application/vnd.api+json"
+ };
+ final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
+ if (localVarAccept != null) {
+ localVarHeaderParams.put("Accept", localVarAccept);
+ }
+
+ final String[] localVarContentTypes = {
+ };
+ final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
+ if (localVarContentType != null) {
+ localVarHeaderParams.put("Content-Type", localVarContentType);
+ }
+
+ String[] localVarAuthNames = new String[] { "bearer_auth" };
+ return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
+ }
+
+ @SuppressWarnings("rawtypes")
+ private okhttp3.Call listAlertRoutesValidateBeforeCall(@javax.annotation.Nullable Integer pageNumber, @javax.annotation.Nullable Integer pageSize, @javax.annotation.Nullable String filterSearch, @javax.annotation.Nullable String filterName, @javax.annotation.Nullable String sort, final ApiCallback _callback) throws ApiException {
+ return listAlertRoutesCall(pageNumber, pageSize, filterSearch, filterName, sort, _callback);
+
+ }
+
+ /**
+ * List alert routes
+ * List all alert routes for the current team with filtering and pagination. **Note: This endpoint requires access to Advanced Alert Routing. If you're unsure whether you have access to this feature, please contact Rootly customer support.**
+ * @param pageNumber (optional)
+ * @param pageSize (optional)
+ * @param filterSearch (optional)
+ * @param filterName (optional)
+ * @param sort (optional)
+ * @return AlertRouteList
+ * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 200 | alert routes filtered by search | - |
+ | 401 | unauthorized | - |
+
+ */
+ public AlertRouteList listAlertRoutes(@javax.annotation.Nullable Integer pageNumber, @javax.annotation.Nullable Integer pageSize, @javax.annotation.Nullable String filterSearch, @javax.annotation.Nullable String filterName, @javax.annotation.Nullable String sort) throws ApiException {
+ ApiResponse localVarResp = listAlertRoutesWithHttpInfo(pageNumber, pageSize, filterSearch, filterName, sort);
+ return localVarResp.getData();
+ }
+
+ /**
+ * List alert routes
+ * List all alert routes for the current team with filtering and pagination. **Note: This endpoint requires access to Advanced Alert Routing. If you're unsure whether you have access to this feature, please contact Rootly customer support.**
+ * @param pageNumber (optional)
+ * @param pageSize (optional)
+ * @param filterSearch (optional)
+ * @param filterName (optional)
+ * @param sort (optional)
+ * @return ApiResponse<AlertRouteList>
+ * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 200 | alert routes filtered by search | - |
+ | 401 | unauthorized | - |
+
+ */
+ public ApiResponse listAlertRoutesWithHttpInfo(@javax.annotation.Nullable Integer pageNumber, @javax.annotation.Nullable Integer pageSize, @javax.annotation.Nullable String filterSearch, @javax.annotation.Nullable String filterName, @javax.annotation.Nullable String sort) throws ApiException {
+ okhttp3.Call localVarCall = listAlertRoutesValidateBeforeCall(pageNumber, pageSize, filterSearch, filterName, sort, null);
+ Type localVarReturnType = new TypeToken(){}.getType();
+ return localVarApiClient.execute(localVarCall, localVarReturnType);
+ }
+
+ /**
+ * List alert routes (asynchronously)
+ * List all alert routes for the current team with filtering and pagination. **Note: This endpoint requires access to Advanced Alert Routing. If you're unsure whether you have access to this feature, please contact Rootly customer support.**
+ * @param pageNumber (optional)
+ * @param pageSize (optional)
+ * @param filterSearch (optional)
+ * @param filterName (optional)
+ * @param sort (optional)
+ * @param _callback The callback to be executed when the API call finishes
+ * @return The request call
+ * @throws ApiException If fail to process the API call, e.g. serializing the request body object
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 200 | alert routes filtered by search | - |
+ | 401 | unauthorized | - |
+
+ */
+ public okhttp3.Call listAlertRoutesAsync(@javax.annotation.Nullable Integer pageNumber, @javax.annotation.Nullable Integer pageSize, @javax.annotation.Nullable String filterSearch, @javax.annotation.Nullable String filterName, @javax.annotation.Nullable String sort, final ApiCallback _callback) throws ApiException {
+
+ okhttp3.Call localVarCall = listAlertRoutesValidateBeforeCall(pageNumber, pageSize, filterSearch, filterName, sort, _callback);
+ Type localVarReturnType = new TypeToken(){}.getType();
+ localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
+ return localVarCall;
+ }
+ /**
+ * Build call for patchAlertRoute
+ * @param id (required)
+ * @param patchAlertRoute (required)
+ * @param _callback Callback for upload/download progress
+ * @return Call to execute
+ * @throws ApiException If fail to serialize the request body object
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 200 | delete existing rule by id with _destroy | - |
+ | 422 | invalid request | - |
+ | 401 | unauthorized | - |
+ | 404 | cross-team access denied | - |
+
+ */
+ public okhttp3.Call patchAlertRouteCall(@javax.annotation.Nonnull String id, @javax.annotation.Nonnull PatchAlertRoute patchAlertRoute, final ApiCallback _callback) throws ApiException {
+ String basePath = null;
+ // Operation Servers
+ String[] localBasePaths = new String[] { };
+
+ // Determine Base Path to Use
+ if (localCustomBaseUrl != null){
+ basePath = localCustomBaseUrl;
+ } else if ( localBasePaths.length > 0 ) {
+ basePath = localBasePaths[localHostIndex];
+ } else {
+ basePath = null;
+ }
+
+ Object localVarPostBody = patchAlertRoute;
+
+ // create path and map variables
+ String localVarPath = "/v1/alert_routes/{id}"
+ .replace("{" + "id" + "}", localVarApiClient.escapeString(id.toString()));
+
+ List localVarQueryParams = new ArrayList();
+ List localVarCollectionQueryParams = new ArrayList();
+ Map localVarHeaderParams = new HashMap();
+ Map localVarCookieParams = new HashMap();
+ Map localVarFormParams = new HashMap();
+
+ final String[] localVarAccepts = {
+ "application/vnd.api+json"
+ };
+ final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
+ if (localVarAccept != null) {
+ localVarHeaderParams.put("Accept", localVarAccept);
+ }
+
+ final String[] localVarContentTypes = {
+ "application/vnd.api+json"
+ };
+ final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
+ if (localVarContentType != null) {
+ localVarHeaderParams.put("Content-Type", localVarContentType);
+ }
+
+ String[] localVarAuthNames = new String[] { "bearer_auth" };
+ return localVarApiClient.buildCall(basePath, localVarPath, "PATCH", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
+ }
+
+ @SuppressWarnings("rawtypes")
+ private okhttp3.Call patchAlertRouteValidateBeforeCall(@javax.annotation.Nonnull String id, @javax.annotation.Nonnull PatchAlertRoute patchAlertRoute, final ApiCallback _callback) throws ApiException {
+ // verify the required parameter 'id' is set
+ if (id == null) {
+ throw new ApiException("Missing the required parameter 'id' when calling patchAlertRoute(Async)");
+ }
+
+ // verify the required parameter 'patchAlertRoute' is set
+ if (patchAlertRoute == null) {
+ throw new ApiException("Missing the required parameter 'patchAlertRoute' when calling patchAlertRoute(Async)");
+ }
+
+ return patchAlertRouteCall(id, patchAlertRoute, _callback);
+
+ }
+
+ /**
+ * Update an alert route
+ * Updates an alert route. **Note: This endpoint requires access to Advanced Alert Routing. If you're unsure whether you have access to this feature, please contact Rootly customer support.**
+ * @param id (required)
+ * @param patchAlertRoute (required)
+ * @return AlertRouteResponse
+ * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 200 | delete existing rule by id with _destroy | - |
+ | 422 | invalid request | - |
+ | 401 | unauthorized | - |
+ | 404 | cross-team access denied | - |
+
+ */
+ public AlertRouteResponse patchAlertRoute(@javax.annotation.Nonnull String id, @javax.annotation.Nonnull PatchAlertRoute patchAlertRoute) throws ApiException {
+ ApiResponse localVarResp = patchAlertRouteWithHttpInfo(id, patchAlertRoute);
+ return localVarResp.getData();
+ }
+
+ /**
+ * Update an alert route
+ * Updates an alert route. **Note: This endpoint requires access to Advanced Alert Routing. If you're unsure whether you have access to this feature, please contact Rootly customer support.**
+ * @param id (required)
+ * @param patchAlertRoute (required)
+ * @return ApiResponse<AlertRouteResponse>
+ * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 200 | delete existing rule by id with _destroy | - |
+ | 422 | invalid request | - |
+ | 401 | unauthorized | - |
+ | 404 | cross-team access denied | - |
+
+ */
+ public ApiResponse patchAlertRouteWithHttpInfo(@javax.annotation.Nonnull String id, @javax.annotation.Nonnull PatchAlertRoute patchAlertRoute) throws ApiException {
+ okhttp3.Call localVarCall = patchAlertRouteValidateBeforeCall(id, patchAlertRoute, null);
+ Type localVarReturnType = new TypeToken(){}.getType();
+ return localVarApiClient.execute(localVarCall, localVarReturnType);
+ }
+
+ /**
+ * Update an alert route (asynchronously)
+ * Updates an alert route. **Note: This endpoint requires access to Advanced Alert Routing. If you're unsure whether you have access to this feature, please contact Rootly customer support.**
+ * @param id (required)
+ * @param patchAlertRoute (required)
+ * @param _callback The callback to be executed when the API call finishes
+ * @return The request call
+ * @throws ApiException If fail to process the API call, e.g. serializing the request body object
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 200 | delete existing rule by id with _destroy | - |
+ | 422 | invalid request | - |
+ | 401 | unauthorized | - |
+ | 404 | cross-team access denied | - |
+
+ */
+ public okhttp3.Call patchAlertRouteAsync(@javax.annotation.Nonnull String id, @javax.annotation.Nonnull PatchAlertRoute patchAlertRoute, final ApiCallback _callback) throws ApiException {
+
+ okhttp3.Call localVarCall = patchAlertRouteValidateBeforeCall(id, patchAlertRoute, _callback);
+ Type localVarReturnType = new TypeToken(){}.getType();
+ localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
+ return localVarCall;
+ }
+ /**
+ * Build call for updateAlertRoute
+ * @param id (required)
+ * @param updateAlertRoute (required)
+ * @param _callback Callback for upload/download progress
+ * @return Call to execute
+ * @throws ApiException If fail to serialize the request body object
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 200 | update: handles mixed position types correctly | - |
+ | 422 | update: raises error when multiple fallback rules are present | - |
+ | 404 | cross-team access denied | - |
+
+ */
+ public okhttp3.Call updateAlertRouteCall(@javax.annotation.Nonnull String id, @javax.annotation.Nonnull UpdateAlertRoute updateAlertRoute, final ApiCallback _callback) throws ApiException {
+ String basePath = null;
+ // Operation Servers
+ String[] localBasePaths = new String[] { };
+
+ // Determine Base Path to Use
+ if (localCustomBaseUrl != null){
+ basePath = localCustomBaseUrl;
+ } else if ( localBasePaths.length > 0 ) {
+ basePath = localBasePaths[localHostIndex];
+ } else {
+ basePath = null;
+ }
+
+ Object localVarPostBody = updateAlertRoute;
+
+ // create path and map variables
+ String localVarPath = "/v1/alert_routes/{id}"
+ .replace("{" + "id" + "}", localVarApiClient.escapeString(id.toString()));
+
+ List localVarQueryParams = new ArrayList();
+ List localVarCollectionQueryParams = new ArrayList();
+ Map localVarHeaderParams = new HashMap();
+ Map localVarCookieParams = new HashMap();
+ Map localVarFormParams = new HashMap();
+
+ final String[] localVarAccepts = {
+ "application/vnd.api+json"
+ };
+ final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
+ if (localVarAccept != null) {
+ localVarHeaderParams.put("Accept", localVarAccept);
+ }
+
+ final String[] localVarContentTypes = {
+ "application/vnd.api+json"
+ };
+ final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
+ if (localVarContentType != null) {
+ localVarHeaderParams.put("Content-Type", localVarContentType);
+ }
+
+ String[] localVarAuthNames = new String[] { "bearer_auth" };
+ return localVarApiClient.buildCall(basePath, localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
+ }
+
+ @SuppressWarnings("rawtypes")
+ private okhttp3.Call updateAlertRouteValidateBeforeCall(@javax.annotation.Nonnull String id, @javax.annotation.Nonnull UpdateAlertRoute updateAlertRoute, final ApiCallback _callback) throws ApiException {
+ // verify the required parameter 'id' is set
+ if (id == null) {
+ throw new ApiException("Missing the required parameter 'id' when calling updateAlertRoute(Async)");
+ }
+
+ // verify the required parameter 'updateAlertRoute' is set
+ if (updateAlertRoute == null) {
+ throw new ApiException("Missing the required parameter 'updateAlertRoute' when calling updateAlertRoute(Async)");
+ }
+
+ return updateAlertRouteCall(id, updateAlertRoute, _callback);
+
+ }
+
+ /**
+ * Update an alert route
+ * Update a specific alert route by id. **Note: This endpoint requires access to Advanced Alert Routing. If you're unsure whether you have access to this feature, please contact Rootly customer support.** ### Asynchronous Rule Creation For organizations with large numbers of routing rules, Rootly supports asynchronous rule processing to improve performance. When enabled, rule updates happen in the background. **Important**: When async processing is enabled, the rules list in the API response will not be up-to-date immediately after update. You should refetch the alert route after a few minutes to get the updated rules. If you experience slow operations when managing alert routes with many rules, contact Rootly customer support to enable asynchronous rule processing for your organization.
+ * @param id (required)
+ * @param updateAlertRoute (required)
+ * @return AlertRouteResponse
+ * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 200 | update: handles mixed position types correctly | - |
+ | 422 | update: raises error when multiple fallback rules are present | - |
+ | 404 | cross-team access denied | - |
+
+ */
+ public AlertRouteResponse updateAlertRoute(@javax.annotation.Nonnull String id, @javax.annotation.Nonnull UpdateAlertRoute updateAlertRoute) throws ApiException {
+ ApiResponse localVarResp = updateAlertRouteWithHttpInfo(id, updateAlertRoute);
+ return localVarResp.getData();
+ }
+
+ /**
+ * Update an alert route
+ * Update a specific alert route by id. **Note: This endpoint requires access to Advanced Alert Routing. If you're unsure whether you have access to this feature, please contact Rootly customer support.** ### Asynchronous Rule Creation For organizations with large numbers of routing rules, Rootly supports asynchronous rule processing to improve performance. When enabled, rule updates happen in the background. **Important**: When async processing is enabled, the rules list in the API response will not be up-to-date immediately after update. You should refetch the alert route after a few minutes to get the updated rules. If you experience slow operations when managing alert routes with many rules, contact Rootly customer support to enable asynchronous rule processing for your organization.
+ * @param id (required)
+ * @param updateAlertRoute (required)
+ * @return ApiResponse<AlertRouteResponse>
+ * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 200 | update: handles mixed position types correctly | - |
+ | 422 | update: raises error when multiple fallback rules are present | - |
+ | 404 | cross-team access denied | - |
+
+ */
+ public ApiResponse updateAlertRouteWithHttpInfo(@javax.annotation.Nonnull String id, @javax.annotation.Nonnull UpdateAlertRoute updateAlertRoute) throws ApiException {
+ okhttp3.Call localVarCall = updateAlertRouteValidateBeforeCall(id, updateAlertRoute, null);
+ Type localVarReturnType = new TypeToken(){}.getType();
+ return localVarApiClient.execute(localVarCall, localVarReturnType);
+ }
+
+ /**
+ * Update an alert route (asynchronously)
+ * Update a specific alert route by id. **Note: This endpoint requires access to Advanced Alert Routing. If you're unsure whether you have access to this feature, please contact Rootly customer support.** ### Asynchronous Rule Creation For organizations with large numbers of routing rules, Rootly supports asynchronous rule processing to improve performance. When enabled, rule updates happen in the background. **Important**: When async processing is enabled, the rules list in the API response will not be up-to-date immediately after update. You should refetch the alert route after a few minutes to get the updated rules. If you experience slow operations when managing alert routes with many rules, contact Rootly customer support to enable asynchronous rule processing for your organization.
+ * @param id (required)
+ * @param updateAlertRoute (required)
+ * @param _callback The callback to be executed when the API call finishes
+ * @return The request call
+ * @throws ApiException If fail to process the API call, e.g. serializing the request body object
+ * @http.response.details
+
+ Response Details
+ | Status Code | Description | Response Headers |
+ | 200 | update: handles mixed position types correctly | - |
+ | 422 | update: raises error when multiple fallback rules are present | - |
+ | 404 | cross-team access denied | - |
+
+ */
+ public okhttp3.Call updateAlertRouteAsync(@javax.annotation.Nonnull String id, @javax.annotation.Nonnull UpdateAlertRoute updateAlertRoute, final ApiCallback _callback) throws ApiException {
+
+ okhttp3.Call localVarCall = updateAlertRouteValidateBeforeCall(id, updateAlertRoute, _callback);
+ Type localVarReturnType = new TypeToken(){}.getType();
+ localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
+ return localVarCall;
+ }
+}
diff --git a/src/main/java/com/rootly/client/api/AlertRoutingRulesApi.java b/src/main/java/com/rootly/client/api/AlertRoutingRulesApi.java
index 7d43c6d1..d2826d9f 100644
--- a/src/main/java/com/rootly/client/api/AlertRoutingRulesApi.java
+++ b/src/main/java/com/rootly/client/api/AlertRoutingRulesApi.java
@@ -1,6 +1,6 @@
/*
* Rootly API v1
- * # How to generate an API Key? - **Organization dropdown** > **Organization Settings** > **API Keys** # JSON:API Specification Rootly is using **JSON:API** (https://jsonapi.org) specification: - JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests. - JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. - JSON:API requires use of the JSON:API media type (**application/vnd.api+json**) for exchanging data. # Authentication and Requests We use standard HTTP Authentication over HTTPS to authorize your requests. ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents ```
# Rate limiting - There is a default limit of approximately **3000** **GET** calls **per API key** every **60 seconds**. The limit is calculated over a **60-second sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - There is a default limit of approximately **3000** **PUT**, **POST**, **PATCH** or **DELETE** calls **per API key** every **60 seconds**. The limit is calculated over a **60-second sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - The response to the API call will return 429 HTTP status code - Request Limit Exceeded and Rootly will not ingest the event. - Additional headers will be returned giving you information about the limit: - **RateLimit-Limit** - The maximum number of requests that the consumer is permitted to make. - **RateLimit-Remaining** - The number of requests remaining in the current rate limit window. - **RateLimit-Reset** - The time at which the current rate limit window resets in UTC epoch seconds. # Pagination - Pagination is supported for all endpoints that return a collection of items. - Pagination is controlled by the **page** query parameter ## Example ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10 ```
+ * # How to generate an API Key? - **Organization dropdown** > **Organization Settings** > **API Keys** # JSON:API Specification Rootly is using **JSON:API** (https://jsonapi.org) specification: - JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests. - JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. - JSON:API requires use of the JSON:API media type (**application/vnd.api+json**) for exchanging data. # Authentication and Requests We use standard HTTP Authentication over HTTPS to authorize your requests. ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents ```
# Rate limiting - There is a default limit of **5** **GET**, **HEAD**, and **OPTIONS** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - There is a default limit of **3** **POST**, **PUT**, **PATCH** or **DELETE** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - When rate limits are exceeded, the API will return a **429 Too Many Requests** HTTP status code with the response: `{\"error\": \"Rate limit exceeded. Try again later.\"}` - **X-RateLimit headers** are included in every API response, providing real-time rate limit information: - **X-RateLimit-Limit** - The maximum number of requests permitted and the time window (e.g., \"1000, 1000;window=3600\" for 1000 requests per hour) - **X-RateLimit-Remaining** - The number of requests remaining in the current rate limit window - **X-RateLimit-Used** - The number of requests already made in the current window - **X-RateLimit-Reset** - The time at which the current rate limit window resets, in UTC epoch seconds # Pagination - Pagination is supported for all endpoints that return a collection of items. - Pagination is controlled by the **page** query parameter ## Example ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10 ```
*
* The version of the OpenAPI document: v1
*
@@ -30,6 +30,7 @@
import com.rootly.client.model.AlertRoutingRuleList;
import com.rootly.client.model.AlertRoutingRuleResponse;
import com.rootly.client.model.ErrorsList;
+import com.rootly.client.model.GetAlertFieldIdParameter;
import com.rootly.client.model.NewAlertRoutingRule;
import com.rootly.client.model.UpdateAlertRoutingRule;
@@ -149,7 +150,7 @@ private okhttp3.Call createAlertRoutingRuleValidateBeforeCall(@javax.annotation.
/**
* Creates an alert routing rule
- * Creates a new alert routing rule from provided data
+ * Creates a new alert routing rule from provided data. **Note: If you are an advanced alert routing user, you should use the Alert Routes endpoint instead of this endpoint. If you don't know whether you are an advanced user, please contact Rootly customer support.**
* @param newAlertRoutingRule (required)
* @return AlertRoutingRuleResponse
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -169,7 +170,7 @@ public AlertRoutingRuleResponse createAlertRoutingRule(@javax.annotation.Nonnull
/**
* Creates an alert routing rule
- * Creates a new alert routing rule from provided data
+ * Creates a new alert routing rule from provided data. **Note: If you are an advanced alert routing user, you should use the Alert Routes endpoint instead of this endpoint. If you don't know whether you are an advanced user, please contact Rootly customer support.**
* @param newAlertRoutingRule (required)
* @return ApiResponse<AlertRoutingRuleResponse>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -190,7 +191,7 @@ public ApiResponse createAlertRoutingRuleWithHttpInfo(
/**
* Creates an alert routing rule (asynchronously)
- * Creates a new alert routing rule from provided data
+ * Creates a new alert routing rule from provided data. **Note: If you are an advanced alert routing user, you should use the Alert Routes endpoint instead of this endpoint. If you don't know whether you are an advanced user, please contact Rootly customer support.**
* @param newAlertRoutingRule (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
@@ -225,7 +226,7 @@ public okhttp3.Call createAlertRoutingRuleAsync(@javax.annotation.Nonnull NewAle
| 404 | resource not found | - |
*/
- public okhttp3.Call deleteAlertRoutingRuleCall(@javax.annotation.Nonnull String id, final ApiCallback _callback) throws ApiException {
+ public okhttp3.Call deleteAlertRoutingRuleCall(@javax.annotation.Nonnull GetAlertFieldIdParameter id, final ApiCallback _callback) throws ApiException {
String basePath = null;
// Operation Servers
String[] localBasePaths = new String[] { };
@@ -271,7 +272,7 @@ public okhttp3.Call deleteAlertRoutingRuleCall(@javax.annotation.Nonnull String
}
@SuppressWarnings("rawtypes")
- private okhttp3.Call deleteAlertRoutingRuleValidateBeforeCall(@javax.annotation.Nonnull String id, final ApiCallback _callback) throws ApiException {
+ private okhttp3.Call deleteAlertRoutingRuleValidateBeforeCall(@javax.annotation.Nonnull GetAlertFieldIdParameter id, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException("Missing the required parameter 'id' when calling deleteAlertRoutingRule(Async)");
@@ -283,7 +284,7 @@ private okhttp3.Call deleteAlertRoutingRuleValidateBeforeCall(@javax.annotation.
/**
* Delete an alert routing rule
- * Delete a specific alert routing rule by id
+ * Delete a specific alert routing rule by id. **Note: If you are an advanced alert routing user, you should use the Alert Routes endpoint instead of this endpoint. If you don't know whether you are an advanced user, please contact Rootly customer support.**
* @param id (required)
* @return AlertRoutingRuleResponse
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -295,14 +296,14 @@ private okhttp3.Call deleteAlertRoutingRuleValidateBeforeCall(@javax.annotation.
| 404 | resource not found | - |
*/
- public AlertRoutingRuleResponse deleteAlertRoutingRule(@javax.annotation.Nonnull String id) throws ApiException {
+ public AlertRoutingRuleResponse deleteAlertRoutingRule(@javax.annotation.Nonnull GetAlertFieldIdParameter id) throws ApiException {
ApiResponse localVarResp = deleteAlertRoutingRuleWithHttpInfo(id);
return localVarResp.getData();
}
/**
* Delete an alert routing rule
- * Delete a specific alert routing rule by id
+ * Delete a specific alert routing rule by id. **Note: If you are an advanced alert routing user, you should use the Alert Routes endpoint instead of this endpoint. If you don't know whether you are an advanced user, please contact Rootly customer support.**
* @param id (required)
* @return ApiResponse<AlertRoutingRuleResponse>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -314,7 +315,7 @@ public AlertRoutingRuleResponse deleteAlertRoutingRule(@javax.annotation.Nonnull
| 404 | resource not found | - |
*/
- public ApiResponse deleteAlertRoutingRuleWithHttpInfo(@javax.annotation.Nonnull String id) throws ApiException {
+ public ApiResponse deleteAlertRoutingRuleWithHttpInfo(@javax.annotation.Nonnull GetAlertFieldIdParameter id) throws ApiException {
okhttp3.Call localVarCall = deleteAlertRoutingRuleValidateBeforeCall(id, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
@@ -322,7 +323,7 @@ public ApiResponse deleteAlertRoutingRuleWithHttpInfo(
/**
* Delete an alert routing rule (asynchronously)
- * Delete a specific alert routing rule by id
+ * Delete a specific alert routing rule by id. **Note: If you are an advanced alert routing user, you should use the Alert Routes endpoint instead of this endpoint. If you don't know whether you are an advanced user, please contact Rootly customer support.**
* @param id (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
@@ -335,7 +336,7 @@ public ApiResponse deleteAlertRoutingRuleWithHttpInfo(
| 404 | resource not found | - |
*/
- public okhttp3.Call deleteAlertRoutingRuleAsync(@javax.annotation.Nonnull String id, final ApiCallback _callback) throws ApiException {
+ public okhttp3.Call deleteAlertRoutingRuleAsync(@javax.annotation.Nonnull GetAlertFieldIdParameter id, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = deleteAlertRoutingRuleValidateBeforeCall(id, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
@@ -352,11 +353,11 @@ public okhttp3.Call deleteAlertRoutingRuleAsync(@javax.annotation.Nonnull String
Response Details
| Status Code | Description | Response Headers |
- | 200 | alert routing rule found | - |
+ | 200 | alert_routing_rule found by slug | - |
| 404 | resource not found | - |
*/
- public okhttp3.Call getAlertRoutingRuleCall(@javax.annotation.Nonnull String id, final ApiCallback _callback) throws ApiException {
+ public okhttp3.Call getAlertRoutingRuleCall(@javax.annotation.Nonnull GetAlertFieldIdParameter id, final ApiCallback _callback) throws ApiException {
String basePath = null;
// Operation Servers
String[] localBasePaths = new String[] { };
@@ -402,7 +403,7 @@ public okhttp3.Call getAlertRoutingRuleCall(@javax.annotation.Nonnull String id,
}
@SuppressWarnings("rawtypes")
- private okhttp3.Call getAlertRoutingRuleValidateBeforeCall(@javax.annotation.Nonnull String id, final ApiCallback _callback) throws ApiException {
+ private okhttp3.Call getAlertRoutingRuleValidateBeforeCall(@javax.annotation.Nonnull GetAlertFieldIdParameter id, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException("Missing the required parameter 'id' when calling getAlertRoutingRule(Async)");
@@ -414,7 +415,7 @@ private okhttp3.Call getAlertRoutingRuleValidateBeforeCall(@javax.annotation.Non
/**
* Retrieves an alert routing rule
- * Retrieves a specific alert routing rule by id
+ * Retrieves a specific alert routing rule by id. **Note: If you are an advanced alert routing user, you should use the Alert Routes endpoint instead of this endpoint. If you don't know whether you are an advanced user, please contact Rootly customer support.**
* @param id (required)
* @return AlertRoutingRuleResponse
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -422,18 +423,18 @@ private okhttp3.Call getAlertRoutingRuleValidateBeforeCall(@javax.annotation.Non
Response Details
| Status Code | Description | Response Headers |
- | 200 | alert routing rule found | - |
+ | 200 | alert_routing_rule found by slug | - |
| 404 | resource not found | - |
*/
- public AlertRoutingRuleResponse getAlertRoutingRule(@javax.annotation.Nonnull String id) throws ApiException {
+ public AlertRoutingRuleResponse getAlertRoutingRule(@javax.annotation.Nonnull GetAlertFieldIdParameter id) throws ApiException {
ApiResponse localVarResp = getAlertRoutingRuleWithHttpInfo(id);
return localVarResp.getData();
}
/**
* Retrieves an alert routing rule
- * Retrieves a specific alert routing rule by id
+ * Retrieves a specific alert routing rule by id. **Note: If you are an advanced alert routing user, you should use the Alert Routes endpoint instead of this endpoint. If you don't know whether you are an advanced user, please contact Rootly customer support.**
* @param id (required)
* @return ApiResponse<AlertRoutingRuleResponse>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -441,11 +442,11 @@ public AlertRoutingRuleResponse getAlertRoutingRule(@javax.annotation.Nonnull St
Response Details
| Status Code | Description | Response Headers |
- | 200 | alert routing rule found | - |
+ | 200 | alert_routing_rule found by slug | - |
| 404 | resource not found | - |
*/
- public ApiResponse getAlertRoutingRuleWithHttpInfo(@javax.annotation.Nonnull String id) throws ApiException {
+ public ApiResponse getAlertRoutingRuleWithHttpInfo(@javax.annotation.Nonnull GetAlertFieldIdParameter id) throws ApiException {
okhttp3.Call localVarCall = getAlertRoutingRuleValidateBeforeCall(id, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
@@ -453,7 +454,7 @@ public ApiResponse getAlertRoutingRuleWithHttpInfo(@ja
/**
* Retrieves an alert routing rule (asynchronously)
- * Retrieves a specific alert routing rule by id
+ * Retrieves a specific alert routing rule by id. **Note: If you are an advanced alert routing user, you should use the Alert Routes endpoint instead of this endpoint. If you don't know whether you are an advanced user, please contact Rootly customer support.**
* @param id (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
@@ -462,11 +463,11 @@ public ApiResponse getAlertRoutingRuleWithHttpInfo(@ja
Response Details
| Status Code | Description | Response Headers |
- | 200 | alert routing rule found | - |
+ | 200 | alert_routing_rule found by slug | - |
| 404 | resource not found | - |
*/
- public okhttp3.Call getAlertRoutingRuleAsync(@javax.annotation.Nonnull String id, final ApiCallback _callback) throws ApiException {
+ public okhttp3.Call getAlertRoutingRuleAsync(@javax.annotation.Nonnull GetAlertFieldIdParameter id, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getAlertRoutingRuleValidateBeforeCall(id, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
@@ -587,7 +588,7 @@ private okhttp3.Call listAlertRoutingRulesValidateBeforeCall(@javax.annotation.N
/**
* List alert routing rules
- * List alert routing rules
+ * List alert routing rules. **Note: If you are an advanced alert routing user, you should use the Alert Routes endpoint instead of this endpoint. If you don't know whether you are an advanced user, please contact Rootly customer support.**
* @param include (optional)
* @param pageNumber (optional)
* @param pageSize (optional)
@@ -614,7 +615,7 @@ public AlertRoutingRuleList listAlertRoutingRules(@javax.annotation.Nullable Str
/**
* List alert routing rules
- * List alert routing rules
+ * List alert routing rules. **Note: If you are an advanced alert routing user, you should use the Alert Routes endpoint instead of this endpoint. If you don't know whether you are an advanced user, please contact Rootly customer support.**
* @param include (optional)
* @param pageNumber (optional)
* @param pageSize (optional)
@@ -642,7 +643,7 @@ public ApiResponse listAlertRoutingRulesWithHttpInfo(@java
/**
* List alert routing rules (asynchronously)
- * List alert routing rules
+ * List alert routing rules. **Note: If you are an advanced alert routing user, you should use the Alert Routes endpoint instead of this endpoint. If you don't know whether you are an advanced user, please contact Rootly customer support.**
* @param include (optional)
* @param pageNumber (optional)
* @param pageSize (optional)
@@ -685,7 +686,7 @@ public okhttp3.Call listAlertRoutingRulesAsync(@javax.annotation.Nullable String
| 404 | resource not found | - |
*/
- public okhttp3.Call updateAlertRoutingRuleCall(@javax.annotation.Nonnull String id, @javax.annotation.Nonnull UpdateAlertRoutingRule updateAlertRoutingRule, final ApiCallback _callback) throws ApiException {
+ public okhttp3.Call updateAlertRoutingRuleCall(@javax.annotation.Nonnull GetAlertFieldIdParameter id, @javax.annotation.Nonnull UpdateAlertRoutingRule updateAlertRoutingRule, final ApiCallback _callback) throws ApiException {
String basePath = null;
// Operation Servers
String[] localBasePaths = new String[] { };
@@ -732,7 +733,7 @@ public okhttp3.Call updateAlertRoutingRuleCall(@javax.annotation.Nonnull String
}
@SuppressWarnings("rawtypes")
- private okhttp3.Call updateAlertRoutingRuleValidateBeforeCall(@javax.annotation.Nonnull String id, @javax.annotation.Nonnull UpdateAlertRoutingRule updateAlertRoutingRule, final ApiCallback _callback) throws ApiException {
+ private okhttp3.Call updateAlertRoutingRuleValidateBeforeCall(@javax.annotation.Nonnull GetAlertFieldIdParameter id, @javax.annotation.Nonnull UpdateAlertRoutingRule updateAlertRoutingRule, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException("Missing the required parameter 'id' when calling updateAlertRoutingRule(Async)");
@@ -749,7 +750,7 @@ private okhttp3.Call updateAlertRoutingRuleValidateBeforeCall(@javax.annotation.
/**
* Update an alert routing rule
- * Update a specific alert routing rule by id
+ * Update a specific alert routing rule by id. **Note: If you are an advanced alert routing user, you should use the Alert Routes endpoint instead of this endpoint. If you don't know whether you are an advanced user, please contact Rootly customer support.**
* @param id (required)
* @param updateAlertRoutingRule (required)
* @return AlertRoutingRuleResponse
@@ -762,14 +763,14 @@ private okhttp3.Call updateAlertRoutingRuleValidateBeforeCall(@javax.annotation.
| 404 | resource not found | - |
*/
- public AlertRoutingRuleResponse updateAlertRoutingRule(@javax.annotation.Nonnull String id, @javax.annotation.Nonnull UpdateAlertRoutingRule updateAlertRoutingRule) throws ApiException {
+ public AlertRoutingRuleResponse updateAlertRoutingRule(@javax.annotation.Nonnull GetAlertFieldIdParameter id, @javax.annotation.Nonnull UpdateAlertRoutingRule updateAlertRoutingRule) throws ApiException {
ApiResponse localVarResp = updateAlertRoutingRuleWithHttpInfo(id, updateAlertRoutingRule);
return localVarResp.getData();
}
/**
* Update an alert routing rule
- * Update a specific alert routing rule by id
+ * Update a specific alert routing rule by id. **Note: If you are an advanced alert routing user, you should use the Alert Routes endpoint instead of this endpoint. If you don't know whether you are an advanced user, please contact Rootly customer support.**
* @param id (required)
* @param updateAlertRoutingRule (required)
* @return ApiResponse<AlertRoutingRuleResponse>
@@ -782,7 +783,7 @@ public AlertRoutingRuleResponse updateAlertRoutingRule(@javax.annotation.Nonnull
| 404 | resource not found | - |
*/
- public ApiResponse updateAlertRoutingRuleWithHttpInfo(@javax.annotation.Nonnull String id, @javax.annotation.Nonnull UpdateAlertRoutingRule updateAlertRoutingRule) throws ApiException {
+ public ApiResponse updateAlertRoutingRuleWithHttpInfo(@javax.annotation.Nonnull GetAlertFieldIdParameter id, @javax.annotation.Nonnull UpdateAlertRoutingRule updateAlertRoutingRule) throws ApiException {
okhttp3.Call localVarCall = updateAlertRoutingRuleValidateBeforeCall(id, updateAlertRoutingRule, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
@@ -790,7 +791,7 @@ public ApiResponse updateAlertRoutingRuleWithHttpInfo(
/**
* Update an alert routing rule (asynchronously)
- * Update a specific alert routing rule by id
+ * Update a specific alert routing rule by id. **Note: If you are an advanced alert routing user, you should use the Alert Routes endpoint instead of this endpoint. If you don't know whether you are an advanced user, please contact Rootly customer support.**
* @param id (required)
* @param updateAlertRoutingRule (required)
* @param _callback The callback to be executed when the API call finishes
@@ -804,7 +805,7 @@ public ApiResponse updateAlertRoutingRuleWithHttpInfo(
| 404 | resource not found | - |
*/
- public okhttp3.Call updateAlertRoutingRuleAsync(@javax.annotation.Nonnull String id, @javax.annotation.Nonnull UpdateAlertRoutingRule updateAlertRoutingRule, final ApiCallback _callback) throws ApiException {
+ public okhttp3.Call updateAlertRoutingRuleAsync(@javax.annotation.Nonnull GetAlertFieldIdParameter id, @javax.annotation.Nonnull UpdateAlertRoutingRule updateAlertRoutingRule, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = updateAlertRoutingRuleValidateBeforeCall(id, updateAlertRoutingRule, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
diff --git a/src/main/java/com/rootly/client/api/AlertSourcesApi.java b/src/main/java/com/rootly/client/api/AlertSourcesApi.java
index b039eedf..3d68a344 100644
--- a/src/main/java/com/rootly/client/api/AlertSourcesApi.java
+++ b/src/main/java/com/rootly/client/api/AlertSourcesApi.java
@@ -1,6 +1,6 @@
/*
* Rootly API v1
- * # How to generate an API Key? - **Organization dropdown** > **Organization Settings** > **API Keys** # JSON:API Specification Rootly is using **JSON:API** (https://jsonapi.org) specification: - JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests. - JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. - JSON:API requires use of the JSON:API media type (**application/vnd.api+json**) for exchanging data. # Authentication and Requests We use standard HTTP Authentication over HTTPS to authorize your requests. ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents ```
# Rate limiting - There is a default limit of approximately **3000** **GET** calls **per API key** every **60 seconds**. The limit is calculated over a **60-second sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - There is a default limit of approximately **3000** **PUT**, **POST**, **PATCH** or **DELETE** calls **per API key** every **60 seconds**. The limit is calculated over a **60-second sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - The response to the API call will return 429 HTTP status code - Request Limit Exceeded and Rootly will not ingest the event. - Additional headers will be returned giving you information about the limit: - **RateLimit-Limit** - The maximum number of requests that the consumer is permitted to make. - **RateLimit-Remaining** - The number of requests remaining in the current rate limit window. - **RateLimit-Reset** - The time at which the current rate limit window resets in UTC epoch seconds. # Pagination - Pagination is supported for all endpoints that return a collection of items. - Pagination is controlled by the **page** query parameter ## Example ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10 ```
+ * # How to generate an API Key? - **Organization dropdown** > **Organization Settings** > **API Keys** # JSON:API Specification Rootly is using **JSON:API** (https://jsonapi.org) specification: - JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests. - JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. - JSON:API requires use of the JSON:API media type (**application/vnd.api+json**) for exchanging data. # Authentication and Requests We use standard HTTP Authentication over HTTPS to authorize your requests. ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents ```
# Rate limiting - There is a default limit of **5** **GET**, **HEAD**, and **OPTIONS** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - There is a default limit of **3** **POST**, **PUT**, **PATCH** or **DELETE** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - When rate limits are exceeded, the API will return a **429 Too Many Requests** HTTP status code with the response: `{\"error\": \"Rate limit exceeded. Try again later.\"}` - **X-RateLimit headers** are included in every API response, providing real-time rate limit information: - **X-RateLimit-Limit** - The maximum number of requests permitted and the time window (e.g., \"1000, 1000;window=3600\" for 1000 requests per hour) - **X-RateLimit-Remaining** - The number of requests remaining in the current rate limit window - **X-RateLimit-Used** - The number of requests already made in the current window - **X-RateLimit-Reset** - The time at which the current rate limit window resets, in UTC epoch seconds # Pagination - Pagination is supported for all endpoints that return a collection of items. - Pagination is controlled by the **page** query parameter ## Example ``` curl --request GET \\ --header 'Content-Type: application/vnd.api+json' \\ --header 'Authorization: Bearer YOUR-TOKEN' \\ --url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10 ```
*
* The version of the OpenAPI document: v1
*
@@ -77,7 +77,7 @@ public void setCustomBaseUrl(String customBaseUrl) {
}
/**
- * Build call for createAlertSource
+ * Build call for createAlertsSource
* @param newAlertsSource (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
@@ -91,7 +91,7 @@ public void setCustomBaseUrl(String customBaseUrl) {
| 401 | responds with unauthorized for invalid token | - |
*/
- public okhttp3.Call createAlertSourceCall(@javax.annotation.Nonnull NewAlertsSource newAlertsSource, final ApiCallback _callback) throws ApiException {
+ public okhttp3.Call createAlertsSourceCall(@javax.annotation.Nonnull NewAlertsSource newAlertsSource, final ApiCallback _callback) throws ApiException {
String basePath = null;
// Operation Servers
String[] localBasePaths = new String[] { };
@@ -137,13 +137,13 @@ public okhttp3.Call createAlertSourceCall(@javax.annotation.Nonnull NewAlertsSou
}
@SuppressWarnings("rawtypes")
- private okhttp3.Call createAlertSourceValidateBeforeCall(@javax.annotation.Nonnull NewAlertsSource newAlertsSource, final ApiCallback _callback) throws ApiException {
+ private okhttp3.Call createAlertsSourceValidateBeforeCall(@javax.annotation.Nonnull NewAlertsSource newAlertsSource, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'newAlertsSource' is set
if (newAlertsSource == null) {
- throw new ApiException("Missing the required parameter 'newAlertsSource' when calling createAlertSource(Async)");
+ throw new ApiException("Missing the required parameter 'newAlertsSource' when calling createAlertsSource(Async)");
}
- return createAlertSourceCall(newAlertsSource, _callback);
+ return createAlertsSourceCall(newAlertsSource, _callback);
}
@@ -162,8 +162,8 @@ private okhttp3.Call createAlertSourceValidateBeforeCall(@javax.annotation.Nonnu
| 401 | responds with unauthorized for invalid token | - |
*/
- public AlertsSourceResponse createAlertSource(@javax.annotation.Nonnull NewAlertsSource newAlertsSource) throws ApiException {
- ApiResponse localVarResp = createAlertSourceWithHttpInfo(newAlertsSource);
+ public AlertsSourceResponse createAlertsSource(@javax.annotation.Nonnull NewAlertsSource newAlertsSource) throws ApiException {
+ ApiResponse localVarResp = createAlertsSourceWithHttpInfo(newAlertsSource);
return localVarResp.getData();
}
@@ -182,8 +182,8 @@ public AlertsSourceResponse createAlertSource(@javax.annotation.Nonnull NewAlert
| 401 | responds with unauthorized for invalid token | - |
*/
- public ApiResponse createAlertSourceWithHttpInfo(@javax.annotation.Nonnull NewAlertsSource newAlertsSource) throws ApiException {
- okhttp3.Call localVarCall = createAlertSourceValidateBeforeCall(newAlertsSource, null);
+ public ApiResponse createAlertsSourceWithHttpInfo(@javax.annotation.Nonnull NewAlertsSource newAlertsSource) throws ApiException {
+ okhttp3.Call localVarCall = createAlertsSourceValidateBeforeCall(newAlertsSource, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
@@ -204,15 +204,15 @@ public ApiResponse