{"info":{"title":"FireHydrant API","version":"0.0.1"},"swagger":"2.0","produces":["application/json"],"securityDefinitions":{"api_key":{"type":"apiKey","name":"Authorization","in":"header"}},"security":[{"api_key":[]}],"host":"api.firehydrant.io","schemes":["https"],"tags":[{"name":"Call Routes","description":"Operations about Call Routes"},{"name":"Permissions","description":"Operations about Permissions"},{"name":"Roles","description":"Operations about Roles"},{"name":"Audit Events","description":"Operations about Audit Events"},{"name":"Pages","description":"Operations about Pages"},{"name":"Account Settings","description":"Operations related to Account Settings"},{"name":"Alerts","description":"Operations related to Alerts"},{"name":"Audiences","description":"Operations related to Audiences"},{"name":"Changes","description":"Operations related to Changes"},{"name":"Communication","description":"Operations related to Communication"},{"name":"Conversations","description":"Operations related to Conversations"},{"name":"Incidents","description":"Operations related to Incidents"},{"name":"Incident Settings","description":"Operations related to Incident Settings"},{"name":"Integrations","description":"Operations related to Integrations"},{"name":"Metrics/Reporting","description":"Operations related to Metrics & Reporting"},{"name":"Retrospectives","description":"Operations related to Retrospectives"},{"name":"Runbooks","description":"Operations related to Runbooks"},{"name":"SCIM","description":"Operations related to SCIM"},{"name":"Catalog Entries","description":"Operations related to Catalog Entries"},{"name":"Signals","description":"Operations related to Signals"},{"name":"Status Pages","description":"Operations related to Status Pages"},{"name":"Tasks","description":"Operations related to Tasks"},{"name":"Teams","description":"Operations related to Teams"},{"name":"Ticketing","description":"Operations related to Ticketing"},{"name":"Users","description":"Operations related to Users"},{"name":"Webhooks","description":"Operations related to Webhooks"}],"paths":{"/v1/ping":{"get":{"summary":"Check API connectivity","description":"Simple endpoint to verify your API connection is working","produces":["application/json"],"responses":{"200":{"description":"Simple endpoint to verify your API connection is working","schema":{"$ref":"#/definitions/PongEntity"}}},"tags":["Account Settings"],"operationId":"ping"}},"/v1/environments":{"post":{"summary":"Create an environment","description":"Creates an environment for the organization","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"create_environment","in":"body","required":true,"schema":{"$ref":"#/definitions/create_environment"}}],"responses":{"201":{"description":"Creates an environment for the organization","schema":{"$ref":"#/definitions/EnvironmentEntryEntity"}}},"tags":["Catalog Entries"],"operationId":"create_environment"},"get":{"summary":"List environments","description":"List all of the environments that have been added to the organiation","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"query","description":"A query to search environments by their name or description","type":"string","required":false,"x-nullable":true},{"in":"query","name":"name","description":"A query to search environments by their name","type":"string","required":false,"x-nullable":true}],"responses":{"200":{"description":"List all of the environments that have been added to the organiation","schema":{"$ref":"#/definitions/EnvironmentEntryEntityPaginated"}}},"tags":["Catalog Entries"],"operationId":"list_environments"}},"/v1/environments/{environment_id}":{"delete":{"summary":"Archive an environment","description":"Archive an environment","produces":["application/json"],"parameters":[{"in":"path","name":"environment_id","description":"Environment UUID or slug","type":"string","required":true}],"responses":{"204":{"description":"Archive an environment"}},"tags":["Catalog Entries"],"operationId":"delete_environment"},"patch":{"summary":"Update an environment","description":"Update a environments attributes","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"environment_id","description":"Environment UUID or slug","type":"string","required":true},{"name":"update_environment","in":"body","required":true,"schema":{"$ref":"#/definitions/update_environment"}}],"responses":{"200":{"description":"Update a environments attributes","schema":{"$ref":"#/definitions/EnvironmentEntryEntity"}}},"tags":["Catalog Entries"],"operationId":"update_environment"},"get":{"summary":"Get an environment","description":"Retrieves a single environment by ID","produces":["application/json"],"parameters":[{"in":"path","name":"environment_id","description":"Environment UUID or slug","type":"string","required":true}],"responses":{"200":{"description":"Retrieves a single environment by ID","schema":{"$ref":"#/definitions/EnvironmentEntryEntity"}}},"tags":["Catalog Entries"],"operationId":"get_environment"}},"/v1/environments/{environment_id}/services":{"get":{"summary":"List services for an environment","description":"List services for an environment","produces":["application/json"],"parameters":[{"in":"path","name":"environment_id","type":"string","required":true},{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"List services for an environment","schema":{"$ref":"#/definitions/ServiceEntityLitePaginated"}}},"tags":["Catalog Entries"],"operationId":"list_environment_services"}},"/v1/environments/{environment_id}/functionalities":{"get":{"summary":"List functionalities for an environment","description":"List functionalities for an environment","produces":["application/json"],"parameters":[{"in":"path","name":"environment_id","type":"string","required":true},{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"List functionalities for an environment","schema":{"$ref":"#/definitions/FunctionalityEntityLitePaginated"}}},"tags":["Catalog Entries"],"operationId":"list_environment_functionalities"}},"/v1/services":{"post":{"summary":"Create a service","description":"Creates a service for the organization, you may also create or attach functionalities to the service on create.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"create_service","in":"body","required":true,"schema":{"$ref":"#/definitions/create_service"}}],"responses":{"201":{"description":"Creates a service for the organization, you may also create or attach functionalities to the service on create.","schema":{"$ref":"#/definitions/ServiceEntity"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ErrorEntity"}}},"tags":["Catalog Entries"],"operationId":"create_service"},"get":{"summary":"List services","description":"List all of the services that have been added to the organization.","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"labels","description":"A comma separated list of label key / values in the format of 'key=value,key2=value2'. To filter change events that have a key (with no specific value), omit the value","type":"string","required":false,"x-nullable":true},{"in":"query","name":"query","description":"A query to search services by their name or description","type":"string","required":false,"x-nullable":true},{"in":"query","name":"name","description":"A query to search services by their name","type":"string","required":false,"x-nullable":true},{"in":"query","name":"tiers","description":"A query to search services by their tier","type":"string","required":false,"x-nullable":true},{"in":"query","name":"impacted","description":"A query to search services by if they are impacted with active incidents","type":"string","required":false,"x-nullable":true},{"in":"query","name":"owner","description":"A query to search services by their owner","type":"string","required":false,"x-nullable":true},{"in":"query","name":"responding_teams","description":"A comma separated list of team ids","type":"string","required":false,"x-nullable":true},{"in":"query","name":"functionalities","description":"A comma separated list of functionality ids","type":"string","required":false,"x-nullable":true},{"in":"query","name":"available_downstream_dependencies_for_id","description":"A query to find services that are available to be downstream dependencies for the passed service ID","type":"string","required":false,"x-nullable":true},{"in":"query","name":"available_upstream_dependencies_for_id","description":"A query to find services that are available to be upstream dependencies for the passed service ID","type":"string","required":false,"x-nullable":true},{"in":"query","name":"lite","description":"Boolean to determine whether to return a slimified version of the services object","type":"boolean","required":false,"x-nullable":true},{"in":"query","name":"include","description":"Use in conjunction with lite param to specify additional attributes to include","type":"array","items":{"type":"string"},"required":false,"x-nullable":true}],"responses":{"200":{"description":"List all of the services that have been added to the organization.","schema":{"$ref":"#/definitions/ServiceEntityPaginated"}}},"tags":["Catalog Entries"],"operationId":"list_services"}},"/v1/services/service_links":{"post":{"summary":"Create multiple services linked to external services","description":"Creates a service with the appropriate integration for each external service ID passed","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"create_service_links","in":"body","required":true,"schema":{"$ref":"#/definitions/create_service_links"}}],"responses":{"201":{"description":"Creates a service with the appropriate integration for each external service ID passed","schema":{"type":"array","items":{"$ref":"#/definitions/ServiceLinkEntity"}}}},"tags":["Catalog Entries"],"operationId":"create_service_links"}},"/v1/services/{service_id}":{"delete":{"summary":"Delete a service","description":"Deletes the service from FireHydrant.","produces":["application/json"],"parameters":[{"in":"path","name":"service_id","type":"string","required":true}],"responses":{"204":{"description":"Deletes the service from FireHydrant."}},"tags":["Catalog Entries"],"operationId":"delete_service"},"patch":{"summary":"Update a service","description":"Update a services attributes, you may also add or remove functionalities from the service as well.\nNote: You may not remove or add individual label key/value pairs. You must include the entire object to override label values.\n","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"service_id","type":"string","required":true},{"name":"update_service","in":"body","required":true,"schema":{"$ref":"#/definitions/update_service"}}],"responses":{"200":{"description":"Update a services attributes, you may also add or remove functionalities from the service as well.\nNote: You may not remove or add individual label key/value pairs. You must include the entire object to override label values.\n","schema":{"$ref":"#/definitions/ServiceEntity"}}},"tags":["Catalog Entries"],"operationId":"update_service"},"get":{"summary":"Get a service","description":"Retrieves a single service by ID","produces":["application/json"],"parameters":[{"in":"path","name":"service_id","description":"Service UUID or slug","type":"string","required":true}],"responses":{"200":{"description":"Retrieves a single service by ID","schema":{"$ref":"#/definitions/ServiceEntity"}}},"tags":["Catalog Entries"],"operationId":"get_service"}},"/v1/services/{service_id}/environments":{"get":{"summary":"List environments for a service","description":"List environments for a service","produces":["application/json"],"parameters":[{"in":"path","name":"service_id","type":"string","required":true},{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"List environments for a service","schema":{"$ref":"#/definitions/EnvironmentEntryEntityPaginated"}}},"tags":["Catalog Entries"],"operationId":"list_service_environments"}},"/v1/services/{service_id}/dependencies":{"get":{"summary":"List dependencies for a service","description":"Retrieves a service's dependencies","produces":["application/json"],"parameters":[{"in":"path","name":"service_id","type":"string","required":true},{"in":"query","name":"flatten","description":"If true, returns all dependencies in one array. If false, splits dependencies into different arrays for child and parent dependencies","type":"boolean","required":false,"x-nullable":true}],"responses":{"200":{"description":"Retrieves a service's dependencies","schema":{"$ref":"#/definitions/ServiceWithAllDependenciesEntity"}}},"tags":["Catalog Entries"],"operationId":"get_service_dependencies"}},"/v1/services/{service_id}/available_upstream_dependencies":{"get":{"summary":"List available upstream service dependencies","description":"Retrieves all services that are available to be upstream dependencies","produces":["application/json"],"parameters":[{"in":"path","name":"service_id","type":"string","required":true}],"responses":{"200":{"description":"Retrieves all services that are available to be upstream dependencies","schema":{"$ref":"#/definitions/ServiceEntityLite"}}},"tags":["Catalog Entries"],"operationId":"list_service_available_upstream_dependencies"}},"/v1/services/{service_id}/available_downstream_dependencies":{"get":{"summary":"List available downstream service dependencies","description":"Retrieves all services that are available to be downstream dependencies","produces":["application/json"],"parameters":[{"in":"path","name":"service_id","type":"string","required":true}],"responses":{"200":{"description":"Retrieves all services that are available to be downstream dependencies","schema":{"$ref":"#/definitions/ServiceEntityLite"}}},"tags":["Catalog Entries"],"operationId":"list_service_available_downstream_dependencies"}},"/v1/services/{service_id}/service_links/{remote_id}":{"delete":{"summary":"Delete a service link","description":"Deletes a service link from FireHydrant.","produces":["application/json"],"parameters":[{"in":"path","name":"service_id","type":"string","required":true},{"in":"path","name":"remote_id","description":"The external service ID which can be found in the JSON\nfrom GET services/:service_id endpoint under\nfunctionalities > external_resources > remote_id\n","type":"string","required":true}],"responses":{"204":{"description":"Deletes a service link from FireHydrant."}},"tags":["Catalog Entries"],"operationId":"delete_service_link"}},"/v1/services/{service_id}/checklist_response/{checklist_id}":{"post":{"summary":"Record a response for a checklist item","description":"Creates a response for a checklist item","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"service_id","type":"string","required":true},{"in":"path","name":"checklist_id","type":"string","required":true},{"name":"create_service_checklist_response","in":"body","required":true,"schema":{"$ref":"#/definitions/create_service_checklist_response"}}],"responses":{"201":{"description":"Creates a response for a checklist item"}},"tags":["Catalog Entries"],"operationId":"create_service_checklist_response"}},"/v1/service_dependencies":{"post":{"summary":"Create a service dependency","description":"Creates a service dependency relationship between two services","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"create_service_dependency","in":"body","required":true,"schema":{"$ref":"#/definitions/create_service_dependency"}}],"responses":{"201":{"description":"Creates a service dependency relationship between two services","schema":{"$ref":"#/definitions/ServiceDependencyEntity"}}},"tags":["Catalog Entries"],"operationId":"create_service_dependency"}},"/v1/service_dependencies/{service_dependency_id}":{"delete":{"summary":"Delete a service dependency","description":"Deletes a single service dependency","produces":["application/json"],"parameters":[{"in":"path","name":"service_dependency_id","type":"string","required":true}],"responses":{"204":{"description":"Deletes a single service dependency"}},"tags":["Catalog Entries"],"operationId":"delete_service_dependency"},"patch":{"summary":"Update a service dependency","description":"Update the notes of the service dependency","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"service_dependency_id","type":"string","required":true},{"name":"update_service_dependency","in":"body","required":true,"schema":{"$ref":"#/definitions/update_service_dependency"}}],"responses":{"200":{"description":"Update the notes of the service dependency","schema":{"$ref":"#/definitions/ServiceDependencyEntity"}}},"tags":["Catalog Entries"],"operationId":"update_service_dependency"},"get":{"summary":"Get a service dependency","description":"Retrieves a single service dependency by ID","produces":["application/json"],"parameters":[{"in":"path","name":"service_dependency_id","type":"string","required":true}],"responses":{"200":{"description":"Retrieves a single service dependency by ID","schema":{"$ref":"#/definitions/ServiceDependencyEntity"}}},"tags":["Catalog Entries"],"operationId":"get_service_dependency"}},"/v1/functionalities":{"post":{"summary":"Create a functionality","description":"Creates a functionality for the organization","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"create_functionality","in":"body","required":true,"schema":{"$ref":"#/definitions/create_functionality"}}],"responses":{"201":{"description":"Creates a functionality for the organization","schema":{"$ref":"#/definitions/FunctionalityEntity"}}},"tags":["Catalog Entries"],"operationId":"create_functionality"},"get":{"summary":"List functionalities","description":"List all of the functionalities that have been added to the organiation","produces":["application/json"],"parameters":[{"in":"query","name":"query","description":"A query to search functionalities by their name or description","type":"string","required":false,"x-nullable":true},{"in":"query","name":"name","description":"A query to search functionalities by their name","type":"string","required":false,"x-nullable":true},{"in":"query","name":"impacted","description":"A query to search services by if they are impacted with active incidents","type":"string","required":false,"x-nullable":true},{"in":"query","name":"labels","description":"A comma separated list of label key / values in the format of 'key=value,key2=value2'. To filter change events that have a key (with no specific value), omit the value","type":"string","required":false,"x-nullable":true},{"in":"query","name":"owner","description":"A query to search functionalities by their owning team ID","type":"string","required":false,"x-nullable":true},{"in":"query","name":"lite","description":"Boolean to determine whether to return a slimified version of the functionalities object","type":"boolean","required":false,"x-nullable":true},{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"List all of the functionalities that have been added to the organiation","schema":{"$ref":"#/definitions/FunctionalityEntityPaginated"}}},"tags":["Catalog Entries"],"operationId":"list_functionalities"}},"/v1/functionalities/{functionality_id}":{"delete":{"summary":"Archive a functionality","description":"Archive a functionality","produces":["application/json"],"parameters":[{"in":"path","name":"functionality_id","type":"string","required":true}],"responses":{"204":{"description":"Archive a functionality"}},"tags":["Catalog Entries"],"operationId":"delete_functionality"},"patch":{"summary":"Update a functionality","description":"Update a functionalities attributes","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"functionality_id","type":"string","required":true},{"name":"update_functionality","in":"body","required":true,"schema":{"$ref":"#/definitions/update_functionality"}}],"responses":{"200":{"description":"Update a functionalities attributes","schema":{"$ref":"#/definitions/FunctionalityEntity"}}},"tags":["Catalog Entries"],"operationId":"update_functionality"},"get":{"summary":"Get a functionality","description":"Retrieves a single functionality by ID","produces":["application/json"],"parameters":[{"in":"path","name":"functionality_id","description":"Functionality UUID or slug","type":"string","required":true}],"responses":{"200":{"description":"Retrieves a single functionality by ID","schema":{"$ref":"#/definitions/FunctionalityEntity"}}},"tags":["Catalog Entries"],"operationId":"get_functionality"}},"/v1/functionalities/{functionality_id}/environments":{"get":{"summary":"List environments for a functionality","description":"List environments for a functionality","produces":["application/json"],"parameters":[{"in":"path","name":"functionality_id","type":"string","required":true},{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"List environments for a functionality","schema":{"$ref":"#/definitions/EnvironmentEntryEntityPaginated"}}},"tags":["Catalog Entries"],"operationId":"list_functionality_environments"}},"/v1/functionalities/{functionality_id}/services":{"get":{"summary":"List services for a functionality","description":"List services for a functionality","produces":["application/json"],"parameters":[{"in":"path","name":"functionality_id","type":"string","required":true}],"responses":{"200":{"description":"List services for a functionality","schema":{"$ref":"#/definitions/FunctionalityWithAllServicesEntity"}}},"tags":["Catalog Entries"],"operationId":"list_functionality_services"}},"/v1/teams":{"post":{"summary":"Create a team","description":"Create a new team","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"create_team","in":"body","required":true,"schema":{"$ref":"#/definitions/create_team"}}],"responses":{"201":{"description":"Create a new team","schema":{"$ref":"#/definitions/TeamEntity"}}},"tags":["Teams"],"operationId":"create_team"},"get":{"summary":"List teams","description":"List all of the teams in the organization","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"query","description":"A query to search teams by their name or description","type":"string","required":false,"x-nullable":true},{"in":"query","name":"name","description":"A query to search teams by their name","type":"string","required":false,"x-nullable":true},{"in":"query","name":"services","description":"A comma separated list of service IDs","type":"string","required":false,"x-nullable":true},{"in":"query","name":"default_incident_role","description":"Filter by teams that have or do not have members with a default incident role asssigned. Value may be 'present', 'blank', or the ID of an incident role.","type":"string","required":false,"x-nullable":true},{"in":"query","name":"lite","description":"Boolean to determine whether to return a slimified version of the teams object","type":"boolean","required":false,"x-nullable":true}],"responses":{"200":{"description":"List all of the teams in the organization","schema":{"$ref":"#/definitions/TeamEntityPaginated"}}},"tags":["Teams"],"operationId":"list_teams"}},"/v1/teams/{team_id}":{"delete":{"summary":"Archive a team","description":"Archives an team which will hide it from lists and metrics","produces":["application/json"],"parameters":[{"in":"path","name":"team_id","type":"string","required":true}],"responses":{"204":{"description":"Archives an team which will hide it from lists and metrics"}},"tags":["Teams"],"operationId":"delete_team"},"patch":{"summary":"Update a team","description":"Update a single team from its ID","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"team_id","type":"string","required":true},{"name":"update_team","in":"body","required":true,"schema":{"$ref":"#/definitions/update_team"}}],"responses":{"200":{"description":"Update a single team from its ID","schema":{"$ref":"#/definitions/TeamEntity"}}},"tags":["Teams"],"operationId":"update_team"},"get":{"summary":"Get a team","description":"Retrieve a single team from its ID","produces":["application/json"],"parameters":[{"in":"path","name":"team_id","description":"Team UUID or slug","type":"string","required":true},{"in":"query","name":"lite","description":"Boolean to determine whether to return a slimified version of the teams object","type":"boolean","required":false,"x-nullable":true}],"responses":{"200":{"description":"Retrieve a single team from its ID","schema":{"$ref":"#/definitions/TeamEntity"}}},"tags":["Teams"],"operationId":"get_team"}},"/v1/teams/{team_id}/support_hours_schedule":{"delete":{"summary":"Delete a specific support hours schedule","description":"Delete a specific support hours schedule","produces":["application/json"],"parameters":[{"in":"path","name":"team_id","type":"string","required":true}],"responses":{"204":{"description":"Delete a specific support hours schedule"}},"tags":["Signals"],"operationId":"delete_support_hours_schedule"},"patch":{"summary":"Update support hours schedule","description":"Update the team's support hours schedule","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"team_id","type":"string","required":true},{"name":"update_support_hours_schedule","in":"body","required":true,"schema":{"$ref":"#/definitions/update_support_hours_schedule"}}],"responses":{"200":{"description":"Update the team's support hours schedule","schema":{"$ref":"#/definitions/SupportHoursScheduleEntity"}}},"tags":["Signals"],"operationId":"update_support_hours_schedule"},"get":{"summary":"Get support hours schedule","description":"Get support hours schedule for the team","produces":["application/json"],"parameters":[{"in":"path","name":"team_id","type":"string","required":true}],"responses":{"200":{"description":"Get support hours schedule for the team","schema":{"$ref":"#/definitions/SupportHoursScheduleEntity"}}},"tags":["Signals"],"operationId":"get_support_hours_schedule"}},"/v1/teams/{team_id}/call_routes":{"post":{"summary":"Create a call route for a team","description":"Create a call route for a team","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"team_id","type":"string","required":true},{"name":"create_team_call_route","in":"body","required":true,"schema":{"$ref":"#/definitions/create_team_call_route"}}],"responses":{"201":{"description":"Create a call route for a team","schema":{"$ref":"#/definitions/Signals_API_CallRouteEntity"}}},"tags":["Call Routes"],"operationId":"create_team_call_route"},"get":{"summary":"List call routes for a team","description":"List call routes for a team","produces":["application/json"],"parameters":[{"in":"path","name":"team_id","type":"string","required":true}],"responses":{"200":{"description":"List call routes for a team","schema":{"$ref":"#/definitions/Signals_API_CallRouteEntityPaginated"}}},"tags":["Call Routes"],"operationId":"list_team_call_routes"}},"/v1/teams/{team_id}/escalation_policies":{"post":{"summary":"Create an escalation policy for a team","description":"Create a Signals escalation policy for a team.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"team_id","type":"string","required":true},{"name":"create_team_escalation_policy","in":"body","required":true,"schema":{"$ref":"#/definitions/create_team_escalation_policy"}}],"responses":{"201":{"description":"Create a Signals escalation policy for a team.","schema":{"$ref":"#/definitions/Signals_API_EscalationPolicyEntity"}}},"tags":["Signals"],"operationId":"create_team_escalation_policy"},"get":{"summary":"List escalation policies for a team","description":"List all Signals escalation policies for a team.","produces":["application/json"],"parameters":[{"in":"path","name":"team_id","type":"string","required":true},{"in":"query","name":"query","description":"A query string for searching through the list of escalation policies.","type":"string","required":false,"x-nullable":true},{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"List all Signals escalation policies for a team.","schema":{"$ref":"#/definitions/Signals_API_EscalationPolicyEntityPaginated"}}},"tags":["Signals"],"operationId":"list_team_escalation_policies"}},"/v1/teams/{team_id}/escalation_policies/{id}":{"delete":{"summary":"Delete an escalation policy for a team","description":"Delete a Signals escalation policy by ID","produces":["application/json"],"parameters":[{"in":"path","name":"team_id","type":"string","required":true},{"in":"path","name":"id","type":"string","required":true}],"responses":{"204":{"description":"Delete a Signals escalation policy by ID"}},"tags":["Signals"],"operationId":"delete_team_escalation_policy"},"patch":{"summary":"Update an escalation policy for a team","description":"Update a Signals escalation policy by ID","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"team_id","type":"string","required":true},{"in":"path","name":"id","type":"string","required":true},{"name":"update_team_escalation_policy","in":"body","required":true,"schema":{"$ref":"#/definitions/update_team_escalation_policy"}}],"responses":{"200":{"description":"Update a Signals escalation policy by ID","schema":{"$ref":"#/definitions/Signals_API_EscalationPolicyEntity"}}},"tags":["Signals"],"operationId":"update_team_escalation_policy"},"get":{"summary":"Get an escalation policy for a team","description":"Get a Signals escalation policy by ID","produces":["application/json"],"parameters":[{"in":"path","name":"team_id","type":"string","required":true},{"in":"path","name":"id","type":"string","required":true}],"responses":{"200":{"description":"Get a Signals escalation policy by ID","schema":{"$ref":"#/definitions/Signals_API_EscalationPolicyEntity"}}},"tags":["Signals"],"operationId":"get_team_escalation_policy"}},"/v1/teams/{team_id}/on_call_schedules/preview":{"post":{"summary":"Preview a new on-call schedule for a team","description":"Preview a new on-call schedule based on the provided rotations, allowing you to see how the schedule will look before saving it.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"team_id","type":"string","required":true},{"name":"preview_team_on_call_schedule","in":"body","required":true,"schema":{"$ref":"#/definitions/preview_team_on_call_schedule"}}],"responses":{"201":{"description":"Preview a new on-call schedule based on the provided rotations, allowing you to see how the schedule will look before saving it.","schema":{"$ref":"#/definitions/Signals_API_OnCallSchedulePreviewEntity"}}},"tags":["Signals"],"operationId":"preview_team_on_call_schedule"}},"/v1/teams/{team_id}/on_call_schedules":{"post":{"summary":"Create an on-call schedule for a team","description":"Create a Signals on-call schedule for a team with a single rotation. More rotations can be created later.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"team_id","type":"string","required":true},{"name":"create_team_on_call_schedule","in":"body","required":true,"schema":{"$ref":"#/definitions/create_team_on_call_schedule"}}],"responses":{"201":{"description":"Create a Signals on-call schedule for a team with a single rotation. More rotations can be created later.","schema":{"$ref":"#/definitions/Signals_API_OnCallScheduleEntity"}}},"tags":["Signals"],"operationId":"create_team_on_call_schedule"},"get":{"summary":"List on-call schedules for a team","description":"List all Signals on-call schedules for a team.","produces":["application/json"],"parameters":[{"in":"path","name":"team_id","type":"string","required":true},{"in":"query","name":"shift_time_window_start","description":"An optional ISO8601 timestamp for filtering the shifts listed in each on-call schedule to only include shifts that overlap with the provided time window. If provided, only shifts that end at or after this time will be included.","type":"string","required":false,"x-nullable":true},{"in":"query","name":"shift_time_window_end","description":"An optional ISO8601 timestamp for filtering the shifts listed in each on-call schedule to only include shifts that overlap with the provided time window.. If provided, only shifts that start at or before this time will be included.","type":"string","required":false,"x-nullable":true},{"in":"query","name":"query","description":"A query string for searching through the list of on-call schedules.","type":"string","required":false,"x-nullable":true},{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"List all Signals on-call schedules for a team.","schema":{"$ref":"#/definitions/Signals_API_OnCallScheduleEntityPaginated"}}},"tags":["Signals"],"operationId":"list_team_on_call_schedules"}},"/v1/teams/{team_id}/on_call_schedules/{schedule_id}":{"delete":{"summary":"Delete an on-call schedule for a team","description":"Delete a Signals on-call schedule by ID","produces":["application/json"],"parameters":[{"in":"path","name":"team_id","type":"string","required":true},{"in":"path","name":"schedule_id","type":"string","required":true}],"responses":{"204":{"description":"Delete a Signals on-call schedule by ID"}},"tags":["Signals"],"operationId":"delete_team_on_call_schedule"},"patch":{"summary":"Update an on-call schedule for a team","description":"Update a Signals on-call schedule by ID. For backwards compatibility, all parameters except for\n`name` and `description` will be ignored if the schedule has more than one rotation. If the schedule\nhas only one rotation, you can continue to update that rotation using the rotation-specific parameters.\n","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"team_id","type":"string","required":true},{"in":"path","name":"schedule_id","type":"string","required":true},{"name":"update_team_on_call_schedule","in":"body","required":true,"schema":{"$ref":"#/definitions/update_team_on_call_schedule"}}],"responses":{"200":{"description":"Update a Signals on-call schedule by ID. For backwards compatibility, all parameters except for\n`name` and `description` will be ignored if the schedule has more than one rotation. If the schedule\nhas only one rotation, you can continue to update that rotation using the rotation-specific parameters.\n","schema":{"$ref":"#/definitions/Signals_API_OnCallScheduleEntity"}}},"tags":["Signals"],"operationId":"update_team_on_call_schedule"},"get":{"summary":"Get an on-call schedule for a team","description":"Get a Signals on-call schedule by ID","produces":["application/json"],"parameters":[{"in":"path","name":"team_id","type":"string","required":true},{"in":"path","name":"schedule_id","type":"string","required":true},{"in":"query","name":"shift_time_window_start","description":"An optional ISO8601 timestamp for filtering the shifts listed in each on-call schedule to only include shifts that overlap with the provided time window. If provided, only shifts that end at or after this time will be included.","type":"string","required":false,"x-nullable":true},{"in":"query","name":"shift_time_window_end","description":"An optional ISO8601 timestamp for filtering the shifts listed in each on-call schedule to only include shifts that overlap with the provided time window.. If provided, only shifts that start at or before this time will be included.","type":"string","required":false,"x-nullable":true}],"responses":{"200":{"description":"Get a Signals on-call schedule by ID","schema":{"$ref":"#/definitions/Signals_API_OnCallScheduleEntity"}}},"tags":["Signals"],"operationId":"get_team_on_call_schedule"}},"/v1/teams/{team_id}/on_call_schedules/{schedule_id}/rotations/preview":{"post":{"summary":"Preview an on-call rotation","description":"Preview a new on-call rotation orchanges to an existing on-call rotation","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"team_id","type":"string","required":true},{"in":"path","name":"schedule_id","type":"string","required":true},{"name":"preview_on_call_schedule_rotation","in":"body","required":true,"schema":{"$ref":"#/definitions/preview_on_call_schedule_rotation"}}],"responses":{"201":{"description":"Preview a new on-call rotation orchanges to an existing on-call rotation","schema":{"$ref":"#/definitions/Signals_API_OnCallSchedulePreviewEntity_RotationPreviewEntity"}}},"tags":["Signals"],"operationId":"preview_on_call_schedule_rotation"}},"/v1/teams/{team_id}/on_call_schedules/{schedule_id}/rotations":{"post":{"summary":"Create a new on-call rotation","description":"Add a new rotation to an existing on-call schedule","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"team_id","type":"string","required":true},{"in":"path","name":"schedule_id","type":"string","required":true},{"name":"create_on_call_schedule_rotation","in":"body","required":true,"schema":{"$ref":"#/definitions/create_on_call_schedule_rotation"}}],"responses":{"201":{"description":"Add a new rotation to an existing on-call schedule","schema":{"$ref":"#/definitions/Signals_API_OnCallRotationEntity"}}},"tags":["Signals"],"operationId":"create_on_call_schedule_rotation"}},"/v1/teams/{team_id}/on_call_schedules/{schedule_id}/rotations/{rotation_id}/copy":{"post":{"summary":"Copy an on-call schedule's rotation","description":"Copy an on-call rotation into a different schedule, allowing you to merge them together safely.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"rotation_id","type":"string","required":true},{"in":"path","name":"team_id","type":"string","required":true},{"in":"path","name":"schedule_id","type":"string","required":true},{"name":"copy_on_call_schedule_rotation","in":"body","required":true,"schema":{"$ref":"#/definitions/copy_on_call_schedule_rotation"}}],"responses":{"201":{"description":"Copy an on-call rotation into a different schedule, allowing you to merge them together safely.","schema":{"$ref":"#/definitions/Signals_API_OnCallRotationEntity"}}},"tags":["Signals"],"operationId":"copy_on_call_schedule_rotation"}},"/v1/teams/{team_id}/on_call_schedules/{schedule_id}/rotations/{rotation_id}":{"delete":{"summary":"Delete an on-call schedule's rotation","description":"Delete an on-call schedule's rotation by ID","produces":["application/json"],"parameters":[{"in":"path","name":"rotation_id","type":"string","required":true},{"in":"path","name":"team_id","type":"string","required":true},{"in":"path","name":"schedule_id","type":"string","required":true}],"responses":{"204":{"description":"Delete an on-call schedule's rotation by ID"}},"tags":["Signals"],"operationId":"delete_on_call_schedule_rotation"},"patch":{"summary":"Update an on-call schedule's rotation","description":"Update an on-call schedule's rotation by ID","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"rotation_id","type":"string","required":true},{"in":"path","name":"team_id","type":"string","required":true},{"in":"path","name":"schedule_id","type":"string","required":true},{"name":"update_on_call_schedule_rotation","in":"body","required":true,"schema":{"$ref":"#/definitions/update_on_call_schedule_rotation"}}],"responses":{"200":{"description":"Update an on-call schedule's rotation by ID","schema":{"$ref":"#/definitions/Signals_API_OnCallRotationEntity"}}},"tags":["Signals"],"operationId":"update_on_call_schedule_rotation"},"get":{"summary":"Get an on-call rotation","description":"Get an on-call rotation by ID","produces":["application/json"],"parameters":[{"in":"path","name":"rotation_id","type":"string","required":true},{"in":"path","name":"team_id","type":"string","required":true},{"in":"path","name":"schedule_id","type":"string","required":true}],"responses":{"200":{"description":"Get an on-call rotation by ID","schema":{"$ref":"#/definitions/Signals_API_OnCallRotationEntity"}}},"tags":["Signals"],"operationId":"get_on_call_schedule_rotation"}},"/v1/teams/{team_id}/on_call_schedules/{schedule_id}/rotations/{rotation_id}/overrides":{"post":{"summary":"Override one or more shifts in an on-call rotation","description":"Create an override covering a specific  time period in an on-call rotation, re-assigning that\nperiod to a specific user, or leaving it unassigned and claimable by any user, or even creating\na purposeful gap in coverage if desired.\n","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"rotation_id","type":"string","required":true},{"in":"path","name":"team_id","type":"string","required":true},{"in":"path","name":"schedule_id","type":"string","required":true},{"name":"create_on_call_schedule_rotation_override","in":"body","required":true,"schema":{"$ref":"#/definitions/create_on_call_schedule_rotation_override"}}],"responses":{"201":{"description":"Create an override covering a specific  time period in an on-call rotation, re-assigning that\nperiod to a specific user, or leaving it unassigned and claimable by any user, or even creating\na purposeful gap in coverage if desired.\n","schema":{"$ref":"#/definitions/Signals_API_OnCallOverrideEntity"}}},"tags":["Signals"],"operationId":"create_on_call_schedule_rotation_override"}},"/v1/teams/{team_id}/on_call_schedules/{schedule_id}/shifts":{"post":{"summary":"[DEPRECATED] Create a shift for an on-call schedule","description":"NOTE: This endpoint is deprecated and overrides are now the only way to modify a schedule's shifts.\nFor compatibility, this endpoint will simply create an override for the specified time window.\n","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"team_id","type":"string","required":true},{"in":"path","name":"schedule_id","type":"string","required":true},{"name":"create_on_call_shift","in":"body","required":true,"schema":{"$ref":"#/definitions/create_on_call_shift"}}],"responses":{"201":{"description":"NOTE: This endpoint is deprecated and overrides are now the only way to modify a schedule's shifts.\nFor compatibility, this endpoint will simply create an override for the specified time window.\n","schema":{"$ref":"#/definitions/Signals_API_OnCallOverrideEntity"}}},"tags":["Signals"],"operationId":"create_on_call_shift"}},"/v1/teams/{team_id}/on_call_schedules/{schedule_id}/shifts/{id}":{"delete":{"summary":"[DEPRECATED] Delete an on-call shift from a team schedule","description":"NOTE: This endpoint is deprecated and overrides are now the only way to modify a schedule's shifts.\nFor compatibility, this endpoint will simply create a \"gap\" override for the specified time window,\nwhich will still result in no shifts being present for that time window in the final schedule.\n","produces":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true},{"in":"path","name":"team_id","type":"string","required":true},{"in":"path","name":"schedule_id","type":"string","required":true}],"responses":{"204":{"description":"NOTE: This endpoint is deprecated and overrides are now the only way to modify a schedule's shifts.\nFor compatibility, this endpoint will simply create a \"gap\" override for the specified time window,\nwhich will still result in no shifts being present for that time window in the final schedule.\n"}},"tags":["Signals"],"operationId":"delete_on_call_shift"},"patch":{"summary":"[DEPRECATED] Update an on-call shift for a team schedule","description":"NOTE: This endpoint is deprecated and overrides are now the only way to modify a schedule's shifts.\nFor compatibility, this endpoint will simply create an override for the specified time window.\n","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true},{"in":"path","name":"team_id","type":"string","required":true},{"in":"path","name":"schedule_id","type":"string","required":true},{"name":"update_on_call_shift","in":"body","required":true,"schema":{"$ref":"#/definitions/update_on_call_shift"}}],"responses":{"200":{"description":"NOTE: This endpoint is deprecated and overrides are now the only way to modify a schedule's shifts.\nFor compatibility, this endpoint will simply create an override for the specified time window.\n","schema":{"$ref":"#/definitions/Signals_API_OnCallShiftEntity"}}},"tags":["Signals"],"operationId":"update_on_call_shift"},"get":{"summary":"[DEPRECATED] Get an on-call shift for a team schedule","description":"NOTE: This endpoint is deprecated and should not be used due to the fact that overrides may result in\nshifts being split into multiple, separated shifts that still share the same ID. For compatibility, this\nendpoint will still return the specified shift, but it may not reflect later fragments of the same shift\nthat were split off by overrides. You should instead request the rotation itself and inspect the shifts\nthat are returned for the time window you care about.\n","produces":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true},{"in":"path","name":"team_id","type":"string","required":true},{"in":"path","name":"schedule_id","type":"string","required":true}],"responses":{"200":{"description":"NOTE: This endpoint is deprecated and should not be used due to the fact that overrides may result in\nshifts being split into multiple, separated shifts that still share the same ID. For compatibility, this\nendpoint will still return the specified shift, but it may not reflect later fragments of the same shift\nthat were split off by overrides. You should instead request the rotation itself and inspect the shifts\nthat are returned for the time window you care about.\n","schema":{"$ref":"#/definitions/Signals_API_OnCallShiftEntity"}}},"tags":["Signals"],"operationId":"get_on_call_shift"}},"/v1/teams/{team_id}/signal_rules":{"post":{"summary":"Create a Signals rule","description":"Create a Signals rule for a team. We support up to 2000 rules per organization.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"team_id","type":"string","required":true},{"name":"create_team_signal_rule","in":"body","required":true,"schema":{"$ref":"#/definitions/create_team_signal_rule"}}],"responses":{"201":{"description":"Create a Signals rule for a team. We support up to 2000 rules per organization.","schema":{"$ref":"#/definitions/Signals_API_RuleEntity"}}},"tags":["Signals"],"operationId":"create_team_signal_rule"},"get":{"summary":"List Signals rules","description":"List all Signals rules for a team.","produces":["application/json"],"parameters":[{"in":"path","name":"team_id","type":"string","required":true},{"in":"query","name":"query","description":"A query string for searching through the list of alerting rules.","type":"string","required":false,"x-nullable":true},{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"List all Signals rules for a team.","schema":{"$ref":"#/definitions/Signals_API_RuleEntityPaginated"}}},"tags":["Signals"],"operationId":"list_team_signal_rules"}},"/v1/teams/{team_id}/signal_rules/{id}":{"delete":{"summary":"Delete a Signals rule","description":"Delete a Signals rule by ID","produces":["application/json"],"parameters":[{"in":"path","name":"team_id","type":"string","required":true},{"in":"path","name":"id","type":"string","required":true}],"responses":{"204":{"description":"Delete a Signals rule by ID"}},"tags":["Signals"],"operationId":"delete_team_signal_rule"},"patch":{"summary":"Update a Signals rule","description":"Update a Signals rule by ID","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"team_id","type":"string","required":true},{"in":"path","name":"id","type":"string","required":true},{"name":"update_team_signal_rule","in":"body","required":true,"schema":{"$ref":"#/definitions/update_team_signal_rule"}}],"responses":{"200":{"description":"Update a Signals rule by ID","schema":{"$ref":"#/definitions/Signals_API_RuleEntity"}}},"tags":["Signals"],"operationId":"update_team_signal_rule"},"get":{"summary":"Get a Signals rule","description":"Get a Signals rule by ID.","produces":["application/json"],"parameters":[{"in":"path","name":"team_id","type":"string","required":true},{"in":"path","name":"id","type":"string","required":true}],"responses":{"200":{"description":"Get a Signals rule by ID.","schema":{"$ref":"#/definitions/Signals_API_RuleEntity"}}},"tags":["Signals"],"operationId":"get_team_signal_rule"}},"/v1/changes":{"post":{"summary":"Create a new change entry","description":"Create a new change entry","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"create_change","in":"body","required":true,"schema":{"$ref":"#/definitions/create_change"}}],"responses":{"201":{"description":"Create a new change entry","schema":{"$ref":"#/definitions/ChangeEntity"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ErrorEntity"}}},"tags":["Changes"],"operationId":"create_change"},"get":{"summary":"List changes","description":"List changes for the organization","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"query","description":"Filter changes by summary","type":"string","required":false,"x-nullable":true}],"responses":{"200":{"description":"List changes for the organization"}},"tags":["Changes"],"operationId":"list_changes"}},"/v1/changes/{change_id}":{"delete":{"summary":"Archive a change entry","description":"Archive a change entry","produces":["application/json"],"parameters":[{"in":"path","name":"change_id","type":"string","required":true}],"responses":{"204":{"description":"Archive a change entry"}},"tags":["Changes"],"operationId":"delete_change"},"patch":{"summary":"Update a change entry","description":"Update a change entry","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"change_id","type":"string","required":true},{"name":"update_change","in":"body","required":true,"schema":{"$ref":"#/definitions/update_change"}}],"responses":{"200":{"description":"Update a change entry","schema":{"$ref":"#/definitions/ChangeEntity"}}},"tags":["Changes"],"operationId":"update_change"}},"/v1/changes/{change_id}/identities":{"post":{"summary":"Create an identity for a change entry","description":"Create an identity for the change entry","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"change_id","type":"string","required":true},{"name":"create_change_identity","in":"body","required":true,"schema":{"$ref":"#/definitions/create_change_identity"}}],"responses":{"201":{"description":"Create an identity for the change entry","schema":{"$ref":"#/definitions/ChangeIdentityEntity"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ErrorEntity"}}},"tags":["Changes"],"operationId":"create_change_identity"},"get":{"summary":"List identities for a change entry","description":"Retrieve all identities for the change entry","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"path","name":"change_id","type":"string","required":true}],"responses":{"200":{"description":"Retrieve all identities for the change entry","schema":{"$ref":"#/definitions/ChangeIdentityEntityPaginated"}}},"tags":["Changes"],"operationId":"list_change_identities"}},"/v1/changes/{change_id}/identities/{identity_id}":{"delete":{"summary":"Delete an identity from a change entry","description":"Delete an identity from the change entry","produces":["application/json"],"parameters":[{"in":"path","name":"identity_id","type":"string","required":true},{"in":"path","name":"change_id","type":"string","required":true}],"responses":{"204":{"description":"Delete an identity from the change entry"},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ErrorEntity"}}},"tags":["Changes"],"operationId":"delete_change_identity"},"patch":{"summary":"Update an identity for a change entry","description":"Update an identity for the change entry","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"identity_id","type":"string","required":true},{"in":"path","name":"change_id","type":"string","required":true},{"name":"update_change_identity","in":"body","required":true,"schema":{"$ref":"#/definitions/update_change_identity"}}],"responses":{"200":{"description":"Update an identity for the change entry","schema":{"$ref":"#/definitions/ChangeIdentityEntity"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ErrorEntity"}}},"tags":["Changes"],"operationId":"update_change_identity"}},"/v1/changes/events":{"post":{"summary":"Create a change event","description":"Create a change event","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"create_change_event","in":"body","required":true,"schema":{"$ref":"#/definitions/create_change_event"}}],"responses":{"201":{"description":"Create a change event","schema":{"$ref":"#/definitions/ChangeEventEntity"}}},"tags":["Changes"],"operationId":"create_change_event"},"get":{"summary":"List change events","description":"List change events for the organization. Note: Not all information is included on a change event like attachments and related changes. You must fetch a change event separately to retrieve all of the information about it","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"saved_search_id","description":"The id of a previously saved search.","type":"string","required":false,"x-nullable":true},{"in":"query","name":"query","description":"A text query for change events","type":"string","required":false,"x-nullable":true},{"in":"query","name":"labels","description":"A comma separated list of label key / values in the format of \"key=value,key2=value2\". To filter change events that have a key (with no specific value), omit the value","type":"string","required":false,"x-nullable":true},{"in":"query","name":"environments","description":"A comma separated list of environment IDs","type":"string","required":false,"x-nullable":true},{"in":"query","name":"services","description":"A comma separated list of service IDs","type":"string","required":false,"x-nullable":true},{"in":"query","name":"starts_at","description":"The start time to start returning change events from","type":"string","required":false,"x-nullable":true},{"in":"query","name":"ends_at","description":"The end time to return change events up to","type":"string","format":"date-time","required":false,"x-nullable":true}],"responses":{"200":{"description":"List change events for the organization. Note: Not all information is included on a change event like attachments and related changes. You must fetch a change event separately to retrieve all of the information about it","schema":{"$ref":"#/definitions/ChangeEventSlimEntityPaginated"}}},"tags":["Changes"],"operationId":"list_change_events"}},"/v1/changes/events/{change_event_id}":{"delete":{"summary":"Delete a change event","description":"Delete a change event","produces":["application/json"],"parameters":[{"in":"path","name":"change_event_id","type":"string","required":true}],"responses":{"204":{"description":"Delete a change event"}},"tags":["Changes"],"operationId":"delete_change_event"},"patch":{"summary":"Update a change event","description":"Update a change event","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"change_event_id","type":"string","required":true},{"name":"update_change_event","in":"body","required":true,"schema":{"$ref":"#/definitions/update_change_event"}}],"responses":{"200":{"description":"Update a change event","schema":{"$ref":"#/definitions/ChangeEventEntity"}}},"tags":["Changes"],"operationId":"update_change_event"},"get":{"summary":"Get a change event","description":"Retrieve a change event","produces":["application/json"],"parameters":[{"in":"path","name":"change_event_id","type":"string","required":true}],"responses":{"200":{"description":"Retrieve a change event","schema":{"$ref":"#/definitions/ChangeEventEntity"}}},"tags":["Changes"],"operationId":"get_change_event"}},"/v1/change_types":{"get":{"summary":"List change types","description":"List change types for the organization","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"List change types for the organization","schema":{"$ref":"#/definitions/ChangeTypeEntityPaginated"}}},"tags":["Changes"],"operationId":"list_change_types"}},"/v1/entitlements":{"get":{"summary":"List entitlements","description":"List the organization's entitlements","produces":["application/json"],"parameters":[{"in":"query","name":"name","description":"Name of Entitlement","type":"string","required":false,"x-nullable":true},{"in":"query","name":"type","description":"Type of Entitlement","type":"string","enum":["quota","access"],"required":false,"x-nullable":true}],"responses":{"200":{"description":"List the organization's entitlements","schema":{"$ref":"#/definitions/EntitlementEntityPaginated"}}},"tags":["Account Settings"],"operationId":"list_entitlements"}},"/v1/incidents":{"post":{"summary":"Create an incident","description":"Create a new incident","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"create_incident","in":"body","required":true,"schema":{"$ref":"#/definitions/create_incident"}}],"responses":{"201":{"description":"Create a new incident","schema":{"$ref":"#/definitions/IncidentEntity"}}},"tags":["Incidents"],"operationId":"create_incident"},"get":{"summary":"List incidents","description":"List all of the incidents in the organization","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"conditions","description":"A JSON string that defines 'logic' and 'user_data'","type":"string","required":false,"x-nullable":true},{"in":"query","name":"environments","description":"A comma separated list of environment IDs or 'is_empty' to filter for incidents with no impacted environments. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"services","description":"A comma separated list of service IDs or 'is_empty' to filter for incidents with no impacted services. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"functionalities","description":"A comma separated list of functionality IDs or 'is_empty' to filter for incidents with no impacted functionalities. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"excluded_infrastructure_ids","description":"A comma separated list of infrastructure IDs. Returns incidents that do not have the following infrastructure ids associated with them. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"teams","description":"A comma separated list of team IDs. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"assigned_teams","description":"A comma separated list of IDs for assigned teams or 'is_empty' to filter for incidents with no active team assignments. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"status","description":"Incident status","type":"string","required":false,"x-nullable":true},{"in":"query","name":"start_date","description":"Filters for incidents that started on or after this date","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"end_date","description":"Filters for incidents that started on or before this date","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"resolved_at_or_after","description":"Filters for incidents that were resolved at or after this time. Combine this with the `current_milestones` parameter if you wish to omit incidents that were re-opened and are still active.","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"resolved_at_or_before","description":"Filters for incidents that were resolved at or before this time. Combine this with the `current_milestones` parameter if you wish to omit incidents that were re-opened and are still active.","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"closed_at_or_after","description":"Filters for incidents that were closed at or after this time","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"closed_at_or_before","description":"Filters for incidents that were closed at or before this time","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"created_at_or_after","description":"Filters for incidents that were created at or after this time","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"created_at_or_before","description":"Filters for incidents that were created at or before this time","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"query","description":"A text query for an incident that searches on name, summary, and desciption","type":"string","required":false,"x-nullable":true},{"in":"query","name":"name","description":"A query to search incidents by their name","type":"string","required":false,"x-nullable":true},{"in":"query","name":"saved_search_id","description":"The id of a previously saved search.","type":"string","required":false,"x-nullable":true},{"in":"query","name":"priorities","description":"A text value of priority. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"priority_not_set","description":"Flag for including incidents where priority has not been set","type":"boolean","required":false,"x-nullable":true},{"in":"query","name":"severities","description":"A text value of severity. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"severity_not_set","description":"Flag for including incidents where severity has not been set","type":"boolean","required":false,"x-nullable":true},{"in":"query","name":"current_milestones","description":"A comma separated list of current milestones. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"tags","description":"A comma separated list of tags. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"tag_match_strategy","description":"A matching strategy for the tags provided","type":"string","enum":["any","match_all","exclude"],"required":false,"x-nullable":true},{"in":"query","name":"archived","description":"Return archived incidents","type":"boolean","required":false,"x-nullable":true},{"in":"query","name":"updated_after","description":"Filters for incidents that were updated after this date","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"updated_before","description":"Filters for incidents that were updated before this date","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"incident_type_id","description":"A comma separated list of incident type IDs or 'is_empty' to filter for incidents with no incident type. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"custom_fields[field_id]","description":"Custom field ID to filter on","type":"array","required":false,"items":{"type":"string"},"x-nullable":true},{"in":"query","name":"custom_fields[value]","description":"Custom field value (empty means no value set)","type":"array","required":false,"items":{"type":"string"},"x-nullable":true},{"in":"query","name":"retrospective_templates","description":"A comma separated list of retrospective template IDs. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"attached_runbooks","description":"A comma separated list of runbook IDs. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true}],"responses":{"200":{"description":"List all of the incidents in the organization","schema":{"$ref":"#/definitions/IncidentEntityPaginated"}}},"tags":["Incidents"],"operationId":"list_incidents"}},"/v1/incidents/{incident_id}/channel":{"get":{"summary":"Get chat channel information for an incident","description":"Gives chat channel information for the specified incident","produces":["application/json"],"parameters":[{"in":"path","name":"incident_id","type":"string","required":true}],"responses":{"200":{"description":"Gives chat channel information for the specified incident","schema":{"$ref":"#/definitions/Incidents_ChannelEntity"}}},"tags":["Incidents"],"operationId":"get_incident_channel"}},"/v1/incidents/{incident_id}/close":{"put":{"summary":"Close an incident","description":"Closes an incident and optionally close all children","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"incident_id","type":"string","required":true},{"in":"formData","name":"status_pages[id]","type":"array","required":true,"items":{"type":"string"}},{"in":"formData","name":"status_pages[integration_slug]","type":"array","required":true,"items":{"type":"string"}},{"in":"formData","name":"notify_email_subscribers","description":"When posting to a public status page, whether to also email its subscribers. Defaults to true.","type":"boolean","required":false,"x-nullable":true},{"in":"formData","name":"impact[id]","type":"array","required":true,"items":{"type":"string"}},{"in":"formData","name":"impact[condition_id]","type":"array","required":true,"items":{"type":"string"}}],"responses":{"200":{"description":"Closes an incident and optionally close all children","schema":{"$ref":"#/definitions/IncidentEntity"}}},"tags":["Incidents"],"operationId":"close_incident"}},"/v1/incidents/{incident_id}/resolve":{"put":{"summary":"Resolve an incident","description":"Resolves a currently active incident","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"incident_id","type":"string","required":true},{"in":"formData","name":"milestone","description":"The slug of any milestone in the post-incident or closed phase to set on the incident (and its children, if `resolve_children` os set). Must be one of the configured milestones available on this incident.","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"status_pages[id]","type":"array","required":true,"items":{"type":"string"}},{"in":"formData","name":"status_pages[integration_slug]","type":"array","required":true,"items":{"type":"string"}},{"in":"formData","name":"notify_email_subscribers","description":"When posting to a public status page, whether to also email its subscribers. Defaults to true.","type":"boolean","required":false,"x-nullable":true},{"in":"formData","name":"impact[id]","type":"array","required":true,"items":{"type":"string"}},{"in":"formData","name":"impact[condition_id]","type":"array","required":true,"items":{"type":"string"}}],"responses":{"200":{"description":"Resolves a currently active incident","schema":{"$ref":"#/definitions/IncidentEntity"}}},"tags":["Incidents"],"operationId":"resolve_incident"}},"/v1/incidents/{incident_id}":{"delete":{"summary":"Archive an incident","description":"Archives an incident which will hide it from lists and metrics","produces":["application/json"],"parameters":[{"in":"path","name":"incident_id","type":"string","required":true}],"responses":{"204":{"description":"Archives an incident which will hide it from lists and metrics"}},"tags":["Incidents"],"operationId":"delete_incident"},"patch":{"summary":"Update an incident","description":"Updates an incident with provided parameters","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"incident_id","type":"string","required":true},{"name":"update_incident","in":"body","required":true,"schema":{"$ref":"#/definitions/update_incident"}}],"responses":{"200":{"description":"Updates an incident with provided parameters","schema":{"$ref":"#/definitions/IncidentEntity"}}},"tags":["Incidents"],"operationId":"update_incident"},"get":{"summary":"Get an incident","description":"Retrieve a single incident from its ID","produces":["application/json"],"parameters":[{"in":"path","name":"incident_id","type":"string","required":true}],"responses":{"200":{"description":"Retrieve a single incident from its ID","schema":{"$ref":"#/definitions/IncidentEntity"}}},"tags":["Incidents"],"operationId":"get_incident"}},"/v1/incidents/{incident_id}/unarchive":{"post":{"summary":"Unarchive an incident","description":"Unarchive an incident","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"incident_id","type":"string","required":true}],"responses":{"201":{"description":"Unarchive an incident","schema":{"$ref":"#/definitions/IncidentEntity"}}},"tags":["Incidents"],"operationId":"unarchive_incident"}},"/v1/incidents/{incident_id}/alerts":{"post":{"summary":"Attach an alert to an incident","description":"Add an alert to an incident. FireHydrant needs to have ingested the alert from a third party system in order to attach it to the incident.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"incident_id","type":"string","required":true},{"in":"body","name":"alert_ids","description":"Array of alert IDs to be assigned to the incident","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"204":{"description":"Add an alert to an incident. FireHydrant needs to have ingested the alert from a third party system in order to attach it to the incident."}},"tags":["Alerts"],"operationId":"create_incident_alert"},"get":{"summary":"List alerts for an incident","description":"List alerts that have been attached to an incident","produces":["application/json"],"parameters":[{"in":"path","name":"incident_id","type":"string","required":true}],"responses":{"200":{"description":"List alerts that have been attached to an incident","schema":{"$ref":"#/definitions/Incidents_AlertEntityPaginated"}}},"tags":["Alerts"],"operationId":"list_incident_alerts"}},"/v1/incidents/{incident_id}/alerts/{incident_alert_id}/primary":{"patch":{"summary":"Set an alert as primary for an incident","description":"Setting an alert as primary will overwrite milestone times in the FireHydrant incident with times included in the primary alert. Services attached to the primary alert will also be automatically added to the incident.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"incident_alert_id","type":"string","required":true},{"in":"path","name":"incident_id","type":"string","required":true},{"name":"update_incident_alert_primary","in":"body","required":true,"schema":{"$ref":"#/definitions/update_incident_alert_primary"}}],"responses":{"200":{"description":"Setting an alert as primary will overwrite milestone times in the FireHydrant incident with times included in the primary alert. Services attached to the primary alert will also be automatically added to the incident.","schema":{"$ref":"#/definitions/Incidents_AlertEntity"}}},"tags":["Alerts"],"operationId":"update_incident_alert_primary"}},"/v1/incidents/{incident_id}/alerts/{incident_alert_id}":{"delete":{"summary":"Remove an alert from an incident","description":"Remove an alert from an incident","produces":["application/json"],"parameters":[{"in":"path","name":"incident_alert_id","type":"string","required":true},{"in":"path","name":"incident_id","type":"string","required":true}],"responses":{"204":{"description":"Remove an alert from an incident"}},"tags":["Alerts"],"operationId":"delete_incident_alert"}},"/v1/incidents/{incident_id}/milestones/bulk_update":{"put":{"summary":"Update milestone times","description":"Update milestone times in bulk for a given incident. All milestone\ntimes for an incident must occur in chronological order\ncorresponding to the configured order of milestones. If the result\nof this request would cause any milestone(s) to appear out of place,\na 422 response will instead be returned. This includes milestones\nnot explicitly submitted or updated in this request.\n","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"incident_id","type":"string","required":true},{"name":"bulk_update_incident_milestones","in":"body","required":true,"schema":{"$ref":"#/definitions/bulk_update_incident_milestones"}}],"responses":{"200":{"description":"Update milestone times in bulk for a given incident. All milestone\ntimes for an incident must occur in chronological order\ncorresponding to the configured order of milestones. If the result\nof this request would cause any milestone(s) to appear out of place,\na 422 response will instead be returned. This includes milestones\nnot explicitly submitted or updated in this request.\n","schema":{"$ref":"#/definitions/Incidents_MilestoneEntityPaginated"}}},"tags":["Incidents"],"operationId":"bulk_update_incident_milestones"}},"/v1/incidents/{incident_id}/milestones":{"get":{"summary":"List incident milestones","description":"List times and durations for each milestone on an incident","produces":["application/json"],"parameters":[{"in":"path","name":"incident_id","type":"string","required":true}],"responses":{"200":{"description":"List times and durations for each milestone on an incident","schema":{"$ref":"#/definitions/Incidents_MilestoneEntityPaginated"}}},"tags":["Incidents"],"operationId":"list_incident_milestones"}},"/v1/incidents/{incident_id}/related_change_events":{"post":{"summary":"Add a related change to an incident","description":"Add a related change to an incident. Changes added to an incident can be causes, fixes, or suspects. To remove a change from an incident, the type field should be set to dismissed.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"incident_id","type":"string","required":true},{"name":"create_incident_change_event","in":"body","required":true,"schema":{"$ref":"#/definitions/create_incident_change_event"}}],"responses":{"201":{"description":"Add a related change to an incident. Changes added to an incident can be causes, fixes, or suspects. To remove a change from an incident, the type field should be set to dismissed.","schema":{"$ref":"#/definitions/Incidents_RelatedChangeEventEntity"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ErrorEntity"}},"409":{"description":"Already Added","schema":{"$ref":"#/definitions/ErrorEntity"}}},"tags":["Incidents"],"operationId":"create_incident_change_event"},"get":{"summary":"List related changes on an incident","description":"List related changes that have been attached to an incident","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"type","description":"The type of the relation to the incident","type":"string","enum":["caused","fixed","suspect","dismissed"],"required":false,"x-nullable":true},{"in":"path","name":"incident_id","type":"string","required":true}],"responses":{"200":{"description":"List related changes that have been attached to an incident","schema":{"$ref":"#/definitions/Incidents_RelatedChangeEventEntityPaginated"}}},"tags":["Incidents"],"operationId":"list_incident_change_events"}},"/v1/incidents/{incident_id}/related_change_events/{related_change_event_id}":{"patch":{"summary":"Update a change attached to an incident","description":"Update a change attached to an incident","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"related_change_event_id","type":"string","required":true},{"in":"path","name":"incident_id","type":"string","required":true},{"name":"update_incident_change_event","in":"body","required":true,"schema":{"$ref":"#/definitions/update_incident_change_event"}}],"responses":{"200":{"description":"Update a change attached to an incident","schema":{"$ref":"#/definitions/Incidents_RelatedChangeEventEntity"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ErrorEntity"}},"409":{"description":"Already Added","schema":{"$ref":"#/definitions/ErrorEntity"}}},"tags":["Incidents"],"operationId":"update_incident_change_event"}},"/v1/incidents/{incident_id}/status_pages":{"post":{"summary":"Add a status page to an incident","description":"Add a status page to an incident.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"incident_id","type":"string","required":true},{"name":"create_incident_status_page","in":"body","required":true,"schema":{"$ref":"#/definitions/create_incident_status_page"}}],"responses":{"201":{"description":"Add a status page to an incident.","schema":{"$ref":"#/definitions/Incidents_StatusPageEntity"}}},"tags":["Incidents"],"operationId":"create_incident_status_page"},"get":{"summary":"List status pages for an incident","description":"List status pages that are attached to an incident","produces":["application/json"],"parameters":[{"in":"path","name":"incident_id","type":"string","required":true}],"responses":{"200":{"description":"List status pages that are attached to an incident","schema":{"$ref":"#/definitions/Incidents_StatusPageEntityPaginated"}}},"tags":["Incidents"],"operationId":"list_incident_status_pages"}},"/v1/incidents/{incident_id}/status_pages/{status_page_id}":{"delete":{"summary":"Remove a status page from an incident","description":"Remove a status page incident attached to an incident","produces":["application/json"],"parameters":[{"in":"path","name":"status_page_id","type":"string","required":true},{"in":"path","name":"incident_id","type":"string","required":true}],"responses":{"204":{"description":"Remove a status page incident attached to an incident"}},"tags":["Status Pages"],"operationId":"delete_incident_status_page"}},"/v1/incidents/{incident_id}/task_lists":{"post":{"summary":"Add tasks from a task list to an incident","description":"Add all tasks from list to incident","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"incident_id","type":"string","required":true},{"name":"create_incident_task_list","in":"body","required":true,"schema":{"$ref":"#/definitions/create_incident_task_list"}}],"responses":{"201":{"description":"Add all tasks from list to incident","schema":{"$ref":"#/definitions/TaskEntity"}}},"tags":["Tasks"],"operationId":"create_incident_task_list"}},"/v1/incidents/{incident_id}/tasks":{"post":{"summary":"Create an incident task","description":"Create a task","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"incident_id","type":"string","required":true},{"name":"create_incident_task","in":"body","required":true,"schema":{"$ref":"#/definitions/create_incident_task"}}],"responses":{"201":{"description":"Create a task","schema":{"$ref":"#/definitions/TaskEntity"}}},"tags":["Tasks"],"operationId":"create_incident_task"},"get":{"summary":"List tasks for an incident","description":"Retrieve a list of all tasks for a specific incident","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"path","name":"incident_id","type":"string","required":true}],"responses":{"200":{"description":"Retrieve a list of all tasks for a specific incident","schema":{"$ref":"#/definitions/TaskEntityPaginated"}}},"tags":["Tasks"],"operationId":"list_incident_tasks"}},"/v1/incidents/{incident_id}/tasks/{task_id}":{"delete":{"summary":"Delete an incident task","description":"Delete a task","produces":["application/json"],"parameters":[{"in":"path","name":"task_id","type":"string","required":true},{"in":"path","name":"incident_id","type":"string","required":true}],"responses":{"204":{"description":"Delete a task"}},"tags":["Tasks"],"operationId":"delete_incident_task"},"patch":{"summary":"Update an incident task","description":"Update a task's attributes","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"task_id","type":"string","required":true},{"in":"path","name":"incident_id","type":"string","required":true},{"name":"update_incident_task","in":"body","required":true,"schema":{"$ref":"#/definitions/update_incident_task"}}],"responses":{"200":{"description":"Update a task's attributes","schema":{"$ref":"#/definitions/TaskEntity"}}},"tags":["Tasks"],"operationId":"update_incident_task"},"get":{"summary":"Get an incident task","description":"Retrieve a single task for an incident","produces":["application/json"],"parameters":[{"in":"path","name":"task_id","type":"string","required":true},{"in":"path","name":"incident_id","type":"string","required":true}],"responses":{"200":{"description":"Retrieve a single task for an incident"}},"tags":["Tasks"],"operationId":"get_incident_task"}},"/v1/incidents/{incident_id}/tasks/{task_id}/convert":{"post":{"summary":"Convert a task to a follow-up","description":"Convert a task to a follow-up","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"task_id","type":"string","required":true},{"in":"path","name":"incident_id","type":"string","required":true},{"name":"convert_incident_task","in":"body","required":true,"schema":{"$ref":"#/definitions/convert_incident_task"}}],"responses":{"201":{"description":"Convert a task to a follow-up","schema":{"$ref":"#/definitions/TaskEntityPaginated"}}},"tags":["Tasks"],"operationId":"convert_incident_task"}},"/v1/incidents/{incident_id}/links":{"get":{"summary":"List links on an incident","description":"List all the editable, external incident links attached to an incident","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"path","name":"incident_id","type":"string","required":true}],"responses":{"200":{"description":"List all the editable, external incident links attached to an incident","schema":{"$ref":"#/definitions/Attachments_LinkEntityPaginated"}}},"tags":["Incidents"],"operationId":"list_incident_links"},"post":{"summary":"Add a link to an incident","description":"Allows adding adhoc links to an incident as an attachment","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"incident_id","type":"string","required":true},{"name":"create_incident_link","in":"body","required":true,"schema":{"$ref":"#/definitions/create_incident_link"}}],"responses":{"201":{"description":"Allows adding adhoc links to an incident as an attachment","schema":{"$ref":"#/definitions/Attachments_LinkEntity"}}},"tags":["Incidents"],"operationId":"create_incident_link"}},"/v1/incidents/{incident_id}/links/{link_id}":{"delete":{"summary":"Remove a link from an incident","description":"Remove a link from an incident","produces":["application/json"],"parameters":[{"in":"path","name":"link_id","type":"string","required":true},{"in":"path","name":"incident_id","type":"string","required":true}],"responses":{"204":{"description":"Remove a link from an incident"}},"tags":["Incidents"],"operationId":"delete_incident_link"},"put":{"summary":"Update the external incident link","description":"Update the external incident link attributes","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"link_id","type":"string","required":true},{"in":"path","name":"incident_id","type":"string","required":true},{"name":"update_incident_link","in":"body","required":true,"schema":{"$ref":"#/definitions/update_incident_link"}}],"responses":{"200":{"description":"Update the external incident link attributes"}},"tags":["Incidents"],"operationId":"update_incident_link"}},"/v1/incidents/{incident_id}/transcript/attribution":{"put":{"summary":"Update the attribution of a transcript","description":"Update the attribution of a transcript","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"from_speaker","description":"The speaker to attribute the transcript to.","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"from_user_id","description":"The user to attribute the transcript to.","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"to_user_id","description":"The ID of the user to attribute the transcript to.","type":"string","required":true},{"in":"formData","name":"transcript_id","description":"The ID of the specific transcript entry to change attribution for.","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"conference_bridge_id","description":"The ID of the conference bridge to attribute the transcript to.","type":"string","required":false,"x-nullable":true},{"in":"path","name":"incident_id","type":"string","required":true}],"responses":{"200":{"description":"Update the attribution of a transcript"}},"tags":["Incidents"],"operationId":"update_transcript_attribution"}},"/v1/incidents/{incident_id}/transcript":{"get":{"summary":"Lists all of the messages in the incident's transcript","description":"Retrieve the transcript for a specific incident","produces":["application/json"],"parameters":[{"in":"query","name":"after","description":"The ID of the transcript entry to start after.","type":"string","required":false,"x-nullable":true},{"in":"query","name":"before","description":"The ID of the transcript entry to start before.","type":"string","required":false,"x-nullable":true},{"in":"query","name":"sort","description":"The order to sort the transcript entries.","type":"string","default":"asc","enum":["asc","desc"],"required":false,"x-nullable":true},{"in":"path","name":"incident_id","type":"string","required":true}],"responses":{"200":{"description":"Retrieve the transcript for a specific incident","schema":{"$ref":"#/definitions/PublicAPI_V1_Incidents_TranscriptEntity"}}},"tags":["Incidents"],"operationId":"list_transcript_entries"}},"/v1/incidents/{incident_id}/transcript/{transcript_id}":{"delete":{"summary":"Delete a transcript from an incident","description":"Delete a transcript from an incident","produces":["application/json"],"parameters":[{"in":"path","name":"transcript_id","type":"string","required":true},{"in":"path","name":"incident_id","type":"string","required":true}],"responses":{"204":{"description":"Delete a transcript from an incident"}},"tags":["Incidents"],"operationId":"delete_transcript_entry"}},"/v1/incidents/{incident_id}/conference_bridges":{"get":{"summary":"Retrieve all conference bridges for an incident","description":"Retrieve all conference bridges for an incident","produces":["application/json"],"parameters":[{"in":"path","name":"incident_id","type":"string","required":true}],"responses":{"200":{"description":"Retrieve all conference bridges for an incident","schema":{"$ref":"#/definitions/Incidents_ConferenceBridgeEntity"}}},"tags":["Incidents"],"operationId":"list_incident_conference_bridges"}},"/v1/incidents/{incident_id}/conference_bridges/{id}/translations/{language_code}":{"get":{"summary":"Retrieve the translations for a specific conference bridge","description":"Retrieve the translations for a specific conference bridge","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The ID of the conference bridge","type":"string","required":true},{"in":"path","name":"language_code","description":"The language code of the translation","type":"string","required":true},{"in":"path","name":"incident_id","type":"string","required":true}],"responses":{"200":{"description":"Retrieve the translations for a specific conference bridge","schema":{"$ref":"#/definitions/Incidents_ConferenceBridgeEntity"}}},"tags":["Incidents"],"operationId":"get_conference_bridge_translation"}},"/v1/incidents/{incident_id}/similar":{"get":{"summary":"List similar incidents","description":"Retrieve a list of similar incidents","produces":["application/json"],"parameters":[{"in":"query","name":"threshold","type":"number","format":"float","default":0.2,"required":false,"x-nullable":true},{"in":"query","name":"limit","type":"integer","format":"int32","default":5,"required":false,"x-nullable":true},{"in":"path","name":"incident_id","type":"string","required":true}],"responses":{"200":{"description":"Retrieve a list of similar incidents","schema":{"$ref":"#/definitions/SimilarIncidentEntityPaginated"}}},"tags":["Incidents"],"operationId":"list_similar_incidents"}},"/v1/incidents/{incident_id}/attachments":{"get":{"summary":"List attachments for an incident","description":"List attachments for an incident","produces":["application/json"],"parameters":[{"in":"path","name":"incident_id","type":"string","required":true},{"in":"query","name":"attachable_type","type":"string","required":false,"x-nullable":true},{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"List attachments for an incident","schema":{"$ref":"#/definitions/Attachments_TypedAttachmentEntityPaginated"}}},"tags":["Incidents"],"operationId":"list_incident_attachments"},"post":{"summary":"Add an attachment to the incident timeline","description":"Allows adding image attachments to an incident","produces":["application/json"],"consumes":["multipart/form-data"],"parameters":[{"in":"path","name":"incident_id","type":"string","required":true},{"in":"formData","name":"file","type":"file","required":true},{"in":"formData","name":"description","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"occurred_at","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"formData","name":"vote_direction","type":"string","enum":["up","down"],"required":false,"x-nullable":true}],"responses":{"201":{"description":"Allows adding image attachments to an incident","schema":{"$ref":"#/definitions/IncidentAttachmentEntity"}}},"tags":["Incidents"],"operationId":"create_incident_attachment"}},"/v1/incidents/{incident_id}/events":{"get":{"summary":"List events for an incident","description":"List all events for an incident. An event is a timeline entry. This can be filtered with params to retrieve events of a certain type.","produces":["application/json"],"parameters":[{"in":"path","name":"incident_id","type":"string","required":true},{"in":"query","name":"types","description":"A comma separated list of types of events to filter by. Possible values are:\n - `add_task_list`: Task list was added\n - `alert_event`: Someone was paged or took action on a linked alert\n - `alert_linked`: An alert was linked to the incident\n - `bulk_milestone_update`: When a milestone change occurs with no other changes\n - `bulk_update`: When an incident note/update is posted or when impacted components are updated. If other changes occur together with either of these changes (e.g., milestone change), they are all bundled together into a bulk_update\n - `change_type`: Updates to associated change events\n - `chat_message`: Any chat message event in a linked chat app like Slack or MS Teams\n - `children_changed`: When adding or updating child related incidents\n - `external_link`: When an external link is added or updated\n - `general_update`: Currently only describes Runbook stoppage events\n - `generic_chat_message`: When an event or message is manually added to the timeline via the web UI or API\n - `incident_attachment`: When attachments or files are added to the timeline\n - `generic_resource_change`: Any changes to individual fields within the incident, including custom fields\n - `incident_restriction`: When an incident is converted to private\n - `incident_status`: Only used when an incident starts and changes to an `active` state\n - `note`: When a message is posted to a status page directly and not via `/fh update`\n - `role_update`: Any updates to assigned roles\n - `runbook_attachment`: Any updates to a runbook\n - `runbook_step_execution_update`: Any Runbook step events\n - `task_update`: Task update events\n - `team_assignment`: Team assignment events\n - `ticket_update`: Updates to incident and follow-up tickets","type":"string","required":false,"x-nullable":true},{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"List all events for an incident. An event is a timeline entry. This can be filtered with params to retrieve events of a certain type.","schema":{"$ref":"#/definitions/IncidentEventEntityPaginated"}}},"tags":["Incidents"],"operationId":"list_incident_events"}},"/v1/incidents/{incident_id}/events/{event_id}":{"delete":{"summary":"Delete an incident event","description":"Delete an event for an incident","produces":["application/json"],"parameters":[{"in":"path","name":"incident_id","type":"string","required":true},{"in":"path","name":"event_id","type":"string","required":true}],"responses":{"204":{"description":"Delete an event for an incident"}},"tags":["Incidents"],"operationId":"delete_incident_event"},"patch":{"summary":"Update an incident event","description":"Update a single event for an incident","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"incident_id","type":"string","required":true},{"in":"path","name":"event_id","type":"string","required":true}],"responses":{"200":{"description":"Update a single event for an incident","schema":{"$ref":"#/definitions/IncidentEventEntity"}}},"tags":["Incidents"],"operationId":"update_incident_event"},"get":{"summary":"Get an incident event","description":"Retrieve a single event for an incident","produces":["application/json"],"parameters":[{"in":"path","name":"incident_id","type":"string","required":true},{"in":"path","name":"event_id","type":"string","required":true}],"responses":{"200":{"description":"Retrieve a single event for an incident","schema":{"$ref":"#/definitions/IncidentEventEntity"}}},"tags":["Incidents"],"operationId":"get_incident_event"}},"/v1/incidents/{incident_id}/events/{event_id}/votes/status":{"get":{"summary":"Get votes","description":"Get an object's current vote counts","produces":["application/json"],"parameters":[{"in":"path","name":"incident_id","type":"string","required":true},{"in":"path","name":"event_id","type":"string","required":true}],"responses":{"200":{"description":"Get an object's current vote counts","schema":{"$ref":"#/definitions/VotesEntity"}}},"tags":["Conversations"],"operationId":"get_vote_status"}},"/v1/incidents/{incident_id}/events/{event_id}/votes":{"patch":{"summary":"Update votes","description":"Upvote or downvote an object","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"incident_id","type":"string","required":true},{"in":"path","name":"event_id","type":"string","required":true},{"name":"update_vote","in":"body","required":true,"schema":{"$ref":"#/definitions/update_vote"}}],"responses":{"200":{"description":"Upvote or downvote an object","schema":{"$ref":"#/definitions/VotesEntity"}}},"tags":["Conversations"],"operationId":"update_vote"}},"/v1/incidents/{incident_id}/impact":{"patch":{"summary":"Update impacts for an incident","description":"Allows updating an incident's impacted infrastructure, with the option to\nmove the incident into a different milestone and provide a note to update\nthe incident timeline and any attached status pages. If this method is\nrequested with the PUT verb, impacts will be completely replaced with the\ninformation in the request body, even if not provided (effectively clearing\nall impacts). If this method is requested with the PATCH verb, the provided\nimpacts will be added or updated, but no impacts will be removed.\n","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"incident_id","type":"string","required":true},{"name":"update_incident_impact_patch","in":"body","required":true,"schema":{"$ref":"#/definitions/update_incident_impact_patch"}}],"responses":{"200":{"description":"Allows updating an incident's impacted infrastructure, with the option to\nmove the incident into a different milestone and provide a note to update\nthe incident timeline and any attached status pages. If this method is\nrequested with the PUT verb, impacts will be completely replaced with the\ninformation in the request body, even if not provided (effectively clearing\nall impacts). If this method is requested with the PATCH verb, the provided\nimpacts will be added or updated, but no impacts will be removed.\n","schema":{"$ref":"#/definitions/IncidentEntity"}}},"tags":["Incidents"],"operationId":"update_incident_impact_patch"},"put":{"summary":"Update impacts for an incident","description":"Allows updating an incident's impacted infrastructure, with the option to\nmove the incident into a different milestone and provide a note to update\nthe incident timeline and any attached status pages. If this method is\nrequested with the PUT verb, impacts will be completely replaced with the\ninformation in the request body, even if not provided (effectively clearing\nall impacts). If this method is requested with the PATCH verb, the provided\nimpacts will be added or updated, but no impacts will be removed.\n","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"incident_id","type":"string","required":true},{"name":"update_incident_impact_put","in":"body","required":true,"schema":{"$ref":"#/definitions/update_incident_impact_put"}}],"responses":{"200":{"description":"Allows updating an incident's impacted infrastructure, with the option to\nmove the incident into a different milestone and provide a note to update\nthe incident timeline and any attached status pages. If this method is\nrequested with the PUT verb, impacts will be completely replaced with the\ninformation in the request body, even if not provided (effectively clearing\nall impacts). If this method is requested with the PATCH verb, the provided\nimpacts will be added or updated, but no impacts will be removed.\n","schema":{"$ref":"#/definitions/IncidentEntity"}}},"tags":["Incidents"],"operationId":"update_incident_impact_put"}},"/v1/incidents/{incident_id}/impact/{type}":{"post":{"summary":"Add impacted infrastructure to an incident","description":"Add impacted infrastructure to an incident","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"incident_id","type":"string","required":true},{"in":"path","name":"type","type":"string","enum":["environments","functionalities","services","customers"],"required":true},{"name":"create_incident_impact","in":"body","required":true,"schema":{"$ref":"#/definitions/create_incident_impact"}}],"responses":{"201":{"description":"Add impacted infrastructure to an incident","schema":{"$ref":"#/definitions/IncidentImpactEntity"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ErrorEntity"}}},"tags":["Incidents"],"operationId":"create_incident_impact"},"get":{"summary":"List impacted infrastructure for an incident","description":"List impacted infrastructure on an incident by specifying type","produces":["application/json"],"parameters":[{"in":"path","name":"incident_id","type":"string","required":true},{"in":"path","name":"type","type":"string","enum":["environments","functionalities","services","customers"],"required":true}],"responses":{"200":{"description":"List impacted infrastructure on an incident by specifying type","schema":{"$ref":"#/definitions/IncidentImpactEntityPaginated"}}},"tags":["Incidents"],"operationId":"list_incident_impacts"}},"/v1/incidents/{incident_id}/impact/{type}/{id}":{"delete":{"summary":"Remove impacted infrastructure from an incident","description":"Remove impacted infrastructure from an incident","produces":["application/json"],"parameters":[{"in":"path","name":"incident_id","type":"string","required":true},{"in":"path","name":"type","type":"string","enum":["environments","functionalities","services","customers"],"required":true},{"in":"path","name":"id","type":"string","required":true}],"responses":{"204":{"description":"Remove impacted infrastructure from an incident"},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ErrorEntity"}}},"tags":["Incidents"],"operationId":"delete_incident_impact"}},"/v1/incidents/{incident_id}/notes":{"post":{"summary":"Add a note to an incident","description":"Create a new note on for an incident. The visibility field on a note determines where it gets posted.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"incident_id","type":"string","required":true},{"name":"create_incident_note","in":"body","required":true,"schema":{"$ref":"#/definitions/create_incident_note"}}],"responses":{"201":{"description":"Create a new note on for an incident. The visibility field on a note determines where it gets posted.","schema":{"$ref":"#/definitions/Event_NoteEntity"}}},"tags":["Incidents"],"operationId":"create_incident_note"}},"/v1/incidents/{incident_id}/notes/{note_id}":{"patch":{"summary":"Update a note","description":"Updates the body of a note","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"note_id","type":"string","required":true},{"in":"path","name":"incident_id","type":"string","required":true},{"name":"update_incident_note","in":"body","required":true,"schema":{"$ref":"#/definitions/update_incident_note"}}],"responses":{"200":{"description":"Updates the body of a note","schema":{"$ref":"#/definitions/Event_NoteEntity"}}},"tags":["Incidents"],"operationId":"update_incident_note"}},"/v1/incidents/{incident_id}/generic_chat_messages":{"post":{"summary":"Add a chat message to an incident","description":"Create a new generic chat message on an incident timeline. These are independent of any specific chat provider.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"incident_id","type":"string","required":true},{"name":"create_incident_chat_message","in":"body","required":true,"schema":{"$ref":"#/definitions/create_incident_chat_message"}}],"responses":{"201":{"description":"Create a new generic chat message on an incident timeline. These are independent of any specific chat provider.","schema":{"$ref":"#/definitions/Event_GenericChatMessageEntity"}}},"tags":["Incidents"],"operationId":"create_incident_chat_message"}},"/v1/incidents/{incident_id}/generic_chat_messages/{message_id}":{"delete":{"summary":"Delete a chat message from an incident","description":"Delete an existing generic chat message on an incident.","produces":["application/json"],"parameters":[{"in":"path","name":"message_id","type":"string","required":true},{"in":"path","name":"incident_id","type":"string","required":true}],"responses":{"204":{"description":"Delete an existing generic chat message on an incident."}},"tags":["Incidents"],"operationId":"delete_incident_chat_message"},"patch":{"summary":"Update a chat message on an incident","description":"Update an existing generic chat message on an incident.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"message_id","type":"string","required":true},{"in":"path","name":"incident_id","type":"string","required":true},{"name":"update_incident_chat_message","in":"body","required":true,"schema":{"$ref":"#/definitions/update_incident_chat_message"}}],"responses":{"200":{"description":"Update an existing generic chat message on an incident.","schema":{"$ref":"#/definitions/Event_GenericChatMessageEntity"}}},"tags":["Incidents"],"operationId":"update_incident_chat_message"}},"/v1/incidents/{incident_id}/role_assignments":{"get":{"summary":"List incident assignees","description":"Retrieve a list of all of the current role assignments for the incident","produces":["application/json"],"parameters":[{"in":"path","name":"incident_id","type":"string","required":true},{"in":"query","name":"status","description":"Filter on status of the role assignment","type":"string","enum":["active","inactive"],"required":false,"x-nullable":true}],"responses":{"200":{"description":"Retrieve a list of all of the current role assignments for the incident","schema":{"$ref":"#/definitions/Incidents_RoleAssignmentEntityPaginated"}}},"tags":["Incidents"],"operationId":"list_incident_role_assignments"},"post":{"summary":"Assign a user to an incident","description":"Assign a role to a user for this incident","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"incident_id","type":"string","required":true},{"name":"create_incident_role_assignment","in":"body","required":true,"schema":{"$ref":"#/definitions/create_incident_role_assignment"}}],"responses":{"201":{"description":"Assign a role to a user for this incident","schema":{"$ref":"#/definitions/Incidents_RoleAssignmentEntity"}}},"tags":["Incidents"],"operationId":"create_incident_role_assignment"}},"/v1/incidents/{incident_id}/role_assignments/{role_assignment_id}":{"delete":{"summary":"Unassign a user from an incident","description":"Unassign a role from a user","produces":["application/json"],"parameters":[{"in":"path","name":"incident_id","type":"string","required":true},{"in":"path","name":"role_assignment_id","type":"string","required":true}],"responses":{"204":{"description":"Unassign a role from a user"}},"tags":["Incidents"],"operationId":"delete_incident_role_assignment"}},"/v1/incidents/{incident_id}/team_assignments":{"post":{"summary":"Assign a team to an incident","description":"Assign a team for this incident","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"incident_id","type":"string","required":true},{"name":"create_incident_team_assignment","in":"body","required":true,"schema":{"$ref":"#/definitions/create_incident_team_assignment"}}],"responses":{"201":{"description":"Assign a team for this incident"}},"tags":["Incidents"],"operationId":"create_incident_team_assignment"}},"/v1/incidents/{incident_id}/team_assignments/{team_assignment_id}":{"delete":{"summary":"Unassign a team from an incident","description":"Unassign a team from an incident","produces":["application/json"],"parameters":[{"in":"path","name":"incident_id","type":"string","required":true},{"in":"path","name":"team_assignment_id","type":"string","required":true},{"in":"formData","name":"role_assignment_ids","description":"Team role assignments to unassign from the incident","type":"array","items":{"type":"string"},"required":false,"x-nullable":true}],"responses":{"204":{"description":"Unassign a team from an incident"}},"tags":["Incidents"],"operationId":"delete_incident_team_assignment"}},"/v1/incidents/{incident_id}/users/{user_id}":{"get":{"summary":"Get the current user's incident role","description":"Retrieve a user with current roles for an incident","produces":["application/json"],"parameters":[{"in":"path","name":"incident_id","type":"string","required":true},{"in":"path","name":"user_id","type":"string","required":true}],"responses":{"200":{"description":"Retrieve a user with current roles for an incident","schema":{"$ref":"#/definitions/Incidents_RoleAssignmentEntity"}}},"tags":["Incidents"],"operationId":"get_incident_user"}},"/v1/incidents/{incident_id}/relationships":{"get":{"summary":"List incident relationships","description":"List any parent/child relationships for an incident","produces":["application/json"],"parameters":[{"in":"path","name":"incident_id","type":"string","required":true}],"responses":{"200":{"description":"List any parent/child relationships for an incident","schema":{"$ref":"#/definitions/Incidents_RelationshipsEntity"}}},"tags":["Incidents"],"operationId":"get_incident_relationships"}},"/v1/incidents/{incident_id}/retrospectives/share":{"post":{"summary":"Share an incident's retrospective","description":"Share incident retrospectives with users or teams","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"user_ids","description":"An array of user IDs with whom to share the report","type":"array","items":{"type":"string"},"required":false,"x-nullable":true},{"in":"formData","name":"team_ids","description":"An array of team IDs with whom to share the report","type":"array","items":{"type":"string"},"required":false,"x-nullable":true},{"in":"formData","name":"retrospective_ids","description":"An array of retrospective IDs to share","type":"array","items":{"type":"string"},"required":true},{"in":"path","name":"incident_id","type":"string","required":true}],"responses":{"201":{"description":"Share incident retrospectives with users or teams","schema":{"$ref":"#/definitions/Incidents_ShareRetrospectivesResultEntity"}}},"tags":["Retrospectives"],"operationId":"share_incident_retrospectives"}},"/v1/incidents/{incident_id}/retrospectives/export_markdown":{"post":{"summary":"Export an incident's retrospective(s) as markdown","description":"Export incident's retrospective(s) as markdown","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"incident_id","type":"string","required":true}],"responses":{"201":{"description":"Export incident's retrospective(s) as markdown","schema":{"$ref":"#/definitions/Incidents_ExportRetrospectiveMarkdownEntity"}}},"tags":["Retrospectives"],"operationId":"export_incident_retrospectives_markdown"}},"/v1/incidents/{incident_id}/retrospectives/export":{"post":{"summary":"Export an incident's retrospective(s)","description":"Export incident's retrospective(s) using their templates","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"integration_slug","description":"The name of the integration to export the retrospective to.","type":"string","enum":["confluence_cloud","google_docs"],"required":true},{"in":"formData","name":"parent_page_id","description":"The ID of the parent page to export the retrospective to.","type":"string","required":false,"x-nullable":true},{"in":"path","name":"incident_id","type":"string","required":true}],"responses":{"201":{"description":"Export incident's retrospective(s) using their templates","schema":{"$ref":"#/definitions/Incidents_ExportRetrospectivesResultEntity"}}},"tags":["Retrospectives"],"operationId":"export_incident_retrospectives"}},"/v1/incidents/{incident_id}/retrospectives":{"post":{"summary":"Create a new retrospective on the incident using the template","description":"Create a new retrospective for an incident","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"retrospective_template_id","description":"The id of the retrospective template to apply.","type":"string","required":true},{"in":"path","name":"incident_id","type":"string","required":true}],"responses":{"201":{"description":"Create a new retrospective for an incident","schema":{"$ref":"#/definitions/Incidents_RetrospectiveEntity"}}},"tags":["Retrospectives"],"operationId":"create_incident_retrospective"},"get":{"summary":"All attached retrospectives for an incident","description":"Retrieve retrospectives attached to an incident","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"is_hidden","description":"Filter by hidden status.","type":"boolean","required":false,"x-nullable":true},{"in":"path","name":"incident_id","type":"string","required":true}],"responses":{"200":{"description":"Retrieve retrospectives attached to an incident","schema":{"$ref":"#/definitions/Incidents_RetrospectiveEntityPaginated"}}},"tags":["Retrospectives"],"operationId":"list_incident_retrospectives"}},"/v1/incidents/{incident_id}/retrospectives/{retrospective_id}":{"patch":{"summary":"Update a retrospective on the incident","description":"Update a retrospective attached to an incident","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"retrospective_id","type":"string","required":true},{"in":"path","name":"incident_id","type":"string","required":true},{"name":"update_incident_retrospective","in":"body","required":true,"schema":{"$ref":"#/definitions/update_incident_retrospective"}}],"responses":{"200":{"description":"Update a retrospective attached to an incident","schema":{"$ref":"#/definitions/Incidents_RetrospectiveEntity"}}},"tags":["Retrospectives"],"operationId":"update_incident_retrospective"}},"/v1/incidents/{incident_id}/retrospectives/{retrospective_id}/fields":{"patch":{"summary":"Appends a new incident retrospective field to an incident retrospective","description":"Add a new field to an incident retrospective","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"retrospective_id","type":"string","required":true},{"in":"formData","name":"label","type":"string","required":true},{"in":"formData","name":"type","type":"string","enum":["text","single_select","multi_select","numeric","datetime","dynamic_input_group","markdown","markdown_text"],"required":true},{"in":"formData","name":"help_text","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"permissible_values","type":"array","items":{"type":"string"},"required":false,"x-nullable":true},{"in":"formData","name":"is_required","type":"boolean","required":false,"x-nullable":true},{"in":"formData","name":"schema","type":"array","items":{"type":"string"},"required":false,"x-nullable":true},{"in":"formData","name":"required_at_milestone_id","type":"string","required":false,"x-nullable":true},{"in":"path","name":"incident_id","type":"string","required":true}],"responses":{"200":{"description":"Add a new field to an incident retrospective","schema":{"$ref":"#/definitions/Incidents_RetrospectiveFieldEntity"}}},"tags":["Retrospectives"],"operationId":"create_incident_retrospective_field"}},"/v1/incidents/{incident_id}/retrospectives/{retrospective_id}/fields/{field_id}":{"patch":{"summary":"Update the value on a retrospective field","description":"Update retrospective field value","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"retrospective_id","type":"string","required":true},{"in":"path","name":"field_id","type":"string","required":true},{"in":"path","name":"incident_id","type":"string","required":true},{"name":"update_incident_retrospective_field","in":"body","required":true,"schema":{"$ref":"#/definitions/update_incident_retrospective_field"}}],"responses":{"200":{"description":"Update retrospective field value","schema":{"$ref":"#/definitions/Incidents_RetrospectiveFieldEntity"}}},"tags":["Retrospectives"],"operationId":"update_incident_retrospective_field"},"get":{"summary":"Get a retrospective field","description":"Retrieve a field on an incident retrospective","produces":["application/json"],"parameters":[{"in":"path","name":"retrospective_id","type":"string","required":true},{"in":"path","name":"field_id","type":"string","required":true},{"in":"path","name":"incident_id","type":"string","required":true}],"responses":{"200":{"description":"Retrieve a field on an incident retrospective","schema":{"$ref":"#/definitions/Incidents_RetrospectiveFieldEntity"}}},"tags":["Retrospectives"],"operationId":"get_incident_retrospective_field"}},"/v1/incidents/{incident_id}/retrospectives/{retrospective_id}/fields/{field_id}/inputs":{"delete":{"summary":"Removes a dynamic input from a retrospective's dynamic input group field","description":"Delete a dynamic input on a dynamic input group","produces":["application/json"],"parameters":[{"in":"path","name":"retrospective_id","type":"string","required":true},{"in":"path","name":"field_id","type":"string","required":true},{"in":"query","name":"dynamic_input_field_id","description":"The ID of the dynamic input field to delete.","type":"string","required":true},{"in":"path","name":"incident_id","type":"string","required":true}],"responses":{"204":{"description":"Delete a dynamic input on a dynamic input group"}},"tags":["Retrospectives"],"operationId":"delete_incident_retrospective_dynamic_input"},"post":{"summary":"Add a new dynamic input field to a retrospective's dynamic input group field","description":"Add a new dynamic input field to a dynamic input group","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"retrospective_id","type":"string","required":true},{"in":"path","name":"field_id","type":"string","required":true},{"in":"path","name":"incident_id","type":"string","required":true}],"responses":{"201":{"description":"Add a new dynamic input field to a dynamic input group","schema":{"$ref":"#/definitions/Incidents_RetrospectiveFieldEntity"}}},"tags":["Retrospectives"],"operationId":"create_incident_retrospective_dynamic_input"}},"/v1/incident_roles":{"get":{"summary":"List incident roles","description":"List all of the incident roles in the organization","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"List all of the incident roles in the organization","schema":{"$ref":"#/definitions/IncidentRoleEntityPaginated"}}},"tags":["Incident Settings"],"operationId":"list_incident_roles"},"post":{"summary":"Create an incident role","description":"Create a new incident role","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"create_incident_role","in":"body","required":true,"schema":{"$ref":"#/definitions/create_incident_role"}}],"responses":{"201":{"description":"Create a new incident role","schema":{"$ref":"#/definitions/IncidentRoleEntity"}}},"tags":["Incident Settings"],"operationId":"create_incident_role"}},"/v1/incident_roles/{incident_role_id}":{"delete":{"summary":"Archive an incident role","description":"Archives an incident role which will hide it from lists and metrics","produces":["application/json"],"parameters":[{"in":"path","name":"incident_role_id","type":"string","required":true}],"responses":{"204":{"description":"Archives an incident role which will hide it from lists and metrics"}},"tags":["Incident Settings"],"operationId":"delete_incident_role"},"patch":{"summary":"Update an incident role","description":"Update a single incident role from its ID","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"incident_role_id","type":"string","required":true},{"name":"update_incident_role","in":"body","required":true,"schema":{"$ref":"#/definitions/update_incident_role"}}],"responses":{"200":{"description":"Update a single incident role from its ID","schema":{"$ref":"#/definitions/IncidentRoleEntity"}}},"tags":["Incident Settings"],"operationId":"update_incident_role"},"get":{"summary":"Get an incident role","description":"Retrieve a single incident role from its ID","produces":["application/json"],"parameters":[{"in":"path","name":"incident_role_id","type":"string","required":true}],"responses":{"200":{"description":"Retrieve a single incident role from its ID","schema":{"$ref":"#/definitions/IncidentRoleEntity"}}},"tags":["Incident Settings"],"operationId":"get_incident_role"}},"/v1/incident_tags/validate":{"post":{"summary":"Validate incident tags","description":"Validate the format of a list of tags","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"body","name":"tags","description":"A list of tags to validate","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"201":{"description":"Validate the format of a list of tags","schema":{"$ref":"#/definitions/TagEntity"}}},"tags":["Incident Settings"],"operationId":"validate_incident_tags"}},"/v1/incident_tags":{"get":{"summary":"List incident tags","description":"List all of the incident tags in the organization","produces":["application/json"],"parameters":[{"in":"query","name":"prefix","type":"string","required":false,"x-nullable":true}],"responses":{"200":{"description":"List all of the incident tags in the organization","schema":{"$ref":"#/definitions/TagEntityPaginated"}}},"tags":["Incident Settings"],"operationId":"list_incident_tags"}},"/v1/incident_types":{"post":{"summary":"Create an incident type","description":"Create a new incident type","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"create_incident_type","in":"body","required":true,"schema":{"$ref":"#/definitions/create_incident_type"}}],"responses":{"201":{"description":"Create a new incident type","schema":{"$ref":"#/definitions/IncidentTypeEntity"}}},"tags":["Incident Settings"],"operationId":"create_incident_type"},"get":{"summary":"List incident types","description":"List all of the incident types in the organization","produces":["application/json"],"parameters":[{"in":"query","name":"query","description":"A query to search incident types by their name","type":"string","required":false,"x-nullable":true},{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"List all of the incident types in the organization","schema":{"$ref":"#/definitions/IncidentTypeEntityPaginated"}}},"tags":["Incident Settings"],"operationId":"list_incident_types"}},"/v1/incident_types/{id}":{"delete":{"summary":"Archive an incident type","description":"Archives an incident type which will hide it from lists and metrics","produces":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true}],"responses":{"204":{"description":"Archives an incident type which will hide it from lists and metrics"}},"tags":["Incident Settings"],"operationId":"delete_incident_type"},"patch":{"summary":"Update an incident type","description":"Update a single incident type from its ID","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true},{"name":"update_incident_type","in":"body","required":true,"schema":{"$ref":"#/definitions/update_incident_type"}}],"responses":{"200":{"description":"Update a single incident type from its ID","schema":{"$ref":"#/definitions/IncidentTypeEntity"}}},"tags":["Incident Settings"],"operationId":"update_incident_type"},"get":{"summary":"Get an incident type","description":"Retrieve a single incident type from its ID","produces":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true}],"responses":{"200":{"description":"Retrieve a single incident type from its ID","schema":{"$ref":"#/definitions/IncidentTypeEntity"}}},"tags":["Incident Settings"],"operationId":"get_incident_type"}},"/v1/integrations":{"get":{"summary":"List integrations","description":"Lists the available and configured integrations","produces":["application/json"],"responses":{"200":{"description":"Lists the available and configured integrations","schema":{"$ref":"#/definitions/Integrations_IntegrationEntityPaginated"}}},"tags":["Integrations"],"operationId":"list_integrations"}},"/v1/integrations/{integration_id}":{"get":{"summary":"Get an integration","description":"Retrieve a single integration","produces":["application/json"],"parameters":[{"in":"path","name":"integration_id","description":"Integration UUID","type":"string","required":true}],"responses":{"200":{"description":"Retrieve a single integration","schema":{"$ref":"#/definitions/Integrations_IntegrationEntity"}}},"tags":["Integrations"],"operationId":"get_integration"}},"/v1/integrations/field_maps/{field_map_id}":{"patch":{"summary":"Update field mapping","description":"Update field mapping","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"field_map_id","type":"string","required":true}],"responses":{"200":{"description":"Update field mapping","schema":{"$ref":"#/definitions/FieldMapping_FieldMapEntity"}}},"tags":["Integrations"],"operationId":"update_field_map"}},"/v1/integrations/field_maps/{field_map_id}/available_fields":{"get":{"summary":"List available fields for field mapping","description":"Get a description of the fields to which data can be mapped","produces":["application/json"],"parameters":[{"in":"path","name":"field_map_id","type":"string","required":true}],"responses":{"200":{"description":"Get a description of the fields to which data can be mapped","schema":{"$ref":"#/definitions/FieldMapping_MappableFieldEntity"}}},"tags":["Integrations"],"operationId":"list_field_map_available_fields"}},"/v1/integrations/authed_providers/{integration_slug}/{connection_id}":{"get":{"summary":"Lists the available and configured integrations","description":"Lists the available and configured integrations","produces":["application/json"],"parameters":[{"in":"path","name":"integration_slug","description":"Integration slug","type":"string","required":true},{"in":"path","name":"connection_id","description":"Connection ID","type":"string","required":true},{"in":"query","name":"query","description":"Query for users by name","type":"string","required":false,"x-nullable":true}],"responses":{"200":{"description":"Lists the available and configured integrations","schema":{"$ref":"#/definitions/Integrations_AuthedProviderEntityPaginated"}}},"tags":["Integrations"],"operationId":"list_authed_providers"}},"/v1/integrations/authed_providers/{integration_slug}/{connection_id}/{authed_provider_id}":{"patch":{"summary":"Get an authed provider","description":"Retrieve a single authed provider","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"integration_slug","description":"Integration slug","type":"string","required":true},{"in":"path","name":"connection_id","description":"Connection ID","type":"string","required":true},{"in":"path","name":"authed_provider_id","description":"Authed provider ID","type":"string","required":true},{"in":"formData","name":"integration_default","description":"Set as the default integration for the account","type":"boolean","required":false,"x-nullable":true}],"responses":{"200":{"description":"Retrieve a single authed provider","schema":{"$ref":"#/definitions/PublicAPI_V1_Integrations_AuthedProviderEntity"}}},"tags":["Integrations"],"operationId":"update_authed_provider"}},"/v1/integrations/connections":{"get":{"summary":"List integration connections","description":"List available integration connections","produces":["application/json"],"parameters":[{"in":"query","name":"integration_slug","description":"Only return installed integrations with the supplied slugs (types).","type":"string","required":false,"x-nullable":true}],"responses":{"200":{"description":"List available integration connections","schema":{"$ref":"#/definitions/Integrations_ConnectionEntityPaginated"}}},"tags":["Integrations"],"operationId":"list_connections"}},"/v1/integrations/connections/{slug}":{"post":{"summary":"Create a new integration connection","description":"Create a new integration connection","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"slug","type":"string","required":true}],"responses":{"201":{"description":"Create a new integration connection","schema":{"$ref":"#/definitions/Integrations_ConnectionEntity"}}},"tags":["Integrations"],"operationId":"create_connection"}},"/v1/integrations/connections/{slug}/{connection_id}/refresh":{"patch":{"summary":"Refresh an integration connection's incident role schedules","description":"Refresh the integration connection's incident role schedules","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"slug","type":"string","required":true},{"in":"path","name":"connection_id","type":"string","required":true}],"responses":{"200":{"description":"Refresh the integration connection's incident role schedules","schema":{"$ref":"#/definitions/Integrations_ConnectionEntity"}}},"tags":["Integrations"],"operationId":"refresh_connection"}},"/v1/integrations/connections/{slug}/{connection_id}":{"patch":{"summary":"Update an integration connection","description":"Update the integration connection with the provided data","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"slug","type":"string","required":true},{"in":"path","name":"connection_id","type":"string","required":true}],"responses":{"200":{"description":"Update the integration connection with the provided data","schema":{"$ref":"#/definitions/Integrations_ConnectionEntity"}}},"tags":["Integrations"],"operationId":"update_connection"}},"/v1/integrations/statuses":{"get":{"summary":"Get integration connection status","description":"Retrieve overall integration connection status","produces":["application/json"],"responses":{"200":{"description":"Retrieve overall integration connection status","schema":{"$ref":"#/definitions/Integrations_ConnectionStatusEntity"}}},"tags":["Integrations"],"operationId":"list_connection_statuses"}},"/v1/integrations/statuses/{slug}":{"get":{"summary":"Get an integration connection status","description":"Retrieve a single integration connection status","produces":["application/json"],"parameters":[{"in":"path","name":"slug","type":"string","required":true}],"responses":{"200":{"description":"Retrieve a single integration connection status","schema":{"$ref":"#/definitions/Integrations_ConnectionStatusEntity"}}},"tags":["Integrations"],"operationId":"list_connection_statuses_by_slug"}},"/v1/integrations/statuses/{slug}/{by_connection_id}":{"get":{"summary":"Get an integration connection status","description":"Retrieve a single integration connection status","produces":["application/json"],"parameters":[{"in":"path","name":"slug","type":"string","required":true},{"in":"path","name":"by_connection_id","type":"string","required":true}],"responses":{"200":{"description":"Retrieve a single integration connection status","schema":{"$ref":"#/definitions/Integrations_ConnectionStatusEntity"}}},"tags":["Integrations"],"operationId":"list_connection_statuses_by_slug_and_id"}},"/v1/integrations/aws/connections":{"get":{"summary":"List AWS connections","description":"Lists the available and configured AWS integration connections for the authenticated organization.","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"aws_account_id","description":"AWS account ID containing the role to be assumed","type":"string","required":false,"x-nullable":true},{"in":"query","name":"target_arn","description":"ARN of the role to be assumed","type":"string","required":false,"x-nullable":true},{"in":"query","name":"external_id","description":"The external ID supplied when assuming the role","type":"string","required":false,"x-nullable":true}],"responses":{"200":{"description":"Lists the available and configured AWS integration connections for the authenticated organization.","schema":{"$ref":"#/definitions/Integrations_Aws_ConnectionEntityPaginated"}}},"tags":["Integrations"],"operationId":"list_aws_connections"}},"/v1/integrations/aws/connections/{id}":{"patch":{"summary":"Update an AWS connection","description":"Update the AWS connection with the provided data.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true},{"name":"update_aws_connection","in":"body","required":true,"schema":{"$ref":"#/definitions/update_aws_connection"}}],"responses":{"200":{"description":"Update the AWS connection with the provided data.","schema":{"$ref":"#/definitions/Integrations_Aws_ConnectionEntity"}}},"tags":["Integrations"],"operationId":"update_aws_connection"},"get":{"summary":"Get an AWS connection","description":"Retrieves the information about the AWS connection.","produces":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true}],"responses":{"200":{"description":"Retrieves the information about the AWS connection.","schema":{"$ref":"#/definitions/Integrations_Aws_ConnectionEntity"}}},"tags":["Integrations"],"operationId":"get_aws_connection"}},"/v1/integrations/aws/cloudtrail_batches":{"get":{"summary":"List CloudTrail batches","description":"Lists CloudTrail batches for the authenticated organization.","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"connection_id","description":"AWS connection ID","type":"string","required":false,"x-nullable":true}],"responses":{"200":{"description":"Lists CloudTrail batches for the authenticated organization.","schema":{"$ref":"#/definitions/Integrations_Aws_CloudtrailBatchEntityPaginated"}}},"tags":["Integrations"],"operationId":"list_aws_cloudtrail_batches"}},"/v1/integrations/aws/cloudtrail_batches/{id}":{"patch":{"summary":"Update a CloudTrail batch","description":"Update a CloudTrail batch with new information.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true},{"name":"update_aws_cloudtrail_batch","in":"body","required":true,"schema":{"$ref":"#/definitions/update_aws_cloudtrail_batch"}}],"responses":{"200":{"description":"Update a CloudTrail batch with new information.","schema":{"$ref":"#/definitions/Integrations_Aws_CloudtrailBatchEntity"}}},"tags":["Integrations"],"operationId":"update_aws_cloudtrail_batch"},"get":{"summary":"Get a CloudTrail batch","description":"Retrieve a single CloudTrail batch.","produces":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true}],"responses":{"200":{"description":"Retrieve a single CloudTrail batch.","schema":{"$ref":"#/definitions/Integrations_Aws_CloudtrailBatchEntity"}}},"tags":["Integrations"],"operationId":"get_aws_cloudtrail_batch"}},"/v1/integrations/aws/cloudtrail_batches/{id}/events":{"get":{"summary":"List events for an AWS CloudTrail batch","description":"List events for an AWS CloudTrail batch","produces":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true}],"responses":{"200":{"description":"List events for an AWS CloudTrail batch","schema":{"$ref":"#/definitions/ChangeEventEntity"}}},"tags":["Integrations"],"operationId":"list_aws_cloudtrail_batch_events"}},"/v1/integrations/confluence_cloud/connections/{id}/space/search":{"get":{"summary":"List Confluence spaces","description":"Lists available space keys for the Confluence integration connection.","produces":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true},{"in":"query","name":"keyword","description":"Space Key (Deprecated)","type":"string","required":false,"x-nullable":true},{"in":"query","name":"query","description":"Space name query","type":"string","required":false,"x-nullable":true},{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"Lists available space keys for the Confluence integration connection.","schema":{"$ref":"#/definitions/Integrations_ConfluenceCloud_SpaceEntity"}}},"tags":["Integrations"],"operationId":"search_confluence_spaces"}},"/v1/integrations/slack/connections/{connection_id}/workspaces":{"get":{"summary":"List Slack workspaces","description":"Lists all Slack workspaces","produces":["application/json"],"parameters":[{"in":"path","name":"connection_id","description":"Connection UUID","type":"string","required":true}],"responses":{"200":{"description":"Lists all Slack workspaces","schema":{"$ref":"#/definitions/Integrations_Slack_WorkspaceEntity"}}},"tags":["Integrations"],"operationId":"list_slack_workspaces"}},"/v1/integrations/slack/channels":{"get":{"summary":"List Slack channels","description":"List or search for known Slack channels that the FireHydrant bot can access","produces":["application/json"],"parameters":[{"in":"query","name":"slack_channel_id","type":"string","required":false,"x-nullable":true},{"in":"query","name":"query","type":"string","required":false,"x-nullable":true},{"in":"query","name":"name","type":"string","required":false,"x-nullable":true},{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"List or search for known Slack channels that the FireHydrant bot can access"}},"tags":["Integrations"],"operationId":"search_slack_channels"}},"/v1/integrations/slack/channels/{id}/test":{"put":{"summary":"Test a Slack channel","description":"Test the ability of the FireHydrant bot to operate in a Slack channel","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true}],"responses":{"200":{"description":"Test the ability of the FireHydrant bot to operate in a Slack channel"}},"tags":["Integrations"],"operationId":"test_slack_channel"}},"/v1/integrations/slack/usergroups":{"get":{"summary":"List Slack user groups","description":"Lists all Slack user groups","produces":["application/json"],"responses":{"200":{"description":"Lists all Slack user groups","schema":{"$ref":"#/definitions/Integrations_Slack_UsergroupEntity"}}},"tags":["Integrations"],"operationId":"list_slack_usergroups"}},"/v1/integrations/slack/connections/{connection_id}/emoji_actions":{"post":{"summary":"Create a new Slack emoji action","description":"Creates a new Slack emoji action","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"connection_id","description":"Slack Connection UUID","type":"string","required":true},{"in":"formData","name":"emoji_name","description":"The name of the emoji to associate with this action","type":"string","required":true},{"in":"formData","name":"incident_type_id","description":"The ID of the incident type to associate with this emoji action","type":"string","required":false,"x-nullable":true}],"responses":{"201":{"description":"Creates a new Slack emoji action"}},"tags":["Integrations"],"operationId":"create_slack_emoji_action"},"get":{"summary":"List Slack emoji actions","description":"Lists Slack emoji actions","produces":["application/json"],"parameters":[{"in":"path","name":"connection_id","description":"Slack Connection UUID","type":"string","required":true},{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"Lists Slack emoji actions"}},"tags":["Integrations"],"operationId":"list_slack_emoji_actions"}},"/v1/integrations/slack/connections/{connection_id}/emoji_actions/{emoji_action_id}":{"delete":{"summary":"Delete a Slack emoji action","description":"Deletes a Slack emoji action","produces":["application/json"],"parameters":[{"in":"path","name":"connection_id","description":"Slack Connection UUID","type":"string","required":true},{"in":"path","name":"emoji_action_id","type":"string","required":true}],"responses":{"204":{"description":"Deletes a Slack emoji action"}},"tags":["Integrations"],"operationId":"delete_slack_emoji_action"},"patch":{"summary":"Update a Slack emoji action","description":"Updates a Slack emoji action","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"connection_id","description":"Slack Connection UUID","type":"string","required":true},{"in":"path","name":"emoji_action_id","type":"string","required":true},{"in":"formData","name":"emoji_name","description":"The name of the emoji to associate with this action","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"incident_type_id","description":"The ID of the incident type to associate with this emoji action","type":"string","required":false,"x-nullable":true}],"responses":{"200":{"description":"Updates a Slack emoji action"}},"tags":["Integrations"],"operationId":"update_slack_emoji_action"},"get":{"summary":"Get a Slack emoji action","description":"Retrieves a Slack emoji action","produces":["application/json"],"parameters":[{"in":"path","name":"connection_id","description":"Slack Connection UUID","type":"string","required":true},{"in":"path","name":"emoji_action_id","type":"string","required":true}],"responses":{"200":{"description":"Retrieves a Slack emoji action"}},"tags":["Integrations"],"operationId":"get_slack_emoji_action"}},"/v1/integrations/statuspage/connections":{"get":{"summary":"List Statuspage connections","description":"Lists the available and configured Statuspage integrations connections for the authenticated organization.","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"Lists the available and configured Statuspage integrations connections for the authenticated organization.","schema":{"$ref":"#/definitions/Integrations_Statuspage_ConnectionEntityPaginated"}}},"tags":["Integrations"],"operationId":"list_statuspage_connections"}},"/v1/integrations/statuspage/connections/{connection_id}":{"delete":{"summary":"Delete a Statuspage connection","description":"Deletes the given Statuspage integration connection.","produces":["application/json"],"parameters":[{"in":"path","name":"connection_id","description":"Connection UUID","type":"string","required":true}],"responses":{"204":{"description":"Deletes the given Statuspage integration connection."}},"tags":["Integrations"],"operationId":"delete_statuspage_connection"},"patch":{"summary":"Update a Statuspage connection","description":"Update the given Statuspage integration connection.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"connection_id","description":"Connection UUID","type":"string","required":true},{"name":"update_statuspage_connection","in":"body","required":true,"schema":{"$ref":"#/definitions/update_statuspage_connection"}}],"responses":{"200":{"description":"Update the given Statuspage integration connection.","schema":{"$ref":"#/definitions/Integrations_Statuspage_ConnectionEntity"}}},"tags":["Integrations"],"operationId":"update_statuspage_connection"},"get":{"summary":"Get a Statuspage connection","description":"Retrieve the information about the Statuspage connection.","produces":["application/json"],"parameters":[{"in":"path","name":"connection_id","description":"Connection UUID","type":"string","required":true}],"responses":{"200":{"description":"Retrieve the information about the Statuspage connection.","schema":{"$ref":"#/definitions/Integrations_Statuspage_ConnectionEntity"}}},"tags":["Integrations"],"operationId":"get_statuspage_connection"}},"/v1/integrations/statuspage/connections/{connection_id}/pages":{"get":{"summary":"List StatusPage pages for a connection","description":"Lists available page IDs for the Statuspage integration connection.","produces":["application/json"],"parameters":[{"in":"path","name":"connection_id","description":"Connection UUID","type":"string","required":true}],"responses":{"200":{"description":"Lists available page IDs for the Statuspage integration connection.","schema":{"$ref":"#/definitions/Integrations_Statuspage_PageEntity"}}},"tags":["Integrations"],"operationId":"list_statuspage_connection_pages"}},"/v1/integrations/zendesk/{connection_id}/tickets/search":{"get":{"summary":"Search for Zendesk tickets","description":"Search for Zendesk tickets","produces":["application/json"],"parameters":[{"in":"path","name":"connection_id","type":"string","required":true},{"in":"query","name":"query","type":"string","required":true},{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"Search for Zendesk tickets","schema":{"$ref":"#/definitions/Integrations_Zendesk_SearchTickets_PaginatedEntity"}}},"tags":["Integrations"],"operationId":"search_zendesk_tickets"}},"/v1/integrations/zendesk/search":{"get":{"summary":"Search for Zendesk tickets","description":"Search for Zendesk tickets","produces":["application/json"],"parameters":[{"in":"query","name":"ticket_id","description":"Zendesk ticket ID","type":"string","required":true},{"in":"query","name":"include","description":"Use to include attached_incidents","type":"string","required":false,"x-nullable":true}],"responses":{"200":{"description":"Search for Zendesk tickets"}},"tags":["Integrations"],"operationId":"get_zendesk_customer_support_issue"}},"/v1/users":{"get":{"summary":"List users","description":"Retrieve a list of all users in an organization","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"query","description":"Text string of a query to filter users by name or email","type":"string","required":false,"x-nullable":true},{"in":"query","name":"name","description":"Text string of a query to filter users by name","type":"string","required":false,"x-nullable":true}],"responses":{"200":{"description":"Retrieve a list of all users in an organization","schema":{"$ref":"#/definitions/UserEntityPaginated"}}},"tags":["Users"],"operationId":"list_users"}},"/v1/users/{id}":{"get":{"summary":"Get a user","description":"Retrieve a single user by ID","produces":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true}],"responses":{"200":{"description":"Retrieve a single user by ID","schema":{"$ref":"#/definitions/UserEntity"}}},"tags":["Users"],"operationId":"get_user"}},"/v1/users/{id}/services":{"get":{"summary":"List services owned by a user's teams","description":"Retrieves a list of services owned by the teams a user is on","produces":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true},{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"Retrieves a list of services owned by the teams a user is on","schema":{"type":"array","items":{"$ref":"#/definitions/TeamEntityPaginated"}}}},"tags":["Catalog Entries"],"operationId":"list_user_owned_services"}},"/v1/current_user":{"get":{"summary":"Get the currently authenticated user","description":"Retrieve the current user","produces":["application/json"],"responses":{"200":{"description":"Retrieve the current user","schema":{"$ref":"#/definitions/CurrentUserEntity"}}},"tags":["Users"],"operationId":"get_current_user"}},"/v1/permissions":{"get":{"summary":"List permissions","description":"List all permissions in the organization","produces":["application/json"],"responses":{"200":{"description":"List all permissions in the organization","schema":{"$ref":"#/definitions/PermissionEntityList"}}},"tags":["Permissions"],"operationId":"list_permissions"}},"/v1/permissions/current_user":{"get":{"summary":"Get all permissions for the current user","description":"Get all permissions for the current user","produces":["application/json"],"responses":{"200":{"description":"Get all permissions for the current user","schema":{"$ref":"#/definitions/PermissionEntityList"}}},"tags":["Permissions"],"operationId":"list_current_user_permissions"}},"/v1/permissions/team":{"get":{"summary":"Get all permissions for a team","description":"Get all permissions for a team","produces":["application/json"],"responses":{"200":{"description":"Get all permissions for a team","schema":{"$ref":"#/definitions/PermissionEntityList"}}},"tags":["Permissions"],"operationId":"list_team_permissions"}},"/v1/reports/mean_time":{"get":{"summary":"Get mean time metrics for incidents","description":"Returns a report with time bucketed analytics data","produces":["application/json"],"parameters":[{"in":"query","name":"environments","description":"A comma separated list of environment IDs","type":"string","required":false,"x-nullable":true},{"in":"query","name":"teams","description":"A comma separated list of team IDs","type":"string","required":false,"x-nullable":true},{"in":"query","name":"services","description":"A comma separated list of service IDs","type":"string","required":false,"x-nullable":true},{"in":"query","name":"status","description":"Incident status","type":"string","required":false,"x-nullable":true},{"in":"query","name":"start_date","description":"The start date to return incidents from","type":"string","format":"date","required":false,"x-nullable":true},{"in":"query","name":"end_date","description":"The end date to return incidents from","type":"string","format":"date","required":false,"x-nullable":true},{"in":"query","name":"query","description":"A text query for an incident that searches on name, summary, and desciption","type":"string","required":false,"x-nullable":true},{"in":"query","name":"saved_search_id","description":"The id of a previously saved search.","type":"string","required":false,"x-nullable":true},{"in":"query","name":"priorities","description":"A comma separated list of priorities","type":"string","required":false,"x-nullable":true},{"in":"query","name":"priority_not_set","description":"Flag for including incidents where priority has not been set","type":"boolean","required":false,"x-nullable":true},{"in":"query","name":"severities","description":"A comma separated list of severities","type":"string","required":false,"x-nullable":true},{"in":"query","name":"severity_not_set","description":"Flag for including incidents where severity has not been set","type":"boolean","required":false,"x-nullable":true},{"in":"query","name":"current_milestones","description":"A comma separated list of current milestones","type":"string","required":false,"x-nullable":true}],"responses":{"200":{"description":"Returns a report with time bucketed analytics data","schema":{"$ref":"#/definitions/ReportEntity"}}},"tags":["Metrics/Reporting"],"operationId":"get_mean_time_report"}},"/v1/retrospectives":{"get":{"summary":"List retrospective reports","description":"List all retrospective reports","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"incident_id","description":"Filter the reports by an incident ID","type":"string","required":false,"x-nullable":true},{"in":"query","name":"updated_since","description":"Filter for reports updated after the given ISO8601 timestamp","type":"string","format":"date-time","required":false,"x-nullable":true}],"responses":{"200":{"description":"List all retrospective reports","schema":{"$ref":"#/definitions/Incidents_RetrospectiveEntityPaginated"}}},"tags":["Retrospectives"],"operationId":"list_retrospectives"}},"/v1/roles":{"post":{"summary":"Create a role","description":"Create a new role","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"create_role","in":"body","required":true,"schema":{"$ref":"#/definitions/create_role"}}],"responses":{"201":{"description":"Create a new role","schema":{"$ref":"#/definitions/PublicAPI_V1_RoleEntity"}}},"tags":["Roles"],"operationId":"create_role"},"get":{"summary":"Get all roles","description":"Get all roles in the organization","produces":["application/json"],"parameters":[{"in":"query","name":"query","description":"A search query to filter roles by name and slug.","type":"string","required":false,"x-nullable":true},{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"Get all roles in the organization","schema":{"$ref":"#/definitions/RoleEntityPaginated"}}},"tags":["Roles"],"operationId":"list_roles"}},"/v1/roles/{id}":{"delete":{"summary":"Delete a role","description":"Delete a role","produces":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true}],"responses":{"204":{"description":"Delete a role"}},"tags":["Roles"],"operationId":"delete_role"},"patch":{"summary":"Update a role","description":"Update a role","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true},{"name":"update_role","in":"body","required":true,"schema":{"$ref":"#/definitions/update_role"}}],"responses":{"200":{"description":"Update a role","schema":{"$ref":"#/definitions/PublicAPI_V1_RoleEntity"}}},"tags":["Roles"],"operationId":"update_role"},"get":{"summary":"Get a role","description":"Get a role","produces":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true}],"responses":{"200":{"description":"Get a role","schema":{"$ref":"#/definitions/PublicAPI_V1_RoleEntity"}}},"tags":["Roles"],"operationId":"get_role"}},"/v1/metrics/ticket_funnel":{"get":{"summary":"List ticket task and follow up creation and completion metrics","description":"Returns a report with task and follow up creation and completion data","produces":["application/json"],"parameters":[{"in":"query","name":"conditions","description":"A JSON string that defines 'logic' and 'user_data'","type":"string","required":false,"x-nullable":true},{"in":"query","name":"environments","description":"A comma separated list of environment IDs or 'is_empty' to filter for incidents with no impacted environments. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"services","description":"A comma separated list of service IDs or 'is_empty' to filter for incidents with no impacted services. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"functionalities","description":"A comma separated list of functionality IDs or 'is_empty' to filter for incidents with no impacted functionalities. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"excluded_infrastructure_ids","description":"A comma separated list of infrastructure IDs. Returns incidents that do not have the following infrastructure ids associated with them. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"teams","description":"A comma separated list of team IDs. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"assigned_teams","description":"A comma separated list of IDs for assigned teams or 'is_empty' to filter for incidents with no active team assignments. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"status","description":"Incident status","type":"string","required":false,"x-nullable":true},{"in":"query","name":"start_date","description":"Filters for incidents that started on or after this date","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"end_date","description":"Filters for incidents that started on or before this date","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"resolved_at_or_after","description":"Filters for incidents that were resolved at or after this time. Combine this with the `current_milestones` parameter if you wish to omit incidents that were re-opened and are still active.","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"resolved_at_or_before","description":"Filters for incidents that were resolved at or before this time. Combine this with the `current_milestones` parameter if you wish to omit incidents that were re-opened and are still active.","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"closed_at_or_after","description":"Filters for incidents that were closed at or after this time","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"closed_at_or_before","description":"Filters for incidents that were closed at or before this time","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"created_at_or_after","description":"Filters for incidents that were created at or after this time","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"created_at_or_before","description":"Filters for incidents that were created at or before this time","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"query","description":"A text query for an incident that searches on name, summary, and desciption","type":"string","required":false,"x-nullable":true},{"in":"query","name":"name","description":"A query to search incidents by their name","type":"string","required":false,"x-nullable":true},{"in":"query","name":"saved_search_id","description":"The id of a previously saved search.","type":"string","required":false,"x-nullable":true},{"in":"query","name":"priorities","description":"A text value of priority. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"priority_not_set","description":"Flag for including incidents where priority has not been set","type":"boolean","required":false,"x-nullable":true},{"in":"query","name":"severities","description":"A text value of severity. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"severity_not_set","description":"Flag for including incidents where severity has not been set","type":"boolean","required":false,"x-nullable":true},{"in":"query","name":"current_milestones","description":"A comma separated list of current milestones. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"tags","description":"A comma separated list of tags. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"tag_match_strategy","description":"A matching strategy for the tags provided","type":"string","enum":["any","match_all","exclude"],"required":false,"x-nullable":true},{"in":"query","name":"archived","description":"Return archived incidents","type":"boolean","required":false,"x-nullable":true},{"in":"query","name":"updated_after","description":"Filters for incidents that were updated after this date","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"updated_before","description":"Filters for incidents that were updated before this date","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"incident_type_id","description":"A comma separated list of incident type IDs or 'is_empty' to filter for incidents with no incident type. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"custom_fields[field_id]","description":"Custom field ID to filter on","type":"array","required":false,"items":{"type":"string"},"x-nullable":true},{"in":"query","name":"custom_fields[value]","description":"Custom field value (empty means no value set)","type":"array","required":false,"items":{"type":"string"},"x-nullable":true},{"in":"query","name":"retrospective_templates","description":"A comma separated list of retrospective template IDs. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"attached_runbooks","description":"A comma separated list of runbook IDs. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"group_by","type":"array","items":{"type":"string","enum":["started_day","started_week","started_month","all_time"]},"required":false,"x-nullable":true}],"responses":{"200":{"description":"Returns a report with task and follow up creation and completion data","schema":{"$ref":"#/definitions/Metrics_TicketFunnelMetricsEntity"}}},"tags":["Metrics/Reporting"],"operationId":"list_ticket_funnel_metrics"}},"/v1/metrics/retrospectives":{"get":{"summary":"List retrospective metrics","description":"Returns a report with retrospective analytics data","produces":["application/json"],"parameters":[{"in":"query","name":"start_date","description":"The start date to return metrics from","type":"string","format":"date","required":false,"x-nullable":true},{"in":"query","name":"end_date","description":"The end date to return metrics from","type":"string","format":"date","required":false,"x-nullable":true}],"responses":{"200":{"description":"Returns a report with retrospective analytics data","schema":{"$ref":"#/definitions/Metrics_RetrospectiveEntity"}}},"tags":["Metrics/Reporting"],"operationId":"list_retrospective_metrics"}},"/v1/metrics/milestone_funnel":{"get":{"summary":"List milestone funnel metrics","description":"Returns a report with time bucketed milestone data","produces":["application/json"],"parameters":[{"in":"query","name":"conditions","description":"A JSON string that defines 'logic' and 'user_data'","type":"string","required":false,"x-nullable":true},{"in":"query","name":"environments","description":"A comma separated list of environment IDs or 'is_empty' to filter for incidents with no impacted environments. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"services","description":"A comma separated list of service IDs or 'is_empty' to filter for incidents with no impacted services. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"functionalities","description":"A comma separated list of functionality IDs or 'is_empty' to filter for incidents with no impacted functionalities. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"excluded_infrastructure_ids","description":"A comma separated list of infrastructure IDs. Returns incidents that do not have the following infrastructure ids associated with them. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"teams","description":"A comma separated list of team IDs. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"assigned_teams","description":"A comma separated list of IDs for assigned teams or 'is_empty' to filter for incidents with no active team assignments. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"status","description":"Incident status","type":"string","required":false,"x-nullable":true},{"in":"query","name":"start_date","description":"Filters for incidents that started on or after this date","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"end_date","description":"Filters for incidents that started on or before this date","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"resolved_at_or_after","description":"Filters for incidents that were resolved at or after this time. Combine this with the `current_milestones` parameter if you wish to omit incidents that were re-opened and are still active.","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"resolved_at_or_before","description":"Filters for incidents that were resolved at or before this time. Combine this with the `current_milestones` parameter if you wish to omit incidents that were re-opened and are still active.","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"closed_at_or_after","description":"Filters for incidents that were closed at or after this time","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"closed_at_or_before","description":"Filters for incidents that were closed at or before this time","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"created_at_or_after","description":"Filters for incidents that were created at or after this time","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"created_at_or_before","description":"Filters for incidents that were created at or before this time","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"query","description":"A text query for an incident that searches on name, summary, and desciption","type":"string","required":false,"x-nullable":true},{"in":"query","name":"name","description":"A query to search incidents by their name","type":"string","required":false,"x-nullable":true},{"in":"query","name":"saved_search_id","description":"The id of a previously saved search.","type":"string","required":false,"x-nullable":true},{"in":"query","name":"priorities","description":"A text value of priority. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"priority_not_set","description":"Flag for including incidents where priority has not been set","type":"boolean","required":false,"x-nullable":true},{"in":"query","name":"severities","description":"A text value of severity. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"severity_not_set","description":"Flag for including incidents where severity has not been set","type":"boolean","required":false,"x-nullable":true},{"in":"query","name":"current_milestones","description":"A comma separated list of current milestones. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"tags","description":"A comma separated list of tags. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"tag_match_strategy","description":"A matching strategy for the tags provided","type":"string","enum":["any","match_all","exclude"],"required":false,"x-nullable":true},{"in":"query","name":"archived","description":"Return archived incidents","type":"boolean","required":false,"x-nullable":true},{"in":"query","name":"updated_after","description":"Filters for incidents that were updated after this date","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"updated_before","description":"Filters for incidents that were updated before this date","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"incident_type_id","description":"A comma separated list of incident type IDs or 'is_empty' to filter for incidents with no incident type. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"custom_fields[field_id]","description":"Custom field ID to filter on","type":"array","required":false,"items":{"type":"string"},"x-nullable":true},{"in":"query","name":"custom_fields[value]","description":"Custom field value (empty means no value set)","type":"array","required":false,"items":{"type":"string"},"x-nullable":true},{"in":"query","name":"retrospective_templates","description":"A comma separated list of retrospective template IDs. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"attached_runbooks","description":"A comma separated list of runbook IDs. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"group_by","type":"array","items":{"type":"string","enum":["started_day","started_week","started_month","all_time"]},"required":false,"x-nullable":true}],"responses":{"200":{"description":"Returns a report with time bucketed milestone data","schema":{"$ref":"#/definitions/Metrics_MilestonesFunnelEntity"}}},"tags":["Metrics/Reporting"],"operationId":"list_milestone_funnel_metrics"}},"/v1/metrics/user_involvements":{"get":{"summary":"List user metrics","description":"Returns a report with time bucketed analytics data","produces":["application/json"],"parameters":[{"in":"query","name":"start_date","description":"The start date to return metrics from","type":"string","format":"date","required":false,"x-nullable":true},{"in":"query","name":"end_date","description":"The end date to return metrics from","type":"string","format":"date","required":false,"x-nullable":true},{"in":"query","name":"bucket_size","type":"string","required":false,"x-nullable":true},{"in":"query","name":"by","type":"string","required":false,"x-nullable":true},{"in":"query","name":"sort_field","type":"string","enum":["user_count","incident_count","time_spent"],"required":false,"x-nullable":true},{"in":"query","name":"sort_direction","type":"string","enum":["asc","desc"],"required":false,"x-nullable":true},{"in":"query","name":"sort_limit","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"Returns a report with time bucketed analytics data","schema":{"$ref":"#/definitions/Metrics_MetricsEntity"}}},"tags":["Metrics/Reporting"],"operationId":"list_user_involvement_metrics"}},"/v1/metrics/incidents":{"get":{"summary":"List incident metrics and analytics","description":"Returns a report with time bucketed analytics data","produces":["application/json"],"parameters":[{"in":"query","name":"start_date","description":"The start date to return metrics from","type":"string","format":"date","required":false,"x-nullable":true},{"in":"query","name":"end_date","description":"The end date to return metrics from","type":"string","format":"date","required":false,"x-nullable":true},{"in":"query","name":"bucket_size","type":"string","enum":["week","day","month","all_time"],"required":false,"x-nullable":true},{"in":"query","name":"by","type":"string","enum":["total","severity","priority","functionality","service","environment","user","user_involvement"],"required":false,"x-nullable":true},{"in":"query","name":"sort_field","type":"string","enum":["mttd","mtta","mttm","mttr","count","total_time"],"required":false,"x-nullable":true},{"in":"query","name":"sort_direction","type":"string","enum":["asc","desc"],"required":false,"x-nullable":true},{"in":"query","name":"sort_limit","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"conditions","type":"string","required":false,"x-nullable":true}],"responses":{"200":{"description":"Returns a report with time bucketed analytics data","schema":{"$ref":"#/definitions/Metrics_MetricsEntity"}}},"tags":["Metrics/Reporting"],"operationId":"list_incident_metrics"}},"/v1/metrics/mttx":{"get":{"summary":"Get infrastructure metrics","description":"Fetch infrastructure metrics based on custom query","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"conditions","description":"A JSON string that defines 'logic' and 'user_data'","type":"string","required":false,"x-nullable":true},{"in":"query","name":"environments","description":"A comma separated list of environment IDs or 'is_empty' to filter for incidents with no impacted environments. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"services","description":"A comma separated list of service IDs or 'is_empty' to filter for incidents with no impacted services. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"functionalities","description":"A comma separated list of functionality IDs or 'is_empty' to filter for incidents with no impacted functionalities. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"excluded_infrastructure_ids","description":"A comma separated list of infrastructure IDs. Returns incidents that do not have the following infrastructure ids associated with them. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"teams","description":"A comma separated list of team IDs. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"assigned_teams","description":"A comma separated list of IDs for assigned teams or 'is_empty' to filter for incidents with no active team assignments. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"status","description":"Incident status","type":"string","required":false,"x-nullable":true},{"in":"query","name":"start_date","description":"Filters for incidents that started on or after this date","type":"string","format":"date","required":true},{"in":"query","name":"end_date","description":"Filters for incidents that started on or before this date","type":"string","format":"date","required":true},{"in":"query","name":"resolved_at_or_after","description":"Filters for incidents that were resolved at or after this time. Combine this with the `current_milestones` parameter if you wish to omit incidents that were re-opened and are still active.","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"resolved_at_or_before","description":"Filters for incidents that were resolved at or before this time. Combine this with the `current_milestones` parameter if you wish to omit incidents that were re-opened and are still active.","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"closed_at_or_after","description":"Filters for incidents that were closed at or after this time","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"closed_at_or_before","description":"Filters for incidents that were closed at or before this time","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"created_at_or_after","description":"Filters for incidents that were created at or after this time","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"created_at_or_before","description":"Filters for incidents that were created at or before this time","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"query","description":"A text query for an incident that searches on name, summary, and desciption","type":"string","required":false,"x-nullable":true},{"in":"query","name":"name","description":"A query to search incidents by their name","type":"string","required":false,"x-nullable":true},{"in":"query","name":"saved_search_id","description":"The id of a previously saved search.","type":"string","required":false,"x-nullable":true},{"in":"query","name":"priorities","description":"A text value of priority. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"priority_not_set","description":"Flag for including incidents where priority has not been set","type":"boolean","required":false,"x-nullable":true},{"in":"query","name":"severities","description":"A text value of severity. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"severity_not_set","description":"Flag for including incidents where severity has not been set","type":"boolean","required":false,"x-nullable":true},{"in":"query","name":"current_milestones","description":"A comma separated list of current milestones. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"tags","description":"A comma separated list of tags. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"tag_match_strategy","description":"A matching strategy for the tags provided","type":"string","enum":["any","match_all","exclude"],"required":false,"x-nullable":true},{"in":"query","name":"archived","description":"Return archived incidents","type":"boolean","required":false,"x-nullable":true},{"in":"query","name":"updated_after","description":"Filters for incidents that were updated after this date","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"updated_before","description":"Filters for incidents that were updated before this date","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"incident_type_id","description":"A comma separated list of incident type IDs or 'is_empty' to filter for incidents with no incident type. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"custom_fields[field_id]","description":"Custom field ID to filter on","type":"array","required":false,"items":{"type":"string"},"x-nullable":true},{"in":"query","name":"custom_fields[value]","description":"Custom field value (empty means no value set)","type":"array","required":false,"items":{"type":"string"},"x-nullable":true},{"in":"query","name":"retrospective_templates","description":"A comma separated list of retrospective template IDs. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"attached_runbooks","description":"A comma separated list of runbook IDs. Accepts a comma-separated string (e.g. `foo=a,b`) or repeated array syntax (e.g. `foo[]=a&foo[]=b`).","type":"string","required":false,"x-nullable":true},{"in":"query","name":"custom_field_id","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"group_by","type":"array","items":{"type":"string","enum":["services","environments","functionalities","teams","severities","users","incident_types","started_day","started_week","started_month","custom_fields"]},"required":false,"x-nullable":true},{"in":"query","name":"sort_by","type":"string","enum":["count_asc","mttr_asc","mtta_asc","mttd_asc","mttm_asc","healthiness_asc","duration_asc","interactions_asc","count_desc","mttr_desc","mtta_desc","mttd_desc","mttm_desc","healthiness_desc","duration_desc","interactions_desc"],"required":false,"x-nullable":true},{"in":"query","name":"measurements","description":"Comma-separated list of measurements to include in the response","type":"string","required":false,"x-nullable":true},{"in":"query","name":"labels","description":"Comma-separated list of label key / values in the format of 'key=value,key2=value2'","type":"string","required":false,"x-nullable":true},{"in":"query","name":"incident_openers","description":"Comma-separated list of user IDs for the incident openers","type":"string","required":false,"x-nullable":true},{"in":"query","name":"ticket_status","description":"Comma-separated list of ticket status states","type":"string","required":false,"x-nullable":true}],"responses":{"200":{"description":"Fetch infrastructure metrics based on custom query","schema":{"$ref":"#/definitions/Metrics_MttxDataEntity"}}},"tags":["Metrics/Reporting"],"operationId":"list_mttx_metrics"}},"/v1/metrics/{infra_type}":{"get":{"summary":"List metrics for a component type","description":"Returns metrics for all components of a given type","produces":["application/json"],"parameters":[{"in":"path","name":"infra_type","type":"string","enum":["environments","functionalities","services","customers"],"required":true},{"in":"query","name":"start_date","description":"The start date to return metrics from; defaults to 30 days ago","type":"string","format":"date","required":false,"x-nullable":true},{"in":"query","name":"end_date","description":"The end date to return metrics from, defaults to today","type":"string","format":"date","required":false,"x-nullable":true}],"responses":{"200":{"description":"Returns metrics for all components of a given type","schema":{"$ref":"#/definitions/Metrics_InfrastructureListEntity"}}},"tags":["Metrics/Reporting"],"operationId":"list_infrastructure_type_metrics"}},"/v1/metrics/{infra_type}/{infra_id}":{"get":{"summary":"Get metrics for a component","description":"Return metrics for a specific component","produces":["application/json"],"parameters":[{"in":"path","name":"infra_type","type":"string","enum":["environments","functionalities","services","customers"],"required":true},{"in":"path","name":"infra_id","description":"Component UUID","type":"string","required":true},{"in":"query","name":"start_date","description":"The start date to return metrics from; defaults to 30 days ago","type":"string","format":"date","required":false,"x-nullable":true},{"in":"query","name":"end_date","description":"The end date to return metrics from, defaults to today","type":"string","format":"date","required":false,"x-nullable":true}],"responses":{"200":{"description":"Return metrics for a specific component","schema":{"$ref":"#/definitions/Metrics_InfrastructureMetricsEntity"}}},"tags":["Metrics/Reporting"],"operationId":"list_infrastructure_metrics"}},"/v1/runbooks/actions":{"get":{"summary":"List runbook actions","description":"List all runbook actions available through your connected integrations","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"type","description":"List actions supporting this specific Runbook type","type":"string","required":false,"x-nullable":true},{"in":"query","name":"lite","description":"Boolean to determine whether to return a slimified version of the action object's integration","type":"boolean","required":false,"x-nullable":true}],"responses":{"200":{"description":"List all runbook actions available through your connected integrations","schema":{"$ref":"#/definitions/Runbooks_ActionsEntityPaginated"}}},"tags":["Runbooks"],"operationId":"list_runbook_actions"}},"/v1/runbooks/executions":{"post":{"summary":"Create a runbook execution","description":"Attaches a runbook to an incident and executes it","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"create_runbook_execution","in":"body","required":true,"schema":{"$ref":"#/definitions/create_runbook_execution"}}],"responses":{"201":{"description":"Attaches a runbook to an incident and executes it","schema":{"$ref":"#/definitions/Runbooks_ExecutionEntity"}}},"tags":["Runbooks"],"operationId":"create_runbook_execution"},"get":{"summary":"List runbook executions","description":"List all runbook executions across all runbooks","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"List all runbook executions across all runbooks","schema":{"$ref":"#/definitions/Runbooks_ExecutionEntityPaginated"}}},"tags":["Runbooks"],"operationId":"list_runbook_executions"}},"/v1/runbooks/executions/{execution_id}":{"delete":{"summary":"Terminate a runbook execution","description":"Terminates a runbook execution, preventing any further steps from being executed","produces":["application/json"],"parameters":[{"in":"path","name":"execution_id","type":"string","required":true},{"in":"query","name":"reason","description":"The reason for terminating the runbook execution","type":"string","required":true}],"responses":{"204":{"description":"Terminates a runbook execution, preventing any further steps from being executed"}},"tags":["Runbooks"],"operationId":"delete_runbook_execution"},"get":{"summary":"Get a runbook execution","description":"Retrieve a runbook execution by ID","produces":["application/json"],"parameters":[{"in":"path","name":"execution_id","type":"string","required":true}],"responses":{"200":{"description":"Retrieve a runbook execution by ID","schema":{"$ref":"#/definitions/Runbooks_ExecutionEntity"}}},"tags":["Runbooks"],"operationId":"get_runbook_execution"}},"/v1/runbooks/executions/{execution_id}/steps/{step_id}":{"put":{"summary":"Update a runbook step execution","description":"Updates a runbook step execution, especially for changing the state of a step execution.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"execution_id","type":"string","required":true},{"in":"path","name":"step_id","type":"string","required":true},{"name":"update_runbook_execution_step","in":"body","required":true,"schema":{"$ref":"#/definitions/update_runbook_execution_step"}}],"responses":{"200":{"description":"Updates a runbook step execution, especially for changing the state of a step execution.","schema":{"$ref":"#/definitions/Runbooks_ExecutionEntity"}}},"tags":["Runbooks"],"operationId":"update_runbook_execution_step"}},"/v1/runbooks/executions/{execution_id}/steps/{step_id}/script":{"get":{"summary":"Get a step's bash script","description":"Retrieves the bash script from a \"script\" step.","produces":["application/json"],"parameters":[{"in":"path","name":"execution_id","type":"string","required":true},{"in":"path","name":"step_id","type":"string","required":true}],"responses":{"200":{"description":"Retrieves the bash script from a \"script\" step.","schema":{"$ref":"#/definitions/Runbooks_ExecutionEntity"}}},"tags":["Runbooks"],"operationId":"get_runbook_execution_step_script"}},"/v1/runbooks/executions/{execution_id}/steps/{step_id}/script/{state}":{"put":{"summary":"Update a script step's execution status","description":"Updates the execution's step.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"execution_id","type":"string","required":true},{"in":"path","name":"step_id","type":"string","required":true},{"in":"path","name":"state","type":"string","required":true}],"responses":{"200":{"description":"Updates the execution's step.","schema":{"$ref":"#/definitions/Runbooks_ExecutionEntity"}}},"tags":["Runbooks"],"operationId":"update_runbook_execution_step_script"}},"/v1/runbooks/select_options/{integration_slug}/{action_slug}/{field}":{"get":{"summary":"List select options for a runbook integration action field","description":"List select options for a runbook integration action field","produces":["application/json"],"parameters":[{"in":"path","name":"integration_slug","type":"string","required":true},{"in":"path","name":"action_slug","type":"string","required":true},{"in":"path","name":"field","type":"string","required":true},{"in":"query","name":"query","description":"Text string of a query for filtering values.","type":"string","required":false,"x-nullable":true},{"in":"query","name":"scope","description":"Generic params used to add specificity (eg an id of some kind) to the select options request","type":"string","required":false,"x-nullable":true},{"in":"query","name":"per_page","description":"Maximum number of items to return.","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"List select options for a runbook integration action field"}},"tags":["Runbooks"],"operationId":"get_runbook_action_field_options"}},"/v1/runbooks":{"post":{"summary":"Create a runbook","description":"Create a new runbook for use with incidents.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"create_runbook","in":"body","required":true,"schema":{"$ref":"#/definitions/create_runbook"}}],"responses":{"201":{"description":"Create a new runbook for use with incidents.","schema":{"$ref":"#/definitions/RunbookEntity"}}},"tags":["Runbooks"],"operationId":"create_runbook"},"get":{"summary":"List runbooks","description":"Lists all available runbooks.","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"name","description":"A query to search runbooks by their name","type":"string","required":false,"x-nullable":true},{"in":"query","name":"owners","description":"A query to search runbooks by their owners","type":"string","required":false,"x-nullable":true},{"in":"query","name":"sort","description":"Sort runbooks by their updated date. Accepts 'asc', 'desc'. This parameter is deprecated in favor of 'order_by' and 'order_direction'.","type":"string","enum":["asc","desc"],"required":false,"x-nullable":true},{"in":"query","name":"order_by","description":"Sort runbooks by their updated date or name. Accepts 'updated_at', 'name', 'owner', 'last_executed_at', and 'created_at'.","type":"string","enum":["updated_at","name","created_at","last_executed_at","owner"],"required":false,"x-nullable":true},{"in":"query","name":"order_direction","description":"Allows assigning a direction to how the specified `order_by` parameter is sorted. This parameter must be paired with `order_by` and does nothing on its own.","type":"string","enum":["asc","desc"],"required":false,"x-nullable":true}],"responses":{"200":{"description":"Lists all available runbooks.","schema":{"$ref":"#/definitions/SlimRunbookEntityPaginated"}}},"tags":["Runbooks"],"operationId":"list_runbooks"}},"/v1/runbooks/{runbook_id}":{"delete":{"summary":"Delete a runbook","description":"Delete a runbook and make it unavailable for any future incidents.","produces":["application/json"],"parameters":[{"in":"path","name":"runbook_id","type":"string","required":true}],"responses":{"204":{"description":"Delete a runbook and make it unavailable for any future incidents."}},"tags":["Runbooks"],"operationId":"delete_runbook"},"put":{"summary":"Update a runbook","description":"Update a runbook and any attachment rules associated with it. This endpoint is used to configure nearly everything\nabout a runbook, including but not limited to the steps, environments, attachment rules, and severities.\n","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"runbook_id","type":"string","required":true},{"name":"update_runbook","in":"body","required":true,"schema":{"$ref":"#/definitions/update_runbook"}}],"responses":{"200":{"description":"Update a runbook and any attachment rules associated with it. This endpoint is used to configure nearly everything\nabout a runbook, including but not limited to the steps, environments, attachment rules, and severities.\n","schema":{"$ref":"#/definitions/RunbookEntity"}}},"tags":["Runbooks"],"operationId":"update_runbook"},"get":{"summary":"Get a runbook","description":"Get a runbook and all its configuration","produces":["application/json"],"parameters":[{"in":"path","name":"runbook_id","type":"string","required":true}],"responses":{"200":{"description":"Get a runbook and all its configuration","schema":{"$ref":"#/definitions/RunbookEntity"}}},"tags":["Runbooks"],"operationId":"get_runbook"}},"/v1/runbook_audits":{"get":{"summary":"List runbook audits","description":"This endpoint is deprecated.","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"auditable_type","description":"A query to filter audits by type","type":"string","default":"Runbooks::Step","enum":["Runbooks::Step","Runbooks::Runbook"],"required":false,"x-nullable":true},{"in":"query","name":"sort","description":"A query to sort audits by their created_at timestamp. Options are 'asc' or 'desc'","type":"string","required":false,"x-nullable":true}],"responses":{"200":{"description":"List runbook audits"}},"tags":["Runbooks"],"operationId":"list_runbook_audits"}},"/v1/audit_events":{"get":{"summary":"List audit events","description":"List audit events","produces":["application/json"],"parameters":[{"in":"query","name":"cursor","description":"Cursor for pagination.","type":"string","required":false,"x-nullable":true},{"in":"query","name":"filter","description":"Query string to filter audit events, concatenated with AND keyword.\nAvailable filters with example:\n  - event.occurred_at < 2023-01-01T00:00:00Z\n  - event.key = signals.on_call_rotation.generate\n  - event.key = ticketing.sync\n  - event.actor.kind = user\n  - event.actor.id = 00000000-0000-0000-0000-000000000000\n  - resource.kind = incident\n  - resource.kind = ticketing.ticket\n  - resource.id = 00000000-0000-0000-0000-000000000000\n  - resource.response = FAILURE\n  - parent_id = 00000000-0000-0000-0000-000000000000\nValid query looks like (without quotes):\n  event.occurred_at < 2023-01-01T00:00:00Z AND event.key = signals.on_call_rotation.generate\n","type":"string","required":false,"x-nullable":true},{"in":"query","name":"limit","description":"Number of records to display in a single page, maximum is 100 entries. Smaller number is recommended for better performance.","type":"integer","format":"int32","default":20,"required":false,"x-nullable":true}],"responses":{"200":{"description":"List audit events"}},"tags":["Audit Events"],"operationId":"list_audit_events"}},"/v1/audit_events/{id}":{"get":{"summary":"Get a single audit event","description":"Get a single audit event","produces":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true}],"responses":{"200":{"description":"Get a single audit event"}},"tags":["Audit Events"],"operationId":"get_audit_event"}},"/v1/nunc_connections":{"get":{"summary":"List status pages","description":"Lists the information displayed as part of your FireHydrant hosted status pages.","produces":["application/json"],"responses":{"200":{"description":"Lists the information displayed as part of your FireHydrant hosted status pages.","schema":{"$ref":"#/definitions/NuncConnectionEntityPaginated"}}},"tags":["Status Pages"],"operationId":"list_nunc_connections"},"post":{"summary":"Create a status page","description":"Create a new FireHydrant hosted status page for customer facing statuses.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"domain","type":"string","required":true},{"in":"formData","name":"company_name","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"company_website","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"company_tos_url","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"greeting_title","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"greeting_body","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"operational_message","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"title","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"conditions[nunc_condition]","description":"Status page condition to map your severity matrix condition to","type":"array","required":true,"items":{"type":"string"}},{"in":"formData","name":"conditions[condition_id]","description":"Severity matrix condition id","type":"array","required":true,"items":{"type":"string"}},{"in":"formData","name":"components[infrastructure_type]","type":"array","required":true,"items":{"type":"string"}},{"in":"formData","name":"components[infrastructure_id]","type":"array","required":true,"items":{"type":"string"}},{"in":"formData","name":"primary_color","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"secondary_color","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"exposed_fields","type":"array","items":{"type":"string"},"required":false,"x-nullable":true},{"in":"formData","name":"enable_histogram","type":"boolean","required":false,"x-nullable":true},{"in":"formData","name":"ui_version","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"formData","name":"authentication_method","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"oidc_authentication_config[client_id]","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"oidc_authentication_config[issuer_url]","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"oidc_authentication_config[client_secret]","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"auto_publish","type":"boolean","required":false,"x-nullable":true},{"in":"formData","name":"only_display_active_incidents","type":"boolean","required":false,"x-nullable":true}],"responses":{"201":{"description":"Create a new FireHydrant hosted status page for customer facing statuses.","schema":{"$ref":"#/definitions/NuncConnectionEntity"}}},"tags":["Status Pages"],"operationId":"create_nunc_connection"}},"/v1/nunc_connections/{nunc_connection_id}/subscribers":{"delete":{"summary":"Remove subscribers from a status page","description":"Unsubscribes one or more status page subscribers.","produces":["application/json"],"parameters":[{"in":"path","name":"nunc_connection_id","type":"string","required":true},{"in":"query","name":"subscriber_ids","description":"A list of subscriber IDs to unsubscribe.","type":"string","required":true}],"responses":{"204":{"description":"Unsubscribes one or more status page subscribers."}},"tags":["Status Pages"],"operationId":"delete_email_subscriber"},"post":{"summary":"Add subscribers to a status page","description":"Subscribes a comma-separated string of emails to status page updates","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"nunc_connection_id","type":"string","required":true},{"in":"formData","name":"emails","description":"A comma-separated list of emails to subscribe.","type":"string","required":true}],"responses":{"201":{"description":"Subscribes a comma-separated string of emails to status page updates","schema":{"$ref":"#/definitions/NuncEmailSubscribersEntity"}}},"tags":["Status Pages"],"operationId":"create_email_subscriber"},"get":{"summary":"List status page subscribers","description":"Retrieves the list of subscribers for a status page.","produces":["application/json"],"parameters":[{"in":"path","name":"nunc_connection_id","type":"string","required":true}],"responses":{"200":{"description":"Retrieves the list of subscribers for a status page.","schema":{"$ref":"#/definitions/NuncEmailSubscribersEntity"}}},"tags":["Status Pages"],"operationId":"list_email_subscribers"}},"/v1/nunc_connections/{nunc_connection_id}":{"delete":{"summary":"Delete a status page","description":"Delete a FireHydrant hosted status page, stopping updates of your incidents to it.","produces":["application/json"],"parameters":[{"in":"path","name":"nunc_connection_id","type":"string","required":true}],"responses":{"204":{"description":"Delete a FireHydrant hosted status page, stopping updates of your incidents to it."}},"tags":["Status Pages"],"operationId":"delete_nunc_connection"},"put":{"summary":"Update a status page","description":"Update your company's information and other components in the specified FireHydrant hosted status page.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"nunc_connection_id","type":"string","required":true},{"in":"formData","name":"company_name","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"company_website","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"company_tos_url","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"greeting_title","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"greeting_body","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"operational_message","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"title","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"conditions[nunc_condition]","description":"Status page condition to map your severity matrix condition to","type":"array","required":true,"items":{"type":"string"}},{"in":"formData","name":"conditions[condition_id]","description":"Severity matrix condition id","type":"array","required":true,"items":{"type":"string"}},{"in":"formData","name":"components[infrastructure_type]","type":"array","required":true,"items":{"type":"string"}},{"in":"formData","name":"components[infrastructure_id]","type":"array","required":true,"items":{"type":"string"}},{"in":"formData","name":"primary_color","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"secondary_color","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"exposed_fields","type":"array","items":{"type":"string"},"required":false,"x-nullable":true},{"in":"formData","name":"enable_histogram","type":"boolean","required":false,"x-nullable":true},{"in":"formData","name":"ui_version","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"formData","name":"authentication_method","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"oidc_authentication_config[issuer_url]","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"oidc_authentication_config[client_id]","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"oidc_authentication_config[client_secret]","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"auto_publish","type":"boolean","required":false,"x-nullable":true},{"in":"formData","name":"only_display_active_incidents","type":"boolean","required":false,"x-nullable":true}],"responses":{"200":{"description":"Update your company's information and other components in the specified FireHydrant hosted status page.","schema":{"$ref":"#/definitions/NuncConnectionEntity"}}},"tags":["Status Pages"],"operationId":"update_nunc_connection"},"get":{"summary":"Get a status page","description":"Retrieve the information displayed as part of your FireHydrant hosted status page.","produces":["application/json"],"parameters":[{"in":"path","name":"nunc_connection_id","type":"string","required":true}],"responses":{"200":{"description":"Retrieve the information displayed as part of your FireHydrant hosted status page.","schema":{"$ref":"#/definitions/NuncConnectionEntity"}}},"tags":["Status Pages"],"operationId":"get_nunc_connection"}},"/v1/nunc_connections/{nunc_connection_id}/unpublish":{"post":{"summary":"Unpublish a status page","description":"Unpublish a FireHydrant hosted status page","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"nunc_connection_id","type":"string","required":true}],"responses":{"201":{"description":"Unpublish a FireHydrant hosted status page","schema":{"$ref":"#/definitions/NuncConnectionEntity"}}},"tags":["Status Pages"],"operationId":"unpublish_nunc_connection"}},"/v1/nunc_connections/{nunc_connection_id}/publish":{"post":{"summary":"Publish a status page","description":"Publish a FireHydrant hosted status page","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"nunc_connection_id","type":"string","required":true}],"responses":{"201":{"description":"Publish a FireHydrant hosted status page","schema":{"$ref":"#/definitions/NuncConnectionEntity"}}},"tags":["Status Pages"],"operationId":"publish_nunc_connection"}},"/v1/nunc_connections/{nunc_connection_id}/component_groups/{group_id}":{"delete":{"summary":"Delete a status page component group","description":"Delete a component group displayed on a FireHydrant status page","produces":["application/json"],"parameters":[{"in":"path","name":"nunc_connection_id","type":"string","required":true},{"in":"path","name":"group_id","type":"string","required":true}],"responses":{"204":{"description":"Delete a component group displayed on a FireHydrant status page"}},"tags":["Status Pages"],"operationId":"delete_nunc_component_group"},"patch":{"summary":"Update a status page component group","description":"Update a component group to be displayed on a FireHydrant status page","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"nunc_connection_id","type":"string","required":true},{"in":"path","name":"group_id","type":"string","required":true},{"in":"formData","name":"name","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"component_group_id","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"position","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"Update a component group to be displayed on a FireHydrant status page"}},"tags":["Status Pages"],"operationId":"update_nunc_component_group"}},"/v1/nunc_connections/{nunc_connection_id}/component_groups":{"post":{"summary":"Create a component group for a status page","description":"Add a component group to be displayed on a FireHydrant status page","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"nunc_connection_id","type":"string","required":true},{"in":"formData","name":"name","type":"string","required":true},{"in":"formData","name":"component_group_id","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"position","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"201":{"description":"Add a component group to be displayed on a FireHydrant status page","schema":{"$ref":"#/definitions/NuncConnectionEntity"}}},"tags":["Status Pages"],"operationId":"create_nunc_component_group"}},"/v1/nunc_connections/{nunc_connection_id}/links/{link_id}":{"delete":{"summary":"Delete a status page link","description":"Delete a link displayed on a FireHydrant status page","produces":["application/json"],"parameters":[{"in":"path","name":"nunc_connection_id","type":"string","required":true},{"in":"path","name":"link_id","type":"string","required":true}],"responses":{"204":{"description":"Delete a link displayed on a FireHydrant status page"}},"tags":["Status Pages"],"operationId":"delete_nunc_link"},"patch":{"summary":"Update a status page link","description":"Update a link to be displayed on a FireHydrant status page","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"nunc_connection_id","type":"string","required":true},{"in":"path","name":"link_id","type":"string","required":true},{"name":"update_nunc_link","in":"body","required":true,"schema":{"$ref":"#/definitions/update_nunc_link"}}],"responses":{"200":{"description":"Update a link to be displayed on a FireHydrant status page"}},"tags":["Status Pages"],"operationId":"update_nunc_link"}},"/v1/nunc_connections/{nunc_connection_id}/links":{"post":{"summary":"Add link to a status page","description":"Add a link to be displayed on a FireHydrant status page","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"nunc_connection_id","type":"string","required":true}],"responses":{"201":{"description":"Add a link to be displayed on a FireHydrant status page","schema":{"$ref":"#/definitions/NuncConnectionEntity"}}},"tags":["Status Pages"],"operationId":"create_nunc_link"}},"/v1/nunc_connections/{nunc_connection_id}/images/{type}":{"delete":{"summary":"Delete an image from a status page","description":"Delete an image attached to a FireHydrant status page","produces":["application/json"],"parameters":[{"in":"path","name":"nunc_connection_id","type":"string","required":true},{"in":"path","name":"type","type":"string","required":true}],"responses":{"204":{"description":"Delete an image attached to a FireHydrant status page"}},"tags":["Status Pages"],"operationId":"delete_nunc_image"},"put":{"summary":"Upload an image for a status page","description":"Add or replace an image attached to a FireHydrant status page","produces":["application/json"],"consumes":["multipart/form-data"],"parameters":[{"in":"path","name":"nunc_connection_id","type":"string","required":true},{"in":"path","name":"type","type":"string","required":true},{"in":"formData","name":"file","type":"file","required":false,"x-nullable":true}],"responses":{"200":{"description":"Add or replace an image attached to a FireHydrant status page","schema":{"$ref":"#/definitions/NuncConnectionEntity"}}},"tags":["Status Pages"],"operationId":"update_nunc_image"}},"/v1/saved_searches/{resource_type}/{saved_search_id}":{"delete":{"summary":"Delete a saved search","description":"Delete a specific saved search","produces":["application/json"],"parameters":[{"in":"path","name":"resource_type","type":"string","enum":["change_events","incidents","services","scheduled_maintenances","ticket_tasks","ticket_follow_ups","analytics","impact_analytics","alerts","alert_analytics","incident_events"],"required":true},{"in":"path","name":"saved_search_id","type":"string","required":true}],"responses":{"204":{"description":"Delete a specific saved search"}},"tags":["Metrics/Reporting"],"operationId":"delete_saved_search"},"patch":{"summary":"Update a saved search","description":"Update a specific saved search","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"resource_type","type":"string","enum":["change_events","incidents","services","scheduled_maintenances","ticket_tasks","ticket_follow_ups","analytics","impact_analytics","alerts","alert_analytics","incident_events"],"required":true},{"in":"path","name":"saved_search_id","type":"string","required":true},{"name":"update_saved_search","in":"body","required":true,"schema":{"$ref":"#/definitions/update_saved_search"}}],"responses":{"200":{"description":"Update a specific saved search","schema":{"$ref":"#/definitions/SavedSearchEntity"}}},"tags":["Metrics/Reporting"],"operationId":"update_saved_search"},"get":{"summary":"Get a saved search","description":"Retrieve a specific save search","produces":["application/json"],"parameters":[{"in":"path","name":"resource_type","type":"string","enum":["change_events","incidents","services","scheduled_maintenances","ticket_tasks","ticket_follow_ups","analytics","impact_analytics","alerts","alert_analytics","incident_events"],"required":true},{"in":"path","name":"saved_search_id","type":"string","required":true}],"responses":{"200":{"description":"Retrieve a specific save search","schema":{"$ref":"#/definitions/SavedSearchEntity"}}},"tags":["Metrics/Reporting"],"operationId":"get_saved_search"}},"/v1/saved_searches/{resource_type}":{"get":{"summary":"List saved searches","description":"Lists saved searches","produces":["application/json"],"parameters":[{"in":"path","name":"resource_type","type":"string","enum":["change_events","incidents","services","scheduled_maintenances","ticket_tasks","ticket_follow_ups","analytics","impact_analytics","alerts","alert_analytics","incident_events"],"required":true},{"in":"query","name":"user_id","description":"The user ID used to filter saved searches.","type":"string","required":false,"x-nullable":true},{"in":"query","name":"query","description":"Filter saved searches with a query on their name","type":"string","required":false,"x-nullable":true},{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"Lists saved searches","schema":{"$ref":"#/definitions/SavedSearchEntity"}}},"tags":["Metrics/Reporting"],"operationId":"list_saved_searches"},"post":{"summary":"Create a saved search","description":"Create a new saved search for a particular resource type","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"resource_type","type":"string","enum":["change_events","incidents","services","scheduled_maintenances","ticket_tasks","ticket_follow_ups","analytics","impact_analytics","alerts","alert_analytics","incident_events"],"required":true},{"name":"create_saved_search","in":"body","required":true,"schema":{"$ref":"#/definitions/create_saved_search"}}],"responses":{"201":{"description":"Create a new saved search for a particular resource type","schema":{"$ref":"#/definitions/SavedSearchEntity"}}},"tags":["Metrics/Reporting"],"operationId":"create_saved_search"}},"/v1/lifecycles/measurement_definitions":{"post":{"summary":"Create a measurement definition","description":"Create a new measurement definition","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"name","type":"string","required":true},{"in":"formData","name":"slug","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"description","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"starts_at_milestone_id","type":"string","required":true},{"in":"formData","name":"ends_at_milestone_id","type":"string","required":true}],"responses":{"201":{"description":"Create a new measurement definition"}},"tags":["Incident Settings"],"operationId":"create_lifecycle_measurement_definition"},"get":{"summary":"List measurement definitions","description":"List all of the measurement definitions in the organization","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"List all of the measurement definitions in the organization"}},"tags":["Incident Settings"],"operationId":"list_lifecycle_measurement_definitions"}},"/v1/lifecycles/measurement_definitions/{measurement_definition_id}":{"delete":{"summary":"Archive a measurement definition","description":"Archives a measurement definition which will hide it from lists and metrics","produces":["application/json"],"parameters":[{"in":"path","name":"measurement_definition_id","type":"string","required":true}],"responses":{"204":{"description":"Archives a measurement definition which will hide it from lists and metrics"}},"tags":["Incident Settings"],"operationId":"delete_lifecycle_measurement_definition"},"patch":{"summary":"Update a measurement definition","description":"Update a single measurement definition from its ID","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"measurement_definition_id","type":"string","required":true},{"in":"formData","name":"name","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"slug","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"description","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"starts_at_milestone_id","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"ends_at_milestone_id","type":"string","required":false,"x-nullable":true}],"responses":{"200":{"description":"Update a single measurement definition from its ID"}},"tags":["Incident Settings"],"operationId":"update_lifecycle_measurement_definition"},"get":{"summary":"Get a measurement definition","description":"Retrieve a single measurement definition from its ID","produces":["application/json"],"parameters":[{"in":"path","name":"measurement_definition_id","type":"string","required":true}],"responses":{"200":{"description":"Retrieve a single measurement definition from its ID"}},"tags":["Incident Settings"],"operationId":"get_lifecycle_measurement_definition"}},"/v1/lifecycles/phases":{"get":{"summary":"List phases and milestones","description":"List all of the lifecycle phases and milestones in the organization","produces":["application/json"],"responses":{"200":{"description":"List all of the lifecycle phases and milestones in the organization","schema":{"$ref":"#/definitions/Lifecycles_PhaseEntityList"}}},"tags":["Incident Settings"],"operationId":"list_lifecycle_phases"}},"/v1/lifecycles/milestones":{"post":{"summary":"Create a milestone","description":"Create a new milestone","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"name","description":"The name of the milestone","type":"string","required":true},{"in":"formData","name":"description","description":"A long-form description of the milestone's purpose","type":"string","required":true},{"in":"formData","name":"slug","description":"A unique identifier for the milestone. If not provided, one will be generated from the name.","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"phase_id","description":"The ID of the phase to which the milestone should belong","type":"string","required":true},{"in":"formData","name":"position","description":"The position of the milestone within the phase. If not provided, the milestone will be added as the last milestone in the phase.","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"formData","name":"required_at_milestone_id","description":"The ID of a later milestone that cannot be started until this milestone has a timestamp populated","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"auto_assign_timestamp_on_create","description":"The setting for auto-assigning the milestone's timestamp during incident declaration","type":"string","enum":["always_set_on_create","only_set_on_manual_create","never_set_on_create"],"required":false,"x-nullable":true}],"responses":{"201":{"description":"Create a new milestone","schema":{"$ref":"#/definitions/Lifecycles_MilestoneEntity"}}},"tags":["Incident Settings"],"operationId":"create_lifecycle_milestone"}},"/v1/lifecycles/milestones/{milestone_id}":{"delete":{"summary":"Delete a milestone","description":"Delete a milestone","produces":["application/json"],"parameters":[{"in":"path","name":"milestone_id","type":"string","required":true}],"responses":{"204":{"description":"Delete a milestone"}},"tags":["Incident Settings"],"operationId":"delete_lifecycle_milestone"},"patch":{"summary":"Update a milestone","description":"Update a milestone","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"milestone_id","type":"string","required":true},{"in":"formData","name":"name","description":"The name of the milestone","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"description","description":"A long-form description of the milestone's purpose","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"slug","description":"A unique identifier for the milestone. If not provided, one will be generated from the name.","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"position","description":"The position of the milestone within the phase. If not provided, the milestone will be added as the last milestone in the phase.","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"formData","name":"required_at_milestone_id","description":"The ID of a later milestone that cannot be started until this milestone has a timestamp populated","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"auto_assign_timestamp_on_create","description":"The setting for auto-assigning the milestone's timestamp during incident declaration","type":"string","enum":["always_set_on_create","only_set_on_manual_create","never_set_on_create"],"required":false,"x-nullable":true}],"responses":{"200":{"description":"Update a milestone","schema":{"$ref":"#/definitions/Lifecycles_MilestoneEntity"}}},"tags":["Incident Settings"],"operationId":"update_lifecycle_milestone"}},"/v1/priorities":{"post":{"summary":"Create a priority","description":"Create a new priority","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"create_priority","in":"body","required":true,"schema":{"$ref":"#/definitions/create_priority"}}],"responses":{"201":{"description":"Create a new priority","schema":{"$ref":"#/definitions/PriorityEntity"}}},"tags":["Incident Settings"],"operationId":"create_priority"},"get":{"summary":"List priorities","description":"Lists priorities","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"Lists priorities","schema":{"$ref":"#/definitions/PriorityEntity"}}},"tags":["Incident Settings"],"operationId":"list_priorities"}},"/v1/priorities/{priority_slug}":{"delete":{"summary":"Delete a priority","description":"Delete a specific priority","produces":["application/json"],"parameters":[{"in":"path","name":"priority_slug","type":"string","required":true}],"responses":{"204":{"description":"Delete a specific priority"}},"tags":["Incident Settings"],"operationId":"delete_priority"},"patch":{"summary":"Update a priority","description":"Update a specific priority","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"priority_slug","type":"string","required":true},{"name":"update_priority","in":"body","required":true,"schema":{"$ref":"#/definitions/update_priority"}}],"responses":{"200":{"description":"Update a specific priority","schema":{"$ref":"#/definitions/PriorityEntity"}}},"tags":["Incident Settings"],"operationId":"update_priority"},"get":{"summary":"Get a priority","description":"Retrieve a specific priority","produces":["application/json"],"parameters":[{"in":"path","name":"priority_slug","type":"string","required":true}],"responses":{"200":{"description":"Retrieve a specific priority","schema":{"$ref":"#/definitions/PriorityEntity"}}},"tags":["Incident Settings"],"operationId":"get_priority"}},"/v1/severities":{"post":{"summary":"Create a severity","description":"Create a new severity","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"create_severity","in":"body","required":true,"schema":{"$ref":"#/definitions/create_severity"}}],"responses":{"201":{"description":"Create a new severity","schema":{"$ref":"#/definitions/SeverityEntity"}}},"tags":["Incident Settings"],"operationId":"create_severity"},"get":{"summary":"List severities","description":"Lists severities","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"Lists severities","schema":{"$ref":"#/definitions/SeverityEntityPaginated"}}},"tags":["Incident Settings"],"operationId":"list_severities"}},"/v1/severities/{severity_slug}":{"delete":{"summary":"Delete a severity","description":"Delete a specific severity","produces":["application/json"],"parameters":[{"in":"path","name":"severity_slug","type":"string","required":true}],"responses":{"204":{"description":"Delete a specific severity"}},"tags":["Incident Settings"],"operationId":"delete_severity"},"patch":{"summary":"Update a severity","description":"Update a specific severity","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"severity_slug","type":"string","required":true},{"name":"update_severity","in":"body","required":true,"schema":{"$ref":"#/definitions/update_severity"}}],"responses":{"200":{"description":"Update a specific severity","schema":{"$ref":"#/definitions/SeverityEntity"}}},"tags":["Incident Settings"],"operationId":"update_severity"},"get":{"summary":"Get a severity","description":"Retrieve a specific severity","produces":["application/json"],"parameters":[{"in":"path","name":"severity_slug","type":"string","required":true}],"responses":{"200":{"description":"Retrieve a specific severity","schema":{"$ref":"#/definitions/SeverityEntity"}}},"tags":["Incident Settings"],"operationId":"get_severity"}},"/v1/severity_matrix":{"patch":{"summary":"Update severity matrix","description":"Update available severities and impacts in your organization's severity matrix.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"update_severity_matrix","in":"body","required":true,"schema":{"$ref":"#/definitions/update_severity_matrix"}}],"responses":{"200":{"description":"Update available severities and impacts in your organization's severity matrix.","schema":{"$ref":"#/definitions/SeverityMatrix_SeverityMatrixEntity"}}},"tags":["Incident Settings"],"operationId":"update_severity_matrix"},"get":{"summary":"Get severity matrix","description":"Retrieve the Severity matrix for your organization and its components and configured severities.","produces":["application/json"],"responses":{"200":{"description":"Retrieve the Severity matrix for your organization and its components and configured severities.","schema":{"$ref":"#/definitions/SeverityMatrix_SeverityMatrixEntity"}}},"tags":["Incident Settings"],"operationId":"get_severity_matrix"}},"/v1/severity_matrix/conditions":{"get":{"summary":"List severity matrix conditions","description":"Lists conditions","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"Lists conditions","schema":{"$ref":"#/definitions/SeverityMatrix_ConditionEntity"}}},"tags":["Incident Settings"],"operationId":"list_severity_matrix_conditions"},"post":{"summary":"Create a severity matrix condition","description":"Create a new condition","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"create_severity_matrix_condition","in":"body","required":true,"schema":{"$ref":"#/definitions/create_severity_matrix_condition"}}],"responses":{"201":{"description":"Create a new condition","schema":{"$ref":"#/definitions/SeverityMatrix_ConditionEntity"}}},"tags":["Incident Settings"],"operationId":"create_severity_matrix_condition"}},"/v1/severity_matrix/conditions/{condition_id}":{"delete":{"summary":"Delete a severity matrix condition","description":"Delete a specific condition","produces":["application/json"],"parameters":[{"in":"path","name":"condition_id","type":"string","required":true}],"responses":{"204":{"description":"Delete a specific condition"}},"tags":["Incident Settings"],"operationId":"delete_severity_matrix_condition"},"patch":{"summary":"Update a severity matrix condition","description":"Update a severity matrix condition","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"condition_id","type":"string","required":true},{"name":"update_severity_matrix_condition","in":"body","required":true,"schema":{"$ref":"#/definitions/update_severity_matrix_condition"}}],"responses":{"200":{"description":"Update a severity matrix condition","schema":{"$ref":"#/definitions/SeverityMatrix_ConditionEntity"}}},"tags":["Incident Settings"],"operationId":"update_severity_matrix_condition"},"get":{"summary":"Get a severity matrix condition","description":"Retrieve a specific condition","produces":["application/json"],"parameters":[{"in":"path","name":"condition_id","type":"string","required":true}],"responses":{"200":{"description":"Retrieve a specific condition","schema":{"$ref":"#/definitions/SeverityMatrix_ConditionEntity"}}},"tags":["Incident Settings"],"operationId":"get_severity_matrix_condition"}},"/v1/severity_matrix/impacts":{"get":{"summary":"List severity matrix impacts","description":"Lists impacts","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"Lists impacts","schema":{"$ref":"#/definitions/SeverityMatrix_ImpactEntity"}}},"tags":["Incident Settings"],"operationId":"list_severity_matrix_impacts"},"post":{"summary":"Create a severity matrix impact","description":"Create a new impact","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"create_severity_matrix_impact","in":"body","required":true,"schema":{"$ref":"#/definitions/create_severity_matrix_impact"}}],"responses":{"201":{"description":"Create a new impact","schema":{"$ref":"#/definitions/SeverityMatrix_ImpactEntity"}}},"tags":["Incident Settings"],"operationId":"create_severity_matrix_impact"}},"/v1/severity_matrix/impacts/{impact_id}":{"delete":{"summary":"Delete a severity matrix impact","description":"Delete a specific impact","produces":["application/json"],"parameters":[{"in":"path","name":"impact_id","type":"string","required":true}],"responses":{"204":{"description":"Delete a specific impact"}},"tags":["Incident Settings"],"operationId":"delete_severity_matrix_impact"},"patch":{"summary":"Update a severity matrix impact","description":"Update a severity matrix impact","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"impact_id","type":"string","required":true},{"name":"update_severity_matrix_impact","in":"body","required":true,"schema":{"$ref":"#/definitions/update_severity_matrix_impact"}}],"responses":{"200":{"description":"Update a severity matrix impact","schema":{"$ref":"#/definitions/SeverityMatrix_ImpactEntity"}}},"tags":["Incident Settings"],"operationId":"update_severity_matrix_impact"}},"/v1/scheduled_maintenances":{"post":{"summary":"Create a scheduled maintenance event","description":"Create a new scheduled maintenance event","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"create_scheduled_maintenance","in":"body","required":true,"schema":{"$ref":"#/definitions/create_scheduled_maintenance"}}],"responses":{"201":{"description":"Create a new scheduled maintenance event","schema":{"$ref":"#/definitions/ScheduledMaintenanceEntity"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ErrorEntity"}}},"tags":["Incidents"],"operationId":"create_scheduled_maintenance"},"get":{"summary":"List scheduled maintenance events","description":"Lists all scheduled maintenance events","produces":["application/json"],"parameters":[{"in":"query","name":"query","description":"Filter scheduled_maintenances with a query on their name","type":"string","required":false,"x-nullable":true},{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"Lists all scheduled maintenance events","schema":{"$ref":"#/definitions/ScheduledMaintenanceEntity"}}},"tags":["Incidents"],"operationId":"list_scheduled_maintenances"}},"/v1/scheduled_maintenances/{scheduled_maintenance_id}":{"delete":{"summary":"Delete a scheduled maintenance event","description":"Delete a scheduled maintenance event, preventing it from taking place.","produces":["application/json"],"parameters":[{"in":"path","name":"scheduled_maintenance_id","type":"string","required":true}],"responses":{"204":{"description":"Delete a scheduled maintenance event, preventing it from taking place."}},"tags":["Incidents"],"operationId":"delete_scheduled_maintenance"},"patch":{"summary":"Update a scheduled maintenance event","description":"Change the conditions of a scheduled maintenance event, including updating any status page announcements of changes.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"scheduled_maintenance_id","type":"string","required":true},{"name":"update_scheduled_maintenance","in":"body","required":true,"schema":{"$ref":"#/definitions/update_scheduled_maintenance"}}],"responses":{"200":{"description":"Change the conditions of a scheduled maintenance event, including updating any status page announcements of changes.","schema":{"$ref":"#/definitions/ScheduledMaintenanceEntity"}}},"tags":["Incidents"],"operationId":"update_scheduled_maintenance"},"get":{"summary":"Get a scheduled maintenance event","description":"Fetch the details of a scheduled maintenance event.","produces":["application/json"],"parameters":[{"in":"path","name":"scheduled_maintenance_id","type":"string","required":true}],"responses":{"200":{"description":"Fetch the details of a scheduled maintenance event.","schema":{"$ref":"#/definitions/ScheduledMaintenanceEntity"}}},"tags":["Incidents"],"operationId":"get_scheduled_maintenance"}},"/v1/schedules":{"get":{"summary":"List schedules","description":"List all known schedules in FireHydrant as pulled from external sources","produces":["application/json"],"parameters":[{"in":"query","name":"query","description":"Filter schedules with a query on their name","type":"string","required":false,"x-nullable":true},{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"List all known schedules in FireHydrant as pulled from external sources","schema":{"$ref":"#/definitions/ScheduleEntityPaginated"}}},"tags":["Teams"],"operationId":"list_schedules"}},"/v1/infrastructures":{"get":{"summary":"Lists functionality, service and environment objects","description":"Lists functionality, service and environment objects","produces":["application/json"],"parameters":[{"in":"query","name":"query","description":"A query to search infrastructures by their name","type":"string","required":false,"x-nullable":true},{"in":"query","name":"omit_for","description":"Omit for any infrastructure that is added to an incident using the format \"incident/{incident_id}\"","type":"string","required":false,"x-nullable":true},{"in":"query","name":"type","description":"Restrict infrastructure search to given type.","type":"string","required":false,"x-nullable":true},{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"Lists functionality, service and environment objects","schema":{"$ref":"#/definitions/InfrastructureSearchEntity"}}},"tags":["Catalog Entries"],"operationId":"list_infrastructures"}},"/v1/nunc/subscriptions/{unsubscribe_token}":{"delete":{"summary":"Unsubscribe from status page notifications","description":"Unsubscribe from status page updates","produces":["application/json"],"parameters":[{"in":"path","name":"unsubscribe_token","type":"string","required":true}],"responses":{"204":{"description":"Unsubscribe from status page updates"}},"tags":["Status Pages"],"operationId":"delete_nunc_subscription"}},"/v1/nunc/subscriptions":{"post":{"summary":"Create a status page subscription","description":"Subscribe to status page updates","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"create_nunc_subscription","in":"body","required":true,"schema":{"$ref":"#/definitions/create_nunc_subscription"}}],"responses":{"201":{"description":"Subscribe to status page updates","schema":{"$ref":"#/definitions/Nunc_NuncSubscription"}}},"tags":["Status Pages"],"operationId":"create_nunc_subscription"}},"/v1/status_update_templates":{"post":{"summary":"Create a status update template","description":"Create a status update template for your organization","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"create_status_update_template","in":"body","required":true,"schema":{"$ref":"#/definitions/create_status_update_template"}}],"responses":{"201":{"description":"Create a status update template for your organization","schema":{"$ref":"#/definitions/StatusUpdateTemplateEntity"}}},"tags":["Communication"],"operationId":"create_status_update_template"},"get":{"summary":"List status update templates","description":"List all status update templates for your organization","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"List all status update templates for your organization","schema":{"$ref":"#/definitions/StatusUpdateTemplateEntity"}}},"tags":["Communication"],"operationId":"list_status_update_templates"}},"/v1/status_update_templates/{status_update_template_id}":{"delete":{"summary":"Delete a status update template","description":"Delete a single status update template","produces":["application/json"],"parameters":[{"in":"path","name":"status_update_template_id","type":"string","required":true}],"responses":{"204":{"description":"Delete a single status update template"}},"tags":["Communication"],"operationId":"delete_status_update_template"},"patch":{"summary":"Update a status update template","description":"Update a single status update template","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"status_update_template_id","type":"string","required":true},{"name":"update_status_update_template","in":"body","required":true,"schema":{"$ref":"#/definitions/update_status_update_template"}}],"responses":{"200":{"description":"Update a single status update template","schema":{"$ref":"#/definitions/StatusUpdateTemplateEntity"}}},"tags":["Communication"],"operationId":"update_status_update_template"},"get":{"summary":"Get a status update template","description":"Get a single status update template by ID","produces":["application/json"],"parameters":[{"in":"path","name":"status_update_template_id","type":"string","required":true}],"responses":{"200":{"description":"Get a single status update template by ID","schema":{"$ref":"#/definitions/StatusUpdateTemplateEntity"}}},"tags":["Communication"],"operationId":"get_status_update_template"}},"/v1/custom_fields/definitions/{field_id}":{"delete":{"summary":"Delete a custom field definition","description":"Delete a custom field definition","produces":["application/json"],"parameters":[{"in":"path","name":"field_id","type":"string","required":true}],"responses":{"204":{"description":"Delete a custom field definition"}},"tags":["Incident Settings"],"operationId":"delete_custom_field_definition"},"patch":{"summary":"Update a custom field definition","description":"Update a single custom field definition","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"field_id","type":"string","required":true},{"name":"update_custom_field_definition","in":"body","required":true,"schema":{"$ref":"#/definitions/update_custom_field_definition"}}],"responses":{"200":{"description":"Update a single custom field definition","schema":{"$ref":"#/definitions/Organizations_CustomFieldDefinitionEntity"}}},"tags":["Incident Settings"],"operationId":"update_custom_field_definition"}},"/v1/custom_fields/definitions":{"post":{"summary":"Create a custom field definition","description":"Create a new custom field definition","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"create_custom_field_definition","in":"body","required":true,"schema":{"$ref":"#/definitions/create_custom_field_definition"}}],"responses":{"201":{"description":"Create a new custom field definition","schema":{"$ref":"#/definitions/Organizations_CustomFieldDefinitionEntity"}}},"tags":["Incident Settings"],"operationId":"create_custom_field_definition"},"get":{"summary":"List custom field definitions","description":"List all custom field definitions","produces":["application/json"],"responses":{"200":{"description":"List all custom field definitions","schema":{"$ref":"#/definitions/Organizations_CustomFieldDefinitionEntity"}}},"tags":["Incident Settings"],"operationId":"list_custom_field_definitions"}},"/v1/custom_fields/definitions/{field_id}/select_options":{"get":{"summary":"Get available values for a custom field","description":"Get the permissible values for the a currently active custom select or multi-select field.","produces":["application/json"],"parameters":[{"in":"path","name":"field_id","type":"string","required":true},{"in":"query","name":"query","description":"Text string of a query for filtering values.","type":"string","required":false,"x-nullable":true},{"in":"query","name":"all_versions","description":"If true, return all versions of the custom field definition.","type":"boolean","required":false,"x-nullable":true}],"responses":{"200":{"description":"Get the permissible values for the a currently active custom select or multi-select field.","schema":{"$ref":"#/definitions/Organizations_CustomFieldDefinitionEntity"}}},"tags":["Incident Settings"],"operationId":"list_custom_field_select_options"}},"/v1/post_mortems/reports":{"post":{"summary":"Create a retrospective report","description":"Create a report","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"create_post_mortem_report","in":"body","required":true,"schema":{"$ref":"#/definitions/create_post_mortem_report"}}],"responses":{"201":{"description":"Create a report","schema":{"$ref":"#/definitions/PostMortems_PostMortemReportEntity"}}},"tags":["Retrospectives"],"operationId":"create_post_mortem_report"},"get":{"summary":"List retrospective reports","description":"List all reports","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"incident_id","description":"Filter the reports by an incident ID","type":"string","required":false,"x-nullable":true},{"in":"query","name":"updated_since","description":"Filter for reports updated after the given ISO8601 timestamp","type":"string","format":"date-time","required":false,"x-nullable":true}],"responses":{"200":{"description":"List all reports","schema":{"$ref":"#/definitions/PostMortems_PostMortemReportEntityPaginated"}}},"tags":["Retrospectives"],"operationId":"list_post_mortem_reports"}},"/v1/post_mortems/reports/{report_id}":{"patch":{"summary":"Update a retrospective report","description":"Update a report","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"report_id","type":"string","required":true},{"name":"update_post_mortem_report","in":"body","required":true,"schema":{"$ref":"#/definitions/update_post_mortem_report"}}],"responses":{"200":{"description":"Update a report","schema":{"$ref":"#/definitions/PostMortems_PostMortemReportEntity"}}},"tags":["Retrospectives"],"operationId":"update_post_mortem_report"},"get":{"summary":"Get a retrospective report","description":"Get a report","produces":["application/json"],"parameters":[{"in":"path","name":"report_id","type":"string","required":true}],"responses":{"200":{"description":"Get a report","schema":{"$ref":"#/definitions/PostMortems_PostMortemReportEntity"}}},"tags":["Retrospectives"],"operationId":"get_post_mortem_report"}},"/v1/post_mortems/reports/{report_id}/reasons":{"post":{"summary":"Create a contributing factor for a retrospective report","description":"Add a new contributing factor to an incident","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"report_id","type":"string","required":true},{"name":"create_post_mortem_reason","in":"body","required":true,"schema":{"$ref":"#/definitions/create_post_mortem_reason"}}],"responses":{"201":{"description":"Add a new contributing factor to an incident","schema":{"$ref":"#/definitions/PostMortems_ReasonEntity"}}},"tags":["Retrospectives"],"operationId":"create_post_mortem_reason"},"get":{"summary":"List contributing factors for a retrospective report","description":"List all contributing factors to an incident","produces":["application/json"],"parameters":[{"in":"path","name":"report_id","type":"string","required":true},{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"List all contributing factors to an incident","schema":{"$ref":"#/definitions/PostMortems_ReasonEntityPaginated"}}},"tags":["Retrospectives"],"operationId":"list_post_mortem_reasons"}},"/v1/post_mortems/reports/{report_id}/reasons/{reason_id}":{"patch":{"summary":"Update a contributing factor in a retrospective report","description":"Update a contributing factor","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"report_id","type":"string","required":true},{"in":"path","name":"reason_id","type":"string","required":true},{"name":"update_post_mortem_reason","in":"body","required":true,"schema":{"$ref":"#/definitions/update_post_mortem_reason"}}],"responses":{"200":{"description":"Update a contributing factor","schema":{"$ref":"#/definitions/PostMortems_ReasonEntity"}}},"tags":["Retrospectives"],"operationId":"update_post_mortem_reason"},"delete":{"summary":"Delete a contributing factor from a retrospective report","description":"Delete a contributing factor","produces":["application/json"],"parameters":[{"in":"path","name":"report_id","type":"string","required":true},{"in":"path","name":"reason_id","type":"string","required":true}],"responses":{"204":{"description":"Delete a contributing factor"}},"tags":["Retrospectives"],"operationId":"delete_post_mortem_reason"}},"/v1/post_mortems/reports/{report_id}/reasons/order":{"put":{"summary":"Reorder a contributing factor for a retrospective report","description":"Update the order of contributing factors in a retrospective report","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"report_id","type":"string","required":true},{"name":"reorder_post_mortem_reasons","in":"body","required":true,"schema":{"$ref":"#/definitions/reorder_post_mortem_reasons"}}],"responses":{"200":{"description":"Update the order of contributing factors in a retrospective report","schema":{"$ref":"#/definitions/PostMortems_ReasonEntity"}}},"tags":["Retrospectives"],"operationId":"reorder_post_mortem_reasons"}},"/v1/post_mortems/reports/{report_id}/publish":{"post":{"summary":"Publish a retrospective report","description":"Marks an incident retrospective as published and emails all of the participants in the report the summary","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"report_id","type":"string","required":true},{"name":"publish_post_mortem_report","in":"body","required":true,"schema":{"$ref":"#/definitions/publish_post_mortem_report"}}],"responses":{"201":{"description":"Marks an incident retrospective as published and emails all of the participants in the report the summary","schema":{"$ref":"#/definitions/PostMortems_PostMortemReportEntity"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ErrorEntity"}}},"tags":["Retrospectives"],"operationId":"publish_post_mortem_report"}},"/v1/post_mortems/reports/{report_id}/fields/{field_id}":{"patch":{"summary":"Update a retrospective field","description":"Update a field value on a post mortem report","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"field_id","type":"string","required":true},{"in":"path","name":"report_id","type":"string","required":true},{"name":"update_post_mortem_field","in":"body","required":true,"schema":{"$ref":"#/definitions/update_post_mortem_field"}}],"responses":{"200":{"description":"Update a field value on a post mortem report","schema":{"$ref":"#/definitions/PostMortems_SectionFieldEntity"}}},"tags":["Retrospectives"],"operationId":"update_post_mortem_field"}},"/v1/post_mortems/questions":{"put":{"summary":"Update retrospective questions","description":"Update the questions configured to be provided and filled out on future retrospective reports.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"update_post_mortem_questions","in":"body","required":true,"schema":{"$ref":"#/definitions/update_post_mortem_questions"}}],"responses":{"200":{"description":"Update the questions configured to be provided and filled out on future retrospective reports.","schema":{"$ref":"#/definitions/PostMortems_QuestionTypeEntity"}}},"tags":["Retrospectives"],"operationId":"update_post_mortem_questions"},"get":{"summary":"List retrospective questions","description":"List the questions configured to be provided and filled out on each retrospective report.","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"List the questions configured to be provided and filled out on each retrospective report.","schema":{"$ref":"#/definitions/PostMortems_QuestionTypeEntityPaginated"}}},"tags":["Retrospectives"],"operationId":"list_post_mortem_questions"}},"/v1/post_mortems/questions/{question_id}":{"get":{"summary":"Get a retrospective question","description":"Get an incident retrospective question configured to be provided and filled out on each retrospective report.","produces":["application/json"],"parameters":[{"in":"path","name":"question_id","type":"string","required":true}],"responses":{"200":{"description":"Get an incident retrospective question configured to be provided and filled out on each retrospective report."}},"tags":["Retrospectives"],"operationId":"get_post_mortem_question"}},"/v1/retrospective_templates":{"post":{"summary":"Create a retrospective template","description":"Create a new retrospective template","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"name","type":"string","required":true},{"in":"formData","name":"description","type":"string","required":true},{"in":"formData","name":"is_default","type":"boolean","required":false,"x-nullable":true},{"in":"formData","name":"sections[slug]","type":"array","required":true,"items":{"type":"string","enum":["timeline","key_data","details","resources","actions"]}},{"in":"formData","name":"sections[elements]","type":"array","items":{"type":"string"},"required":true},{"in":"formData","name":"fields[label]","type":"array","required":true,"items":{"type":"string"}},{"in":"formData","name":"fields[type]","type":"array","required":true,"items":{"type":"string","enum":["text","single_select","multi_select","numeric","datetime","dynamic_input_group","markdown","markdown_text"]}},{"in":"formData","name":"fields[help_text]","type":"array","required":false,"items":{"type":"string"},"x-nullable":true},{"in":"formData","name":"fields[permissible_values]","type":"array","items":{"type":"string"},"required":false,"x-nullable":true},{"in":"formData","name":"fields[is_required]","type":"array","required":false,"items":{"type":"boolean"},"x-nullable":true},{"in":"formData","name":"fields[required_at_milestone_id]","type":"array","required":false,"items":{"type":"string"},"x-nullable":true},{"in":"formData","name":"fields[schema]","type":"array","items":{"type":"string"},"required":false,"x-nullable":true}],"responses":{"201":{"description":"Create a new retrospective template","schema":{"$ref":"#/definitions/Retrospectives_TemplateEntity"}}},"tags":["Retrospectives"],"operationId":"create_retrospective_template"},"get":{"summary":"List retrospective templates","description":"List all retrospective templates","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"for_incident","type":"string","required":false,"x-nullable":true}],"responses":{"200":{"description":"List all retrospective templates","schema":{"$ref":"#/definitions/Retrospectives_IndexTemplateEntityPaginated"}}},"tags":["Retrospectives"],"operationId":"list_retrospective_templates"}},"/v1/retrospective_templates/{retrospective_template_id}":{"delete":{"summary":"Delete a retrospective template","description":"Delete a single retrospective template","produces":["application/json"],"parameters":[{"in":"path","name":"retrospective_template_id","type":"string","required":true}],"responses":{"204":{"description":"Delete a single retrospective template"}},"tags":["Retrospectives"],"operationId":"delete_retrospective_template"},"patch":{"summary":"Update a retrospective template","description":"Update a single retrospective template","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"retrospective_template_id","type":"string","required":true},{"in":"formData","name":"name","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"description","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"is_default","type":"boolean","required":false,"x-nullable":true},{"in":"formData","name":"sections[slug]","type":"array","required":true,"items":{"type":"string"}},{"in":"formData","name":"sections[elements]","type":"array","items":{"type":"string"},"required":true},{"in":"formData","name":"fields[id]","type":"array","required":false,"items":{"type":"string"},"x-nullable":true},{"in":"formData","name":"fields[label]","type":"array","required":true,"items":{"type":"string"}},{"in":"formData","name":"fields[type]","type":"array","required":true,"items":{"type":"string","enum":["text","single_select","multi_select","numeric","datetime","dynamic_input_group","markdown","markdown_text"]}},{"in":"formData","name":"fields[help_text]","type":"array","required":false,"items":{"type":"string"},"x-nullable":true},{"in":"formData","name":"fields[permissible_values]","type":"array","items":{"type":"string"},"required":false,"x-nullable":true},{"in":"formData","name":"fields[is_required]","type":"array","required":false,"items":{"type":"boolean"},"x-nullable":true},{"in":"formData","name":"fields[required_at_milestone_id]","type":"array","required":false,"items":{"type":"string"},"x-nullable":true},{"in":"formData","name":"fields[schema]","type":"array","items":{"type":"string"},"required":false,"x-nullable":true},{"in":"formData","name":"report_elements[type]","type":"string","enum":["incident_data","retrospective_field","custom_field","prosemirror_content","divider"],"required":true}],"responses":{"200":{"description":"Update a single retrospective template","schema":{"$ref":"#/definitions/Retrospectives_TemplateEntity"}}},"tags":["Retrospectives"],"operationId":"update_retrospective_template"},"get":{"summary":"Get a retrospective template","description":"Retrieve a single retrospective template by ID","produces":["application/json"],"parameters":[{"in":"path","name":"retrospective_template_id","type":"string","required":true}],"responses":{"200":{"description":"Retrieve a single retrospective template by ID","schema":{"$ref":"#/definitions/Retrospectives_TemplateEntity"}}},"tags":["Retrospectives"],"operationId":"get_retrospective_template"}},"/v1/alerts":{"get":{"summary":"List alerts","description":"Retrieve all alerts, including Signals alerts and third-party","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"query","description":"A text query for alerts","type":"string","required":false,"x-nullable":true},{"in":"query","name":"users","description":"A comma separated list of user IDs. This currently only works for Signals alerts.","type":"string","required":false,"x-nullable":true},{"in":"query","name":"teams","description":"A comma separated list of team IDs. This currently only works for Signals alerts.","type":"string","required":false,"x-nullable":true},{"in":"query","name":"signal_rules","description":"A comma separated list of signals rule IDs. This currently only works for Signals alerts.","type":"string","required":false,"x-nullable":true},{"in":"query","name":"environments","description":"A comma separated list of environment IDs. This currently only works for Signals alerts.","type":"string","required":false,"x-nullable":true},{"in":"query","name":"functionalities","description":"A comma separated list of functionality IDs. This currently only works for Signals alerts.","type":"string","required":false,"x-nullable":true},{"in":"query","name":"services","description":"A comma separated list of service IDs. This currently only works for Signals alerts.","type":"string","required":false,"x-nullable":true},{"in":"query","name":"tags","description":"A comma separated list of tags. This currently only works for Signals alerts.","type":"string","required":false,"x-nullable":true},{"in":"query","name":"tag_match_strategy","description":"The strategy to match tags. `any` will return alerts that have at least one of the supplied tags, `match_all` will return only alerts that have all of the supplied tags, and `exclude` will only return alerts that have none of the supplied tags. This currently only works for Signals alerts.","type":"string","enum":["any","match_all","exclude"],"required":false,"x-nullable":true},{"in":"query","name":"statuses","description":"A comma separated list of statuses to filter by. Valid statuses are: opened, acknowledged, resolved, ignored, expired, linked, or snoozed","type":"string","required":false,"x-nullable":true},{"in":"query","name":"has_any_incident","description":"When true, only returns alerts that have at least one associated incident. This currently only works for Signals alerts.","type":"boolean","required":false,"x-nullable":true},{"in":"query","name":"start_date","description":"Filters for alerts that started on or after the beginning of this date","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"end_date","description":"Filters for alerts that started on or before the end of this date","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"start_datetime","description":"Filters for alerts that started at or after this exact datetime","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"end_datetime","description":"Filters for alerts that started at or before this exact datetime","type":"string","format":"date-time","required":false,"x-nullable":true}],"responses":{"200":{"description":"Retrieve all alerts, including Signals alerts and third-party","schema":{"$ref":"#/definitions/Alerts_AlertEntityPaginated"}}},"tags":["Alerts"],"operationId":"list_alerts"}},"/v1/alerts/{alert_id}":{"get":{"summary":"Get an alert","description":"Retrieve a single alert","produces":["application/json"],"parameters":[{"in":"path","name":"alert_id","type":"string","required":true}],"responses":{"200":{"description":"Retrieve a single alert","schema":{"$ref":"#/definitions/Alerts_AlertEntity"}}},"tags":["Alerts"],"operationId":"get_alert"}},"/v1/processing_log_entries":{"get":{"summary":"List alert processing log entries","description":"Processing Log Entries for a specific alert","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"integration_slug","description":"Scopes returned log entries to a specific integration ID","type":"string","required":false,"x-nullable":true},{"in":"query","name":"connection_id","description":"Scopes returned log entries to a specific connection ID","type":"string","required":false,"x-nullable":true},{"in":"query","name":"of_level","description":"Returns logs of all levels equal to or above the provided level","type":"string","enum":["unknown","debug","info","warn","error","fatal"],"required":false,"x-nullable":true},{"in":"query","name":"exact_level","description":"Returns log entries of all levels equal to the provided level","type":"string","enum":["unknown","debug","info","warn","error","fatal"],"required":false,"x-nullable":true}],"responses":{"200":{"description":"Processing Log Entries for a specific alert","schema":{"$ref":"#/definitions/Alerts_ProcessingLogEntryEntityPaginated"}}},"tags":["Alerts"],"operationId":"list_processing_log_entries"}},"/v1/page/signals":{"post":{"summary":"Page a user, team, on-call schedule, or escalation policy","description":"Used for paging an on-call target within FireHydrant's signals product. This can be used for paging users, teams, on-call schedules, and escalation policies.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"create_signals_page","in":"body","required":true,"schema":{"$ref":"#/definitions/create_signals_page"}}],"responses":{"201":{"description":"Used for paging an on-call target within FireHydrant's signals product. This can be used for paging users, teams, on-call schedules, and escalation policies.","schema":{"$ref":"#/definitions/Alerts_AlertEntity"}}},"tags":["Pages"],"operationId":"create_signals_page"}},"/v1/ticketing/tickets":{"post":{"summary":"Create a ticket","description":"Creates a ticket for a project","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"create_ticket","in":"body","required":true,"schema":{"$ref":"#/definitions/create_ticket"}}],"responses":{"201":{"description":"Creates a ticket for a project","schema":{"$ref":"#/definitions/Ticketing_TicketEntity"}}},"tags":["Ticketing"],"operationId":"create_ticket"},"get":{"summary":"List tickets","description":"List all of the tickets that have been added to the organiation","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"tags","description":"A comma separated list of tags","type":"string","required":false,"x-nullable":true},{"in":"query","name":"tag_match_strategy","description":"A matching strategy for the tags provided","type":"string","enum":["any","match_all","exclude"],"required":false,"x-nullable":true},{"in":"query","name":"assigned_user","description":"Filter tickets assigned to this user id","type":"string","required":false,"x-nullable":true},{"in":"query","name":"state","description":"Filter tickets by state","type":"string","enum":["open","in_progress","cancelled","done"],"required":false,"x-nullable":true}],"responses":{"200":{"description":"List all of the tickets that have been added to the organiation","schema":{"$ref":"#/definitions/Ticketing_TicketEntity"}}},"tags":["Ticketing"],"operationId":"list_tickets"}},"/v1/ticketing/tickets/{ticket_id}":{"delete":{"summary":"Archive a ticket","description":"Archive a ticket","produces":["application/json"],"parameters":[{"in":"path","name":"ticket_id","type":"string","required":true}],"responses":{"204":{"description":"Archive a ticket"}},"tags":["Ticketing"],"operationId":"delete_ticket"},"patch":{"summary":"Update a ticket","description":"Update a ticket's attributes","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"ticket_id","type":"string","required":true},{"name":"update_ticket","in":"body","required":true,"schema":{"$ref":"#/definitions/update_ticket"}}],"responses":{"200":{"description":"Update a ticket's attributes","schema":{"$ref":"#/definitions/Ticketing_TicketEntity"}}},"tags":["Ticketing"],"operationId":"update_ticket"},"get":{"summary":"Get a ticket","description":"Retrieves a single ticket by ID","produces":["application/json"],"parameters":[{"in":"path","name":"ticket_id","type":"string","required":true}],"responses":{"200":{"description":"Retrieves a single ticket by ID","schema":{"$ref":"#/definitions/Ticketing_TicketEntity"}}},"tags":["Ticketing"],"operationId":"get_ticket"}},"/v1/ticketing/projects":{"get":{"summary":"List ticketing projects","description":"List all ticketing projects available to the organization","produces":["application/json"],"parameters":[{"in":"query","name":"supports_ticket_types","type":"string","required":false,"x-nullable":true},{"in":"query","name":"providers","type":"string","required":false,"x-nullable":true},{"in":"query","name":"connection_ids","type":"string","required":false,"x-nullable":true},{"in":"query","name":"configured_projects","type":"boolean","required":false,"x-nullable":true},{"in":"query","name":"query","type":"string","required":false,"x-nullable":true},{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"List all ticketing projects available to the organization","schema":{"$ref":"#/definitions/Ticketing_Projects_ProjectListItemEntity"}}},"tags":["Ticketing"],"operationId":"list_ticketing_projects"}},"/v1/ticketing/projects/{ticketing_project_id}":{"get":{"summary":"Get a ticketing project","description":"Retrieve a single ticketing project by ID","produces":["application/json"],"parameters":[{"in":"path","name":"ticketing_project_id","type":"string","required":true}],"responses":{"200":{"description":"Retrieve a single ticketing project by ID","schema":{"$ref":"#/definitions/Ticketing_Projects_ProjectListItemEntity"}}},"tags":["Ticketing"],"operationId":"get_ticketing_project"}},"/v1/ticketing/projects/{ticketing_project_id}/configuration_options":{"get":{"summary":"List configuration options for a ticketing project","description":"List all configuration options for a ticketing project","produces":["application/json"],"parameters":[{"in":"path","name":"ticketing_project_id","type":"string","required":true}],"responses":{"200":{"description":"List all configuration options for a ticketing project"}},"tags":["Ticketing"],"operationId":"get_configuration_options"}},"/v1/ticketing/projects/{ticketing_project_id}/configuration_options/options_for/{field_id}":{"get":{"summary":"List a field's configuration options for a ticketing project","description":"List a field's configuration options for a ticketing project","produces":["application/json"],"parameters":[{"in":"path","name":"field_id","type":"string","required":true},{"in":"path","name":"ticketing_project_id","type":"string","required":true}],"responses":{"200":{"description":"List a field's configuration options for a ticketing project"}},"tags":["Ticketing"],"operationId":"get_options_for_field"}},"/v1/ticketing/projects/{ticketing_project_id}/field_maps/available_fields":{"get":{"summary":"List available fields for ticket field mapping","description":"Returns metadata for the fields that are available for field mapping.","produces":["application/json"],"parameters":[{"in":"path","name":"ticketing_project_id","type":"string","required":true}],"responses":{"200":{"description":"Returns metadata for the fields that are available for field mapping.","schema":{"$ref":"#/definitions/Ticketing_FieldMaps_MappableFieldEntity"}}},"tags":["Ticketing"],"operationId":"list_available_ticketing_field_maps"}},"/v1/ticketing/projects/{ticketing_project_id}/field_maps":{"post":{"summary":"Create a field mapping for a ticketing project","description":"Creates field map for a ticketing project","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"ticketing_project_id","type":"string","required":true}],"responses":{"201":{"description":"Creates field map for a ticketing project","schema":{"$ref":"#/definitions/Ticketing_ProjectFieldMapEntity"}}},"tags":["Ticketing"],"operationId":"create_ticketing_field_map"}},"/v1/ticketing/projects/{ticketing_project_id}/field_maps/{map_id}":{"delete":{"summary":"Archive a field map for a ticketing project","description":"Archive field map for a ticketing project","produces":["application/json"],"parameters":[{"in":"path","name":"map_id","type":"string","required":true},{"in":"path","name":"ticketing_project_id","type":"string","required":true}],"responses":{"204":{"description":"Archive field map for a ticketing project"}},"tags":["Ticketing"],"operationId":"delete_ticketing_field_map"},"get":{"summary":"Get a field map for a ticketing project","description":"Retrieve field map for a ticketing project","produces":["application/json"],"parameters":[{"in":"path","name":"map_id","type":"string","required":true},{"in":"path","name":"ticketing_project_id","type":"string","required":true}],"responses":{"200":{"description":"Retrieve field map for a ticketing project","schema":{"$ref":"#/definitions/Ticketing_ProjectFieldMapEntity"}}},"tags":["Ticketing"],"operationId":"get_ticketing_field_map"},"patch":{"summary":"Update a field map for a ticketing project","description":"Update field map for a ticketing project","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"map_id","type":"string","required":true},{"in":"path","name":"ticketing_project_id","type":"string","required":true}],"responses":{"200":{"description":"Update field map for a ticketing project","schema":{"$ref":"#/definitions/Ticketing_ProjectFieldMapEntity"}}},"tags":["Ticketing"],"operationId":"update_ticketing_field_map"}},"/v1/ticketing/projects/{ticketing_project_id}/inbound_field_maps/available_fields":{"get":{"summary":"List available fields for ticket field mapping","description":"Returns metadata for the fields that are available for inbound field mapping.","produces":["application/json"],"parameters":[{"in":"path","name":"ticketing_project_id","type":"string","required":true}],"responses":{"200":{"description":"Returns metadata for the fields that are available for inbound field mapping.","schema":{"$ref":"#/definitions/Ticketing_ProjectInboundMappableFieldEntity"}}},"tags":["Ticketing"],"operationId":"list_available_inbound_field_maps"}},"/v1/ticketing/projects/{ticketing_project_id}/inbound_field_maps":{"get":{"summary":"List inbound field maps for a ticketing project","description":"List all inbound field maps for a ticketing project","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"ticket_type","description":"Filter by ticket type. Values: incident, follow_up","type":"string","enum":["incident","follow_up"],"required":false,"x-nullable":true},{"in":"path","name":"ticketing_project_id","type":"string","required":true}],"responses":{"200":{"description":"List all inbound field maps for a ticketing project","schema":{"$ref":"#/definitions/Ticketing_ProjectInboundFieldMapEntity"}}},"tags":["Ticketing"],"operationId":"list_inbound_field_maps"},"post":{"summary":"Create inbound field map for a ticketing project","description":"Creates inbound field map for a ticketing project","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"ticketing_project_id","type":"string","required":true}],"responses":{"201":{"description":"Creates inbound field map for a ticketing project","schema":{"$ref":"#/definitions/Ticketing_ProjectInboundFieldMapEntity"}}},"tags":["Ticketing"],"operationId":"create_inbound_field_map"}},"/v1/ticketing/projects/{ticketing_project_id}/inbound_field_maps/{map_id}":{"delete":{"summary":"Archive inbound field map for a ticketing project","description":"Archive inbound field map for a ticketing project","produces":["application/json"],"parameters":[{"in":"path","name":"map_id","type":"string","required":true},{"in":"path","name":"ticketing_project_id","type":"string","required":true}],"responses":{"204":{"description":"Archive inbound field map for a ticketing project"}},"tags":["Ticketing"],"operationId":"delete_inbound_field_map"},"put":{"summary":"Update inbound field map for a ticketing project","description":"Update inbound field map for a ticketing project","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"map_id","type":"string","required":true},{"in":"path","name":"ticketing_project_id","type":"string","required":true}],"responses":{"200":{"description":"Update inbound field map for a ticketing project","schema":{"$ref":"#/definitions/Ticketing_ProjectInboundFieldMapEntity"}}},"tags":["Ticketing"],"operationId":"update_inbound_field_map"},"get":{"summary":"Get inbound field map for a ticketing project","description":"Retrieve inbound field map for a ticketing project","produces":["application/json"],"parameters":[{"in":"path","name":"map_id","type":"string","required":true},{"in":"path","name":"ticketing_project_id","type":"string","required":true}],"responses":{"200":{"description":"Retrieve inbound field map for a ticketing project","schema":{"$ref":"#/definitions/Ticketing_ProjectInboundFieldMapEntity"}}},"tags":["Ticketing"],"operationId":"get_inbound_field_map"}},"/v1/ticketing/projects/{ticketing_project_id}/provider_project_configurations":{"post":{"summary":"Create a ticketing project configuration","description":"Creates configuration for a ticketing project","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"ticketing_project_id","type":"string","required":true}],"responses":{"201":{"description":"Creates configuration for a ticketing project","schema":{"$ref":"#/definitions/Ticketing_ProjectConfigEntity"}}},"tags":["Ticketing"],"operationId":"create_ticketing_project_config"}},"/v1/ticketing/projects/{ticketing_project_id}/provider_project_configurations/{config_id}":{"delete":{"summary":"Archive a ticketing project configuration","description":"Archive configuration for a ticketing project","produces":["application/json"],"parameters":[{"in":"path","name":"ticketing_project_id","type":"string","required":true},{"in":"path","name":"config_id","type":"string","required":true}],"responses":{"204":{"description":"Archive configuration for a ticketing project"}},"tags":["Ticketing"],"operationId":"delete_ticketing_project_config"},"patch":{"summary":"Update configuration for a ticketing project","description":"Update configuration for a ticketing project","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"ticketing_project_id","type":"string","required":true},{"in":"path","name":"config_id","type":"string","required":true}],"responses":{"200":{"description":"Update configuration for a ticketing project","schema":{"$ref":"#/definitions/Ticketing_ProjectConfigEntity"}}},"tags":["Ticketing"],"operationId":"update_ticketing_project_config"},"get":{"summary":"Get configuration for a ticketing project","description":"Retrieve configuration for a ticketing project","produces":["application/json"],"parameters":[{"in":"path","name":"ticketing_project_id","type":"string","required":true},{"in":"path","name":"config_id","type":"string","required":true}],"responses":{"200":{"description":"Retrieve configuration for a ticketing project","schema":{"$ref":"#/definitions/Ticketing_ProjectConfigEntity"}}},"tags":["Ticketing"],"operationId":"get_ticketing_project_config"}},"/v1/ticketing/priorities":{"post":{"summary":"Create a ticketing priority","description":"Create a single ticketing priority","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"create_ticketing_priority","in":"body","required":true,"schema":{"$ref":"#/definitions/create_ticketing_priority"}}],"responses":{"201":{"description":"Create a single ticketing priority","schema":{"$ref":"#/definitions/Ticketing_PriorityEntity"}}},"tags":["Ticketing"],"operationId":"create_ticketing_priority"},"get":{"summary":"List ticketing priorities","description":"List all ticketing priorities available to the organization","produces":["application/json"],"responses":{"200":{"description":"List all ticketing priorities available to the organization","schema":{"$ref":"#/definitions/Ticketing_PriorityEntity"}}},"tags":["Ticketing"],"operationId":"list_ticketing_priorities"}},"/v1/ticketing/priorities/{id}":{"delete":{"summary":"Delete a ticketing priority","description":"Delete a single ticketing priority by ID","produces":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true}],"responses":{"204":{"description":"Delete a single ticketing priority by ID"}},"tags":["Ticketing"],"operationId":"delete_ticketing_priority"},"patch":{"summary":"Update a ticketing priority","description":"Update a single ticketing priority's attributes","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true},{"name":"update_ticketing_priority","in":"body","required":true,"schema":{"$ref":"#/definitions/update_ticketing_priority"}}],"responses":{"200":{"description":"Update a single ticketing priority's attributes","schema":{"$ref":"#/definitions/Ticketing_PriorityEntity"}}},"tags":["Ticketing"],"operationId":"update_ticketing_priority"},"get":{"summary":"Get a ticketing priority","description":"Retrieve a single ticketing priority by ID","produces":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true}],"responses":{"200":{"description":"Retrieve a single ticketing priority by ID","schema":{"$ref":"#/definitions/Ticketing_PriorityEntity"}}},"tags":["Ticketing"],"operationId":"get_ticketing_priority"}},"/v1/ticketing/ticket_tags":{"get":{"summary":"List ticket tags","description":"List all of the ticket tags in the organization","produces":["application/json"],"parameters":[{"in":"query","name":"prefix","type":"string","required":false,"x-nullable":true}],"responses":{"200":{"description":"List all of the ticket tags in the organization","schema":{"$ref":"#/definitions/TagEntityPaginated"}}},"tags":["Ticketing"],"operationId":"list_ticket_tags"}},"/v1/ticketing/form_configurations":{"get":{"summary":"Get the ticketing form configuration","description":"Get the ticketing form configuration","produces":["application/json"],"responses":{"200":{"description":"Get the ticketing form configuration","schema":{"$ref":"#/definitions/Ticketing_TicketFormConfigurationEntity"}}},"tags":["Ticketing"],"operationId":"get_ticketing_form_configuration"}},"/v1/ticketing/custom_fields/definitions":{"post":{"summary":"Create a ticketing custom field","description":"Creates a ticketing custom field for the organization","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"create_ticketing_custom_definition","in":"body","required":true,"schema":{"$ref":"#/definitions/create_ticketing_custom_definition"}}],"responses":{"201":{"description":"Creates a ticketing custom field for the organization","schema":{"$ref":"#/definitions/Organizations_TicketingCustomFieldDefinitionEntity"}}},"tags":["Ticketing"],"operationId":"create_ticketing_custom_definition"},"get":{"summary":"List ticketing custom fields","description":"List all ticketing custom fields available to the organization","produces":["application/json"],"responses":{"200":{"description":"List all ticketing custom fields available to the organization","schema":{"$ref":"#/definitions/Organizations_TicketingCustomFieldDefinitionEntity"}}},"tags":["Ticketing"],"operationId":"list_ticketing_custom_definitions"}},"/v1/ticketing/custom_fields/definitions/{field_id}":{"delete":{"summary":"Delete a ticketing custom field","description":"Deletes a ticketing custom field for the organization","produces":["application/json"],"parameters":[{"in":"path","name":"field_id","type":"string","required":true}],"responses":{"204":{"description":"Deletes a ticketing custom field for the organization"}},"tags":["Ticketing"],"operationId":"delete_ticketing_custom_definition"},"patch":{"summary":"Update a ticketing custom field","description":"Update a ticketing custom field for the organization","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"field_id","type":"string","required":true},{"name":"update_ticketing_custom_definition","in":"body","required":true,"schema":{"$ref":"#/definitions/update_ticketing_custom_definition"}}],"responses":{"200":{"description":"Update a ticketing custom field for the organization","schema":{"$ref":"#/definitions/Organizations_TicketingCustomFieldDefinitionEntity"}}},"tags":["Ticketing"],"operationId":"update_ticketing_custom_definition"}},"/v1/task_lists":{"post":{"summary":"Create a task list","description":"Creates a new task list","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"create_task_list","in":"body","required":true,"schema":{"$ref":"#/definitions/create_task_list"}}],"responses":{"201":{"description":"Creates a new task list","schema":{"$ref":"#/definitions/TaskListEntity"}}},"tags":["Tasks"],"operationId":"create_task_list"},"get":{"summary":"List task lists","description":"Lists all task lists for your organization","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"Lists all task lists for your organization","schema":{"$ref":"#/definitions/TaskListEntity"}}},"tags":["Tasks"],"operationId":"list_task_lists"}},"/v1/task_lists/{task_list_id}":{"delete":{"summary":"Delete a task list","description":"Delete a task list","produces":["application/json"],"parameters":[{"in":"path","name":"task_list_id","type":"string","required":true}],"responses":{"204":{"description":"Delete a task list"}},"tags":["Tasks"],"operationId":"delete_task_list"},"patch":{"summary":"Update a task list","description":"Updates a task list's attributes and task list items","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"task_list_id","type":"string","required":true},{"name":"update_task_list","in":"body","required":true,"schema":{"$ref":"#/definitions/update_task_list"}}],"responses":{"200":{"description":"Updates a task list's attributes and task list items","schema":{"$ref":"#/definitions/TaskListEntity"}}},"tags":["Tasks"],"operationId":"update_task_list"},"get":{"summary":"Get a task list","description":"Retrieves a single task list by ID","produces":["application/json"],"parameters":[{"in":"path","name":"task_list_id","type":"string","required":true}],"responses":{"200":{"description":"Retrieves a single task list by ID","schema":{"$ref":"#/definitions/TaskListEntity"}}},"tags":["Tasks"],"operationId":"get_task_list"}},"/v1/noauth/ping":{"get":{"summary":"Check API connectivity","description":"Simple endpoint to verify your API connection is working","produces":["application/json"],"responses":{"200":{"description":"Simple endpoint to verify your API connection is working","schema":{"$ref":"#/definitions/PongEntity"}}},"tags":["Account Settings"],"operationId":"ping_noauth"}},"/v1/scim/v2/Groups/{id}":{"patch":{"summary":"Partially update a SCIM group","description":"SCIM endpoint to partially update a Team (Colloquial for Group in the SCIM protocol). Supports adding, removing, or replacing members using SCIM PATCH operations.","produces":["application/scim+json"],"consumes":["application/scim+json"],"parameters":[{"in":"path","name":"id","type":"string","required":true},{"name":"patch_scim_group","in":"body","required":true,"schema":{"$ref":"#/definitions/patch_scim_group"}}],"responses":{"200":{"description":"SCIM endpoint to partially update a Team (Colloquial for Group in the SCIM protocol). Supports adding, removing, or replacing members using SCIM PATCH operations."}},"tags":["SCIM"],"operationId":"patch_scim_group"},"put":{"summary":"Update a SCIM group and assign members","description":"SCIM endpoint to update a Team (Colloquial for Group in the SCIM protocol). Any members defined in the payload will be assigned to the team with no defined role, any missing members will be removed from the team.","produces":["application/scim+json"],"consumes":["application/scim+json"],"parameters":[{"in":"path","name":"id","type":"string","required":true},{"name":"update_scim_group","in":"body","required":true,"schema":{"$ref":"#/definitions/update_scim_group"}}],"responses":{"200":{"description":"SCIM endpoint to update a Team (Colloquial for Group in the SCIM protocol). Any members defined in the payload will be assigned to the team with no defined role, any missing members will be removed from the team."}},"tags":["SCIM"],"operationId":"update_scim_group"},"delete":{"summary":"Delete a SCIM group","description":"SCIM endpoint to delete a Team (Colloquial for Group in the SCIM protocol).","produces":["application/scim+json"],"parameters":[{"in":"path","name":"id","type":"string","required":true}],"responses":{"204":{"description":"SCIM endpoint to delete a Team (Colloquial for Group in the SCIM protocol)."}},"tags":["SCIM"],"operationId":"delete_scim_group"},"get":{"summary":"Get a SCIM group","description":"SCIM endpoint that lists a Team (Colloquial for Group in the SCIM protocol)","produces":["application/scim+json"],"parameters":[{"in":"path","name":"id","type":"string","required":true}],"responses":{"200":{"description":"SCIM endpoint that lists a Team (Colloquial for Group in the SCIM protocol)"}},"tags":["SCIM"],"operationId":"get_scim_group"}},"/v1/scim/v2/Groups":{"post":{"summary":"Create a SCIM group and assign members","description":"SCIM endpoint to create a new Team (Colloquial for Group in the SCIM protocol). Any members defined in the payload will be assigned to the team with no defined role.","produces":["application/scim+json"],"consumes":["application/scim+json"],"parameters":[{"name":"create_scim_group","in":"body","required":true,"schema":{"$ref":"#/definitions/create_scim_group"}}],"responses":{"201":{"description":"SCIM endpoint to create a new Team (Colloquial for Group in the SCIM protocol). Any members defined in the payload will be assigned to the team with no defined role."}},"tags":["SCIM"],"operationId":"create_scim_group"},"get":{"summary":"List SCIM groups","description":"SCIM endpoint that lists all Teams (Colloquial for Group in the SCIM protocol)","produces":["application/scim+json"],"parameters":[{"in":"query","name":"startIndex","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"count","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"filter","description":"This is a string used to query groups by displayName.\n        Proper example syntax for this would be `?filter=displayName eq \"My Team Name\"`.\n        Currently we only support the `eq` operator","type":"string","required":false,"x-nullable":true}],"responses":{"200":{"description":"SCIM endpoint that lists all Teams (Colloquial for Group in the SCIM protocol)"}},"tags":["SCIM"],"operationId":"list_scim_groups"}},"/v1/scim/v2/Users/{id}":{"delete":{"summary":"Delete a User matching SCIM data","description":"SCIM endpoint to delete a User. This endpoint will deactivate a confirmed User record in our system.","produces":["application/scim+json"],"parameters":[{"in":"path","name":"id","type":"string","required":true}],"responses":{"204":{"description":"SCIM endpoint to delete a User. This endpoint will deactivate a confirmed User record in our system."}},"tags":["SCIM"],"operationId":"delete_scim_user"},"patch":{"summary":"Update a User from SCIM data","description":"PATCH SCIM endpoint to update a User. This endpoint is used to update a resource's attributes.","produces":["application/scim+json"],"consumes":["application/scim+json"],"parameters":[{"in":"path","name":"id","type":"string","required":true},{"name":"patch_scim_user","in":"body","required":true,"schema":{"$ref":"#/definitions/patch_scim_user"}}],"responses":{"200":{"description":"PATCH SCIM endpoint to update a User. This endpoint is used to update a resource's attributes."}},"tags":["SCIM"],"operationId":"patch_scim_user"},"put":{"summary":"Update a User from SCIM data","description":"PUT SCIM endpoint to update a User. This endpoint is used to replace a resource's attributes.","produces":["application/scim+json"],"consumes":["application/scim+json"],"parameters":[{"in":"path","name":"id","type":"string","required":true},{"name":"update_scim_user","in":"body","required":true,"schema":{"$ref":"#/definitions/update_scim_user"}}],"responses":{"200":{"description":"PUT SCIM endpoint to update a User. This endpoint is used to replace a resource's attributes."}},"tags":["SCIM"],"operationId":"update_scim_user"},"get":{"summary":"Get a SCIM user","description":"SCIM endpoint that lists a User","produces":["application/scim+json"],"parameters":[{"in":"path","name":"id","type":"string","required":true}],"responses":{"200":{"description":"SCIM endpoint that lists a User"}},"tags":["SCIM"],"operationId":"get_scim_user"}},"/v1/scim/v2/Users":{"post":{"summary":"Create a User from SCIM data","description":"SCIM endpoint to create and provision a new User. This endpoint will provision the User, which allows them to accept their account throught their IDP or via the Forgot Password flow.","produces":["application/scim+json"],"consumes":["application/scim+json"],"parameters":[{"name":"create_scim_user","in":"body","required":true,"schema":{"$ref":"#/definitions/create_scim_user"}}],"responses":{"201":{"description":"SCIM endpoint to create and provision a new User. This endpoint will provision the User, which allows them to accept their account throught their IDP or via the Forgot Password flow."}},"tags":["SCIM"],"operationId":"create_scim_user"},"get":{"summary":"List SCIM users","description":"SCIM endpoint that lists users. This endpoint will display a list of Users currently in the system.","produces":["application/scim+json"],"parameters":[{"in":"query","name":"filter","description":"This is a string used to query users by either userName or email.\n        Proper example syntax for this would be `?filter=userName eq john` or `?filter=userName eq \"john@firehydrant.com\"`.\n        Currently we only support the `eq` operator","type":"string","required":false,"x-nullable":true},{"in":"query","name":"startIndex","description":"This is an integer which represents a pagination offset","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"count","description":"This is an integer which represents the number of items per page in the response","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"SCIM endpoint that lists users. This endpoint will display a list of Users currently in the system."}},"tags":["SCIM"],"operationId":"list_scim_users"}},"/v1/catalogs/{catalog_id}/refresh":{"get":{"summary":"Refresh a service catalog","description":"Schedules an async task to re-import catalog info and update catalog data accordingly.","produces":["application/json"],"parameters":[{"in":"path","name":"catalog_id","type":"string","required":true}],"responses":{"200":{"description":"Schedules an async task to re-import catalog info and update catalog data accordingly."}},"tags":["Catalog Entries"],"operationId":"refresh_catalog"}},"/v1/catalogs/{catalog_id}/ingest":{"post":{"summary":"Ingest service catalog data","description":"Accepts catalog data in the configured format and asyncronously processes the data to incorporate changes into service catalog.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"catalog_id","type":"string","required":true},{"name":"ingest_catalog_data","in":"body","required":true,"schema":{"$ref":"#/definitions/ingest_catalog_data"}}],"responses":{"201":{"description":"Accepts catalog data in the configured format and asyncronously processes the data to incorporate changes into service catalog.","schema":{"$ref":"#/definitions/Imports_ImportEntity"}}},"tags":["Catalog Entries"],"operationId":"ingest_catalog_data"}},"/v1/checklist_templates":{"post":{"summary":"Create a checklist template","description":"Creates a checklist template for the organization","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"create_checklist_template","in":"body","required":true,"schema":{"$ref":"#/definitions/create_checklist_template"}}],"responses":{"201":{"description":"Creates a checklist template for the organization","schema":{"$ref":"#/definitions/ChecklistTemplateEntity"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ErrorEntity"}}},"tags":["Tasks"],"operationId":"create_checklist_template"},"get":{"summary":"List checklist templates","description":"List all of the checklist templates that have been added to the organization","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"query","description":"A query to search checklist templates by their name","type":"string","required":false,"x-nullable":true}],"responses":{"200":{"description":"List all of the checklist templates that have been added to the organization","schema":{"$ref":"#/definitions/ChecklistTemplateEntityPaginated"}}},"tags":["Tasks"],"operationId":"list_checklist_templates"}},"/v1/checklist_templates/{id}":{"delete":{"summary":"Archive a checklist template","description":"Archive a checklist template","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Checklist Template UUID","type":"string","required":true}],"responses":{"204":{"description":"Archive a checklist template"}},"tags":["Tasks"],"operationId":"delete_checklist_template"},"patch":{"summary":"Update a checklist template","description":"Update a checklist templates attributes","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true},{"name":"update_checklist_template","in":"body","required":true,"schema":{"$ref":"#/definitions/update_checklist_template"}}],"responses":{"200":{"description":"Update a checklist templates attributes","schema":{"$ref":"#/definitions/ChecklistTemplateEntity"}}},"tags":["Tasks"],"operationId":"update_checklist_template"},"get":{"summary":"Get a checklist template","description":"Retrieves a single checklist template by ID","produces":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true}],"responses":{"200":{"description":"Retrieves a single checklist template by ID","schema":{"$ref":"#/definitions/ChecklistTemplateEntity"}}},"tags":["Tasks"],"operationId":"get_checklist_template"}},"/v1/bootstrap":{"get":{"summary":"Get initial application configuration","description":"Get initial application configuration","produces":["application/json"],"responses":{"200":{"description":"Get initial application configuration","schema":{"$ref":"#/definitions/PublicAPI_V1_BootstrapEntity"}}},"tags":["Account Settings"],"operationId":"get_bootstrap"}},"/v1/form_configurations/{slug}/append_data_on_select/{field_id}/{selected_value}":{"get":{"summary":"Get data for a form field on select","description":"Get data for a form field on select that should be appended to a form by using a template","produces":["application/json"],"parameters":[{"in":"path","name":"slug","type":"string","required":true},{"in":"path","name":"field_id","type":"string","required":true},{"in":"path","name":"selected_value","type":"string","required":true}],"responses":{"200":{"description":"Get data for a form field on select that should be appended to a form by using a template","schema":{"$ref":"#/definitions/PublicAPI_V1_FormConfigurations_SelectedValueEntity"}}},"tags":["Incident Settings"],"operationId":"append_form_data_on_selected_value_get"}},"/v1/form_configurations/{slug}":{"get":{"summary":"Get a form configuration","description":"Get a form configuration","produces":["application/json"],"parameters":[{"in":"path","name":"slug","type":"string","required":true}],"responses":{"200":{"description":"Get a form configuration","schema":{"$ref":"#/definitions/FormConfigurationEntity"}}},"tags":["Incident Settings"],"operationId":"get_form_configuration"}},"/v1/conversations/{conversation_id}/comments/{comment_id}/reactions/{reaction_id}":{"delete":{"summary":"Delete a reaction from a conversation comment","description":"Archive a reaction","produces":["application/json"],"parameters":[{"in":"path","name":"reaction_id","type":"string","required":true},{"in":"path","name":"conversation_id","type":"string","required":true},{"in":"path","name":"comment_id","type":"string","required":true}],"responses":{"204":{"description":"Archive a reaction"}},"tags":["Conversations"],"operationId":"delete_comment_reaction"}},"/v1/conversations/{conversation_id}/comments/{comment_id}/reactions":{"post":{"summary":"Create a reaction for a conversation comment","description":"Create a reaction on a comment","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"conversation_id","type":"string","required":true},{"in":"path","name":"comment_id","type":"string","required":true},{"name":"create_comment_reaction","in":"body","required":true,"schema":{"$ref":"#/definitions/create_comment_reaction"}}],"responses":{"201":{"description":"Create a reaction on a comment"}},"tags":["Conversations"],"operationId":"create_comment_reaction"},"get":{"summary":"List reactions for a conversation comment","description":"List all of the reactions that have been added to a comment","produces":["application/json"],"parameters":[{"in":"path","name":"conversation_id","type":"string","required":true},{"in":"path","name":"comment_id","type":"string","required":true}],"responses":{"200":{"description":"List all of the reactions that have been added to a comment"}},"tags":["Conversations"],"operationId":"list_comment_reactions"}},"/v1/conversations/{conversation_id}/comments/{comment_id}":{"delete":{"summary":"Archive a conversation comment","description":"Archive a comment","produces":["application/json"],"parameters":[{"in":"path","name":"comment_id","type":"string","required":true},{"in":"path","name":"conversation_id","type":"string","required":true}],"responses":{"204":{"description":"Archive a comment"}},"tags":["Conversations"],"operationId":"delete_comment"},"patch":{"summary":"Update a conversation comment","description":"Update a comment's attributes","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"comment_id","type":"string","required":true},{"in":"path","name":"conversation_id","type":"string","required":true},{"name":"update_comment","in":"body","required":true,"schema":{"$ref":"#/definitions/update_comment"}}],"responses":{"200":{"description":"Update a comment's attributes"}},"tags":["Conversations"],"operationId":"update_comment"},"get":{"summary":"Get a conversation comment","description":"Retrieves a single comment by ID","produces":["application/json"],"parameters":[{"in":"path","name":"comment_id","type":"string","required":true},{"in":"path","name":"conversation_id","type":"string","required":true}],"responses":{"200":{"description":"Retrieves a single comment by ID"}},"tags":["Conversations"],"operationId":"get_comment"}},"/v1/conversations/{conversation_id}/comments":{"post":{"summary":"Create a conversation comment","description":"Creates a comment for a project","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"conversation_id","type":"string","required":true},{"name":"create_comment","in":"body","required":true,"schema":{"$ref":"#/definitions/create_comment"}}],"responses":{"201":{"description":"Creates a comment for a project"}},"tags":["Conversations"],"operationId":"create_comment"},"get":{"summary":"List comments for a conversation","description":"List all of the comments that have been added to the organization","produces":["application/json"],"parameters":[{"in":"query","name":"before","description":"An ISO8601 timestamp that allows filtering for comments posted before the provided time.","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"after","description":"An ISO8601 timestamp that allows filtering for comments posted after the provided time.","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"sort","description":"Allows sorting comments by the time they were posted, ascending or descending.","type":"string","default":"asc","enum":["asc","desc"],"required":false,"x-nullable":true},{"in":"path","name":"conversation_id","type":"string","required":true}],"responses":{"200":{"description":"List all of the comments that have been added to the organization"}},"tags":["Conversations"],"operationId":"list_comments"}},"/v1/signals/alerts/{id}":{"patch":{"summary":"Update a Signal alert","description":"Update a Signal alert","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true},{"name":"update_signals_alert","in":"body","required":true,"schema":{"$ref":"#/definitions/update_signals_alert"}}],"responses":{"200":{"description":"Update a Signal alert","schema":{"$ref":"#/definitions/Alerts_SignalAlertEntity"}}},"tags":["Alerts"],"operationId":"update_signals_alert"}},"/v1/signals/analytics/timeseries":{"get":{"summary":"Generate timeseries alert metrics","description":"Generate a timeseries-based report of metrics for Signals alerts","produces":["application/json"],"parameters":[{"in":"query","name":"bucket","description":"String that determines how records are grouped","type":"string","enum":["month","week","day"],"required":false,"x-nullable":true},{"in":"query","name":"signal_rules","description":"A comma separated list of signal rule IDs","type":"string","required":false,"x-nullable":true},{"in":"query","name":"teams","description":"A comma separated list of team IDs","type":"string","required":false,"x-nullable":true},{"in":"query","name":"environments","description":"A comma separated list of environment IDs","type":"string","required":false,"x-nullable":true},{"in":"query","name":"services","description":"A comma separated list of service IDs","type":"string","required":false,"x-nullable":true},{"in":"query","name":"tags","description":"A comma separated list of tags","type":"string","required":false,"x-nullable":true},{"in":"query","name":"users","description":"A comma separated list of user IDs","type":"string","required":false,"x-nullable":true},{"in":"query","name":"group_by","description":"String that determines how records are grouped","type":"string","enum":["signal_rules","teams","services","environments","tags"],"required":false,"x-nullable":true},{"in":"query","name":"sort_by","description":"String that determines how records are sorted","type":"string","enum":["total_opened_alerts","total_acked_alerts","total_incidents","total_billable_alerts","total_resolved_alerts","acked_percentage","incidents_percentage"],"required":false,"x-nullable":true},{"in":"query","name":"sort_direction","description":"String that determines how records are sorted","type":"string","enum":["asc","desc"],"required":false,"x-nullable":true},{"in":"query","name":"start_date","description":"The start date to return metrics from","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"end_date","description":"The end date to return metrics from","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"timezone","description":"The IANA timezone in which the start and end dates are read as whole days. Defaults to UTC","type":"string","enum":["Africa/Abidjan","Africa/Accra","Africa/Addis_Ababa","Africa/Algiers","Africa/Asmara","Africa/Asmera","Africa/Bamako","Africa/Bangui","Africa/Banjul","Africa/Bissau","Africa/Blantyre","Africa/Brazzaville","Africa/Bujumbura","Africa/Cairo","Africa/Casablanca","Africa/Ceuta","Africa/Conakry","Africa/Dakar","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Douala","Africa/El_Aaiun","Africa/Freetown","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Juba","Africa/Kampala","Africa/Khartoum","Africa/Kigali","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Lome","Africa/Luanda","Africa/Lubumbashi","Africa/Lusaka","Africa/Malabo","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Mogadishu","Africa/Monrovia","Africa/Nairobi","Africa/Ndjamena","Africa/Niamey","Africa/Nouakchott","Africa/Ouagadougou","Africa/Porto-Novo","Africa/Sao_Tome","Africa/Timbuktu","Africa/Tripoli","Africa/Tunis","Africa/Windhoek","America/Adak","America/Anchorage","America/Anguilla","America/Antigua","America/Araguaina","America/Argentina/Buenos_Aires","America/Argentina/Catamarca","America/Argentina/ComodRivadavia","America/Argentina/Cordoba","America/Argentina/Jujuy","America/Argentina/La_Rioja","America/Argentina/Mendoza","America/Argentina/Rio_Gallegos","America/Argentina/Salta","America/Argentina/San_Juan","America/Argentina/San_Luis","America/Argentina/Tucuman","America/Argentina/Ushuaia","America/Aruba","America/Asuncion","America/Atikokan","America/Atka","America/Bahia","America/Bahia_Banderas","America/Barbados","America/Belem","America/Belize","America/Blanc-Sablon","America/Boa_Vista","America/Bogota","America/Boise","America/Buenos_Aires","America/Cambridge_Bay","America/Campo_Grande","America/Cancun","America/Caracas","America/Catamarca","America/Cayenne","America/Cayman","America/Chicago","America/Chihuahua","America/Ciudad_Juarez","America/Coral_Harbour","America/Cordoba","America/Costa_Rica","America/Coyhaique","America/Creston","America/Cuiaba","America/Curacao","America/Danmarkshavn","America/Dawson","America/Dawson_Creek","America/Denver","America/Detroit","America/Dominica","America/Edmonton","America/Eirunepe","America/El_Salvador","America/Ensenada","America/Fort_Nelson","America/Fort_Wayne","America/Fortaleza","America/Glace_Bay","America/Godthab","America/Goose_Bay","America/Grand_Turk","America/Grenada","America/Guadeloupe","America/Guatemala","America/Guayaquil","America/Guyana","America/Halifax","America/Havana","America/Hermosillo","America/Indiana/Indianapolis","America/Indiana/Knox","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Tell_City","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Indianapolis","America/Inuvik","America/Iqaluit","America/Jamaica","America/Jujuy","America/Juneau","America/Kentucky/Louisville","America/Kentucky/Monticello","America/Knox_IN","America/Kralendijk","America/La_Paz","America/Lima","America/Los_Angeles","America/Louisville","America/Lower_Princes","America/Maceio","America/Managua","America/Manaus","America/Marigot","America/Martinique","America/Matamoros","America/Mazatlan","America/Mendoza","America/Menominee","America/Merida","America/Metlakatla","America/Mexico_City","America/Miquelon","America/Moncton","America/Monterrey","America/Montevideo","America/Montreal","America/Montserrat","America/Nassau","America/New_York","America/Nipigon","America/Nome","America/Noronha","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","America/Nuuk","America/Ojinaga","America/Panama","America/Pangnirtung","America/Paramaribo","America/Phoenix","America/Port-au-Prince","America/Port_of_Spain","America/Porto_Acre","America/Porto_Velho","America/Puerto_Rico","America/Punta_Arenas","America/Rainy_River","America/Rankin_Inlet","America/Recife","America/Regina","America/Resolute","America/Rio_Branco","America/Rosario","America/Santa_Isabel","America/Santarem","America/Santiago","America/Santo_Domingo","America/Sao_Paulo","America/Scoresbysund","America/Shiprock","America/Sitka","America/St_Barthelemy","America/St_Johns","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Swift_Current","America/Tegucigalpa","America/Thule","America/Thunder_Bay","America/Tijuana","America/Toronto","America/Tortola","America/Vancouver","America/Virgin","America/Whitehorse","America/Winnipeg","America/Yakutat","America/Yellowknife","Antarctica/Casey","Antarctica/Davis","Antarctica/DumontDUrville","Antarctica/Macquarie","Antarctica/Mawson","Antarctica/McMurdo","Antarctica/Palmer","Antarctica/Rothera","Antarctica/South_Pole","Antarctica/Syowa","Antarctica/Troll","Antarctica/Vostok","Arctic/Longyearbyen","Asia/Aden","Asia/Almaty","Asia/Amman","Asia/Anadyr","Asia/Aqtau","Asia/Aqtobe","Asia/Ashgabat","Asia/Ashkhabad","Asia/Atyrau","Asia/Baghdad","Asia/Bahrain","Asia/Baku","Asia/Bangkok","Asia/Barnaul","Asia/Beirut","Asia/Bishkek","Asia/Brunei","Asia/Calcutta","Asia/Chita","Asia/Choibalsan","Asia/Chongqing","Asia/Chungking","Asia/Colombo","Asia/Dacca","Asia/Damascus","Asia/Dhaka","Asia/Dili","Asia/Dubai","Asia/Dushanbe","Asia/Famagusta","Asia/Gaza","Asia/Harbin","Asia/Hebron","Asia/Ho_Chi_Minh","Asia/Hong_Kong","Asia/Hovd","Asia/Irkutsk","Asia/Istanbul","Asia/Jakarta","Asia/Jayapura","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Kashgar","Asia/Kathmandu","Asia/Katmandu","Asia/Khandyga","Asia/Kolkata","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Kuwait","Asia/Macao","Asia/Macau","Asia/Magadan","Asia/Makassar","Asia/Manila","Asia/Muscat","Asia/Nicosia","Asia/Novokuznetsk","Asia/Novosibirsk","Asia/Omsk","Asia/Oral","Asia/Phnom_Penh","Asia/Pontianak","Asia/Pyongyang","Asia/Qatar","Asia/Qostanay","Asia/Qyzylorda","Asia/Rangoon","Asia/Riyadh","Asia/Saigon","Asia/Sakhalin","Asia/Samarkand","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Tel_Aviv","Asia/Thimbu","Asia/Thimphu","Asia/Tokyo","Asia/Tomsk","Asia/Ujung_Pandang","Asia/Ulaanbaatar","Asia/Ulan_Bator","Asia/Urumqi","Asia/Ust-Nera","Asia/Vientiane","Asia/Vladivostok","Asia/Yakutsk","Asia/Yangon","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Bermuda","Atlantic/Canary","Atlantic/Cape_Verde","Atlantic/Faeroe","Atlantic/Faroe","Atlantic/Jan_Mayen","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/South_Georgia","Atlantic/St_Helena","Atlantic/Stanley","Australia/ACT","Australia/Adelaide","Australia/Brisbane","Australia/Broken_Hill","Australia/Canberra","Australia/Currie","Australia/Darwin","Australia/Eucla","Australia/Hobart","Australia/LHI","Australia/Lindeman","Australia/Lord_Howe","Australia/Melbourne","Australia/NSW","Australia/North","Australia/Perth","Australia/Queensland","Australia/South","Australia/Sydney","Australia/Tasmania","Australia/Victoria","Australia/West","Australia/Yancowinna","Brazil/Acre","Brazil/DeNoronha","Brazil/East","Brazil/West","CET","CST6CDT","Canada/Atlantic","Canada/Central","Canada/Eastern","Canada/Mountain","Canada/Newfoundland","Canada/Pacific","Canada/Saskatchewan","Canada/Yukon","Chile/Continental","Chile/EasterIsland","Cuba","EET","EST","EST5EDT","Egypt","Eire","Etc/GMT","Etc/GMT+0","Etc/GMT+1","Etc/GMT+10","Etc/GMT+11","Etc/GMT+12","Etc/GMT+2","Etc/GMT+3","Etc/GMT+4","Etc/GMT+5","Etc/GMT+6","Etc/GMT+7","Etc/GMT+8","Etc/GMT+9","Etc/GMT-0","Etc/GMT-1","Etc/GMT-10","Etc/GMT-11","Etc/GMT-12","Etc/GMT-13","Etc/GMT-14","Etc/GMT-2","Etc/GMT-3","Etc/GMT-4","Etc/GMT-5","Etc/GMT-6","Etc/GMT-7","Etc/GMT-8","Etc/GMT-9","Etc/GMT0","Etc/Greenwich","Etc/UCT","Etc/UTC","Etc/Universal","Etc/Zulu","Europe/Amsterdam","Europe/Andorra","Europe/Astrakhan","Europe/Athens","Europe/Belfast","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Busingen","Europe/Chisinau","Europe/Copenhagen","Europe/Dublin","Europe/Gibraltar","Europe/Guernsey","Europe/Helsinki","Europe/Isle_of_Man","Europe/Istanbul","Europe/Jersey","Europe/Kaliningrad","Europe/Kiev","Europe/Kirov","Europe/Kyiv","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Mariehamn","Europe/Minsk","Europe/Monaco","Europe/Moscow","Europe/Nicosia","Europe/Oslo","Europe/Paris","Europe/Podgorica","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/San_Marino","Europe/Sarajevo","Europe/Saratov","Europe/Simferopol","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Tirane","Europe/Tiraspol","Europe/Ulyanovsk","Europe/Uzhgorod","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zaporozhye","Europe/Zurich","Factory","GB","GB-Eire","GMT","GMT+0","GMT-0","GMT0","Greenwich","HST","Hongkong","Iceland","Indian/Antananarivo","Indian/Chagos","Indian/Christmas","Indian/Cocos","Indian/Comoro","Indian/Kerguelen","Indian/Mahe","Indian/Maldives","Indian/Mauritius","Indian/Mayotte","Indian/Reunion","Iran","Israel","Jamaica","Japan","Kwajalein","Libya","MET","MST","MST7MDT","Mexico/BajaNorte","Mexico/BajaSur","Mexico/General","NZ","NZ-CHAT","Navajo","PRC","PST8PDT","Pacific/Apia","Pacific/Auckland","Pacific/Bougainville","Pacific/Chatham","Pacific/Chuuk","Pacific/Easter","Pacific/Efate","Pacific/Enderbury","Pacific/Fakaofo","Pacific/Fiji","Pacific/Funafuti","Pacific/Galapagos","Pacific/Gambier","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Johnston","Pacific/Kanton","Pacific/Kiritimati","Pacific/Kosrae","Pacific/Kwajalein","Pacific/Majuro","Pacific/Marquesas","Pacific/Midway","Pacific/Nauru","Pacific/Niue","Pacific/Norfolk","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Palau","Pacific/Pitcairn","Pacific/Pohnpei","Pacific/Ponape","Pacific/Port_Moresby","Pacific/Rarotonga","Pacific/Saipan","Pacific/Samoa","Pacific/Tahiti","Pacific/Tarawa","Pacific/Tongatapu","Pacific/Truk","Pacific/Wake","Pacific/Wallis","Pacific/Yap","Poland","Portugal","ROC","ROK","Singapore","Turkey","UCT","US/Alaska","US/Aleutian","US/Arizona","US/Central","US/East-Indiana","US/Eastern","US/Hawaii","US/Indiana-Starke","US/Michigan","US/Mountain","US/Pacific","US/Samoa","UTC","Universal","W-SU","WET","Zulu"],"required":false,"x-nullable":true}],"responses":{"200":{"description":"Generate a timeseries-based report of metrics for Signals alerts","schema":{"$ref":"#/definitions/Signals_API_Analytics_TimeseriesPointEntity"}}},"tags":["Metrics/Reporting"],"operationId":"get_signals_timeseries_analytics"}},"/v1/signals/analytics/grouped_metrics":{"get":{"summary":"Generate grouped alert metrics","description":"Generate a report of grouped metrics for Signals alerts","produces":["application/json"],"parameters":[{"in":"query","name":"signal_rules","description":"A comma separated list of signal rule IDs","type":"string","required":false,"x-nullable":true},{"in":"query","name":"teams","description":"A comma separated list of team IDs","type":"string","required":false,"x-nullable":true},{"in":"query","name":"environments","description":"A comma separated list of environment IDs","type":"string","required":false,"x-nullable":true},{"in":"query","name":"services","description":"A comma separated list of service IDs","type":"string","required":false,"x-nullable":true},{"in":"query","name":"tags","description":"A comma separated list of tags","type":"string","required":false,"x-nullable":true},{"in":"query","name":"users","description":"A comma separated list of user IDs","type":"string","required":false,"x-nullable":true},{"in":"query","name":"group_by","description":"String that determines how records are grouped","type":"string","enum":["signal_rules","teams","services","environments","tags"],"required":false,"x-nullable":true},{"in":"query","name":"sort_by","description":"String that determines how records are sorted","type":"string","enum":["total_opened_alerts","total_acked_alerts","total_incidents","total_billable_alerts","total_resolved_alerts","acked_percentage","incidents_percentage"],"required":false,"x-nullable":true},{"in":"query","name":"sort_direction","description":"String that determines how records are sorted","type":"string","enum":["asc","desc"],"required":false,"x-nullable":true},{"in":"query","name":"start_date","description":"The start date to return metrics from","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"end_date","description":"The end date to return metrics from","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"timezone","description":"The IANA timezone in which the start and end dates are read as whole days. Defaults to UTC","type":"string","enum":["Africa/Abidjan","Africa/Accra","Africa/Addis_Ababa","Africa/Algiers","Africa/Asmara","Africa/Asmera","Africa/Bamako","Africa/Bangui","Africa/Banjul","Africa/Bissau","Africa/Blantyre","Africa/Brazzaville","Africa/Bujumbura","Africa/Cairo","Africa/Casablanca","Africa/Ceuta","Africa/Conakry","Africa/Dakar","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Douala","Africa/El_Aaiun","Africa/Freetown","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Juba","Africa/Kampala","Africa/Khartoum","Africa/Kigali","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Lome","Africa/Luanda","Africa/Lubumbashi","Africa/Lusaka","Africa/Malabo","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Mogadishu","Africa/Monrovia","Africa/Nairobi","Africa/Ndjamena","Africa/Niamey","Africa/Nouakchott","Africa/Ouagadougou","Africa/Porto-Novo","Africa/Sao_Tome","Africa/Timbuktu","Africa/Tripoli","Africa/Tunis","Africa/Windhoek","America/Adak","America/Anchorage","America/Anguilla","America/Antigua","America/Araguaina","America/Argentina/Buenos_Aires","America/Argentina/Catamarca","America/Argentina/ComodRivadavia","America/Argentina/Cordoba","America/Argentina/Jujuy","America/Argentina/La_Rioja","America/Argentina/Mendoza","America/Argentina/Rio_Gallegos","America/Argentina/Salta","America/Argentina/San_Juan","America/Argentina/San_Luis","America/Argentina/Tucuman","America/Argentina/Ushuaia","America/Aruba","America/Asuncion","America/Atikokan","America/Atka","America/Bahia","America/Bahia_Banderas","America/Barbados","America/Belem","America/Belize","America/Blanc-Sablon","America/Boa_Vista","America/Bogota","America/Boise","America/Buenos_Aires","America/Cambridge_Bay","America/Campo_Grande","America/Cancun","America/Caracas","America/Catamarca","America/Cayenne","America/Cayman","America/Chicago","America/Chihuahua","America/Ciudad_Juarez","America/Coral_Harbour","America/Cordoba","America/Costa_Rica","America/Coyhaique","America/Creston","America/Cuiaba","America/Curacao","America/Danmarkshavn","America/Dawson","America/Dawson_Creek","America/Denver","America/Detroit","America/Dominica","America/Edmonton","America/Eirunepe","America/El_Salvador","America/Ensenada","America/Fort_Nelson","America/Fort_Wayne","America/Fortaleza","America/Glace_Bay","America/Godthab","America/Goose_Bay","America/Grand_Turk","America/Grenada","America/Guadeloupe","America/Guatemala","America/Guayaquil","America/Guyana","America/Halifax","America/Havana","America/Hermosillo","America/Indiana/Indianapolis","America/Indiana/Knox","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Tell_City","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Indianapolis","America/Inuvik","America/Iqaluit","America/Jamaica","America/Jujuy","America/Juneau","America/Kentucky/Louisville","America/Kentucky/Monticello","America/Knox_IN","America/Kralendijk","America/La_Paz","America/Lima","America/Los_Angeles","America/Louisville","America/Lower_Princes","America/Maceio","America/Managua","America/Manaus","America/Marigot","America/Martinique","America/Matamoros","America/Mazatlan","America/Mendoza","America/Menominee","America/Merida","America/Metlakatla","America/Mexico_City","America/Miquelon","America/Moncton","America/Monterrey","America/Montevideo","America/Montreal","America/Montserrat","America/Nassau","America/New_York","America/Nipigon","America/Nome","America/Noronha","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","America/Nuuk","America/Ojinaga","America/Panama","America/Pangnirtung","America/Paramaribo","America/Phoenix","America/Port-au-Prince","America/Port_of_Spain","America/Porto_Acre","America/Porto_Velho","America/Puerto_Rico","America/Punta_Arenas","America/Rainy_River","America/Rankin_Inlet","America/Recife","America/Regina","America/Resolute","America/Rio_Branco","America/Rosario","America/Santa_Isabel","America/Santarem","America/Santiago","America/Santo_Domingo","America/Sao_Paulo","America/Scoresbysund","America/Shiprock","America/Sitka","America/St_Barthelemy","America/St_Johns","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Swift_Current","America/Tegucigalpa","America/Thule","America/Thunder_Bay","America/Tijuana","America/Toronto","America/Tortola","America/Vancouver","America/Virgin","America/Whitehorse","America/Winnipeg","America/Yakutat","America/Yellowknife","Antarctica/Casey","Antarctica/Davis","Antarctica/DumontDUrville","Antarctica/Macquarie","Antarctica/Mawson","Antarctica/McMurdo","Antarctica/Palmer","Antarctica/Rothera","Antarctica/South_Pole","Antarctica/Syowa","Antarctica/Troll","Antarctica/Vostok","Arctic/Longyearbyen","Asia/Aden","Asia/Almaty","Asia/Amman","Asia/Anadyr","Asia/Aqtau","Asia/Aqtobe","Asia/Ashgabat","Asia/Ashkhabad","Asia/Atyrau","Asia/Baghdad","Asia/Bahrain","Asia/Baku","Asia/Bangkok","Asia/Barnaul","Asia/Beirut","Asia/Bishkek","Asia/Brunei","Asia/Calcutta","Asia/Chita","Asia/Choibalsan","Asia/Chongqing","Asia/Chungking","Asia/Colombo","Asia/Dacca","Asia/Damascus","Asia/Dhaka","Asia/Dili","Asia/Dubai","Asia/Dushanbe","Asia/Famagusta","Asia/Gaza","Asia/Harbin","Asia/Hebron","Asia/Ho_Chi_Minh","Asia/Hong_Kong","Asia/Hovd","Asia/Irkutsk","Asia/Istanbul","Asia/Jakarta","Asia/Jayapura","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Kashgar","Asia/Kathmandu","Asia/Katmandu","Asia/Khandyga","Asia/Kolkata","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Kuwait","Asia/Macao","Asia/Macau","Asia/Magadan","Asia/Makassar","Asia/Manila","Asia/Muscat","Asia/Nicosia","Asia/Novokuznetsk","Asia/Novosibirsk","Asia/Omsk","Asia/Oral","Asia/Phnom_Penh","Asia/Pontianak","Asia/Pyongyang","Asia/Qatar","Asia/Qostanay","Asia/Qyzylorda","Asia/Rangoon","Asia/Riyadh","Asia/Saigon","Asia/Sakhalin","Asia/Samarkand","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Tel_Aviv","Asia/Thimbu","Asia/Thimphu","Asia/Tokyo","Asia/Tomsk","Asia/Ujung_Pandang","Asia/Ulaanbaatar","Asia/Ulan_Bator","Asia/Urumqi","Asia/Ust-Nera","Asia/Vientiane","Asia/Vladivostok","Asia/Yakutsk","Asia/Yangon","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Bermuda","Atlantic/Canary","Atlantic/Cape_Verde","Atlantic/Faeroe","Atlantic/Faroe","Atlantic/Jan_Mayen","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/South_Georgia","Atlantic/St_Helena","Atlantic/Stanley","Australia/ACT","Australia/Adelaide","Australia/Brisbane","Australia/Broken_Hill","Australia/Canberra","Australia/Currie","Australia/Darwin","Australia/Eucla","Australia/Hobart","Australia/LHI","Australia/Lindeman","Australia/Lord_Howe","Australia/Melbourne","Australia/NSW","Australia/North","Australia/Perth","Australia/Queensland","Australia/South","Australia/Sydney","Australia/Tasmania","Australia/Victoria","Australia/West","Australia/Yancowinna","Brazil/Acre","Brazil/DeNoronha","Brazil/East","Brazil/West","CET","CST6CDT","Canada/Atlantic","Canada/Central","Canada/Eastern","Canada/Mountain","Canada/Newfoundland","Canada/Pacific","Canada/Saskatchewan","Canada/Yukon","Chile/Continental","Chile/EasterIsland","Cuba","EET","EST","EST5EDT","Egypt","Eire","Etc/GMT","Etc/GMT+0","Etc/GMT+1","Etc/GMT+10","Etc/GMT+11","Etc/GMT+12","Etc/GMT+2","Etc/GMT+3","Etc/GMT+4","Etc/GMT+5","Etc/GMT+6","Etc/GMT+7","Etc/GMT+8","Etc/GMT+9","Etc/GMT-0","Etc/GMT-1","Etc/GMT-10","Etc/GMT-11","Etc/GMT-12","Etc/GMT-13","Etc/GMT-14","Etc/GMT-2","Etc/GMT-3","Etc/GMT-4","Etc/GMT-5","Etc/GMT-6","Etc/GMT-7","Etc/GMT-8","Etc/GMT-9","Etc/GMT0","Etc/Greenwich","Etc/UCT","Etc/UTC","Etc/Universal","Etc/Zulu","Europe/Amsterdam","Europe/Andorra","Europe/Astrakhan","Europe/Athens","Europe/Belfast","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Busingen","Europe/Chisinau","Europe/Copenhagen","Europe/Dublin","Europe/Gibraltar","Europe/Guernsey","Europe/Helsinki","Europe/Isle_of_Man","Europe/Istanbul","Europe/Jersey","Europe/Kaliningrad","Europe/Kiev","Europe/Kirov","Europe/Kyiv","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Mariehamn","Europe/Minsk","Europe/Monaco","Europe/Moscow","Europe/Nicosia","Europe/Oslo","Europe/Paris","Europe/Podgorica","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/San_Marino","Europe/Sarajevo","Europe/Saratov","Europe/Simferopol","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Tirane","Europe/Tiraspol","Europe/Ulyanovsk","Europe/Uzhgorod","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zaporozhye","Europe/Zurich","Factory","GB","GB-Eire","GMT","GMT+0","GMT-0","GMT0","Greenwich","HST","Hongkong","Iceland","Indian/Antananarivo","Indian/Chagos","Indian/Christmas","Indian/Cocos","Indian/Comoro","Indian/Kerguelen","Indian/Mahe","Indian/Maldives","Indian/Mauritius","Indian/Mayotte","Indian/Reunion","Iran","Israel","Jamaica","Japan","Kwajalein","Libya","MET","MST","MST7MDT","Mexico/BajaNorte","Mexico/BajaSur","Mexico/General","NZ","NZ-CHAT","Navajo","PRC","PST8PDT","Pacific/Apia","Pacific/Auckland","Pacific/Bougainville","Pacific/Chatham","Pacific/Chuuk","Pacific/Easter","Pacific/Efate","Pacific/Enderbury","Pacific/Fakaofo","Pacific/Fiji","Pacific/Funafuti","Pacific/Galapagos","Pacific/Gambier","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Johnston","Pacific/Kanton","Pacific/Kiritimati","Pacific/Kosrae","Pacific/Kwajalein","Pacific/Majuro","Pacific/Marquesas","Pacific/Midway","Pacific/Nauru","Pacific/Niue","Pacific/Norfolk","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Palau","Pacific/Pitcairn","Pacific/Pohnpei","Pacific/Ponape","Pacific/Port_Moresby","Pacific/Rarotonga","Pacific/Saipan","Pacific/Samoa","Pacific/Tahiti","Pacific/Tarawa","Pacific/Tongatapu","Pacific/Truk","Pacific/Wake","Pacific/Wallis","Pacific/Yap","Poland","Portugal","ROC","ROK","Singapore","Turkey","UCT","US/Alaska","US/Aleutian","US/Arizona","US/Central","US/East-Indiana","US/Eastern","US/Hawaii","US/Indiana-Starke","US/Michigan","US/Mountain","US/Pacific","US/Samoa","UTC","Universal","W-SU","WET","Zulu"],"required":false,"x-nullable":true}],"responses":{"200":{"description":"Generate a report of grouped metrics for Signals alerts","schema":{"$ref":"#/definitions/Signals_API_Analytics_GroupedMetricsEntity"}}},"tags":["Metrics/Reporting"],"operationId":"get_signals_grouped_metrics"}},"/v1/signals/analytics/mttx":{"get":{"summary":"Get MTTX analytics for signals","description":"Get mean-time-to-acknowledged (MTTA) and mean-time-to-resolved (MTTR) metrics for Signals alerts","produces":["application/json"],"parameters":[{"in":"query","name":"signal_rules","description":"A comma separated list of signal rule IDs","type":"string","required":false,"x-nullable":true},{"in":"query","name":"teams","description":"A comma separated list of team IDs","type":"string","required":false,"x-nullable":true},{"in":"query","name":"environments","description":"A comma separated list of environment IDs","type":"string","required":false,"x-nullable":true},{"in":"query","name":"services","description":"A comma separated list of service IDs","type":"string","required":false,"x-nullable":true},{"in":"query","name":"tags","description":"A comma separated list of tags","type":"string","required":false,"x-nullable":true},{"in":"query","name":"users","description":"A comma separated list of user IDs","type":"string","required":false,"x-nullable":true},{"in":"query","name":"group_by","description":"String that determines how records are grouped","type":"string","enum":["signal_rules","teams","services","environments","tags"],"required":false,"x-nullable":true},{"in":"query","name":"sort_by","description":"String that determines how records are sorted","type":"string","enum":["total_opened_alerts","total_acked_alerts","total_incidents","total_billable_alerts","total_resolved_alerts","acked_percentage","incidents_percentage"],"required":false,"x-nullable":true},{"in":"query","name":"sort_direction","description":"String that determines how records are sorted","type":"string","enum":["asc","desc"],"required":false,"x-nullable":true},{"in":"query","name":"start_date","description":"The start date to return metrics from","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"end_date","description":"The end date to return metrics from","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"timezone","description":"The IANA timezone in which the start and end dates are read as whole days. Defaults to UTC","type":"string","enum":["Africa/Abidjan","Africa/Accra","Africa/Addis_Ababa","Africa/Algiers","Africa/Asmara","Africa/Asmera","Africa/Bamako","Africa/Bangui","Africa/Banjul","Africa/Bissau","Africa/Blantyre","Africa/Brazzaville","Africa/Bujumbura","Africa/Cairo","Africa/Casablanca","Africa/Ceuta","Africa/Conakry","Africa/Dakar","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Douala","Africa/El_Aaiun","Africa/Freetown","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Juba","Africa/Kampala","Africa/Khartoum","Africa/Kigali","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Lome","Africa/Luanda","Africa/Lubumbashi","Africa/Lusaka","Africa/Malabo","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Mogadishu","Africa/Monrovia","Africa/Nairobi","Africa/Ndjamena","Africa/Niamey","Africa/Nouakchott","Africa/Ouagadougou","Africa/Porto-Novo","Africa/Sao_Tome","Africa/Timbuktu","Africa/Tripoli","Africa/Tunis","Africa/Windhoek","America/Adak","America/Anchorage","America/Anguilla","America/Antigua","America/Araguaina","America/Argentina/Buenos_Aires","America/Argentina/Catamarca","America/Argentina/ComodRivadavia","America/Argentina/Cordoba","America/Argentina/Jujuy","America/Argentina/La_Rioja","America/Argentina/Mendoza","America/Argentina/Rio_Gallegos","America/Argentina/Salta","America/Argentina/San_Juan","America/Argentina/San_Luis","America/Argentina/Tucuman","America/Argentina/Ushuaia","America/Aruba","America/Asuncion","America/Atikokan","America/Atka","America/Bahia","America/Bahia_Banderas","America/Barbados","America/Belem","America/Belize","America/Blanc-Sablon","America/Boa_Vista","America/Bogota","America/Boise","America/Buenos_Aires","America/Cambridge_Bay","America/Campo_Grande","America/Cancun","America/Caracas","America/Catamarca","America/Cayenne","America/Cayman","America/Chicago","America/Chihuahua","America/Ciudad_Juarez","America/Coral_Harbour","America/Cordoba","America/Costa_Rica","America/Coyhaique","America/Creston","America/Cuiaba","America/Curacao","America/Danmarkshavn","America/Dawson","America/Dawson_Creek","America/Denver","America/Detroit","America/Dominica","America/Edmonton","America/Eirunepe","America/El_Salvador","America/Ensenada","America/Fort_Nelson","America/Fort_Wayne","America/Fortaleza","America/Glace_Bay","America/Godthab","America/Goose_Bay","America/Grand_Turk","America/Grenada","America/Guadeloupe","America/Guatemala","America/Guayaquil","America/Guyana","America/Halifax","America/Havana","America/Hermosillo","America/Indiana/Indianapolis","America/Indiana/Knox","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Tell_City","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Indianapolis","America/Inuvik","America/Iqaluit","America/Jamaica","America/Jujuy","America/Juneau","America/Kentucky/Louisville","America/Kentucky/Monticello","America/Knox_IN","America/Kralendijk","America/La_Paz","America/Lima","America/Los_Angeles","America/Louisville","America/Lower_Princes","America/Maceio","America/Managua","America/Manaus","America/Marigot","America/Martinique","America/Matamoros","America/Mazatlan","America/Mendoza","America/Menominee","America/Merida","America/Metlakatla","America/Mexico_City","America/Miquelon","America/Moncton","America/Monterrey","America/Montevideo","America/Montreal","America/Montserrat","America/Nassau","America/New_York","America/Nipigon","America/Nome","America/Noronha","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","America/Nuuk","America/Ojinaga","America/Panama","America/Pangnirtung","America/Paramaribo","America/Phoenix","America/Port-au-Prince","America/Port_of_Spain","America/Porto_Acre","America/Porto_Velho","America/Puerto_Rico","America/Punta_Arenas","America/Rainy_River","America/Rankin_Inlet","America/Recife","America/Regina","America/Resolute","America/Rio_Branco","America/Rosario","America/Santa_Isabel","America/Santarem","America/Santiago","America/Santo_Domingo","America/Sao_Paulo","America/Scoresbysund","America/Shiprock","America/Sitka","America/St_Barthelemy","America/St_Johns","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Swift_Current","America/Tegucigalpa","America/Thule","America/Thunder_Bay","America/Tijuana","America/Toronto","America/Tortola","America/Vancouver","America/Virgin","America/Whitehorse","America/Winnipeg","America/Yakutat","America/Yellowknife","Antarctica/Casey","Antarctica/Davis","Antarctica/DumontDUrville","Antarctica/Macquarie","Antarctica/Mawson","Antarctica/McMurdo","Antarctica/Palmer","Antarctica/Rothera","Antarctica/South_Pole","Antarctica/Syowa","Antarctica/Troll","Antarctica/Vostok","Arctic/Longyearbyen","Asia/Aden","Asia/Almaty","Asia/Amman","Asia/Anadyr","Asia/Aqtau","Asia/Aqtobe","Asia/Ashgabat","Asia/Ashkhabad","Asia/Atyrau","Asia/Baghdad","Asia/Bahrain","Asia/Baku","Asia/Bangkok","Asia/Barnaul","Asia/Beirut","Asia/Bishkek","Asia/Brunei","Asia/Calcutta","Asia/Chita","Asia/Choibalsan","Asia/Chongqing","Asia/Chungking","Asia/Colombo","Asia/Dacca","Asia/Damascus","Asia/Dhaka","Asia/Dili","Asia/Dubai","Asia/Dushanbe","Asia/Famagusta","Asia/Gaza","Asia/Harbin","Asia/Hebron","Asia/Ho_Chi_Minh","Asia/Hong_Kong","Asia/Hovd","Asia/Irkutsk","Asia/Istanbul","Asia/Jakarta","Asia/Jayapura","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Kashgar","Asia/Kathmandu","Asia/Katmandu","Asia/Khandyga","Asia/Kolkata","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Kuwait","Asia/Macao","Asia/Macau","Asia/Magadan","Asia/Makassar","Asia/Manila","Asia/Muscat","Asia/Nicosia","Asia/Novokuznetsk","Asia/Novosibirsk","Asia/Omsk","Asia/Oral","Asia/Phnom_Penh","Asia/Pontianak","Asia/Pyongyang","Asia/Qatar","Asia/Qostanay","Asia/Qyzylorda","Asia/Rangoon","Asia/Riyadh","Asia/Saigon","Asia/Sakhalin","Asia/Samarkand","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Tel_Aviv","Asia/Thimbu","Asia/Thimphu","Asia/Tokyo","Asia/Tomsk","Asia/Ujung_Pandang","Asia/Ulaanbaatar","Asia/Ulan_Bator","Asia/Urumqi","Asia/Ust-Nera","Asia/Vientiane","Asia/Vladivostok","Asia/Yakutsk","Asia/Yangon","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Bermuda","Atlantic/Canary","Atlantic/Cape_Verde","Atlantic/Faeroe","Atlantic/Faroe","Atlantic/Jan_Mayen","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/South_Georgia","Atlantic/St_Helena","Atlantic/Stanley","Australia/ACT","Australia/Adelaide","Australia/Brisbane","Australia/Broken_Hill","Australia/Canberra","Australia/Currie","Australia/Darwin","Australia/Eucla","Australia/Hobart","Australia/LHI","Australia/Lindeman","Australia/Lord_Howe","Australia/Melbourne","Australia/NSW","Australia/North","Australia/Perth","Australia/Queensland","Australia/South","Australia/Sydney","Australia/Tasmania","Australia/Victoria","Australia/West","Australia/Yancowinna","Brazil/Acre","Brazil/DeNoronha","Brazil/East","Brazil/West","CET","CST6CDT","Canada/Atlantic","Canada/Central","Canada/Eastern","Canada/Mountain","Canada/Newfoundland","Canada/Pacific","Canada/Saskatchewan","Canada/Yukon","Chile/Continental","Chile/EasterIsland","Cuba","EET","EST","EST5EDT","Egypt","Eire","Etc/GMT","Etc/GMT+0","Etc/GMT+1","Etc/GMT+10","Etc/GMT+11","Etc/GMT+12","Etc/GMT+2","Etc/GMT+3","Etc/GMT+4","Etc/GMT+5","Etc/GMT+6","Etc/GMT+7","Etc/GMT+8","Etc/GMT+9","Etc/GMT-0","Etc/GMT-1","Etc/GMT-10","Etc/GMT-11","Etc/GMT-12","Etc/GMT-13","Etc/GMT-14","Etc/GMT-2","Etc/GMT-3","Etc/GMT-4","Etc/GMT-5","Etc/GMT-6","Etc/GMT-7","Etc/GMT-8","Etc/GMT-9","Etc/GMT0","Etc/Greenwich","Etc/UCT","Etc/UTC","Etc/Universal","Etc/Zulu","Europe/Amsterdam","Europe/Andorra","Europe/Astrakhan","Europe/Athens","Europe/Belfast","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Busingen","Europe/Chisinau","Europe/Copenhagen","Europe/Dublin","Europe/Gibraltar","Europe/Guernsey","Europe/Helsinki","Europe/Isle_of_Man","Europe/Istanbul","Europe/Jersey","Europe/Kaliningrad","Europe/Kiev","Europe/Kirov","Europe/Kyiv","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Mariehamn","Europe/Minsk","Europe/Monaco","Europe/Moscow","Europe/Nicosia","Europe/Oslo","Europe/Paris","Europe/Podgorica","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/San_Marino","Europe/Sarajevo","Europe/Saratov","Europe/Simferopol","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Tirane","Europe/Tiraspol","Europe/Ulyanovsk","Europe/Uzhgorod","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zaporozhye","Europe/Zurich","Factory","GB","GB-Eire","GMT","GMT+0","GMT-0","GMT0","Greenwich","HST","Hongkong","Iceland","Indian/Antananarivo","Indian/Chagos","Indian/Christmas","Indian/Cocos","Indian/Comoro","Indian/Kerguelen","Indian/Mahe","Indian/Maldives","Indian/Mauritius","Indian/Mayotte","Indian/Reunion","Iran","Israel","Jamaica","Japan","Kwajalein","Libya","MET","MST","MST7MDT","Mexico/BajaNorte","Mexico/BajaSur","Mexico/General","NZ","NZ-CHAT","Navajo","PRC","PST8PDT","Pacific/Apia","Pacific/Auckland","Pacific/Bougainville","Pacific/Chatham","Pacific/Chuuk","Pacific/Easter","Pacific/Efate","Pacific/Enderbury","Pacific/Fakaofo","Pacific/Fiji","Pacific/Funafuti","Pacific/Galapagos","Pacific/Gambier","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Johnston","Pacific/Kanton","Pacific/Kiritimati","Pacific/Kosrae","Pacific/Kwajalein","Pacific/Majuro","Pacific/Marquesas","Pacific/Midway","Pacific/Nauru","Pacific/Niue","Pacific/Norfolk","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Palau","Pacific/Pitcairn","Pacific/Pohnpei","Pacific/Ponape","Pacific/Port_Moresby","Pacific/Rarotonga","Pacific/Saipan","Pacific/Samoa","Pacific/Tahiti","Pacific/Tarawa","Pacific/Tongatapu","Pacific/Truk","Pacific/Wake","Pacific/Wallis","Pacific/Yap","Poland","Portugal","ROC","ROK","Singapore","Turkey","UCT","US/Alaska","US/Aleutian","US/Arizona","US/Central","US/East-Indiana","US/Eastern","US/Hawaii","US/Indiana-Starke","US/Michigan","US/Mountain","US/Pacific","US/Samoa","UTC","Universal","W-SU","WET","Zulu"],"required":false,"x-nullable":true}],"responses":{"200":{"description":"Get mean-time-to-acknowledged (MTTA) and mean-time-to-resolved (MTTR) metrics for Signals alerts","schema":{"$ref":"#/definitions/Signals_API_Analytics_MttxMetricsEntity"}}},"tags":["Metrics/Reporting"],"operationId":"get_signals_mttx_analytics"}},"/v1/signals/analytics/noise/metrics":{"get":{"summary":"Get noise analytics for signals","description":"Get noise metrics for Signals alerts","produces":["application/json"],"parameters":[{"in":"query","name":"bucket","description":"String that determines how records are grouped","type":"string","enum":["month","week","day"],"required":false,"x-nullable":true},{"in":"query","name":"signal_rules","description":"A comma separated list of signal rule IDs","type":"string","required":false,"x-nullable":true},{"in":"query","name":"teams","description":"A comma separated list of team IDs","type":"string","required":false,"x-nullable":true},{"in":"query","name":"environments","description":"A comma separated list of environment IDs","type":"string","required":false,"x-nullable":true},{"in":"query","name":"services","description":"A comma separated list of service IDs","type":"string","required":false,"x-nullable":true},{"in":"query","name":"tags","description":"A comma separated list of tags","type":"string","required":false,"x-nullable":true},{"in":"query","name":"users","description":"A comma separated list of user IDs","type":"string","required":false,"x-nullable":true},{"in":"query","name":"group_by","description":"String that determines how records are grouped","type":"string","enum":["signal_rules","teams","services","environments","tags"],"required":false,"x-nullable":true},{"in":"query","name":"sort_by","description":"String that determines how records are sorted","type":"string","enum":["total_opened_alerts","total_acked_alerts","total_incidents","total_billable_alerts","total_resolved_alerts","acked_percentage","incidents_percentage"],"required":false,"x-nullable":true},{"in":"query","name":"sort_direction","description":"String that determines how records are sorted","type":"string","enum":["asc","desc"],"required":false,"x-nullable":true},{"in":"query","name":"start_date","description":"The start date to return metrics from","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"end_date","description":"The end date to return metrics from","type":"string","format":"date-time","required":false,"x-nullable":true},{"in":"query","name":"timezone","description":"The IANA timezone in which the start and end dates are read as whole days. Defaults to UTC","type":"string","enum":["Africa/Abidjan","Africa/Accra","Africa/Addis_Ababa","Africa/Algiers","Africa/Asmara","Africa/Asmera","Africa/Bamako","Africa/Bangui","Africa/Banjul","Africa/Bissau","Africa/Blantyre","Africa/Brazzaville","Africa/Bujumbura","Africa/Cairo","Africa/Casablanca","Africa/Ceuta","Africa/Conakry","Africa/Dakar","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Douala","Africa/El_Aaiun","Africa/Freetown","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Juba","Africa/Kampala","Africa/Khartoum","Africa/Kigali","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Lome","Africa/Luanda","Africa/Lubumbashi","Africa/Lusaka","Africa/Malabo","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Mogadishu","Africa/Monrovia","Africa/Nairobi","Africa/Ndjamena","Africa/Niamey","Africa/Nouakchott","Africa/Ouagadougou","Africa/Porto-Novo","Africa/Sao_Tome","Africa/Timbuktu","Africa/Tripoli","Africa/Tunis","Africa/Windhoek","America/Adak","America/Anchorage","America/Anguilla","America/Antigua","America/Araguaina","America/Argentina/Buenos_Aires","America/Argentina/Catamarca","America/Argentina/ComodRivadavia","America/Argentina/Cordoba","America/Argentina/Jujuy","America/Argentina/La_Rioja","America/Argentina/Mendoza","America/Argentina/Rio_Gallegos","America/Argentina/Salta","America/Argentina/San_Juan","America/Argentina/San_Luis","America/Argentina/Tucuman","America/Argentina/Ushuaia","America/Aruba","America/Asuncion","America/Atikokan","America/Atka","America/Bahia","America/Bahia_Banderas","America/Barbados","America/Belem","America/Belize","America/Blanc-Sablon","America/Boa_Vista","America/Bogota","America/Boise","America/Buenos_Aires","America/Cambridge_Bay","America/Campo_Grande","America/Cancun","America/Caracas","America/Catamarca","America/Cayenne","America/Cayman","America/Chicago","America/Chihuahua","America/Ciudad_Juarez","America/Coral_Harbour","America/Cordoba","America/Costa_Rica","America/Coyhaique","America/Creston","America/Cuiaba","America/Curacao","America/Danmarkshavn","America/Dawson","America/Dawson_Creek","America/Denver","America/Detroit","America/Dominica","America/Edmonton","America/Eirunepe","America/El_Salvador","America/Ensenada","America/Fort_Nelson","America/Fort_Wayne","America/Fortaleza","America/Glace_Bay","America/Godthab","America/Goose_Bay","America/Grand_Turk","America/Grenada","America/Guadeloupe","America/Guatemala","America/Guayaquil","America/Guyana","America/Halifax","America/Havana","America/Hermosillo","America/Indiana/Indianapolis","America/Indiana/Knox","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Tell_City","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Indianapolis","America/Inuvik","America/Iqaluit","America/Jamaica","America/Jujuy","America/Juneau","America/Kentucky/Louisville","America/Kentucky/Monticello","America/Knox_IN","America/Kralendijk","America/La_Paz","America/Lima","America/Los_Angeles","America/Louisville","America/Lower_Princes","America/Maceio","America/Managua","America/Manaus","America/Marigot","America/Martinique","America/Matamoros","America/Mazatlan","America/Mendoza","America/Menominee","America/Merida","America/Metlakatla","America/Mexico_City","America/Miquelon","America/Moncton","America/Monterrey","America/Montevideo","America/Montreal","America/Montserrat","America/Nassau","America/New_York","America/Nipigon","America/Nome","America/Noronha","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","America/Nuuk","America/Ojinaga","America/Panama","America/Pangnirtung","America/Paramaribo","America/Phoenix","America/Port-au-Prince","America/Port_of_Spain","America/Porto_Acre","America/Porto_Velho","America/Puerto_Rico","America/Punta_Arenas","America/Rainy_River","America/Rankin_Inlet","America/Recife","America/Regina","America/Resolute","America/Rio_Branco","America/Rosario","America/Santa_Isabel","America/Santarem","America/Santiago","America/Santo_Domingo","America/Sao_Paulo","America/Scoresbysund","America/Shiprock","America/Sitka","America/St_Barthelemy","America/St_Johns","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Swift_Current","America/Tegucigalpa","America/Thule","America/Thunder_Bay","America/Tijuana","America/Toronto","America/Tortola","America/Vancouver","America/Virgin","America/Whitehorse","America/Winnipeg","America/Yakutat","America/Yellowknife","Antarctica/Casey","Antarctica/Davis","Antarctica/DumontDUrville","Antarctica/Macquarie","Antarctica/Mawson","Antarctica/McMurdo","Antarctica/Palmer","Antarctica/Rothera","Antarctica/South_Pole","Antarctica/Syowa","Antarctica/Troll","Antarctica/Vostok","Arctic/Longyearbyen","Asia/Aden","Asia/Almaty","Asia/Amman","Asia/Anadyr","Asia/Aqtau","Asia/Aqtobe","Asia/Ashgabat","Asia/Ashkhabad","Asia/Atyrau","Asia/Baghdad","Asia/Bahrain","Asia/Baku","Asia/Bangkok","Asia/Barnaul","Asia/Beirut","Asia/Bishkek","Asia/Brunei","Asia/Calcutta","Asia/Chita","Asia/Choibalsan","Asia/Chongqing","Asia/Chungking","Asia/Colombo","Asia/Dacca","Asia/Damascus","Asia/Dhaka","Asia/Dili","Asia/Dubai","Asia/Dushanbe","Asia/Famagusta","Asia/Gaza","Asia/Harbin","Asia/Hebron","Asia/Ho_Chi_Minh","Asia/Hong_Kong","Asia/Hovd","Asia/Irkutsk","Asia/Istanbul","Asia/Jakarta","Asia/Jayapura","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Kashgar","Asia/Kathmandu","Asia/Katmandu","Asia/Khandyga","Asia/Kolkata","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Kuwait","Asia/Macao","Asia/Macau","Asia/Magadan","Asia/Makassar","Asia/Manila","Asia/Muscat","Asia/Nicosia","Asia/Novokuznetsk","Asia/Novosibirsk","Asia/Omsk","Asia/Oral","Asia/Phnom_Penh","Asia/Pontianak","Asia/Pyongyang","Asia/Qatar","Asia/Qostanay","Asia/Qyzylorda","Asia/Rangoon","Asia/Riyadh","Asia/Saigon","Asia/Sakhalin","Asia/Samarkand","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Tel_Aviv","Asia/Thimbu","Asia/Thimphu","Asia/Tokyo","Asia/Tomsk","Asia/Ujung_Pandang","Asia/Ulaanbaatar","Asia/Ulan_Bator","Asia/Urumqi","Asia/Ust-Nera","Asia/Vientiane","Asia/Vladivostok","Asia/Yakutsk","Asia/Yangon","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Bermuda","Atlantic/Canary","Atlantic/Cape_Verde","Atlantic/Faeroe","Atlantic/Faroe","Atlantic/Jan_Mayen","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/South_Georgia","Atlantic/St_Helena","Atlantic/Stanley","Australia/ACT","Australia/Adelaide","Australia/Brisbane","Australia/Broken_Hill","Australia/Canberra","Australia/Currie","Australia/Darwin","Australia/Eucla","Australia/Hobart","Australia/LHI","Australia/Lindeman","Australia/Lord_Howe","Australia/Melbourne","Australia/NSW","Australia/North","Australia/Perth","Australia/Queensland","Australia/South","Australia/Sydney","Australia/Tasmania","Australia/Victoria","Australia/West","Australia/Yancowinna","Brazil/Acre","Brazil/DeNoronha","Brazil/East","Brazil/West","CET","CST6CDT","Canada/Atlantic","Canada/Central","Canada/Eastern","Canada/Mountain","Canada/Newfoundland","Canada/Pacific","Canada/Saskatchewan","Canada/Yukon","Chile/Continental","Chile/EasterIsland","Cuba","EET","EST","EST5EDT","Egypt","Eire","Etc/GMT","Etc/GMT+0","Etc/GMT+1","Etc/GMT+10","Etc/GMT+11","Etc/GMT+12","Etc/GMT+2","Etc/GMT+3","Etc/GMT+4","Etc/GMT+5","Etc/GMT+6","Etc/GMT+7","Etc/GMT+8","Etc/GMT+9","Etc/GMT-0","Etc/GMT-1","Etc/GMT-10","Etc/GMT-11","Etc/GMT-12","Etc/GMT-13","Etc/GMT-14","Etc/GMT-2","Etc/GMT-3","Etc/GMT-4","Etc/GMT-5","Etc/GMT-6","Etc/GMT-7","Etc/GMT-8","Etc/GMT-9","Etc/GMT0","Etc/Greenwich","Etc/UCT","Etc/UTC","Etc/Universal","Etc/Zulu","Europe/Amsterdam","Europe/Andorra","Europe/Astrakhan","Europe/Athens","Europe/Belfast","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Busingen","Europe/Chisinau","Europe/Copenhagen","Europe/Dublin","Europe/Gibraltar","Europe/Guernsey","Europe/Helsinki","Europe/Isle_of_Man","Europe/Istanbul","Europe/Jersey","Europe/Kaliningrad","Europe/Kiev","Europe/Kirov","Europe/Kyiv","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Mariehamn","Europe/Minsk","Europe/Monaco","Europe/Moscow","Europe/Nicosia","Europe/Oslo","Europe/Paris","Europe/Podgorica","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/San_Marino","Europe/Sarajevo","Europe/Saratov","Europe/Simferopol","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Tirane","Europe/Tiraspol","Europe/Ulyanovsk","Europe/Uzhgorod","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zaporozhye","Europe/Zurich","Factory","GB","GB-Eire","GMT","GMT+0","GMT-0","GMT0","Greenwich","HST","Hongkong","Iceland","Indian/Antananarivo","Indian/Chagos","Indian/Christmas","Indian/Cocos","Indian/Comoro","Indian/Kerguelen","Indian/Mahe","Indian/Maldives","Indian/Mauritius","Indian/Mayotte","Indian/Reunion","Iran","Israel","Jamaica","Japan","Kwajalein","Libya","MET","MST","MST7MDT","Mexico/BajaNorte","Mexico/BajaSur","Mexico/General","NZ","NZ-CHAT","Navajo","PRC","PST8PDT","Pacific/Apia","Pacific/Auckland","Pacific/Bougainville","Pacific/Chatham","Pacific/Chuuk","Pacific/Easter","Pacific/Efate","Pacific/Enderbury","Pacific/Fakaofo","Pacific/Fiji","Pacific/Funafuti","Pacific/Galapagos","Pacific/Gambier","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Johnston","Pacific/Kanton","Pacific/Kiritimati","Pacific/Kosrae","Pacific/Kwajalein","Pacific/Majuro","Pacific/Marquesas","Pacific/Midway","Pacific/Nauru","Pacific/Niue","Pacific/Norfolk","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Palau","Pacific/Pitcairn","Pacific/Pohnpei","Pacific/Ponape","Pacific/Port_Moresby","Pacific/Rarotonga","Pacific/Saipan","Pacific/Samoa","Pacific/Tahiti","Pacific/Tarawa","Pacific/Tongatapu","Pacific/Truk","Pacific/Wake","Pacific/Wallis","Pacific/Yap","Poland","Portugal","ROC","ROK","Singapore","Turkey","UCT","US/Alaska","US/Aleutian","US/Arizona","US/Central","US/East-Indiana","US/Eastern","US/Hawaii","US/Indiana-Starke","US/Michigan","US/Mountain","US/Pacific","US/Samoa","UTC","Universal","W-SU","WET","Zulu"],"required":false,"x-nullable":true}],"responses":{"200":{"description":"Get noise metrics for Signals alerts","schema":{"$ref":"#/definitions/Signals_API_Analytics_NoiseMetricsEntity"}}},"tags":["Metrics/Reporting"],"operationId":"get_signals_noise_analytics"}},"/v1/signals/analytics/shifts/export":{"get":{"summary":"Export on-call hours report","description":"Export on-call hours report for users/teams during a time period","produces":["application/json"],"parameters":[{"in":"query","name":"user_ids","description":"Array of user IDs to fetch oncall hours for","type":"array","items":{"type":"string"},"required":false,"x-nullable":true},{"in":"query","name":"team_ids","description":"Array of team IDs to fetch oncall hours for","type":"array","items":{"type":"string"},"required":false,"x-nullable":true},{"in":"query","name":"period_start","description":"Start of the period to fetch hours for (UTC)","type":"string","format":"date-time","required":true},{"in":"query","name":"period_end","description":"End of the period to fetch hours for (UTC)","type":"string","format":"date-time","required":true}],"responses":{"200":{"description":"Export on-call hours report for users/teams during a time period"}},"tags":["Metrics/Reporting"],"operationId":"export_signals_shift_analytics"}},"/v1/signals/call_routes":{"get":{"summary":"List call routes","description":"List call routes for the organization","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"List call routes for the organization","schema":{"$ref":"#/definitions/Signals_API_CallRouteEntityPaginated"}}},"tags":["Call Routes"],"operationId":"list_call_routes"}},"/v1/signals/call_routes/{id}":{"delete":{"summary":"Delete a call route","description":"Delete a call route by ID","produces":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true}],"responses":{"204":{"description":"Delete a call route by ID"}},"tags":["Call Routes"],"operationId":"delete_call_route"},"patch":{"summary":"Update a call route","description":"Update a call route by ID","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true},{"name":"update_call_route","in":"body","required":true,"schema":{"$ref":"#/definitions/update_call_route"}}],"responses":{"200":{"description":"Update a call route by ID","schema":{"$ref":"#/definitions/Signals_API_CallRouteEntity"}}},"tags":["Call Routes"],"operationId":"update_call_route"},"get":{"summary":"Retrieve a call route","description":"Retrieve a call route by ID","produces":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true}],"responses":{"200":{"description":"Retrieve a call route by ID","schema":{"$ref":"#/definitions/Signals_API_CallRouteEntity"}}},"tags":["Call Routes"],"operationId":"get_call_route"}},"/v1/signals/event_sources":{"put":{"summary":"Create an event source for Signals","description":"Create a Signals event source for the authenticated user.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"create_signals_event_source","in":"body","required":true,"schema":{"$ref":"#/definitions/create_signals_event_source"}}],"responses":{"200":{"description":"Create a Signals event source for the authenticated user.","schema":{"$ref":"#/definitions/Signals_API_TransposerEntity"}}},"tags":["Signals"],"operationId":"create_signals_event_source"},"get":{"summary":"List event sources for Signals","description":"List all Signals event sources for the authenticated user.","produces":["application/json"],"parameters":[{"in":"query","name":"team_id","description":"Team ID to send signals to directly","type":"string","required":false,"x-nullable":true},{"in":"query","name":"escalation_policy_id","description":"Escalation policy ID to send signals to directly. `team_id` is required if this is provided.","type":"string","required":false,"x-nullable":true},{"in":"query","name":"on_call_schedule_id","description":"On-call schedule ID to send signals to directly. `team_id` is required if this is provided.","type":"string","required":false,"x-nullable":true},{"in":"query","name":"user_id","description":"User ID to send signals to directly","type":"string","required":false,"x-nullable":true}],"responses":{"200":{"description":"List all Signals event sources for the authenticated user.","schema":{"$ref":"#/definitions/Signals_API_TransposerListEntity"}}},"tags":["Signals"],"operationId":"list_signals_event_sources"}},"/v1/signals/event_sources/{transposer_slug}":{"delete":{"summary":"Delete an event source for Signals","description":"Delete a Signals event source by slug","produces":["application/json"],"parameters":[{"in":"path","name":"transposer_slug","type":"string","required":true}],"responses":{"204":{"description":"Delete a Signals event source by slug"}},"tags":["Signals"],"operationId":"delete_signals_event_source"},"get":{"summary":"Get an event source for Signals","description":"Get a Signals event source by slug","produces":["application/json"],"parameters":[{"in":"path","name":"transposer_slug","type":"string","required":true}],"responses":{"200":{"description":"Get a Signals event source by slug","schema":{"$ref":"#/definitions/Signals_API_TransposerEntity"}}},"tags":["Signals"],"operationId":"get_signals_event_source"}},"/v1/signals/hacker_mode":{"get":{"summary":"Get hacker mode status","description":"Get the status of the hacker mode for the current user","produces":["application/json"],"responses":{"200":{"description":"Get the status of the hacker mode for the current user","schema":{"$ref":"#/definitions/Signals_API_HackerModeEntity"}}},"tags":["Signals"],"operationId":"get_signals_hacker_mode"}},"/v1/signals/grouping":{"post":{"summary":"Create an alert grouping configuration.","description":"Create a Signals alert grouping rule for the organization.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"create_signals_alert_grouping_configuration","in":"body","required":true,"schema":{"$ref":"#/definitions/create_signals_alert_grouping_configuration"}}],"responses":{"201":{"description":"Create a Signals alert grouping rule for the organization.","schema":{"$ref":"#/definitions/Signals_API_GroupingEntity"}}},"tags":["Signals"],"operationId":"create_signals_alert_grouping_configuration"},"get":{"summary":"List alert grouping configurations.","description":"List all Signals alert grouping rules for the organization.","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"List all Signals alert grouping rules for the organization.","schema":{"$ref":"#/definitions/Signals_API_GroupingEntityPaginated"}}},"tags":["Signals"],"operationId":"list_signals_alert_grouping_configurations"}},"/v1/signals/grouping/{id}":{"delete":{"summary":"Delete an alert grouping configuration.","description":"Delete a Signals alert grouping rule by ID.","produces":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true}],"responses":{"204":{"description":"Delete a Signals alert grouping rule by ID."}},"tags":["Signals"],"operationId":"delete_signals_alert_grouping_configuration"},"patch":{"summary":"Update an alert grouping configuration.","description":"Update a Signals alert grouping rule for the organization.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true},{"name":"update_signals_alert_grouping_configuration","in":"body","required":true,"schema":{"$ref":"#/definitions/update_signals_alert_grouping_configuration"}}],"responses":{"200":{"description":"Update a Signals alert grouping rule for the organization.","schema":{"$ref":"#/definitions/Signals_API_GroupingEntity"}}},"tags":["Signals"],"operationId":"update_signals_alert_grouping_configuration"},"get":{"summary":"Get an alert grouping configuration.","description":"Get a Signals alert grouping rule by ID.","produces":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true}],"responses":{"200":{"description":"Get a Signals alert grouping rule by ID.","schema":{"$ref":"#/definitions/Signals_API_GroupingEntity"}}},"tags":["Signals"],"operationId":"get_signals_alert_grouping_configuration"}},"/v1/signals/email_targets":{"post":{"summary":"Create an email target for signals","description":"Create a Signals email target for a team.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"create_signals_email_target","in":"body","required":true,"schema":{"$ref":"#/definitions/create_signals_email_target"}}],"responses":{"201":{"description":"Create a Signals email target for a team.","schema":{"$ref":"#/definitions/Signals_API_EmailTargetEntity"}}},"tags":["Signals"],"operationId":"create_signals_email_target"},"get":{"summary":"List email targets for signals","description":"List all Signals email targets for a team.","produces":["application/json"],"parameters":[{"in":"query","name":"query","description":"A query string to search the list of targets by.","type":"string","required":false,"x-nullable":true}],"responses":{"200":{"description":"List all Signals email targets for a team.","schema":{"$ref":"#/definitions/Signals_API_EmailTargetEntityPaginated"}}},"tags":["Signals"],"operationId":"list_signals_email_targets"}},"/v1/signals/email_targets/{id}":{"delete":{"summary":"Delete a signal email target","description":"Delete a Signals email target by ID","produces":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true}],"responses":{"204":{"description":"Delete a Signals email target by ID"}},"tags":["Signals"],"operationId":"delete_signals_email_target"},"patch":{"summary":"Update an email target","description":"Update a Signals email target by ID","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true},{"name":"update_signals_email_target","in":"body","required":true,"schema":{"$ref":"#/definitions/update_signals_email_target"}}],"responses":{"200":{"description":"Update a Signals email target by ID","schema":{"$ref":"#/definitions/Signals_API_EmailTargetEntity"}}},"tags":["Signals"],"operationId":"update_signals_email_target"},"get":{"summary":"Get a signal email target","description":"Get a Signals email target by ID","produces":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true}],"responses":{"200":{"description":"Get a Signals email target by ID","schema":{"$ref":"#/definitions/Signals_API_EmailTargetEntity"}}},"tags":["Signals"],"operationId":"get_signals_email_target"}},"/v1/signals/webhook_targets":{"post":{"summary":"Create a webhook target","description":"Create a Signals webhook target.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"create_signals_webhook_target","in":"body","required":true,"schema":{"$ref":"#/definitions/create_signals_webhook_target"}}],"responses":{"201":{"description":"Create a Signals webhook target.","schema":{"$ref":"#/definitions/Signals_API_WebhookTargetEntity"}}},"tags":["Signals"],"operationId":"create_signals_webhook_target"},"get":{"summary":"List webhook targets","description":"List all Signals webhook targets.","produces":["application/json"],"parameters":[{"in":"query","name":"query","description":"A query string for searching through the list of webhook targets.","type":"string","required":false,"x-nullable":true},{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"List all Signals webhook targets.","schema":{"$ref":"#/definitions/Signals_API_WebhookTargetEntityPaginated"}}},"tags":["Signals"],"operationId":"list_signals_webhook_targets"}},"/v1/signals/webhook_targets/{id}":{"delete":{"summary":"Delete a webhook target","description":"Delete a Signals webhook target by ID","produces":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true}],"responses":{"204":{"description":"Delete a Signals webhook target by ID"}},"tags":["Signals"],"operationId":"delete_signals_webhook_target"},"patch":{"summary":"Update a webhook target","description":"Update a Signals webhook target by ID","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true},{"name":"update_signals_webhook_target","in":"body","required":true,"schema":{"$ref":"#/definitions/update_signals_webhook_target"}}],"responses":{"200":{"description":"Update a Signals webhook target by ID","schema":{"$ref":"#/definitions/Signals_API_WebhookTargetEntity"}}},"tags":["Signals"],"operationId":"update_signals_webhook_target"},"get":{"summary":"Get a webhook target","description":"Get a Signals webhook target by ID","produces":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true}],"responses":{"200":{"description":"Get a Signals webhook target by ID","schema":{"$ref":"#/definitions/Signals_API_WebhookTargetEntity"}}},"tags":["Signals"],"operationId":"get_signals_webhook_target"}},"/v1/signals/heartbeat_endpoints":{"post":{"summary":"Create a heartbeat endpoint configuration","description":"Create a new heartbeat endpoint configuration for your organization","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"create_signals_heartbeat_endpoint_configuration","in":"body","required":true,"schema":{"$ref":"#/definitions/create_signals_heartbeat_endpoint_configuration"}}],"responses":{"201":{"description":"Create a new heartbeat endpoint configuration for your organization"}},"tags":["Signals"],"operationId":"create_signals_heartbeat_endpoint_configuration"},"get":{"summary":"List heartbeat endpoint configurations","description":"Retrieve all heartbeat endpoint configurations for your organization","produces":["application/json"],"parameters":[{"in":"query","name":"team_id","description":"ID of the team the heartbeat belongs to","type":"string","required":false,"x-nullable":true}],"responses":{"200":{"description":"Retrieve all heartbeat endpoint configurations for your organization"}},"tags":["Signals"],"operationId":"list_signals_heartbeat_endpoint_configurations"}},"/v1/signals/heartbeat_endpoints/statuses":{"get":{"summary":"Get heartbeat endpoint status","description":"Check the current status of a heartbeat endpoint","produces":["application/json"],"parameters":[{"in":"formData","name":"ids","description":"Array of heartbeat endpoint configuration IDs to check status for","type":"array","items":{"type":"string"},"required":true}],"responses":{"200":{"description":"Check the current status of a heartbeat endpoint"}},"tags":["Signals"],"operationId":"get_signals_heartbeat_endpoint_status"}},"/v1/signals/heartbeat_endpoints/addresses":{"get":{"summary":"Get heartbeat endpoint URL","description":"Retrieve the URL for a heartbeat endpoint","produces":["application/json"],"parameters":[{"in":"formData","name":"ids","description":"Array of heartbeat endpoint configuration IDs to get URLs for","type":"array","items":{"type":"string"},"required":true}],"responses":{"200":{"description":"Retrieve the URL for a heartbeat endpoint"}},"tags":["Signals"],"operationId":"get_signals_heartbeat_endpoint_url"}},"/v1/signals/heartbeat_endpoints/{id}":{"delete":{"summary":"Delete a heartbeat endpoint configuration","description":"Delete a heartbeat endpoint configuration","produces":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true}],"responses":{"204":{"description":"Delete a heartbeat endpoint configuration"}},"tags":["Signals"],"operationId":"delete_signals_heartbeat_endpoint_configuration"},"patch":{"summary":"Update a heartbeat endpoint configuration","description":"Update an existing heartbeat endpoint configuration","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true},{"name":"update_signals_heartbeat_endpoint_configuration","in":"body","required":true,"schema":{"$ref":"#/definitions/update_signals_heartbeat_endpoint_configuration"}}],"responses":{"200":{"description":"Update an existing heartbeat endpoint configuration"}},"tags":["Signals"],"operationId":"update_signals_heartbeat_endpoint_configuration"},"get":{"summary":"Get a heartbeat endpoint configuration","description":"Retrieve a single heartbeat endpoint configuration","produces":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true}],"responses":{"200":{"description":"Retrieve a single heartbeat endpoint configuration"}},"tags":["Signals"],"operationId":"get_signals_heartbeat_endpoint_configuration"}},"/v1/signals/notification_policy_items":{"post":{"summary":"Create a notification policy","description":"Create a Signals notification policy.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"notification_group_method","description":"The group method of notification that will be delivered.","type":"string","enum":["any","push","email","voice","mobile_text","chat"],"required":true},{"in":"formData","name":"max_delay","description":"An ISO8601 duration string specifying the maximum delay of the notification.","type":"string","required":true},{"in":"formData","name":"priority","description":"The priority of the notification.","type":"string","enum":["HIGH","MEDIUM","LOW"],"required":true}],"responses":{"201":{"description":"Create a Signals notification policy.","schema":{"$ref":"#/definitions/Signals_API_NotificationPolicyItemEntity"}}},"tags":["Signals"],"operationId":"create_notification_policy"},"get":{"summary":"List notification policies","description":"List all Signals notification policies.","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"List all Signals notification policies.","schema":{"$ref":"#/definitions/Signals_API_NotificationPolicyItemEntityPaginated"}}},"tags":["Signals"],"operationId":"list_notification_policy_settings"}},"/v1/signals/notification_policy_items/{id}":{"delete":{"summary":"Delete a notification policy","description":"Delete a Signals notification policy by ID","produces":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true}],"responses":{"204":{"description":"Delete a Signals notification policy by ID"}},"tags":["Signals"],"operationId":"delete_notification_policy"},"patch":{"summary":"Update a notification policy","description":"Update a Signals notification policy by ID","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true},{"in":"formData","name":"notification_group_method","description":"The group method of notification that will be delivered.","type":"string","enum":["any","push","email","voice","mobile_text","chat"],"required":false,"x-nullable":true},{"in":"formData","name":"max_delay","description":"An ISO8601 duration string specifying the maximum delay of the notification.","type":"string","required":false,"x-nullable":true},{"in":"formData","name":"priority","description":"The priority of the notification.","type":"string","enum":["HIGH","MEDIUM","LOW"],"required":false,"x-nullable":true}],"responses":{"200":{"description":"Update a Signals notification policy by ID"}},"tags":["Signals"],"operationId":"update_notification_policy"},"get":{"summary":"Get a notification policy","description":"Get a Signals notification policy by ID","produces":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true}],"responses":{"200":{"description":"Get a Signals notification policy by ID","schema":{"$ref":"#/definitions/Signals_API_NotificationPolicyItemEntity"}}},"tags":["Signals"],"operationId":"get_notification_policy"}},"/v1/signals/users/{user_id}/notification_settings":{"get":{"summary":"List notification settings for a user","description":"List all Signals notification settings for a specific user. Requires an API key with PII access enabled.","produces":["application/json"],"parameters":[{"in":"path","name":"user_id","type":"string","required":true},{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"notification_priority","description":"The level of priority for the notification setting.","type":"string","enum":["HIGH","MEDIUM","LOW"],"required":false,"x-nullable":true}],"responses":{"200":{"description":"List all Signals notification settings for a specific user. Requires an API key with PII access enabled.","schema":{"$ref":"#/definitions/Signals_API_UserNotificationSettingEntityPaginated"}},"403":{"description":"","schema":{"$ref":"#/definitions/ErrorEntity"}}},"tags":["Signals"],"operationId":"list_user_notification_settings_by_user_id"}},"/v1/signals/transposers":{"get":{"summary":"List signal transposers","description":"List all transposers for your organization","produces":["application/json"],"responses":{"200":{"description":"List all transposers for your organization","schema":{"$ref":"#/definitions/Signals_API_TransposerListEntity"}}},"tags":["Signals"],"operationId":"list_signals_transposers"}},"/v1/signals/ingest_url":{"get":{"summary":"Get the signals ingestion URL","description":"Retrieve the url for ingesting signals for your organization","produces":["application/json"],"parameters":[{"in":"query","name":"team_id","description":"Team ID to send signals to directly","type":"string","required":false,"x-nullable":true},{"in":"query","name":"escalation_policy_id","description":"Escalation policy ID to send signals to directly. `team_id` is required if this is provided.","type":"string","required":false,"x-nullable":true},{"in":"query","name":"on_call_schedule_id","description":"On-call schedule ID to send signals to directly. `team_id` is required if this is provided.","type":"string","required":false,"x-nullable":true},{"in":"query","name":"user_id","description":"User ID to send signals to directly","type":"string","required":false,"x-nullable":true}],"responses":{"200":{"description":"Retrieve the url for ingesting signals for your organization","schema":{"$ref":"#/definitions/Signals_API_IngestKeyEntity"}}},"tags":["Signals"],"operationId":"get_signals_ingest_url"}},"/v1/signals/debugger":{"post":{"summary":"Debug Signals expressions","description":"Debug Signals expressions","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"debug_signals_expression","in":"body","required":true,"schema":{"$ref":"#/definitions/debug_signals_expression"}}],"responses":{"201":{"description":"Debug Signals expressions"}},"tags":["Signals"],"operationId":"debug_signals_expression"}},"/v1/signals_on_call":{"get":{"summary":"List who's on call for the organization","description":"List all users who are currently on-call across the entire organization.","produces":["application/json"],"parameters":[{"in":"query","name":"team_id","description":"An optional comma separated list of team IDs to filter currently on-call users by","type":"string","required":false,"x-nullable":true}],"responses":{"200":{"description":"List all users who are currently on-call across the entire organization.","schema":{"$ref":"#/definitions/Signals_API_OrganizationOnCallScheduleEntityPaginated"}}},"tags":["Signals"],"operationId":"list_organization_on_call_schedules"}},"/v1/webhooks":{"post":{"summary":"Create a webhook","description":"Create a new webhook","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"create_webhook","in":"body","required":true,"schema":{"$ref":"#/definitions/create_webhook"}}],"responses":{"201":{"description":"Create a new webhook","schema":{"$ref":"#/definitions/Webhooks_Entities_WebhookEntity"}}},"tags":["Webhooks"],"operationId":"create_webhook"},"get":{"summary":"List webhooks","description":"Lists webhooks","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"Lists webhooks","schema":{"$ref":"#/definitions/Webhooks_Entities_WebhookEntityPaginated"}}},"tags":["Webhooks"],"operationId":"list_webhooks"}},"/v1/webhooks/{webhook_id}/deliveries":{"get":{"summary":"List webhook deliveries","description":"Get webhook deliveries","produces":["application/json"],"parameters":[{"in":"path","name":"webhook_id","description":"ID of a webhook","type":"string","required":true},{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"Get webhook deliveries","schema":{"$ref":"#/definitions/Webhooks_Entities_DeliveryEntityPaginated"}}},"tags":["Webhooks"],"operationId":"list_webhook_deliveries"}},"/v1/webhooks/{webhook_id}":{"delete":{"summary":"Delete a webhook","description":"Delete a specific webhook","produces":["application/json"],"parameters":[{"in":"path","name":"webhook_id","type":"string","required":true}],"responses":{"204":{"description":"Delete a specific webhook"}},"tags":["Webhooks"],"operationId":"delete_webhook"},"patch":{"summary":"Update a webhook","description":"Update a specific webhook","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"webhook_id","type":"string","required":true},{"name":"update_webhook","in":"body","required":true,"schema":{"$ref":"#/definitions/update_webhook"}}],"responses":{"200":{"description":"Update a specific webhook","schema":{"$ref":"#/definitions/Webhooks_Entities_WebhookEntity"}}},"tags":["Webhooks"],"operationId":"update_webhook"},"get":{"summary":"Get a webhook","description":"Retrieve a specific webhook","produces":["application/json"],"parameters":[{"in":"path","name":"webhook_id","type":"string","required":true}],"responses":{"200":{"description":"Retrieve a specific webhook","schema":{"$ref":"#/definitions/Webhooks_Entities_WebhookEntity"}}},"tags":["Webhooks"],"operationId":"get_webhook"}},"/v1/ai/summarize_incident/{incident_id}/{generated_summary_id}/voted":{"get":{"summary":"Get the current user's vote status for an AI-generated incident summary","description":"Get the current user's vote status for an AI-generated incident summary","produces":["application/json"],"parameters":[{"in":"path","name":"incident_id","type":"string","required":true},{"in":"path","name":"generated_summary_id","type":"string","required":true}],"responses":{"200":{"description":"Get the current user's vote status for an AI-generated incident summary"}},"tags":["Incidents"],"operationId":"get_ai_incident_summary_vote_status"}},"/v1/ai/summarize_incident/{incident_id}/{generated_summary_id}/vote":{"put":{"summary":"Vote on an AI-generated incident summary","description":"Vote on an AI-generated incident summary for the current user","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"incident_id","type":"string","required":true},{"in":"path","name":"generated_summary_id","type":"string","required":true},{"in":"formData","name":"direction","type":"string","enum":["up","down"],"required":true}],"responses":{"200":{"description":"Vote on an AI-generated incident summary for the current user","schema":{"$ref":"#/definitions/AI_Entities_IncidentSummaryEntity"}}},"tags":["Incidents"],"operationId":"vote_ai_incident_summary"}},"/v1/ai/preferences":{"patch":{"summary":"Update AI preferences","description":"Updates the AI preferences","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"ai","description":"Whether to enable AI features","type":"boolean","required":false,"x-nullable":true},{"in":"formData","name":"summaries","description":"Whether to enable incident summaries","type":"boolean","required":false,"x-nullable":true},{"in":"formData","name":"description","description":"Whether to enable incident descriptions","type":"boolean","required":false,"x-nullable":true},{"in":"formData","name":"impact","description":"Whether to enable incident impact","type":"boolean","required":false,"x-nullable":true},{"in":"formData","name":"updates","description":"Whether to enable incident updates","type":"boolean","required":false,"x-nullable":true},{"in":"formData","name":"retros","description":"Whether to enable incident retrospectives","type":"boolean","required":false,"x-nullable":true},{"in":"formData","name":"followups","description":"Whether to enable incident followups","type":"boolean","required":false,"x-nullable":true},{"in":"formData","name":"similar_incidents","description":"Whether to enable similar incidents","type":"boolean","required":false,"x-nullable":true},{"in":"formData","name":"similar_incidents_cooldown_minutes","description":"Minimum minutes between related-incident posts per incident. 0 disables the cooldown. Null = no cooldown.","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"formData","name":"similar_incidents_max_per_incident","description":"Maximum related-incident posts per incident lifetime. 0 disables related-incident posts entirely. Null = no cap.","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"formData","name":"conference_bridge_summary_min_interval_minutes","description":"Minimum minutes between conference bridge summary posts. Null uses the default (5 minutes).","type":"integer","format":"int32","required":false,"x-nullable":true}],"responses":{"200":{"description":"Updates the AI preferences","schema":{"$ref":"#/definitions/AI_Entities_PreferencesEntity"}}},"tags":["Account Settings"],"operationId":"update_ai_preferences"},"get":{"summary":"Get AI preferences","description":"Retrieves the current AI preferences","produces":["application/json"],"responses":{"200":{"description":"Retrieves the current AI preferences","schema":{"$ref":"#/definitions/AI_Entities_PreferencesEntity"}}},"tags":["Account Settings"],"operationId":"get_ai_preferences"}},"/v1/audiences":{"get":{"summary":"List audiences","description":"List all audiences","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false,"x-nullable":true},{"in":"query","name":"include_archived","description":"Include archived (discarded) audiences","type":"boolean","default":false,"required":false,"x-nullable":true}],"responses":{"200":{"description":"List all audiences","schema":{"$ref":"#/definitions/Audiences_Entities_AudienceEntityPaginated"}}},"tags":["Audiences"],"operationId":"list_audiences"},"post":{"summary":"Create audience","description":"Create a new audience","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"create_audience","in":"body","required":true,"schema":{"$ref":"#/definitions/create_audience"}}],"responses":{"201":{"description":"Create a new audience","schema":{"$ref":"#/definitions/Audiences_Entities_AudienceEntity"}}},"tags":["Audiences"],"operationId":"create_audience"}},"/v1/audiences/{audience_id}":{"delete":{"summary":"Archive audience","description":"Archive an audience","produces":["application/json"],"parameters":[{"in":"path","name":"audience_id","description":"Unique identifier of the audience","type":"string","required":true}],"responses":{"204":{"description":"Archive an audience"}},"tags":["Audiences"],"operationId":"archive_audience"},"get":{"summary":"Get audience","description":"Get audience details","produces":["application/json"],"parameters":[{"in":"path","name":"audience_id","description":"Unique identifier of the audience","type":"string","required":true}],"responses":{"200":{"description":"Get audience details","schema":{"$ref":"#/definitions/Audiences_Entities_AudienceShowEntity"}}},"tags":["Audiences"],"operationId":"get_audience"},"patch":{"summary":"Update audience","description":"Update an existing audience","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"audience_id","description":"Unique identifier of the audience","type":"string","required":true},{"name":"update_audience","in":"body","required":true,"schema":{"$ref":"#/definitions/update_audience"}}],"responses":{"200":{"description":"Update an existing audience","schema":{"$ref":"#/definitions/Audiences_Entities_AudienceEntity"}}},"tags":["Audiences"],"operationId":"update_audience"}},"/v1/audiences/{audience_id}/restore":{"patch":{"summary":"Restore audience","description":"Restore a previously archived audience","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"audience_id","description":"Unique identifier of the audience","type":"string","required":true}],"responses":{"200":{"description":"Restore a previously archived audience","schema":{"$ref":"#/definitions/Audiences_Entities_AudienceEntity"}}},"tags":["Audiences"],"operationId":"restore_audience"}},"/v1/audiences/member/{member_id}/default":{"put":{"summary":"Set default audience","description":"Set member's default audience","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"audience_id","description":"ID of the audience to set as default","type":"string","required":true},{"in":"path","name":"member_id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Set member's default audience","schema":{"$ref":"#/definitions/Audiences_Entities_AudienceEntity"}}},"tags":["Audiences"],"operationId":"set_member_default_audience"},"get":{"summary":"Get default audience","description":"Get member's default audience","produces":["application/json"],"parameters":[{"in":"path","name":"member_id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Get member's default audience","schema":{"$ref":"#/definitions/Audiences_Entities_AudienceEntity"}}},"tags":["Audiences"],"operationId":"get_member_default_audience"}},"/v1/audiences/{audience_id}/summaries/{incident_id}":{"post":{"summary":"Generate summary (async)","description":"Initiates asynchronous generation of a new audience-specific summary for an incident. This is an async operation that can take up to 60 seconds to complete. The response includes a WebSocket topic name for internal use. After initiating generation, use the GET endpoint to poll for the completed summary.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"audience_id","description":"Unique identifier of the audience","type":"string","required":true},{"in":"path","name":"incident_id","description":"Unique identifier of the incident to summarize","type":"string","required":true},{"in":"formData","name":"force_regenerate","description":"Whether to force regeneration of the summary","type":"boolean","default":true,"required":false,"x-nullable":true}],"responses":{"202":{"description":"Summary generation initiated successfully"},"404":{"description":"Incident or audience not found"}},"tags":["Audiences"],"operationId":"generate_audience_summary"},"get":{"summary":"Get latest summary","description":"Get the latest audience-specific summary for an incident","produces":["application/json"],"parameters":[{"in":"path","name":"audience_id","description":"Unique identifier of the audience","type":"string","required":true},{"in":"path","name":"incident_id","description":"Unique identifier of the incident to summarize","type":"string","required":true}],"responses":{"200":{"description":"Get the latest audience-specific summary for an incident","schema":{"$ref":"#/definitions/AI_Entities_IncidentSummaryEntity"}}},"tags":["Audiences"],"operationId":"get_audience_summary"}},"/v1/audiences/summaries/{incident_id}":{"get":{"summary":"List audience summaries","description":"List all audience summaries for an incident","produces":["application/json"],"parameters":[{"in":"path","name":"incident_id","description":"Unique identifier of the incident to summarize","type":"string","required":true}],"responses":{"200":{"description":"List all audience summaries for an incident","schema":{"$ref":"#/definitions/Audiences_Entities_AudienceSummariesEntity"}}},"tags":["Audiences"],"operationId":"list_audience_summaries"}}},"definitions":{"ErrorEntity":{"type":"object","properties":{"detail":{"type":"string","x-nullable":true},"messages":{"type":"array","items":{"type":"string"},"x-nullable":true},"meta":{"type":"object","description":"An object with additional error metadata","x-nullable":true},"code":{"type":"string","description":"A stable code on which to match errors","x-nullable":true}},"description":"ErrorEntity model"},"PongEntity":{"type":"object","properties":{"response":{"type":"string","x-nullable":true},"actor":{"$ref":"#/definitions/NullableActorEntity"},"organization":{"$ref":"#/definitions/NullableOrganizationEntity"}},"description":"PongEntity model"},"ActorEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"email":{"type":"string","x-nullable":true},"type":{"type":"string","enum":["firehydrant_user","firehydrant_bot","alertmanager","asana","aws","bugsnag","checkly","custom_alerts","datadog","shortcut","new_relic","nunc","github","giphy","google_meet","google_calendar","microsoft_teams","microsoft_teams_v2","webex","jira_cloud","jira_onprem","opsgenie","pager_duty","honeycomb","patchy","service_now","signals","slack","statuspage","victorops","zendesk","zoom","confluence_cloud","google_docs","zoom_v2","linear","cortex","freshservice"],"x-nullable":true}}},"OrganizationEntity":{"type":"object","properties":{"name":{"type":"string","x-nullable":true},"id":{"type":"string","x-nullable":true},"provisioned_in_freshworks":{"type":"string","x-nullable":true}}},"create_environment":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","x-nullable":true},"functionalities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of a functionality"}},"required":["id"]},"x-nullable":true},"services":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of a service"}},"required":["id"]},"x-nullable":true}},"required":["name"],"description":"Creates an environment for the organization"},"EnvironmentEntryEntity":{"type":"object","properties":{"id":{"type":"string","description":"UUID of the Environment","x-nullable":true},"name":{"type":"string","description":"Name of the Environment","x-nullable":true},"slug":{"type":"string","description":"Slug of the Environment","x-nullable":true},"description":{"type":"string","description":"Description of the Environment","x-nullable":true},"updated_at":{"type":"string","format":"date-time","description":"The time the environment was updated","x-nullable":true},"created_at":{"type":"string","format":"date-time","description":"The time the environment was created","x-nullable":true},"active_incidents":{"type":"array","items":{"type":"string"},"description":"List of active incident guids","x-nullable":true},"external_resources":{"type":"array","items":{"$ref":"#/definitions/ExternalResourceEntity"},"description":"Information about known linkages to representations of services outside of FireHydrant.","x-nullable":true},"functionalities":{"type":"array","items":{"$ref":"#/definitions/FunctionalityEntityLite"},"description":"Functionalities related to this environment","x-nullable":true},"services":{"type":"array","items":{"$ref":"#/definitions/ServiceEntityLite"},"description":"Services related to this environment","x-nullable":true}},"description":"EnvironmentEntryEntity model"},"ExternalResourceEntity":{"type":"object","properties":{"connection_type":{"type":"string","x-nullable":true},"connection_name":{"type":"string","x-nullable":true},"connection_full_favicon_url":{"type":"string","x-nullable":true},"connection_id":{"type":"string","x-nullable":true},"remote_id":{"type":"string","x-nullable":true},"remote_url":{"type":"string","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"name":{"type":"string","x-nullable":true}}},"FunctionalityEntityLite":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"slug":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"labels":{"type":"object","description":"An object of label key and values","additionalProperties":true,"x-nullable":true},"active_incidents":{"type":"array","items":{"type":"string"},"description":"List of active incident guids","x-nullable":true},"links":{"type":"array","items":{"$ref":"#/definitions/LinksEntity"},"description":"List of links attached to this functionality.","x-nullable":true},"owner":{"$ref":"#/definitions/NullableTeamEntityLite","description":"Team that owns the functionality"},"service_tier":{"type":"integer","format":"int32","description":"Integer representing functionality tier (0-5, lower is more critical)","x-nullable":true},"alert_on_add":{"type":"boolean","x-nullable":true},"auto_add_responding_team":{"type":"boolean","x-nullable":true},"updated_by":{"$ref":"#/definitions/NullableAuthorEntity","description":"The most recent user to update the current functionality"},"teams":{"type":"array","items":{"$ref":"#/definitions/TeamEntityLite"},"description":"List of teams attached to the functionality","x-nullable":true}}},"LinksEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"href_url":{"type":"string","x-nullable":true},"icon_url":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true}}},"TeamEntityLite":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"slug":{"type":"string","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"signals_ical_url":{"type":"string","x-nullable":true},"created_by":{"$ref":"#/definitions/NullableAuthorEntity"},"in_support_hours":{"type":"boolean","x-nullable":true},"restrict_signals_resource_management":{"type":"boolean","x-nullable":true}}},"AuthorEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"source":{"type":"string","x-nullable":true},"email":{"type":"string","x-nullable":true}}},"ServiceEntityLite":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"slug":{"type":"string","x-nullable":true},"service_tier":{"type":"integer","format":"int32","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"allowed_params":{"type":"array","items":{"type":"string"},"x-nullable":true},"labels":{"type":"object","description":"An object of label key and values","additionalProperties":true,"x-nullable":true},"alert_on_add":{"type":"boolean","x-nullable":true},"auto_add_responding_team":{"type":"boolean","x-nullable":true}},"description":"ServiceEntityLite model"},"EnvironmentEntryEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/EnvironmentEntryEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"EnvironmentEntryEntityPaginated model"},"PaginationEntity":{"type":"object","properties":{"count":{"type":"integer","format":"int32","x-nullable":true},"page":{"type":"integer","format":"int32","x-nullable":true},"items":{"type":"integer","format":"int32","x-nullable":true},"pages":{"type":"integer","format":"int32","x-nullable":true},"last":{"type":"integer","format":"int32","x-nullable":true},"prev":{"type":"integer","format":"int32","x-nullable":true},"next":{"type":"integer","format":"int32","x-nullable":true}}},"update_environment":{"type":"object","properties":{"name":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"functionalities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of a functionality"},"remove":{"type":"boolean","description":"Set to true if you want to remove the given functionality from the environment","x-nullable":true}},"required":["id"]},"x-nullable":true},"remove_remaining_functionalities":{"type":"boolean","description":"Set this to true if you want to remove all of the functionalities that are not included in the functionalities array from the environment","default":false,"x-nullable":true},"services":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of a service"},"remove":{"type":"boolean","description":"Set to true if you want to remove the given service from the environment","x-nullable":true}},"required":["id"]},"x-nullable":true},"remove_remaining_services":{"type":"boolean","description":"Set this to true if you want to remove all of the services that are not included in the services array from the environment","default":false,"x-nullable":true}},"description":"Update a environments attributes"},"ServiceEntityLitePaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/ServiceEntityLite"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"ServiceEntityLitePaginated model"},"FunctionalityEntityLitePaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/FunctionalityEntityLite"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"FunctionalityEntityLitePaginated model"},"create_service":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","x-nullable":true},"labels":{"type":"object","description":"A hash of label keys and values","additionalProperties":{"type":"string"},"x-nullable":true},"service_tier":{"type":"integer","format":"int32","description":"Integer representing service tier. Lower values represent higher criticality. If not specified the default value will be 5.","enum":[0,1,2,3,4,5],"x-nullable":true},"functionalities":{"type":"array","description":"An array of functionalities","items":{"type":"object","properties":{"summary":{"type":"string","description":"If you are trying to create a new functionality and attach it to this service, set the summary key","x-nullable":true},"id":{"type":"string","description":"If you are trying to reuse a functionality, you may set the ID to attach it to the service","x-nullable":true}}},"x-nullable":true},"environments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of an environment"}},"required":["id"]},"x-nullable":true},"links":{"type":"array","description":"An array of links to associate with this service","items":{"type":"object","properties":{"name":{"type":"string","description":"Short name used to display and identify this link"},"href_url":{"type":"string","description":"URL"},"icon_url":{"type":"string","description":"An optional URL to an icon representing this link","x-nullable":true}},"required":["name","href_url"]},"x-nullable":true},"owner":{"type":"object","description":"An object representing a Team that owns the service","properties":{"id":{"type":"string"}},"required":["id"],"x-nullable":true},"teams":{"type":"array","description":"An array of teams to attach to this service.","items":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"x-nullable":true},"alert_on_add":{"type":"boolean","x-nullable":true},"auto_add_responding_team":{"type":"boolean","x-nullable":true},"external_resources":{"type":"array","description":"An array of external resources to attach to this service.","items":{"type":"object","properties":{"remote_id":{"type":"string"},"connection_type":{"type":"string","description":"The integration slug for the external resource. Can be one of: github, opsgenie, pager_duty, victorops. Not required if the resource has already been imported.","x-nullable":true}},"required":["remote_id"]},"x-nullable":true}},"required":["name"],"description":"Creates a service for the organization, you may also create or attach functionalities to the service on create."},"ServiceEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"slug":{"type":"string","x-nullable":true},"service_tier":{"type":"integer","format":"int32","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"allowed_params":{"type":"array","items":{"type":"string"},"x-nullable":true},"labels":{"type":"object","description":"An object of label key and values","additionalProperties":true,"x-nullable":true},"alert_on_add":{"type":"boolean","x-nullable":true},"auto_add_responding_team":{"type":"boolean","x-nullable":true},"active_incidents":{"type":"array","items":{"type":"string"},"description":"List of active incident guids","x-nullable":true},"checklists":{"type":"array","items":{"$ref":"#/definitions/ChecklistTemplateEntity"},"description":"List of checklists associated with a service","x-nullable":true},"completed_checks":{"type":"integer","format":"int32","x-nullable":true},"external_resources":{"type":"array","items":{"$ref":"#/definitions/ExternalResourceEntity"},"description":"Information about known linkages to representations of services outside of FireHydrant.","x-nullable":true},"functionalities":{"type":"array","items":{"$ref":"#/definitions/FunctionalityEntity"},"description":"List of functionalities attached to the service","x-nullable":true},"environments":{"type":"array","items":{"$ref":"#/definitions/EnvironmentEntryEntity"},"description":"Environments related to this service","x-nullable":true},"last_import":{"$ref":"#/definitions/NullableImports_ImportableResourceEntity"},"links":{"type":"array","items":{"$ref":"#/definitions/LinksEntity"},"description":"List of links attached to this service.","x-nullable":true},"managed_by":{"type":"string","description":"If set, this field indicates that the service is managed by an integration and thus cannot be set manually","x-nullable":true},"managed_by_settings":{"type":"object","description":"Indicates the settings of the catalog that manages this service","x-nullable":true},"owner":{"$ref":"#/definitions/NullableTeamEntityLite","description":"Team that owns the service"},"service_checklist_updated_at":{"type":"string","format":"date-time","x-nullable":true},"teams":{"type":"array","items":{"$ref":"#/definitions/TeamEntityLite"},"description":"List of teams attached to the service","x-nullable":true},"updated_by":{"$ref":"#/definitions/NullableAuthorEntity","description":"The most recent user to update the current service"}},"description":"ServiceEntity model"},"ChecklistTemplateEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"created_at":{"type":"string","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"checks":{"type":"array","items":{"$ref":"#/definitions/ChecklistCheckEntity"},"x-nullable":true},"owner":{"$ref":"#/definitions/NullableTeamEntityLite","description":"Team that owns the checklist template"},"connected_services":{"type":"array","items":{"$ref":"#/definitions/ServiceEntityChecklist"},"description":"List of services that use this checklist","x-nullable":true}},"description":"ChecklistTemplateEntity model"},"ChecklistCheckEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"status":{"type":"boolean","x-nullable":true}}},"ServiceEntityChecklist":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"slug":{"type":"string","x-nullable":true},"service_tier":{"type":"integer","format":"int32","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"allowed_params":{"type":"array","items":{"type":"string"},"x-nullable":true},"labels":{"type":"object","description":"An object of label key and values","additionalProperties":true,"x-nullable":true},"alert_on_add":{"type":"boolean","x-nullable":true},"auto_add_responding_team":{"type":"boolean","x-nullable":true},"completed_checks":{"type":"integer","format":"int32","x-nullable":true},"owner":{"$ref":"#/definitions/NullableTeamEntityLite","description":"Team that owns the service"},"service_checklist_updated_at":{"type":"string","format":"date-time","x-nullable":true}}},"FunctionalityEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"slug":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"labels":{"type":"object","description":"An object of label key and values","additionalProperties":true,"x-nullable":true},"active_incidents":{"type":"array","items":{"type":"string"},"description":"List of active incident guids","x-nullable":true},"links":{"type":"array","items":{"$ref":"#/definitions/LinksEntity"},"description":"List of links attached to this functionality.","x-nullable":true},"owner":{"$ref":"#/definitions/NullableTeamEntityLite","description":"Team that owns the functionality"},"service_tier":{"type":"integer","format":"int32","description":"Integer representing functionality tier (0-5, lower is more critical)","x-nullable":true},"alert_on_add":{"type":"boolean","x-nullable":true},"auto_add_responding_team":{"type":"boolean","x-nullable":true},"updated_by":{"$ref":"#/definitions/NullableAuthorEntity","description":"The most recent user to update the current functionality"},"teams":{"type":"array","items":{"$ref":"#/definitions/TeamEntityLite"},"description":"List of teams attached to the functionality","x-nullable":true},"services":{"type":"array","items":{"$ref":"#/definitions/ServiceEntityLite"},"description":"Services this functionality provides","x-nullable":true},"environments":{"type":"array","items":{"$ref":"#/definitions/EnvironmentEntryEntity"},"description":"Environments related to this functionality","x-nullable":true},"external_resources":{"type":"array","items":{"$ref":"#/definitions/ExternalResourceEntity"},"description":"Information about known linkages to representations of services outside of FireHydrant.","x-nullable":true}},"description":"FunctionalityEntity model"},"Imports_ImportableResourceEntity":{"type":"object","properties":{"import_errors":{"type":"array","items":{"$ref":"#/definitions/Imports_ImportErrorEntity"},"x-nullable":true},"imported_at":{"type":"string","format":"date-time","x-nullable":true},"remote_id":{"type":"string","x-nullable":true},"state":{"type":"string","enum":["selected","skipped","imported","errored"],"x-nullable":true}}},"Imports_ImportErrorEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"message":{"type":"string","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"data":{"type":"object","description":"Additional error data","x-nullable":true},"resource":{"$ref":"#/definitions/NullableImports_ImportErrorEntity_ResourceEntity"}}},"Imports_ImportErrorEntity_ResourceEntity":{"type":"object","properties":{"resource_id":{"type":"string","x-nullable":true},"resource_type":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true}}},"ServiceEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/ServiceEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"ServiceEntityPaginated model"},"create_service_links":{"type":"object","properties":{"external_service_ids":{"type":"string","description":"ID of the service"},"connection_id":{"type":"string","description":"ID for the integration. This can be found by going to the edit page for the integration"},"integration":{"type":"string","description":"The name of the service","enum":["pager_duty","opsgenie","victorops"]}},"required":["external_service_ids","connection_id","integration"],"description":"Creates a service with the appropriate integration for each external service ID passed"},"ServiceLinkEntity":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","x-nullable":true},"service":{"$ref":"#/definitions/NullableServiceEntity"}},"description":"ServiceLinkEntity model"},"update_service":{"type":"object","properties":{"alert_on_add":{"type":"boolean","x-nullable":true},"auto_add_responding_team":{"type":"boolean","x-nullable":true},"checklists":{"type":"array","description":"Array of checklist IDs to attach to the service","items":{"type":"object","properties":{"id":{"type":"string"},"remove":{"type":"boolean","description":"Set to `true` to remove checklist from service","x-nullable":true}},"required":["id"]},"x-nullable":true},"description":{"type":"string","x-nullable":true},"external_resources":{"type":"array","description":"An array of external resources to attach to this service.","items":{"type":"object","properties":{"remote_id":{"type":"string"},"connection_type":{"type":"string","description":"The integration slug for the external resource. Can be one of: github, opsgenie, pager_duty, victorops. Not required if the resource has already been imported.","x-nullable":true},"remove":{"type":"boolean","description":"If you are trying to remove an external resource from a service, set this to 'true'.","x-nullable":true}},"required":["remote_id"]},"x-nullable":true},"functionalities":{"type":"array","description":"An array of functionalities","items":{"type":"object","properties":{"id":{"type":"string","description":"If you are trying to reuse a functionality, you may set the ID to attach it to the service","x-nullable":true},"remove":{"type":"boolean","description":"If you are trying to remove a functionality from a service, set this to 'true'","x-nullable":true},"summary":{"type":"string","description":"If you are trying to create a new functionality and attach it to this service, set the summary key","x-nullable":true}}},"x-nullable":true},"remove_remaining_functionalities":{"type":"boolean","description":"If set to true, any functionalities tagged on the service that are not included in the given array will be removed. Set this to true if you want to do a replacement operation for the functionalities","x-nullable":true},"environments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of an environment"},"remove":{"type":"boolean","description":"Set to true if you want to remove the given environment from the service","x-nullable":true}},"required":["id"]},"x-nullable":true},"remove_remaining_environments":{"type":"boolean","description":"Set this to true if you want to remove all of the environments that are not included in the environments array from the service","default":false,"x-nullable":true},"labels":{"type":"object","description":"A hash of label keys and values","additionalProperties":{"type":"string"},"x-nullable":true},"links":{"type":"array","description":"An array of links to associate with this service. This will remove all links not present in the patch. Only acts if 'links' key is included in the payload.","items":{"type":"object","properties":{"href_url":{"type":"string","description":"URL"},"name":{"type":"string","description":"Short name used to display and identify this link"},"icon_url":{"type":"string","description":"An optional URL to an icon representing this link","x-nullable":true},"remove":{"type":"boolean","description":"If you are trying to remove a link, set this to 'true'","x-nullable":true},"id":{"type":"string","description":"If updating an existing link, specify it's id.","x-nullable":true}},"required":["href_url","name"]},"x-nullable":true},"name":{"type":"string","x-nullable":true},"owner":{"type":"object","description":"An object representing a Team that owns the service","properties":{"id":{"type":"string"}},"required":["id"],"x-nullable":true},"remove_owner":{"type":"boolean","description":"If you are trying to remove a team as an owner from a service, set this to 'true'","x-nullable":true},"remove_remaining_checklists":{"type":"boolean","description":"If set to true, any checklists tagged on the service that are not included in the given array will be removed. Set this to true if you want to do a replacement operation for the checklists","x-nullable":true},"remove_remaining_external_resources":{"type":"boolean","description":"If set to true, any external_resources tagged on the service that are not included in the given array will be removed. Set this to true if you want to do a replacement operation for the external_resources","x-nullable":true},"remove_remaining_teams":{"type":"boolean","description":"If set to true, any teams tagged on the service that are not included in the given array will be removed. Set this to true if you want to do a replacement operation for the teams","x-nullable":true},"service_tier":{"type":"integer","format":"int32","description":"Integer representing service tier","enum":[0,1,2,3,4,5],"x-nullable":true},"teams":{"type":"array","description":"An array of teams to attach to this service.","items":{"type":"object","properties":{"id":{"type":"string"},"remove":{"type":"boolean","description":"If you are trying to remove a team from a service, set this to 'true'","x-nullable":true}},"required":["id"]},"x-nullable":true}},"description":"Update a services attributes, you may also add or remove functionalities from the service as well.\nNote: You may not remove or add individual label key/value pairs. You must include the entire object to override label values.\n"},"ServiceWithAllDependenciesEntity":{"type":"object","properties":{"child_service_dependencies":{"type":"array","items":{"$ref":"#/definitions/ServiceChildDependencyEntity"},"description":"Services that depend on this service","x-nullable":true},"parent_service_dependencies":{"type":"array","items":{"$ref":"#/definitions/ServiceParentDependencyEntity"},"description":"Services that this service is dependent on","x-nullable":true},"service_dependencies":{"type":"array","items":{"type":"object"},"description":"All dependencies. Can be one of: ServiceChildDependencyEntity, ServiceParentDependencyEntity","x-nullable":true}},"description":"ServiceWithAllDependenciesEntity model"},"ServiceChildDependencyEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"notes":{"type":"string","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"service":{"$ref":"#/definitions/NullableServiceEntity"},"type":{"type":"string","x-nullable":true}}},"ServiceParentDependencyEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"notes":{"type":"string","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"service":{"$ref":"#/definitions/NullableServiceEntity"},"type":{"type":"string","x-nullable":true}}},"create_service_checklist_response":{"type":"object","properties":{"check_id":{"type":"string"},"status":{"type":"boolean","description":"Status of the check. 'true' if it's complete, 'false' if incomplete, or blank if not yet interacted with"}},"required":["check_id","status"],"description":"Creates a response for a checklist item"},"create_service_dependency":{"type":"object","properties":{"service_id":{"type":"string"},"connected_service_id":{"type":"string"},"notes":{"type":"string","description":"A note to describe the service dependency relationship","x-nullable":true}},"required":["service_id","connected_service_id"],"description":"Creates a service dependency relationship between two services"},"ServiceDependencyEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"notes":{"type":"string","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"service":{"$ref":"#/definitions/NullableServiceEntity"},"connected_service":{"$ref":"#/definitions/NullableServiceEntity"}},"description":"ServiceDependencyEntity model"},"update_service_dependency":{"type":"object","properties":{"notes":{"type":"string","description":"A note to describe the service dependency relationship","x-nullable":true}},"description":"Update the notes of the service dependency"},"create_functionality":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","x-nullable":true},"services":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of a service"}},"required":["id"]},"x-nullable":true},"environments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of an environment"}},"required":["id"]},"x-nullable":true},"labels":{"type":"object","description":"A hash of label keys and values","additionalProperties":{"type":"string"},"x-nullable":true},"service_tier":{"type":"integer","format":"int32","description":"Integer representing functionality tier. Lower values represent higher criticality. Default is 5.","enum":[0,1,2,3,4,5],"x-nullable":true},"alert_on_add":{"type":"boolean","x-nullable":true},"auto_add_responding_team":{"type":"boolean","x-nullable":true},"external_resources":{"type":"array","description":"An array of external resources to attach to this service.","items":{"type":"object","properties":{"remote_id":{"type":"string"},"connection_type":{"type":"string","description":"The integration slug for the external resource. Can be one of: github, opsgenie, pager_duty, statuspage, victorops. Not required if the resource has already been imported.","x-nullable":true}},"required":["remote_id"]},"x-nullable":true},"links":{"type":"array","description":"An array of links to associate with this service","items":{"type":"object","properties":{"name":{"type":"string","description":"Short name used to display and identify this link"},"href_url":{"type":"string","description":"URL"},"icon_url":{"type":"string","description":"An optional URL to an icon representing this link","x-nullable":true}},"required":["name","href_url"]},"x-nullable":true},"owner":{"type":"object","description":"An object representing a Team that owns the service","properties":{"id":{"type":"string"}},"required":["id"],"x-nullable":true},"teams":{"type":"array","description":"An array of teams to attach to this service.","items":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"x-nullable":true}},"required":["name"],"description":"Creates a functionality for the organization"},"FunctionalityEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/FunctionalityEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"FunctionalityEntityPaginated model"},"update_functionality":{"type":"object","properties":{"name":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"service_tier":{"type":"integer","format":"int32","description":"Integer representing functionality tier","enum":[0,1,2,3,4,5],"x-nullable":true},"services":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of a service"},"remove":{"type":"boolean","description":"Set to true if you want to remove the given service from the functionality","x-nullable":true}},"required":["id"]},"x-nullable":true},"remove_remaining_services":{"type":"boolean","description":"Set this to true if you want to remove all of the services that are not included in the services array from the functionality","default":false,"x-nullable":true},"environments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of an environment"},"remove":{"type":"boolean","description":"Set to true if you want to remove the given environment from the functionality","x-nullable":true}},"required":["id"]},"x-nullable":true},"remove_remaining_environments":{"type":"boolean","description":"Set this to true if you want to remove all of the environments that are not included in the environments array from the functionality","default":false,"x-nullable":true},"links":{"type":"array","description":"An array of links to associate with this functionality. This will remove all links not present in the patch. Only acts if 'links' key is included in the payload.","items":{"type":"object","properties":{"href_url":{"type":"string","description":"URL"},"name":{"type":"string","description":"Short name used to display and identify this link"},"icon_url":{"type":"string","description":"An optional URL to an icon representing this link","x-nullable":true},"remove":{"type":"boolean","description":"If you are trying to remove a link, set this to 'true'","x-nullable":true},"id":{"type":"string","description":"If updating an existing link, specify it's id.","x-nullable":true}},"required":["href_url","name"]},"x-nullable":true},"owner":{"type":"object","description":"An object representing a Team that owns the functionality","properties":{"id":{"type":"string"}},"required":["id"],"x-nullable":true},"remove_owner":{"type":"boolean","description":"If you are trying to remove a team as an owner from a functionality, set this to 'true'","x-nullable":true},"teams":{"type":"array","description":"An array of teams to attach to this functionality.","items":{"type":"object","properties":{"id":{"type":"string"},"remove":{"type":"boolean","description":"If you are trying to remove a team from a functionality, set this to 'true'","x-nullable":true}},"required":["id"]},"x-nullable":true},"remove_remaining_teams":{"type":"boolean","description":"If set to true, any teams tagged on the service that are not included in the given array will be removed. Set this to true if you want to do a replacement operation for the teams","x-nullable":true},"external_resources":{"type":"array","description":"An array of external resources to attach to this service.","items":{"type":"object","properties":{"remote_id":{"type":"string"},"connection_type":{"type":"string","description":"The integration slug for the external resource. Can be one of: github, opsgenie, pager_duty, statuspage, victorops. Not required if the resource has already been imported.","x-nullable":true},"remove":{"type":"boolean","description":"If you are trying to remove an external resource from a service, set this to 'true'.","x-nullable":true}},"required":["remote_id"]},"x-nullable":true},"remove_remaining_external_resources":{"type":"boolean","description":"If set to true, any external_resources tagged on the service that are not included in the given array will be removed. Set this to true if you want to do a replacement operation for the external_resources","x-nullable":true},"labels":{"type":"object","description":"A hash of label keys and values","additionalProperties":{"type":"string"},"x-nullable":true},"alert_on_add":{"type":"boolean","x-nullable":true},"auto_add_responding_team":{"type":"boolean","x-nullable":true}},"description":"Update a functionalities attributes"},"FunctionalityWithAllServicesEntity":{"type":"object","properties":{"services":{"type":"array","items":{"$ref":"#/definitions/ServiceEntity"},"description":"Services this functionality provides","x-nullable":true}},"description":"FunctionalityWithAllServicesEntity model"},"create_team":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","x-nullable":true},"slug":{"type":"string","x-nullable":true},"slack_channel_id":{"type":"string","description":"The Slack channel ID associated with this team. This may be the reference in FireHydrant's system (i.e. UUID) or the ID value from Slack (e.g. C1234567890).\n","x-nullable":true},"ms_teams_channel":{"type":"object","description":"MS Teams channel identity for channel associated with this team","properties":{"channel_id":{"type":"string"},"ms_team_id":{"type":"string"}},"required":["channel_id","ms_team_id"],"x-nullable":true},"memberships":{"type":"array","items":{"type":"object","properties":{"user_id":{"type":"string","description":"The ID of a user to add to the team. This parameter is mutually exclusive with schedule_id and signals_on_call_schedule_id.","x-nullable":true},"schedule_id":{"type":"string","description":"The ID of a third-party on-call schedule to add to the team, allowing you to specify that whoever is on call for this schedule when the team is assigned to an incident gets added to the incident and optionally assigned to the configured incident role. This parameter is mutually exclusive with user_id and signals_on_call_schedule_id.","x-nullable":true},"signals_on_call_schedule_id":{"type":"string","description":"The ID of a Signals on-call schedule to add to the team, allowing you to specify that whoever is on call for this schedule when the team is assigned to an incident gets added to the incident and optionally assigned to the configured incident role.. This parameter is mutually exclusive with user_id and schedule_id.","x-nullable":true},"incident_role_id":{"type":"string","description":"An incident role ID that the user will automatically assigned if this team is assigned to an incident","x-nullable":true}}},"x-nullable":true},"invite_emails":{"type":"array","description":"A list of email addresses to invite to join the organization and automatically add to this team. If an email already has a pending invitation, the team will be added to their existing invitation.","items":{"type":"string"},"x-nullable":true}},"required":["name"],"description":"Create a new team"},"TeamEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"slug":{"type":"string","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"signals_ical_url":{"type":"string","x-nullable":true},"created_by":{"$ref":"#/definitions/NullableAuthorEntity"},"in_support_hours":{"type":"boolean","x-nullable":true},"restrict_signals_resource_management":{"type":"boolean","x-nullable":true},"slack_channel":{"$ref":"#/definitions/NullableIntegrations_Slack_SlackChannelEntity"},"ms_teams_channel":{"$ref":"#/definitions/NullableIntegrations_MicrosoftTeamsV2_ChannelEntity"},"memberships":{"type":"array","items":{"$ref":"#/definitions/MembershipEntity"},"x-nullable":true},"owned_checklist_templates":{"type":"array","items":{"$ref":"#/definitions/ChecklistTemplateEntity"},"x-nullable":true},"owned_functionalities":{"type":"array","items":{"$ref":"#/definitions/FunctionalityEntityLite"},"x-nullable":true},"owned_services":{"type":"array","items":{"$ref":"#/definitions/ServiceEntityLite"},"x-nullable":true},"owned_runbooks":{"type":"array","items":{"$ref":"#/definitions/SlimRunbookEntity"},"x-nullable":true},"responding_services":{"type":"array","items":{"$ref":"#/definitions/ServiceEntityLite"},"x-nullable":true},"services":{"type":"array","items":{"$ref":"#/definitions/ServiceEntityLite"},"x-nullable":true},"functionalities":{"type":"array","items":{"$ref":"#/definitions/FunctionalityEntityLite"},"x-nullable":true},"default_signals_escalation_policy":{"$ref":"#/definitions/NullableSuccinctEntity","description":"The team's default Signals escalation policy"}},"description":"TeamEntity model"},"Integrations_Slack_SlackChannelEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"slack_channel_id":{"type":"string","x-nullable":true}}},"Integrations_MicrosoftTeamsV2_ChannelEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"channel_id":{"type":"string","x-nullable":true},"channel_name":{"type":"string","x-nullable":true},"ms_team_id":{"type":"string","x-nullable":true},"team_name":{"type":"string","x-nullable":true},"channel_url":{"type":"string","x-nullable":true},"status":{"type":"string","x-nullable":true},"incident":{"$ref":"#/definitions/NullableIncidentEntity"}}},"IncidentEntity":{"type":"object","properties":{"id":{"type":"string","description":"UUID of the Incident","x-nullable":true},"name":{"type":"string","description":"Name of the incident","x-nullable":true},"created_at":{"type":"string","format":"date-time","description":"The time the incident was opened","x-nullable":true},"started_at":{"type":"string","format":"date-time","description":"The time the incident started","x-nullable":true},"discarded_at":{"type":"string","format":"date-time","description":"The time the incident was archived","x-nullable":true},"summary":{"type":"string","x-nullable":true},"customer_impact_summary":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"current_milestone":{"type":"string","description":"The type/slug of the current milestone. Will be one of the currently configured milestones for the given incident.","x-nullable":true},"number":{"type":"integer","format":"int32","description":"Incident number","x-nullable":true},"priority":{"type":"string","x-nullable":true},"severity":{"type":"string","x-nullable":true},"severity_color":{"type":"string","x-nullable":true},"severity_impact":{"type":"string","x-nullable":true},"severity_condition":{"type":"string","x-nullable":true},"tag_list":{"type":"array","items":{"type":"string"},"x-nullable":true},"incident_type":{"$ref":"#/definitions/NullableSuccinctEntity"},"severity_impact_object":{"$ref":"#/definitions/NullableSeverityMatrix_ImpactEntity"},"severity_condition_object":{"$ref":"#/definitions/NullableSeverityMatrix_ConditionEntity"},"private_id":{"type":"string","x-nullable":true},"organization_id":{"type":"string","x-nullable":true},"milestones":{"type":"array","items":{"$ref":"#/definitions/Incidents_MilestoneEntity"},"description":"DEPRECATED: Please use lifecycle phases instead","x-nullable":true},"lifecycle_phases":{"type":"array","items":{"$ref":"#/definitions/Incidents_LifecyclePhaseEntity"},"x-nullable":true},"lifecycle_measurements":{"type":"array","items":{"$ref":"#/definitions/Incidents_LifecycleMeasurementEntity"},"x-nullable":true},"active":{"type":"boolean","x-nullable":true},"labels":{"type":"object","description":"A key/value of labels","x-nullable":true},"role_assignments":{"type":"array","items":{"$ref":"#/definitions/Incidents_RoleAssignmentEntity"},"x-nullable":true},"status_pages":{"type":"array","items":{"$ref":"#/definitions/Incidents_StatusPageEntity"},"x-nullable":true},"incident_url":{"type":"string","x-nullable":true},"private_status_page_url":{"type":"string","x-nullable":true},"organization":{"$ref":"#/definitions/NullableOrganizationEntity"},"customers_impacted":{"type":"integer","format":"int32","x-nullable":true},"monetary_impact":{"type":"integer","format":"int32","x-nullable":true},"monetary_impact_cents":{"type":"integer","format":"int32","x-nullable":true},"last_update":{"type":"string","x-nullable":true},"last_note":{"$ref":"#/definitions/NullableEvent_NoteEntity"},"report_id":{"type":"string","x-nullable":true},"ai_incident_summary":{"type":"string","description":"DEPRECATED: this field is deprecated and will be removed in a future version. Please use the `/v1/audiences/summaries/:incident_id` endpoint instead.","x-nullable":true},"services":{"type":"array","items":{"$ref":"#/definitions/SuccinctEntity"},"x-nullable":true},"environments":{"type":"array","items":{"$ref":"#/definitions/SuccinctEntity"},"x-nullable":true},"functionalities":{"type":"array","items":{"$ref":"#/definitions/SuccinctEntity"},"x-nullable":true},"channel_name":{"type":"string","x-nullable":true},"channel_reference":{"type":"string","x-nullable":true},"channel_id":{"type":"string","x-nullable":true},"channel_status":{"type":"string","description":"inoperative: 0, operational: 1, archived: 2","x-nullable":true},"incident_tickets":{"type":"array","items":{"$ref":"#/definitions/Ticketing_TicketEntity"},"x-nullable":true},"ticket":{"$ref":"#/definitions/NullableTicketing_TicketEntity"},"impacts":{"type":"array","items":{"$ref":"#/definitions/Incidents_ImpactEntity"},"x-nullable":true},"conference_bridges":{"type":"array","items":{"$ref":"#/definitions/Incidents_ConferenceBridgeEntity"},"x-nullable":true},"incident_channels":{"type":"array","items":{"$ref":"#/definitions/Incidents_ChannelEntity"},"x-nullable":true},"retro_exports":{"type":"array","items":{"type":"object"},"description":"A list of objects attached to this item. Can be one of: LinkEntity, CustomerSupportIssueEntity, or GenericAttachmentEntity","x-nullable":true},"created_by":{"$ref":"#/definitions/NullableAuthorEntity"},"context_object":{"$ref":"#/definitions/NullableIncidents_ContextObjectEntity"},"team_assignments":{"type":"array","items":{"$ref":"#/definitions/Incidents_TeamAssignmentEntityLite"},"x-nullable":true},"conversations":{"type":"array","items":{"$ref":"#/definitions/Conversations_API_Entities_Reference"},"x-nullable":true},"custom_fields":{"type":"array","items":{"$ref":"#/definitions/CustomFields_FieldValue"},"x-nullable":true},"field_requirements":{"type":"array","items":{"$ref":"#/definitions/IncidentEntity_FieldRequirementEntity"},"x-nullable":true}},"description":"IncidentEntity model"},"SuccinctEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true}}},"SeverityMatrix_ImpactEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"type":{"type":"string","x-nullable":true},"affects_id":{"type":"string","x-nullable":true},"position":{"type":"integer","format":"int32","x-nullable":true}},"description":"SeverityMatrix_ImpactEntity model"},"SeverityMatrix_ConditionEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"position":{"type":"integer","format":"int32","description":"Position is used to determine ordering of conditions in API responses and dropdowns. The condition with the lowest position (typically 0) will be considered the Default Condition","x-nullable":true}},"description":"SeverityMatrix_ConditionEntity model"},"Incidents_MilestoneEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"type":{"type":"string","description":"The milestone's type. This will be one of the currently configured milestones for the given incident.","x-nullable":true},"duration":{"type":"string","description":"How long the incident spent in this milestones, in ISO 8601 Duration Format. This will be null if the milestone is the incident's current milestone.","x-nullable":true},"occurred_at":{"type":"string","format":"date-time","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true}}},"Incidents_LifecyclePhaseEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"type":{"type":"string","x-nullable":true},"position":{"type":"integer","format":"int32","x-nullable":true},"milestones":{"type":"array","items":{"$ref":"#/definitions/Incidents_LifecycleMilestoneEntity"},"x-nullable":true}}},"Incidents_LifecycleMilestoneEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"slug":{"type":"string","x-nullable":true},"position":{"type":"integer","format":"int32","x-nullable":true},"occurred_at":{"type":"string","format":"date-time","x-nullable":true},"duration":{"type":"string","x-nullable":true},"updated_by":{"$ref":"#/definitions/NullableAuthorEntity"},"updated_at":{"type":"string","format":"date-time","x-nullable":true}}},"Incidents_LifecycleMeasurementEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"slug":{"type":"string","x-nullable":true},"starts_at_milestone":{"type":"string","x-nullable":true},"ends_at_milestone":{"type":"string","x-nullable":true},"value":{"type":"string","x-nullable":true},"calculated_at":{"type":"string","format":"date-time","x-nullable":true}}},"Incidents_RoleAssignmentEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"status":{"type":"string","enum":["active","inactive"],"x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"incident_role":{"$ref":"#/definitions/NullableIncidentRoleEntity"},"user":{"$ref":"#/definitions/NullableUserEntity"}},"description":"Incidents_RoleAssignmentEntity model"},"IncidentRoleEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"summary":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"discarded_at":{"type":"string","format":"date-time","x-nullable":true}},"description":"IncidentRoleEntity model"},"UserEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"email":{"type":"string","x-nullable":true},"slack_user_id":{"type":"string","x-nullable":true},"role":{"type":"string","x-nullable":true},"slack_linked?":{"type":"boolean","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"signals_enabled_notification_types":{"type":"array","items":{"type":"string"},"x-nullable":true},"signals_notification_policy_compliance":{"type":"array","items":{"$ref":"#/definitions/Signals_API_NotificationPolicyItemComplianceEntity"},"x-nullable":true}},"description":"UserEntity model"},"Signals_API_NotificationPolicyItemComplianceEntity":{"type":"object","properties":{"notification_policy_item_id":{"type":"string","x-nullable":true},"is_compliant":{"type":"boolean","x-nullable":true}}},"Incidents_StatusPageEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"url":{"type":"string","x-nullable":true},"external_id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"display_name":{"type":"string","x-nullable":true},"integration":{"$ref":"#/definitions/NullableIntegrationEntity"}},"description":"Incidents_StatusPageEntity model"},"IntegrationEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"integration_name":{"type":"string","x-nullable":true},"integration_slug":{"type":"string","x-nullable":true},"display_name":{"type":"string","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true}}},"Event_NoteEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"body":{"type":"string","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"status_pages":{"type":"array","items":{"$ref":"#/definitions/Incidents_StatusPageEntity"},"x-nullable":true},"conversations":{"type":"array","items":{"$ref":"#/definitions/Conversations_API_Entities_Reference"},"x-nullable":true}},"description":"Event_NoteEntity model"},"Conversations_API_Entities_Reference":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"resource_class":{"type":"string","x-nullable":true},"resource_id":{"type":"string","x-nullable":true},"field":{"type":"string","x-nullable":true},"comments_url":{"type":"string","x-nullable":true},"channel":{"$ref":"#/definitions/NullableConversations_API_Entities_Channel"}}},"Conversations_API_Entities_Channel":{"type":"object","properties":{"name":{"type":"string","x-nullable":true}}},"Ticketing_TicketEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"summary":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"state":{"type":"string","enum":["open","in_progress","cancelled","done"],"x-nullable":true},"external_status_label":{"type":"string","description":"The status label as named by the ticketing provider","x-nullable":true},"type":{"type":"string","enum":["incident","task","follow_up"],"x-nullable":true},"connection_type":{"type":"string","description":"Integration slug for the ticket's connection (e.g. freshservice, jira_cloud)","x-nullable":true},"assignees":{"type":"array","items":{"$ref":"#/definitions/AuthorEntity"},"x-nullable":true},"priority":{"$ref":"#/definitions/NullableTicketing_PriorityEntity"},"created_by":{"$ref":"#/definitions/NullableAuthorEntity"},"attachments":{"type":"array","items":{"type":"object"},"description":"A list of objects attached to this item. Can be one of: LinkEntity, CustomerSupportIssueEntity, or GenericAttachmentEntity","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"tag_list":{"type":"array","items":{"type":"string"},"x-nullable":true},"incident_id":{"type":"string","description":"ID of incident that this ticket is related to","x-nullable":true},"incident_name":{"type":"string","description":"Name of incident that this ticket is related to","x-nullable":true},"incident_current_milestone":{"type":"string","description":"Milestone of incident that this ticket is related to","x-nullable":true},"task_id":{"type":"string","description":"ID of task that this ticket is related to","x-nullable":true},"due_at":{"type":"string","format":"date-time","x-nullable":true},"sync_error_message":{"type":"string","description":"Error message from syncing this ticket to integrations","x-nullable":true},"ticketing_custom_fields":{"type":"array","items":{"$ref":"#/definitions/Ticketing_CustomFields_FieldValue"},"x-nullable":true},"link":{"$ref":"#/definitions/NullableAttachments_LinkEntity"},"provider_status_label":{"type":"string","description":"Integration-specific status label (e.g. Freshservice status name)","x-nullable":true}},"description":"Ticketing_TicketEntity model"},"Ticketing_PriorityEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"position":{"type":"integer","format":"int32","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true}},"description":"Ticketing_PriorityEntity model"},"Ticketing_CustomFields_FieldValue":{"type":"object","properties":{"name":{"type":"string","description":"The name of the custom field definition","x-nullable":true},"value_type":{"type":"string","description":"The type of the custom field definition","x-nullable":true},"display_name":{"type":"string","description":"The display name of the custom field definition","x-nullable":true},"description":{"type":"string","description":"The description of the custom field definition","x-nullable":true},"slug":{"type":"string","description":"The slug of the custom field definition","x-nullable":true},"field_id":{"type":"string","description":"The field id of the custom field definition","x-nullable":true},"field_type":{"type":"string","description":"The field type of the custom field definition","x-nullable":true},"permissible_values":{"type":"array","items":{"type":"string"},"description":"An array of strings representing selections for single_select or multi_select fields","x-nullable":true},"value_array":{"type":"array","items":{"type":"string"},"description":"The value of the custom field as an array (for select fields)","x-nullable":true},"value_string":{"type":"string","description":"The value of the custom field as a string (for string and datetime types)","x-nullable":true},"value":{"type":"string","description":"The raw value of the custom field","x-nullable":true}}},"Attachments_LinkEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"type":{"type":"string","x-nullable":true},"display_text":{"type":"string","x-nullable":true},"href_url":{"type":"string","x-nullable":true},"icon_url":{"type":"string","x-nullable":true},"editable":{"type":"boolean","description":"Link can be edited","x-nullable":true},"deletable":{"type":"boolean","description":"Link can be deleted","x-nullable":true}},"description":"Attachments_LinkEntity model"},"Incidents_ImpactEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"type":{"type":"string","enum":["customer","environment","functionality","service"],"x-nullable":true},"impact":{"$ref":"#/definitions/NullableSuccinctEntity"},"condition":{"$ref":"#/definitions/NullableSeverityMatrix_ConditionEntity"},"conversations":{"type":"array","items":{"$ref":"#/definitions/Conversations_API_Entities_Reference"},"x-nullable":true}}},"Incidents_ConferenceBridgeEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"attachments":{"type":"array","items":{"type":"object"},"description":"A list of objects attached to this item. Can be one of: LinkEntity, CustomerSupportIssueEntity, or GenericAttachmentEntity","x-nullable":true},"has_translated_transcripts":{"type":"boolean","x-nullable":true},"language_codes":{"type":"array","items":{"type":"string"},"description":"A list of language codes that have translated transcripts for this conference bridge","x-nullable":true},"transcription_status":{"type":"string","x-nullable":true},"transcription_sub_code":{"type":"string","x-nullable":true},"previous_host_assignment":{"type":"string","x-nullable":true}},"description":"Incidents_ConferenceBridgeEntity model"},"Incidents_ChannelEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"source":{"type":"string","x-nullable":true},"source_name":{"type":"string","x-nullable":true},"source_id":{"type":"string","x-nullable":true},"url":{"type":"string","x-nullable":true},"icon_url":{"type":"string","x-nullable":true},"status":{"type":"string","x-nullable":true}},"description":"Incidents_ChannelEntity model"},"Incidents_ContextObjectEntity":{"type":"object","properties":{"object_type":{"type":"string","x-nullable":true},"object_id":{"type":"string","x-nullable":true},"context_tag":{"type":"string","x-nullable":true},"context_description":{"type":"string","x-nullable":true}}},"Incidents_TeamAssignmentEntityLite":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"status":{"type":"string","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"team":{"$ref":"#/definitions/NullableTeamEntityLite"}}},"CustomFields_FieldValue":{"type":"object","properties":{"name":{"type":"string","x-nullable":true},"value_type":{"type":"string","x-nullable":true},"display_name":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"slug":{"type":"string","x-nullable":true},"field_id":{"type":"string","x-nullable":true},"value_array":{"type":"array","items":{"type":"string"},"x-nullable":true},"value_string":{"type":"string","x-nullable":true},"value":{"type":"string","x-nullable":true}}},"IncidentEntity_FieldRequirementEntity":{"type":"object","properties":{"field_id":{"type":"string","description":"A unique identifier for the field.","x-nullable":true},"required_at_milestone_id":{"type":"string","description":"The milestone at which this field is required. If null, this field is always required.","x-nullable":true}}},"MembershipEntity":{"type":"object","properties":{"user":{"$ref":"#/definitions/NullableUserEntity"},"schedule":{"$ref":"#/definitions/NullableScheduleEntity"},"signals_on_call_schedule":{"$ref":"#/definitions/NullableSuccinctEntity"},"default_incident_role":{"$ref":"#/definitions/NullableIncidentRoleEntity"},"read_only_permissions":{"type":"boolean","description":"Whether the user has read-only permissions","x-nullable":true}}},"ScheduleEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"integration":{"type":"string","x-nullable":true},"discarded":{"type":"boolean","x-nullable":true}}},"SlimRunbookEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"summary":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"type":{"type":"string","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"attachment_rule":{"$ref":"#/definitions/NullableRules_RuleEntity"},"owner":{"$ref":"#/definitions/NullableTeamEntityLite","description":"Team that owns the runbook"},"categories":{"type":"array","items":{"type":"string"},"description":"categories the runbook applies to","x-nullable":true},"last_executed_at":{"type":"string","format":"date-time","description":"The timestamp when this runbook was last executed","x-nullable":true},"last_executed_for_incident":{"$ref":"#/definitions/NullablePublicAPI_V1_Incidents_SuccinctEntity","description":"The incident for which this runbook was most recently executed, if accessible"}}},"Rules_RuleEntity":{"type":"object","properties":{"logic":{"type":"object","description":"An unstructured object of key/value pairs describing the logic for applying the rule.","x-nullable":true},"user_data":{"$ref":"#/definitions/NullableFHTypes_GenericEntity"}}},"FHTypes_GenericEntity":{"type":"object","properties":{"type":{"type":"string","x-nullable":true},"value":{"type":"string","x-nullable":true},"label":{"type":"string","x-nullable":true}}},"PublicAPI_V1_Incidents_SuccinctEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"number":{"type":"integer","format":"int32","x-nullable":true}}},"TeamEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/TeamEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"TeamEntityPaginated model"},"update_team":{"type":"object","properties":{"name":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"slug":{"type":"string","x-nullable":true},"slack_channel_id":{"type":"string","description":"The Slack channel ID associated with this team. This may be the reference in FireHydrant's system (i.e. UUID) or the ID value from Slack (e.g. C1234567890).\n","x-nullable":true},"ms_teams_channel":{"type":"object","description":"MS Teams channel identity for channel associated with this team","properties":{"channel_id":{"type":"string"},"ms_team_id":{"type":"string"}},"required":["channel_id","ms_team_id"],"x-nullable":true},"memberships":{"type":"array","items":{"type":"object","properties":{"user_id":{"type":"string","description":"The ID of a user to add to the team. This parameter is mutually exclusive with schedule_id and signals_on_call_schedule_id.","x-nullable":true},"schedule_id":{"type":"string","description":"The ID of a third-party on-call schedule to add to the team, allowing you to specify that whoever is on call for this schedule when the team is assigned to an incident gets added to the incident and optionally assigned to the configured incident role. This parameter is mutually exclusive with user_id and signals_on_call_schedule_id.","x-nullable":true},"signals_on_call_schedule_id":{"type":"string","description":"The ID of a Signals on-call schedule to add to the team, allowing you to specify that whoever is on call for this schedule when the team is assigned to an incident gets added to the incident and optionally assigned to the configured incident role.. This parameter is mutually exclusive with user_id and schedule_id.","x-nullable":true},"incident_role_id":{"type":"string","description":"An incident role ID that this user will automatically be assigned if this team is assigned to an incident. Omit this field to leave the member's current default incident role unchanged; pass null explicitly to clear it.","x-nullable":true}}},"x-nullable":true},"invite_emails":{"type":"array","description":"A list of email addresses to invite to join the organization and automatically add to this team. If an email already has a pending invitation, the team will be added to their existing invitation.","items":{"type":"string"},"x-nullable":true}},"description":"Update a single team from its ID"},"update_support_hours_schedule":{"type":"object","properties":{"time_zone":{"type":"string","x-nullable":true},"signals_maximum_notification_priority":{"type":"string","enum":["HIGH","MEDIUM","LOW"],"x-nullable":true},"bypass_priority_threshold":{"type":"string","enum":["HIGH","MEDIUM","LOW"],"x-nullable":true},"shifts":{"type":"array","items":{"type":"object","properties":{"start_time":{"type":"string"},"end_time":{"type":"string"},"day_of_week":{"type":"string","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]},"signals_maximum_notification_priority":{"type":"string","enum":["HIGH","MEDIUM","LOW"]}},"required":["start_time","end_time","day_of_week","signals_maximum_notification_priority"]},"x-nullable":true}},"description":"Update the team's support hours schedule"},"SupportHoursScheduleEntity":{"type":"object","properties":{"team_id":{"type":"string","x-nullable":true},"time_zone":{"type":"string","x-nullable":true},"signals_maximum_notification_priority":{"type":"string","x-nullable":true},"bypass_priority_threshold":{"type":"string","x-nullable":true},"in_support_hours":{"type":"boolean","x-nullable":true},"shifts":{"type":"array","items":{"$ref":"#/definitions/SupportHoursShiftEntity"},"x-nullable":true},"updated_by":{"$ref":"#/definitions/NullableAuthorEntity"}},"description":"SupportHoursScheduleEntity model"},"SupportHoursShiftEntity":{"type":"object","properties":{"day_of_week":{"type":"string","x-nullable":true},"start_time":{"type":"string","format":"date-time","x-nullable":true},"end_time":{"type":"string","format":"date-time","x-nullable":true},"signals_maximum_notification_priority":{"type":"string","x-nullable":true}}},"create_team_call_route":{"type":"object","properties":{"name":{"type":"string","description":"Name of the call route"},"phone_number":{"type":"string","description":"Phone number to route calls to"},"routing_mode":{"type":"string","description":"Routing mode for the call route","enum":["ROUTING_MODE_TAKE_MESSAGE","ROUTING_MODE_DIRECT_CONNECT"]},"connect_mode":{"type":"string","description":"Connect mode for the call route","enum":["CONNECT_MODE_CONFERENCE","CONNECT_MODE_DIRECT_DIAL"],"x-nullable":true},"description":{"type":"string","description":"Description of the call route","x-nullable":true},"greeting_message":{"type":"string","description":"Greeting message for the call route","x-nullable":true},"steps":{"type":"array","description":"Steps for the call route","items":{"type":"object","properties":{"target_type":{"type":"string","description":"Type of target","enum":["User","OnCallSchedule"]},"target_id":{"type":"string","description":"ID of the target"},"timeout":{"type":"string","description":"Timeout in seconds for the step"},"on_call_rotation_id":{"type":"string","description":"The ID of a specific on-call rotation that should be routed to if the `target_type` is `OnCallSchedule`. If not provided, the schedule's first rotation will be used.","x-nullable":true}},"required":["target_type","target_id","timeout"]},"x-nullable":true},"target":{"type":"object","description":"Target for the call route (required unless connect_mode is direct_dial)","properties":{"type":{"type":"string","description":"Type of target"},"id":{"type":"string","description":"ID of the target"}},"required":["type","id"],"x-nullable":true}},"required":["name","phone_number","routing_mode"],"description":"Create a call route for a team"},"Signals_API_CallRouteEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"phone_number":{"type":"string","x-nullable":true},"greeting_message":{"type":"string","x-nullable":true},"routing_mode":{"type":"string","enum":["ROUTING_MODE_TAKE_MESSAGE","ROUTING_MODE_DIRECT_CONNECT"],"x-nullable":true},"connect_mode":{"type":"string","enum":["CONNECT_MODE_CONFERENCE","CONNECT_MODE_DIRECT_DIAL"],"x-nullable":true},"steps":{"$ref":"#/definitions/NullableSignals_API_CallRouteStepEntity"},"target":{"$ref":"#/definitions/NullableSignals_API_TargetEntity"}},"description":"Signals_API_CallRouteEntity model"},"Signals_API_CallRouteStepEntity":{"type":"object","properties":{"target":{"$ref":"#/definitions/NullableSignals_API_TargetEntity"},"position":{"type":"integer","format":"int32","x-nullable":true},"timeout":{"type":"string","x-nullable":true},"on_call_rotation":{"$ref":"#/definitions/NullableSuccinctEntity"}}},"Signals_API_TargetEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"type":{"type":"string","x-nullable":true},"team_id":{"type":"string","x-nullable":true},"is_pageable":{"type":"boolean","x-nullable":true}}},"Signals_API_CallRouteEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Signals_API_CallRouteEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"Signals_API_CallRouteEntityPaginated model"},"create_team_escalation_policy":{"type":"object","properties":{"name":{"type":"string","description":"The escalation policy's name."},"description":{"type":"string","description":"A detailed description of the escalation policy.","x-nullable":true},"repetitions":{"type":"integer","format":"int32","description":"The number of times that the escalation policy should repeat before an alert is dropped.","default":0,"x-nullable":true},"default":{"type":"boolean","description":"Whether this escalation policy should be the default for the team.","default":false,"x-nullable":true},"step_strategy":{"type":"string","description":"The strategy for handling steps in the escalation policy. Can be \"static\" or \"dynamic_by_priority\".","x-nullable":true},"steps":{"type":"array","description":"A list of steps that define how an alert should escalate through the policy.","items":{"type":"object","properties":{"targets":{"type":"array","description":"A list of targets that the step will notify. You can specify up to 15 targets per step.","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of target that the step will notify.","enum":["OnCallSchedule","User","SlackChannel","MicrosoftTeamsChannel","EntireTeam","Webhook"]},"id":{"type":"string","description":"The ID of the target that the step will notify."}},"required":["type","id"]}},"timeout":{"type":"string","description":"An ISO8601 duration string specifying how long to wait before moving on to the next step. For the last step, this value specifies how long to wait before the escalation policy should repeat, if it repeats."},"distribution_type":{"type":"string","description":"The round robin configuration for the step. One of 'unspecified', 'round_robin_by_alert', or 'round_robin_by_escalation_policy'.","enum":["unspecified","round_robin_by_alert","round_robin_by_escalation_policy"],"x-nullable":true},"priorities":{"type":"array","description":"A list of priorities (HIGH, MEDIUM, LOW) to which the step applies when using a dynamic escalation policy.","items":{"type":"string"},"x-nullable":true}},"required":["targets","timeout"]}},"handoff_step":{"type":"object","description":"A step that defines where an alert should be sent when the policy is exhausted and the alert is still unacknowledged.","properties":{"target_type":{"type":"string","description":"The type of target to which the policy will hand off.","enum":["EscalationPolicy","Team"]},"target_id":{"type":"string","description":"The ID of the target to which the policy will hand off."}},"required":["target_type","target_id"],"x-nullable":true},"prioritized_settings":{"type":"object","description":"Priority-specific settings for dynamic escalation policies","properties":{"high":{"type":"object","description":"Settings for HIGH priority alerts","properties":{"repetitions":{"type":"integer","format":"int32","description":"Number of repetitions for HIGH priority alerts","x-nullable":true},"handoff_step":{"type":"object","description":"Handoff step for HIGH priority alerts","properties":{"target_type":{"type":"string","enum":["EscalationPolicy","Team"]},"target_id":{"type":"string"}},"required":["target_type","target_id"],"x-nullable":true}},"x-nullable":true},"medium":{"type":"object","description":"Settings for MEDIUM priority alerts","properties":{"repetitions":{"type":"integer","format":"int32","description":"Number of repetitions for MEDIUM priority alerts","x-nullable":true},"handoff_step":{"type":"object","description":"Handoff step for MEDIUM priority alerts","properties":{"target_type":{"type":"string","enum":["EscalationPolicy","Team"]},"target_id":{"type":"string"}},"required":["target_type","target_id"],"x-nullable":true}},"x-nullable":true},"low":{"type":"object","description":"Settings for LOW priority alerts","properties":{"repetitions":{"type":"integer","format":"int32","description":"Number of repetitions for LOW priority alerts","x-nullable":true},"handoff_step":{"type":"object","description":"Handoff step for LOW priority alerts","properties":{"target_type":{"type":"string","enum":["EscalationPolicy","Team"]},"target_id":{"type":"string"}},"required":["target_type","target_id"],"x-nullable":true}},"x-nullable":true}},"x-nullable":true}},"required":["name","steps"],"description":"Create a Signals escalation policy for a team."},"Signals_API_EscalationPolicyEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"default":{"type":"boolean","x-nullable":true},"repetitions":{"type":"integer","format":"int32","x-nullable":true},"steps":{"type":"array","items":{"$ref":"#/definitions/Signals_API_EscalationPolicyStepEntity"},"x-nullable":true},"handoff_step":{"$ref":"#/definitions/NullableSignals_API_EscalationPolicyHandoffStepEntity"},"created_by":{"$ref":"#/definitions/NullableAuthorEntity"},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"step_strategy":{"type":"string","x-nullable":true},"notification_priority_policies":{"type":"array","items":{"$ref":"#/definitions/Signals_API_NotificationPriorityPolicyEntity"},"description":"Priority-specific policies for dynamic escalation policies","x-nullable":true}},"description":"Signals_API_EscalationPolicyEntity model"},"Signals_API_EscalationPolicyStepEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"position":{"type":"integer","format":"int32","x-nullable":true},"parent_position":{"type":"integer","format":"int32","x-nullable":true},"targets":{"type":"array","items":{"$ref":"#/definitions/Signals_API_TargetEntity"},"x-nullable":true},"timeout":{"type":"string","x-nullable":true},"distribution_type":{"type":"string","enum":["unspecified","round_robin_by_alert","round_robin_by_escalation_policy"],"description":"The distribution type for the step","x-nullable":true},"next_target_for_round_robin":{"$ref":"#/definitions/NullableSignals_API_TargetEntity","description":"The next target to receive an alert in a round-robin distribution"},"priorities":{"type":"array","items":{"type":"string"},"description":"The notification priorities that this step is assigned to. Valid values are HIGH, MEDIUM, and LOW.","x-nullable":true}}},"Signals_API_EscalationPolicyHandoffStepEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"target":{"$ref":"#/definitions/NullableSignals_API_TargetEntity"}}},"Signals_API_NotificationPriorityPolicyEntity":{"type":"object","properties":{"notification_priority":{"type":"string","description":"The notification priority this policy handles (HIGH, MEDIUM, or LOW)","x-nullable":true},"repetitions":{"type":"integer","format":"int32","description":"Number of repetitions for this priority","x-nullable":true},"handoff_step":{"$ref":"#/definitions/NullableSignals_API_EscalationPolicyHandoffStepEntity","description":"The handoff step for this priority"},"steps":{"type":"array","items":{"$ref":"#/definitions/Signals_API_EscalationPolicyStepEntity"},"description":"Steps for this priority","x-nullable":true}}},"Signals_API_EscalationPolicyEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Signals_API_EscalationPolicyEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"Signals_API_EscalationPolicyEntityPaginated model"},"update_team_escalation_policy":{"type":"object","properties":{"name":{"type":"string","description":"The escalation policy's name.","x-nullable":true},"description":{"type":"string","description":"A detailed description of the escalation policy.","x-nullable":true},"repetitions":{"type":"integer","format":"int32","description":"The number of times that the escalation policy should repeat before an alert is dropped.","default":0,"x-nullable":true},"default":{"type":"boolean","description":"Whether this escalation policy should be the default for the team.","default":false,"x-nullable":true},"step_strategy":{"type":"string","description":"The strategy for handling steps in the escalation policy. Can be \"static\" or \"dynamic_by_priority\".","x-nullable":true},"steps":{"type":"array","description":"A list of steps that define how an alert should escalate through the policy.","items":{"type":"object","properties":{"targets":{"type":"array","description":"A list of targets that the step will notify. You can specify up to 15 targets per step.","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of target that the step will notify.","enum":["OnCallSchedule","User","SlackChannel","MicrosoftTeamsChannel","EntireTeam","Webhook"]},"id":{"type":"string","description":"The ID of the target that the step will notify."}},"required":["type","id"]},"x-nullable":true},"timeout":{"type":"string","description":"An ISO8601 duration string specifying how long to wait before moving on to the next step. For the last step, this value specifies how long to wait before the escalation policy should repeat, if it repeats."},"distribution_type":{"type":"string","description":"The round robin configuration for the step. One of 'unspecified', 'round_robin_by_alert', or 'round_robin_by_escalation_policy'.","enum":["unspecified","round_robin_by_alert","round_robin_by_escalation_policy"],"x-nullable":true},"priorities":{"type":"array","description":"A list of priorities (HIGH, MEDIUM, LOW) to which the step applies when using a dynamic escalation policy.","items":{"type":"string"},"x-nullable":true}},"required":["timeout"]},"x-nullable":true},"handoff_step":{"type":"object","description":"A step that defines where an alert should be sent when the policy is exhausted and the alert is still unacknowledged.","properties":{"target_type":{"type":"string","description":"The type of target to which the policy will hand off.","enum":["EscalationPolicy","Team"]},"target_id":{"type":"string","description":"The ID of the target to which the policy will hand off."}},"required":["target_type","target_id"],"x-nullable":true},"prioritized_settings":{"type":"object","description":"Priority-specific settings for dynamic escalation policies","properties":{"high":{"type":"object","description":"Settings for HIGH priority alerts","properties":{"repetitions":{"type":"integer","format":"int32","description":"Number of repetitions for HIGH priority alerts","x-nullable":true},"handoff_step":{"type":"object","description":"Handoff step for HIGH priority alerts","properties":{"target_type":{"type":"string","enum":["EscalationPolicy","Team"]},"target_id":{"type":"string"}},"required":["target_type","target_id"],"x-nullable":true}},"x-nullable":true},"medium":{"type":"object","description":"Settings for MEDIUM priority alerts","properties":{"repetitions":{"type":"integer","format":"int32","description":"Number of repetitions for MEDIUM priority alerts","x-nullable":true},"handoff_step":{"type":"object","description":"Handoff step for MEDIUM priority alerts","properties":{"target_type":{"type":"string","enum":["EscalationPolicy","Team"]},"target_id":{"type":"string"}},"required":["target_type","target_id"],"x-nullable":true}},"x-nullable":true},"low":{"type":"object","description":"Settings for LOW priority alerts","properties":{"repetitions":{"type":"integer","format":"int32","description":"Number of repetitions for LOW priority alerts","x-nullable":true},"handoff_step":{"type":"object","description":"Handoff step for LOW priority alerts","properties":{"target_type":{"type":"string","enum":["EscalationPolicy","Team"]},"target_id":{"type":"string"}},"required":["target_type","target_id"],"x-nullable":true}},"x-nullable":true}},"x-nullable":true}},"description":"Update a Signals escalation policy by ID"},"preview_team_on_call_schedule":{"type":"object","properties":{"name":{"type":"string","description":"The on-call schedule's name."},"description":{"type":"string","description":"A detailed description of the on-call schedule.","x-nullable":true},"rotations":{"type":"array","description":"An array of objects that specify rotations for the schedule. If not provided, the deprecated single-rotation parameters can be used instead, with `time_zone` and `strategy` being required.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the on-call rotation"},"description":{"type":"string","description":"A detailed description of the on-call schedule.","x-nullable":true},"time_zone":{"type":"string","description":"The timezone of the on-call rotation as a string"},"slack_user_group_id":{"type":"string","description":"The Slack Usergroup ID for the on-call rotation","x-nullable":true},"enable_slack_channel_notifications":{"type":"boolean","description":"Notify the team's Slack channel when handoffs occur","x-nullable":true},"prevent_shift_deletion":{"type":"boolean","description":"Prevent shifts from being deleted by users and leading to gaps in coverage.","x-nullable":true},"coverage_gap_notification_interval":{"type":"string","description":"An ISO8601 duration string specifying that the team should be notified about gaps in coverage for the upcoming interval. Notifications are sent at 9am daily in the rotation's time zone via email and, if enabled, the team's Slack channel.","x-nullable":true},"color":{"type":"string","description":"A hex color code that will be used to represent the rotation in FireHydrant's UI.","x-nullable":true},"members":{"type":"array","description":"An ordered list of objects that specify members of the schedule's rotation.","items":{"type":"object","properties":{"user_id":{"type":"string","description":"The ID of a user who should be added to the schedule's initial rotation. You can add a user to the\nschedule multiple times to construct more complex rotations, and you can specify a `null` user ID\nto either leave a gap in the rotation or create an unassigned shift in the rotation depending on\nthe value of `create_unassigned_shifts`.\n","x-nullable":true},"create_unassigned_shifts":{"type":"boolean","description":"When `user_id` is `null`, allows populating the rotation with unassigned shifts for this slot when\nset to `true`. When `false`, the default value, the rotation will instead have a gap for this slot.\nNote: this value will be ignored when a valid `user_id` is provided.\n","x-nullable":true}}},"x-nullable":true},"strategy":{"type":"object","description":"An object that specifies how the rotation's on-call shifts should be generated.","properties":{"type":{"type":"string","description":"The type of strategy. Must be one of \"daily\", \"weekly\", or \"custom\".","enum":["daily","weekly","custom"]},"handoff_time":{"type":"string","description":"An ISO8601 time string specifying when on-call shifts should hand off. This value is only used if the strategy type is \"daily\" or \"weekly\".","x-nullable":true},"handoff_day":{"type":"string","description":"The day of the week on which on-call shifts should hand off, as its long-form name (e.g. \"monday\", \"tuesday\", etc). This value is only used if the strategy type is \"weekly\".","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"],"x-nullable":true},"shift_duration":{"type":"string","description":"An ISO8601 duration string specifying how long each shift should last. This value is only used if the strategy type is \"custom\".","x-nullable":true}},"required":["type"]},"restrictions":{"type":"array","description":"A list of objects that restrict the rotation to specific on-call periods.","items":{"type":"object","properties":{"start_day":{"type":"string","description":"The day of the week on which the restriction should start, as its long-form name (e.g. \"monday\", \"tuesday\", etc).","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]},"start_time":{"type":"string","description":"An ISO8601 time string specifying when the restriction should start."},"end_day":{"type":"string","description":"The day of the week on which the restriction should end, as its long-form name (e.g. \"monday\", \"tuesday\", etc).","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]},"end_time":{"type":"string","description":"An ISO8601 time string specifying when the restriction should end."}},"required":["start_day","start_time","end_day","end_time"]},"x-nullable":true},"start_time":{"type":"string","description":"An ISO8601 time string specifying when the initial rotation should start. This value is only used if the rotation's strategy type is \"custom\".","x-nullable":true}},"required":["name","time_zone","strategy"]}},"from":{"type":"string","description":"An ISO8601 time string specifying the start of the time window to preview. Defaults to now.","x-nullable":true},"to":{"type":"string","description":"An ISO8601 time string specifying the end of the time window to preview. Defaults to two weeks from now.","x-nullable":true}},"required":["name","rotations"],"description":"Preview a new on-call schedule based on the provided rotations, allowing you to see how the schedule will look before saving it."},"Signals_API_OnCallSchedulePreviewEntity":{"type":"object","properties":{"name":{"type":"string","x-nullable":true},"rotations":{"type":"array","items":{"$ref":"#/definitions/Signals_API_OnCallSchedulePreviewEntity_RotationPreviewEntity"},"x-nullable":true}},"description":"Signals_API_OnCallSchedulePreviewEntity model"},"Signals_API_OnCallSchedulePreviewEntity_RotationPreviewEntity":{"type":"object","properties":{"name":{"type":"string","x-nullable":true},"color":{"type":"string","x-nullable":true},"original_shifts":{"type":"array","items":{"$ref":"#/definitions/Signals_API_OnCallSchedulePreviewEntity_OriginalShiftPreviewEntity"},"x-nullable":true},"overrides":{"type":"array","items":{"$ref":"#/definitions/Signals_API_OnCallSchedulePreviewEntity_OverridePreviewEntity"},"x-nullable":true},"shifts":{"type":"array","items":{"$ref":"#/definitions/Signals_API_OnCallSchedulePreviewEntity_ShiftPreviewEntity"},"x-nullable":true}},"description":"Signals_API_OnCallSchedulePreviewEntity_RotationPreviewEntity model"},"Signals_API_OnCallSchedulePreviewEntity_OriginalShiftPreviewEntity":{"type":"object","properties":{"start_time":{"type":"string","format":"date-time","x-nullable":true},"end_time":{"type":"string","format":"date-time","x-nullable":true},"user":{"$ref":"#/definitions/NullableSuccinctEntity"}}},"Signals_API_OnCallSchedulePreviewEntity_OverridePreviewEntity":{"type":"object","properties":{"start_time":{"type":"string","format":"date-time","x-nullable":true},"end_time":{"type":"string","format":"date-time","x-nullable":true},"user":{"$ref":"#/definitions/NullableSuccinctEntity"},"id":{"type":"string","x-nullable":true},"coverage_request":{"type":"string","x-nullable":true},"is_gap":{"type":"boolean","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true}}},"Signals_API_OnCallSchedulePreviewEntity_ShiftPreviewEntity":{"type":"object","properties":{"start_time":{"type":"string","format":"date-time","x-nullable":true},"end_time":{"type":"string","format":"date-time","x-nullable":true},"user":{"$ref":"#/definitions/NullableSuccinctEntity"},"is_override":{"type":"boolean","x-nullable":true},"coverage_request":{"type":"string","x-nullable":true}}},"create_team_on_call_schedule":{"type":"object","properties":{"name":{"type":"string","description":"The on-call schedule's name."},"description":{"type":"string","description":"A detailed description of the on-call schedule.","x-nullable":true},"rotations":{"type":"array","description":"An array of objects that specify rotations for the schedule. If not provided, the deprecated single-rotation parameters can be used instead, with `time_zone` and `strategy` being required.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the on-call rotation"},"description":{"type":"string","description":"A detailed description of the on-call schedule.","x-nullable":true},"time_zone":{"type":"string","description":"The timezone of the on-call rotation as a string"},"slack_user_group_id":{"type":"string","description":"The Slack Usergroup ID for the on-call rotation","x-nullable":true},"enable_slack_channel_notifications":{"type":"boolean","description":"Notify the team's Slack channel when handoffs occur","x-nullable":true},"prevent_shift_deletion":{"type":"boolean","description":"Prevent shifts from being deleted by users and leading to gaps in coverage.","x-nullable":true},"coverage_gap_notification_interval":{"type":"string","description":"An ISO8601 duration string specifying that the team should be notified about gaps in coverage for the upcoming interval. Notifications are sent at 9am daily in the rotation's time zone via email and, if enabled, the team's Slack channel.","x-nullable":true},"color":{"type":"string","description":"A hex color code that will be used to represent the rotation in FireHydrant's UI.","x-nullable":true},"members":{"type":"array","description":"An ordered list of objects that specify members of the schedule's rotation.","items":{"type":"object","properties":{"user_id":{"type":"string","description":"The ID of a user who should be added to the schedule's initial rotation. You can add a user to the\nschedule multiple times to construct more complex rotations, and you can specify a `null` user ID\nto either leave a gap in the rotation or create an unassigned shift in the rotation depending on\nthe value of `create_unassigned_shifts`.\n","x-nullable":true},"create_unassigned_shifts":{"type":"boolean","description":"When `user_id` is `null`, allows populating the rotation with unassigned shifts for this slot when\nset to `true`. When `false`, the default value, the rotation will instead have a gap for this slot.\nNote: this value will be ignored when a valid `user_id` is provided.\n","x-nullable":true}}},"x-nullable":true},"strategy":{"type":"object","description":"An object that specifies how the rotation's on-call shifts should be generated.","properties":{"type":{"type":"string","description":"The type of strategy. Must be one of \"daily\", \"weekly\", or \"custom\".","enum":["daily","weekly","custom"]},"handoff_time":{"type":"string","description":"An ISO8601 time string specifying when on-call shifts should hand off. This value is only used if the strategy type is \"daily\" or \"weekly\".","x-nullable":true},"handoff_day":{"type":"string","description":"The day of the week on which on-call shifts should hand off, as its long-form name (e.g. \"monday\", \"tuesday\", etc). This value is only used if the strategy type is \"weekly\".","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"],"x-nullable":true},"shift_duration":{"type":"string","description":"An ISO8601 duration string specifying how long each shift should last. This value is only used if the strategy type is \"custom\".","x-nullable":true}},"required":["type"]},"restrictions":{"type":"array","description":"A list of objects that restrict the rotation to specific on-call periods.","items":{"type":"object","properties":{"start_day":{"type":"string","description":"The day of the week on which the restriction should start, as its long-form name (e.g. \"monday\", \"tuesday\", etc).","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]},"start_time":{"type":"string","description":"An ISO8601 time string specifying when the restriction should start."},"end_day":{"type":"string","description":"The day of the week on which the restriction should end, as its long-form name (e.g. \"monday\", \"tuesday\", etc).","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]},"end_time":{"type":"string","description":"An ISO8601 time string specifying when the restriction should end."}},"required":["start_day","start_time","end_day","end_time"]},"x-nullable":true},"start_time":{"type":"string","description":"An ISO8601 time string specifying when the initial rotation should start. This value is only used if the rotation's strategy type is \"custom\".","x-nullable":true}},"required":["name","time_zone","strategy"]},"x-nullable":true},"rotation_name":{"type":"string","description":"An optional name for the initial rotation. If not provided, the schedule's name will be used.","x-nullable":true},"rotation_description":{"type":"string","description":"An optional description for the initial rotation. If not provided, the schedule's description will be used.","x-nullable":true},"color":{"type":"string","description":"A hex color code that will be used to represent the initial rotation in FireHydrant's UI.","x-nullable":true},"time_zone":{"type":"string","description":"The time zone in which the on-call schedule's rotation will operate. This value must be a valid IANA time zone name and must be provided if `rotations` is not.","x-nullable":true},"slack_user_group_id":{"type":"string","description":"The ID of a Slack user group to sync the initial rotation's on-call members to.","x-nullable":true},"members":{"type":"array","description":"An ordered list of objects that specify members of the initial rotation.","items":{"type":"object","properties":{"user_id":{"type":"string","description":"The ID of a user who should be added to the schedule's initial rotation. You can add a user to the\nschedule multiple times to construct more complex rotations, and you can specify a `null` user ID\nto either leave a gap in the rotation or create an unassigned shift in the rotation depending on\nthe value of `create_unassigned_shifts`.\n","x-nullable":true},"create_unassigned_shifts":{"type":"boolean","description":"When `user_id` is `null`, allows populating the rotation with unassigned shifts for this slot when\nset to `true`. When `false`, the default value, the rotation will instead have a gap for this slot.\nNote: this value will be ignored when a valid `user_id` is provided.\n","x-nullable":true}}},"x-nullable":true},"strategy":{"type":"object","description":"An object that specifies how the initial rotation's on-call shifts should be generated. This value must be provided if `rotations` is not.","properties":{"type":{"type":"string","description":"The type of strategy. Must be one of \"daily\", \"weekly\", or \"custom\".","enum":["daily","weekly","custom"]},"handoff_time":{"type":"string","description":"An ISO8601 time string specifying when on-call shifts should hand off. This value is only used if the strategy type is \"daily\" or \"weekly\".","x-nullable":true},"handoff_day":{"type":"string","description":"The day of the week on which on-call shifts should hand off, as its long-form name (e.g. \"monday\", \"tuesday\", etc). This value is only used if the strategy type is \"weekly\".","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"],"x-nullable":true},"shift_duration":{"type":"string","description":"An ISO8601 duration string specifying how long each shift should last. This value is only used if the strategy type is \"custom\".","x-nullable":true}},"required":["type"],"x-nullable":true},"restrictions":{"type":"array","description":"A list of objects that restrict the initial rotation to specific on-call periods.","items":{"type":"object","properties":{"start_day":{"type":"string","description":"The day of the week on which the restriction should start, as its long-form name (e.g. \"monday\", \"tuesday\", etc).","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]},"start_time":{"type":"string","description":"An ISO8601 time string specifying when the restriction should start."},"end_day":{"type":"string","description":"The day of the week on which the restriction should end, as its long-form name (e.g. \"monday\", \"tuesday\", etc).","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]},"end_time":{"type":"string","description":"An ISO8601 time string specifying when the restriction should end."}},"required":["start_day","start_time","end_day","end_time"]},"x-nullable":true},"start_time":{"type":"string","description":"An ISO8601 time string specifying when the initial rotation should start. This value is only used if the rotation's strategy type is \"custom\".","x-nullable":true},"member_ids":{"type":"array","description":"This parameter is deprecated; use `members` instead.","items":{"type":"string"},"x-nullable":true}},"required":["name"],"description":"Create a Signals on-call schedule for a team with a single rotation. More rotations can be created later."},"Signals_API_OnCallScheduleEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"rotations":{"type":"array","items":{"$ref":"#/definitions/Signals_API_OnCallRotationEntity"},"x-nullable":true},"team":{"$ref":"#/definitions/NullableSuccinctEntity"},"created_by":{"$ref":"#/definitions/NullableAuthorEntity"},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"signals_ical_url":{"type":"string","x-nullable":true},"time_zone":{"type":"string","x-nullable":true},"color":{"type":"string","x-nullable":true},"slack_user_group_id":{"type":"string","x-nullable":true},"members":{"type":"array","items":{"$ref":"#/definitions/SuccinctEntity"},"x-nullable":true},"shifts":{"type":"array","items":{"$ref":"#/definitions/Signals_API_OnCallShiftEntity"},"x-nullable":true},"strategy":{"$ref":"#/definitions/NullableSignals_API_OnCallStrategyEntity"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/Signals_API_OnCallRestrictionEntity"},"x-nullable":true}},"description":"Signals_API_OnCallScheduleEntity model"},"Signals_API_OnCallRotationEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"time_zone":{"type":"string","x-nullable":true},"color":{"type":"string","x-nullable":true},"slack_user_group_id":{"type":"string","x-nullable":true},"enable_slack_channel_notifications":{"type":"boolean","x-nullable":true},"prevent_shift_deletion":{"type":"boolean","x-nullable":true},"coverage_gap_notification_interval":{"type":"string","x-nullable":true},"team":{"$ref":"#/definitions/NullableSuccinctEntity"},"strategy":{"$ref":"#/definitions/NullableSignals_API_OnCallStrategyEntity"},"members":{"type":"array","items":{"$ref":"#/definitions/SuccinctEntity"},"x-nullable":true},"restrictions":{"type":"array","items":{"$ref":"#/definitions/Signals_API_OnCallRestrictionEntity"},"x-nullable":true},"original_shifts":{"type":"array","items":{"$ref":"#/definitions/Signals_API_OriginalOnCallShiftEntity"},"x-nullable":true},"overrides":{"type":"array","items":{"$ref":"#/definitions/Signals_API_OnCallOverrideEntity"},"x-nullable":true},"shifts":{"type":"array","items":{"$ref":"#/definitions/Signals_API_OnCallShiftEntity"},"x-nullable":true},"created_by":{"$ref":"#/definitions/NullableAuthorEntity"},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true}},"description":"Signals_API_OnCallRotationEntity model"},"Signals_API_OnCallStrategyEntity":{"type":"object","properties":{"type":{"type":"string","x-nullable":true},"handoff_time":{"type":"string","x-nullable":true},"handoff_day":{"type":"string","x-nullable":true},"shift_duration":{"type":"string","x-nullable":true}}},"Signals_API_OnCallRestrictionEntity":{"type":"object","properties":{"start_day":{"type":"string","x-nullable":true},"start_time":{"type":"string","x-nullable":true},"end_day":{"type":"string","x-nullable":true},"end_time":{"type":"string","x-nullable":true}}},"Signals_API_OriginalOnCallShiftEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"user":{"$ref":"#/definitions/NullableSuccinctEntity"},"color":{"type":"string","x-nullable":true},"time_zone":{"type":"string","x-nullable":true},"on_call_schedule":{"$ref":"#/definitions/NullableSuccinctEntity"},"on_call_rotation":{"$ref":"#/definitions/NullableSuccinctEntity"},"team":{"$ref":"#/definitions/NullableSuccinctEntity"},"start_time":{"type":"string","format":"date-time","x-nullable":true},"end_time":{"type":"string","format":"date-time","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true}}},"Signals_API_OnCallOverrideEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"user":{"$ref":"#/definitions/NullableSuccinctEntity"},"color":{"type":"string","x-nullable":true},"time_zone":{"type":"string","x-nullable":true},"on_call_schedule":{"$ref":"#/definitions/NullableSuccinctEntity"},"on_call_rotation":{"$ref":"#/definitions/NullableSuccinctEntity"},"team":{"$ref":"#/definitions/NullableSuccinctEntity"},"start_time":{"type":"string","format":"date-time","x-nullable":true},"end_time":{"type":"string","format":"date-time","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"coverage_request":{"type":"string","x-nullable":true},"is_gap":{"type":"boolean","x-nullable":true}},"description":"Signals_API_OnCallOverrideEntity model"},"Signals_API_OnCallShiftEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"user":{"$ref":"#/definitions/NullableSuccinctEntity"},"color":{"type":"string","x-nullable":true},"time_zone":{"type":"string","x-nullable":true},"on_call_schedule":{"$ref":"#/definitions/NullableSuccinctEntity"},"on_call_rotation":{"$ref":"#/definitions/NullableSuccinctEntity"},"team":{"$ref":"#/definitions/NullableSuccinctEntity"},"start_time":{"type":"string","format":"date-time","x-nullable":true},"end_time":{"type":"string","format":"date-time","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"is_override":{"type":"boolean","x-nullable":true},"coverage_request":{"type":"string","x-nullable":true}},"description":"Signals_API_OnCallShiftEntity model"},"Signals_API_OnCallScheduleEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Signals_API_OnCallScheduleEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"Signals_API_OnCallScheduleEntityPaginated model"},"update_team_on_call_schedule":{"type":"object","properties":{"name":{"type":"string","description":"A new name for the on-call schedule.","x-nullable":true},"description":{"type":"string","description":"A new, detailed description for the on-call schedule.","x-nullable":true},"rotation_name":{"type":"string","description":"A new name for the schedule's rotation.","x-nullable":true},"rotation_description":{"type":"string","description":"A new, detailed description for the schedule's rotation.","x-nullable":true},"color":{"type":"string","description":"A hex color code that will be used to represent the schedule's rotation in FireHydrant's UI.","x-nullable":true},"time_zone":{"type":"string","description":"The time zone in which the on-call schedule's rotation will operate. This value must be a valid IANA time zone name.","x-nullable":true},"slack_user_group_id":{"type":"string","description":"The ID of a Slack user group to sync the rotation's on-call members to.","x-nullable":true},"members":{"type":"array","description":"An ordered list of objects that specify members of the schedule's rotation.","items":{"type":"object","properties":{"user_id":{"type":"string","description":"The ID of a user who should be added to the schedule's initial rotation. You can add a user to the\nschedule multiple times to construct more complex rotations, and you can specify a `null` user ID\nto either leave a gap in the rotation or create an unassigned shift in the rotation depending on\nthe value of `create_unassigned_shifts`.\n","x-nullable":true},"create_unassigned_shifts":{"type":"boolean","description":"When `user_id` is `null`, allows populating the rotation with unassigned shifts for this slot when\nset to `true`. When `false`, the default value, the rotation will instead have a gap for this slot.\nNote: this value will be ignored when a valid `user_id` is provided.\n","x-nullable":true}}},"x-nullable":true},"strategy":{"type":"object","description":"An object that specifies how the rotation's on-call shifts should be generated.","properties":{"type":{"type":"string","description":"The type of strategy. Must be one of \"daily\", \"weekly\", or \"custom\".","enum":["daily","weekly","custom"]},"handoff_time":{"type":"string","description":"An ISO8601 time string specifying when on-call shifts should hand off. This value is only used if the strategy type is \"daily\" or \"weekly\".","x-nullable":true},"handoff_day":{"type":"string","description":"The day of the week on which on-call shifts should hand off, as its long-form name (e.g. \"monday\", \"tuesday\", etc). This value is only used if the strategy type is \"weekly\".","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"],"x-nullable":true},"shift_duration":{"type":"string","description":"An ISO8601 duration string specifying how long each shift should last. This value is only used if the strategy type is \"custom\".","x-nullable":true}},"required":["type"],"x-nullable":true},"restrictions":{"type":"array","description":"A list of objects that restrict the schedule's rotation to specific on-call periods.","items":{"type":"object","properties":{"start_day":{"type":"string","description":"The day of the week on which the restriction should start, as its long-form name (e.g. \"monday\", \"tuesday\", etc).","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]},"start_time":{"type":"string","description":"An ISO8601 time string specifying when the restriction should start."},"end_day":{"type":"string","description":"The day of the week on which the restriction should end, as its long-form name (e.g. \"monday\", \"tuesday\", etc).","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]},"end_time":{"type":"string","description":"An ISO8601 time string specifying when the restriction should end."}},"required":["start_day","start_time","end_day","end_time"]},"x-nullable":true},"effective_at":{"type":"string","description":"An ISO8601 time string specifying when the updated schedule should take effect. This\nvalue must be provided if editing an attribute that would affect how the schedule's\nshifts are generated, such as the time zone, members, strategy, or restrictions.\n","x-nullable":true},"member_ids":{"type":"array","description":"This parameter is deprecated; use `members` instead.","items":{"type":"string"},"x-nullable":true}},"description":"Update a Signals on-call schedule by ID. For backwards compatibility, all parameters except for\n`name` and `description` will be ignored if the schedule has more than one rotation. If the schedule\nhas only one rotation, you can continue to update that rotation using the rotation-specific parameters.\n"},"preview_on_call_schedule_rotation":{"type":"object","properties":{"rotation_id":{"type":"string","description":"The ID of a rotation being updated. Leave this blank if you're previewing the creation of a new rotation.","x-nullable":true},"name":{"type":"string","description":"The name of the on-call rotation","x-nullable":true},"description":{"type":"string","description":"The description of the on-call rotation","x-nullable":true},"time_zone":{"type":"string","description":"The timezone of the on-call rotation as a string","x-nullable":true},"slack_user_group_id":{"type":"string","description":"The Slack Usergroup ID for the on-call rotation","x-nullable":true},"enable_slack_channel_notifications":{"type":"boolean","description":"Notify the team's Slack channel when handoffs occur","x-nullable":true},"prevent_shift_deletion":{"type":"boolean","description":"Prevent shifts from being deleted by users and leading to gaps in coverage.","x-nullable":true},"coverage_gap_notification_interval":{"type":"string","description":"An ISO8601 duration string specifying that the team should be notified about gaps in coverage for the upcoming interval. Notifications are sent at 9am daily in the rotation's time zone via email and, if enabled, the team's Slack channel.","x-nullable":true},"color":{"type":"string","description":"A hex color code that will be used to represent the rotation in FireHydrant's UI.","x-nullable":true},"members":{"type":"array","description":"An ordered list of objects that specify members of the schedule's rotation.","items":{"type":"object","properties":{"user_id":{"type":"string","description":"The ID of a user who should be added to the schedule's initial rotation. You can add a user to the\nschedule multiple times to construct more complex rotations, and you can specify a `null` user ID\nto either leave a gap in the rotation or create an unassigned shift in the rotation depending on\nthe value of `create_unassigned_shifts`.\n","x-nullable":true},"create_unassigned_shifts":{"type":"boolean","description":"When `user_id` is `null`, allows populating the rotation with unassigned shifts for this slot when\nset to `true`. When `false`, the default value, the rotation will instead have a gap for this slot.\nNote: this value will be ignored when a valid `user_id` is provided.\n","x-nullable":true}}},"x-nullable":true},"strategy":{"type":"object","description":"An object that specifies how the rotation's on-call shifts should be generated.","properties":{"type":{"type":"string","description":"The type of strategy. Must be one of \"daily\", \"weekly\", or \"custom\".","enum":["daily","weekly","custom"]},"handoff_time":{"type":"string","description":"An ISO8601 time string specifying when on-call shifts should hand off. This value is only used if the strategy type is \"daily\" or \"weekly\".","x-nullable":true},"handoff_day":{"type":"string","description":"The day of the week on which on-call shifts should hand off, as its long-form name (e.g. \"monday\", \"tuesday\", etc). This value is only used if the strategy type is \"weekly\".","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"],"x-nullable":true},"shift_duration":{"type":"string","description":"An ISO8601 duration string specifying how long each shift should last. This value is only used if the strategy type is \"custom\".","x-nullable":true}},"required":["type"],"x-nullable":true},"restrictions":{"type":"array","description":"A list of objects that restrict the rotation to specific on-call periods.","items":{"type":"object","properties":{"start_day":{"type":"string","description":"The day of the week on which the restriction should start, as its long-form name (e.g. \"monday\", \"tuesday\", etc).","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]},"start_time":{"type":"string","description":"An ISO8601 time string specifying when the restriction should start."},"end_day":{"type":"string","description":"The day of the week on which the restriction should end, as its long-form name (e.g. \"monday\", \"tuesday\", etc).","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]},"end_time":{"type":"string","description":"An ISO8601 time string specifying when the restriction should end."}},"required":["start_day","start_time","end_day","end_time"]},"x-nullable":true},"start_time":{"type":"string","description":"An ISO8601 time string specifying when the initial rotation should start. This value is only used if the rotation's strategy type is \"custom\".","x-nullable":true},"effective_at":{"type":"string","description":"An ISO8601 time string specifying when the updated schedule should take effect. This\nvalue must be provided if editing an attribute that would affect how the schedule's\nshifts are generated, such as the time zone, members, strategy, or restrictions.\n","x-nullable":true},"clear_overrides":{"type":"boolean","description":"Whether or not to clear relevant overrides when updating a rotation and regenerating its shifts.\nIf true, overrides after the `effective_at` time will be cleared, and any override that overlaps\nwith the `effective_at` time will be truncated to end at that time. If false, overrides will be\nretained and applied to any newly generated shifts. Defaults to false.\n","x-nullable":true},"from":{"type":"string","description":"An ISO8601 time string specifying the start of the time window to preview. Defaults to now.","x-nullable":true},"to":{"type":"string","description":"An ISO8601 time string specifying the end of the time window to preview. Defaults to two weeks from now.","x-nullable":true}},"description":"Preview a new on-call rotation orchanges to an existing on-call rotation"},"create_on_call_schedule_rotation":{"type":"object","properties":{"name":{"type":"string","description":"The name of the on-call rotation"},"time_zone":{"type":"string","description":"The timezone of the on-call rotation as a string"},"description":{"type":"string","description":"The description of the on-call rotation","x-nullable":true},"slack_user_group_id":{"type":"string","description":"The Slack Usergroup ID for the on-call rotation","x-nullable":true},"enable_slack_channel_notifications":{"type":"boolean","description":"Notify the team's Slack channel when handoffs occur","x-nullable":true},"prevent_shift_deletion":{"type":"boolean","description":"Prevent shifts from being deleted by users and leading to gaps in coverage.","x-nullable":true},"coverage_gap_notification_interval":{"type":"string","description":"An ISO8601 duration string specifying that the team should be notified about gaps in coverage for the upcoming interval. Notifications are sent at 9am daily in the rotation's time zone via email and, if enabled, the team's Slack channel.","x-nullable":true},"color":{"type":"string","description":"A hex color code that will be used to represent the rotation in FireHydrant's UI.","x-nullable":true},"members":{"type":"array","description":"An ordered list of objects that specify members of the schedule's rotation.","items":{"type":"object","properties":{"user_id":{"type":"string","description":"The ID of a user who should be added to the schedule's initial rotation. You can add a user to the\nschedule multiple times to construct more complex rotations, and you can specify a `null` user ID\nto either leave a gap in the rotation or create an unassigned shift in the rotation depending on\nthe value of `create_unassigned_shifts`.\n","x-nullable":true},"create_unassigned_shifts":{"type":"boolean","description":"When `user_id` is `null`, allows populating the rotation with unassigned shifts for this slot when\nset to `true`. When `false`, the default value, the rotation will instead have a gap for this slot.\nNote: this value will be ignored when a valid `user_id` is provided.\n","x-nullable":true}}},"x-nullable":true},"strategy":{"type":"object","description":"An object that specifies how the rotation's on-call shifts should be generated.","properties":{"type":{"type":"string","description":"The type of strategy. Must be one of \"daily\", \"weekly\", or \"custom\".","enum":["daily","weekly","custom"]},"handoff_time":{"type":"string","description":"An ISO8601 time string specifying when on-call shifts should hand off. This value is only used if the strategy type is \"daily\" or \"weekly\".","x-nullable":true},"handoff_day":{"type":"string","description":"The day of the week on which on-call shifts should hand off, as its long-form name (e.g. \"monday\", \"tuesday\", etc). This value is only used if the strategy type is \"weekly\".","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"],"x-nullable":true},"shift_duration":{"type":"string","description":"An ISO8601 duration string specifying how long each shift should last. This value is only used if the strategy type is \"custom\".","x-nullable":true}},"required":["type"]},"restrictions":{"type":"array","description":"A list of objects that restrict the rotation to specific on-call periods.","items":{"type":"object","properties":{"start_day":{"type":"string","description":"The day of the week on which the restriction should start, as its long-form name (e.g. \"monday\", \"tuesday\", etc).","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]},"start_time":{"type":"string","description":"An ISO8601 time string specifying when the restriction should start."},"end_day":{"type":"string","description":"The day of the week on which the restriction should end, as its long-form name (e.g. \"monday\", \"tuesday\", etc).","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]},"end_time":{"type":"string","description":"An ISO8601 time string specifying when the restriction should end."}},"required":["start_day","start_time","end_day","end_time"]},"x-nullable":true},"start_time":{"type":"string","description":"An ISO8601 time string specifying when the initial rotation should start. This value is only used if the rotation's strategy type is \"custom\".","x-nullable":true}},"required":["name","time_zone","strategy"],"description":"Add a new rotation to an existing on-call schedule"},"copy_on_call_schedule_rotation":{"type":"object","properties":{"target_schedule_id":{"type":"string","description":"The ID of the schedule to clone the rotation into"},"name":{"type":"string","description":"The name of the on-call rotation","x-nullable":true}},"required":["target_schedule_id"],"description":"Copy an on-call rotation into a different schedule, allowing you to merge them together safely."},"update_on_call_schedule_rotation":{"type":"object","properties":{"name":{"type":"string","description":"The name of the on-call rotation","x-nullable":true},"description":{"type":"string","description":"The description of the on-call rotation","x-nullable":true},"time_zone":{"type":"string","description":"The timezone of the on-call rotation as a string","x-nullable":true},"slack_user_group_id":{"type":"string","description":"The Slack Usergroup ID for the on-call rotation","x-nullable":true},"enable_slack_channel_notifications":{"type":"boolean","description":"Notify the team's Slack channel when handoffs occur","x-nullable":true},"coverage_gap_notification_interval":{"type":"string","description":"An ISO8601 duration string specifying that the team should be notified about gaps in coverage for the upcoming interval. Notifications are sent at 9am daily in the rotation's time zone via email and, if enabled, the team's Slack channel.","x-nullable":true},"prevent_shift_deletion":{"type":"boolean","description":"Prevent shifts from being deleted by users and leading to gaps in coverage.","x-nullable":true},"color":{"type":"string","description":"A hex color code that will be used to represent the rotation in FireHydrant's UI.","x-nullable":true},"members":{"type":"array","description":"An ordered list of objects that specify members of the schedule's rotation.","items":{"type":"object","properties":{"user_id":{"type":"string","description":"The ID of a user who should be added to the schedule's initial rotation. You can add a user to the\nschedule multiple times to construct more complex rotations, and you can specify a `null` user ID\nto either leave a gap in the rotation or create an unassigned shift in the rotation depending on\nthe value of `create_unassigned_shifts`.\n","x-nullable":true},"create_unassigned_shifts":{"type":"boolean","description":"When `user_id` is `null`, allows populating the rotation with unassigned shifts for this slot when\nset to `true`. When `false`, the default value, the rotation will instead have a gap for this slot.\nNote: this value will be ignored when a valid `user_id` is provided.\n","x-nullable":true}}},"x-nullable":true},"strategy":{"type":"object","description":"An object that specifies how the rotation's on-call shifts should be generated.","properties":{"type":{"type":"string","description":"The type of strategy. Must be one of \"daily\", \"weekly\", or \"custom\".","enum":["daily","weekly","custom"]},"handoff_time":{"type":"string","description":"An ISO8601 time string specifying when on-call shifts should hand off. This value is only used if the strategy type is \"daily\" or \"weekly\".","x-nullable":true},"handoff_day":{"type":"string","description":"The day of the week on which on-call shifts should hand off, as its long-form name (e.g. \"monday\", \"tuesday\", etc). This value is only used if the strategy type is \"weekly\".","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"],"x-nullable":true},"shift_duration":{"type":"string","description":"An ISO8601 duration string specifying how long each shift should last. This value is only used if the strategy type is \"custom\".","x-nullable":true}},"required":["type"],"x-nullable":true},"restrictions":{"type":"array","description":"A list of objects that restrict the rotation to specific on-call periods.","items":{"type":"object","properties":{"start_day":{"type":"string","description":"The day of the week on which the restriction should start, as its long-form name (e.g. \"monday\", \"tuesday\", etc).","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]},"start_time":{"type":"string","description":"An ISO8601 time string specifying when the restriction should start."},"end_day":{"type":"string","description":"The day of the week on which the restriction should end, as its long-form name (e.g. \"monday\", \"tuesday\", etc).","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]},"end_time":{"type":"string","description":"An ISO8601 time string specifying when the restriction should end."}},"required":["start_day","start_time","end_day","end_time"]},"x-nullable":true},"effective_at":{"type":"string","description":"An ISO8601 time string specifying when the updated schedule should take effect. This\nvalue must be provided if editing an attribute that would affect how the schedule's\nshifts are generated, such as the time zone, members, strategy, or restrictions.\n","x-nullable":true},"clear_overrides":{"type":"boolean","description":"Whether or not to clear relevant overrides when updating a rotation and regenerating its shifts.\nIf true, overrides after the `effective_at` time will be cleared, and any override that overlaps\nwith the `effective_at` time will be truncated to end at that time. If false, overrides will be\nretained and applied to any newly generated shifts. Defaults to false.\n","x-nullable":true}},"description":"Update an on-call schedule's rotation by ID"},"create_on_call_schedule_rotation_override":{"type":"object","properties":{"start_time":{"type":"string","description":"An ISO8601 time string specifying when the override should start."},"end_time":{"type":"string","description":"An ISO8601 time string specifying when the override should end."},"user_id":{"type":"string","description":"The ID of the user who should be on-call for the overridden period. If not provided, the override will be unassigned and claimable by any user.","x-nullable":true},"is_gap":{"type":"boolean","description":"Whether or not the override should create a gap in coverage. If true, the override will result in the time window having no shifts present at all in the final schedule (defaults to false)","x-nullable":true}},"required":["start_time","end_time"],"description":"Create an override covering a specific  time period in an on-call rotation, re-assigning that\nperiod to a specific user, or leaving it unassigned and claimable by any user, or even creating\na purposeful gap in coverage if desired.\n"},"create_on_call_shift":{"type":"object","properties":{"start_time":{"type":"string","format":"date-time","description":"The start time of the shift in ISO8601 format."},"end_time":{"type":"string","format":"date-time","description":"The end time of the shift in ISO8601 format."},"user_id":{"type":"string","description":"The ID of the user who is on-call for the shift. If not provided, the shift will be unassigned.","x-nullable":true},"rotation_id":{"type":"string","description":"The ID of the on-call rotation you want to create the shift in. This parameter is optional for backwards compatibility but must be provided if the schedule has multiple rotations.","x-nullable":true}},"required":["start_time","end_time"],"description":"NOTE: This endpoint is deprecated and overrides are now the only way to modify a schedule's shifts.\nFor compatibility, this endpoint will simply create an override for the specified time window.\n"},"update_on_call_shift":{"type":"object","properties":{"start_time":{"type":"string","format":"date-time","description":"The start time of the shift in ISO8601 format.","x-nullable":true},"end_time":{"type":"string","format":"date-time","description":"The end time of the shift in ISO8601 format.","x-nullable":true},"user_id":{"type":"string","description":"The ID of the user who is on-call for the shift. If not provided, the shift will be unassigned.","x-nullable":true},"coverage_request":{"type":"string","description":"A description of why coverage is needed for this shift. If the shift is re-assigned, this will automatically be cleared unless provided again.","x-nullable":true}},"description":"NOTE: This endpoint is deprecated and overrides are now the only way to modify a schedule's shifts.\nFor compatibility, this endpoint will simply create an override for the specified time window.\n"},"create_team_signal_rule":{"type":"object","properties":{"name":{"type":"string","description":"The rule's name."},"expression":{"type":"string","description":"The CEL expression that defines the rule."},"target_type":{"type":"string","description":"The type of target that the rule will notify when matched.","enum":["EscalationPolicy","OnCallSchedule","User","Webhook","SlackChannel","MicrosoftTeamsChannel"]},"target_id":{"type":"string","description":"The ID of the target that the rule will notify when matched."},"incident_type_id":{"type":"string","description":"The ID of an incident type that should be used when an alert is promoted to an incident","x-nullable":true},"notification_priority_override":{"type":"string","description":"A notification priority that will be set on the resulting alert (default: HIGH)","enum":["HIGH","MEDIUM","LOW",""],"x-nullable":true},"create_incident_condition_when":{"type":"string","description":"Determines when an incident should be created when this rule is matched","enum":["WHEN_UNSPECIFIED","WHEN_ALWAYS"],"x-nullable":true},"deduplication_expiry":{"type":"string","description":"The amount of time alerts created from this rule will be deduplicated","x-nullable":true}},"required":["name","expression","target_type","target_id"],"description":"Create a Signals rule for a team. We support up to 2000 rules per organization."},"Signals_API_RuleEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"expression":{"type":"string","x-nullable":true},"team_id":{"type":"string","x-nullable":true},"heartbeat_id":{"type":"string","x-nullable":true},"target":{"$ref":"#/definitions/NullableSignals_API_TargetEntity"},"created_by":{"$ref":"#/definitions/NullableAuthorEntity"},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"incident_type":{"$ref":"#/definitions/NullableSuccinctEntity"},"notification_priority_override":{"type":"string","enum":["HIGH","MEDIUM","LOW",""],"x-nullable":true},"create_incident_condition_when":{"type":"string","enum":["WHEN_UNSPECIFIED","WHEN_ALWAYS"],"x-nullable":true},"deduplication_expiry":{"type":"string","example":"PT1H","description":"Duration for deduplicating similar alerts (ISO8601 duration format e.g., 'PT30M', 'PT2H', 'P1D')","x-nullable":true}},"description":"Signals_API_RuleEntity model"},"Signals_API_RuleEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Signals_API_RuleEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"Signals_API_RuleEntityPaginated model"},"update_team_signal_rule":{"type":"object","properties":{"name":{"type":"string","description":"The rule's name.","x-nullable":true},"expression":{"type":"string","description":"The CEL expression that defines the rule.","x-nullable":true},"target_type":{"type":"string","description":"The type of target that the rule will notify when matched.","enum":["EscalationPolicy","OnCallSchedule","User","Webhook","SlackChannel","MicrosoftTeamsChannel"],"x-nullable":true},"target_id":{"type":"string","description":"The ID of the target that the rule will notify when matched.","x-nullable":true},"incident_type_id":{"type":"string","description":"The ID of an incident type that should be used when an alert is promoted to an incident","x-nullable":true},"notification_priority_override":{"type":"string","description":"A notification priority that will be set on the resulting alert (default: HIGH)","enum":["HIGH","MEDIUM","LOW",""],"x-nullable":true},"create_incident_condition_when":{"type":"string","description":"Determines when an incident should be created when this rule is matched","enum":["WHEN_UNSPECIFIED","WHEN_ALWAYS"],"x-nullable":true},"deduplication_expiry":{"type":"string","description":"The amount of time alerts created from this rule will be deduplicated","x-nullable":true}},"description":"Update a Signals rule by ID"},"create_change":{"type":"object","properties":{"summary":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"labels":{"type":"object","description":"A labels hash of keys and values","additionalProperties":{"type":"string"},"x-nullable":true}},"description":"Create a new change entry"},"ChangeEntity":{"type":"object","properties":{"id":{"type":"string","description":"UUID of the Change","x-nullable":true},"summary":{"type":"string","description":"Description of the Change","x-nullable":true},"created_at":{"type":"string","format":"date-time","description":"The time the change entry was created","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"labels":{"type":"object","description":"Arbitrary key/value pairs of labels.","x-nullable":true},"description":{"type":"string","description":"Description of the Change","x-nullable":true}},"description":"ChangeEntity model"},"update_change":{"type":"object","properties":{"summary":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"labels":{"type":"object","additionalProperties":{"type":"string"},"x-nullable":true}},"description":"Update a change entry"},"create_change_identity":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}},"required":["type","value"],"description":"Create an identity for the change entry"},"ChangeIdentityEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"type":{"type":"string","x-nullable":true},"value":{"type":"string","x-nullable":true},"change_id":{"type":"string","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true}},"description":"ChangeIdentityEntity model"},"ChangeIdentityEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/ChangeIdentityEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"ChangeIdentityEntityPaginated model"},"update_change_identity":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}},"required":["type","value"],"description":"Update an identity for the change entry"},"create_change_event":{"type":"object","properties":{"summary":{"type":"string"},"description":{"type":"string","x-nullable":true},"labels":{"type":"object","additionalProperties":{"type":"string"},"x-nullable":true},"starts_at":{"type":"string","format":"date-time","x-nullable":true},"ends_at":{"type":"string","format":"date-time","x-nullable":true},"environments":{"type":"array","description":"An array of environment IDs","items":{"type":"string"},"x-nullable":true},"services":{"type":"array","description":"An array of service IDs","items":{"type":"string"},"x-nullable":true},"changes":{"type":"array","description":"An array of change IDs","items":{"type":"string"},"x-nullable":true},"external_id":{"type":"string","description":"The ID of a change event as assigned by an external provider","x-nullable":true},"change_identities":{"type":"array","description":"If provided and valid, the event will be linked to all changes that have the same identities. Identity *values* must be unique.","items":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}},"required":["type","value"]},"x-nullable":true},"attachments":{"type":"array","description":"JSON objects representing attachments, see attachments documentation for the schema","items":{"type":"object","properties":{"type":{"type":"string","enum":["link"],"additionalProperties":{"type":"string"}}},"required":["type"]},"x-nullable":true},"authors":{"type":"array","description":"Array of additional authors to add to the change event, the creating actor will automatically be added as an author","items":{"type":"object","properties":{"source":{"type":"string"},"source_id":{"type":"string"},"name":{"type":"string"}},"required":["source","source_id","name"]},"x-nullable":true}},"required":["summary"],"description":"Create a change event"},"ChangeEventEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"summary":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"external_id":{"type":"string","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"starts_at":{"type":"string","format":"date-time","x-nullable":true},"ends_at":{"type":"string","format":"date-time","x-nullable":true},"duration_ms":{"type":"integer","format":"int32","x-nullable":true},"duration_iso8601":{"type":"string","x-nullable":true},"environments":{"type":"array","items":{"$ref":"#/definitions/EnvironmentEntryEntity"},"x-nullable":true},"related_changes":{"type":"array","items":{"$ref":"#/definitions/ChangeEntity"},"x-nullable":true},"identities":{"type":"array","items":{"$ref":"#/definitions/ChangeIdentityEntity"},"x-nullable":true},"authors":{"type":"array","items":{"$ref":"#/definitions/AuthorEntity"},"x-nullable":true},"attachments":{"type":"array","items":{"type":"object"},"description":"A list of objects attached to this item. Can be one of: LinkEntity, CustomerSupportIssueEntity, or GenericAttachmentEntity","x-nullable":true},"labels":{"type":"object","description":"An object of label key and values","x-nullable":true},"services":{"type":"array","items":{"$ref":"#/definitions/ServiceEntityLite"},"x-nullable":true}},"description":"ChangeEventEntity model"},"ChangeEventSlimEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/ChangeEventSlimEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"ChangeEventSlimEntityPaginated model"},"ChangeEventSlimEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"summary":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"external_id":{"type":"string","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"starts_at":{"type":"string","format":"date-time","x-nullable":true},"ends_at":{"type":"string","format":"date-time","x-nullable":true},"duration_ms":{"type":"integer","format":"int32","x-nullable":true},"duration_iso8601":{"type":"string","x-nullable":true},"environments":{"type":"array","items":{"$ref":"#/definitions/EnvironmentEntryEntity"},"x-nullable":true},"authors":{"type":"array","items":{"$ref":"#/definitions/AuthorEntity"},"x-nullable":true},"labels":{"type":"object","description":"An object of label key and values","x-nullable":true},"services":{"type":"array","items":{"$ref":"#/definitions/ServiceEntityLite"},"x-nullable":true}}},"update_change_event":{"type":"object","properties":{"summary":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"labels":{"type":"object","additionalProperties":{"type":"string"},"x-nullable":true},"starts_at":{"type":"string","format":"date-time","x-nullable":true},"ends_at":{"type":"string","format":"date-time","x-nullable":true},"environments":{"type":"array","description":"An array of environment IDs (setting this will overwrite the current environments)","items":{"type":"string"},"x-nullable":true},"services":{"type":"array","description":"An array of service IDs (setting this will overwrite the current services)","items":{"type":"string"},"x-nullable":true},"attachments":{"type":"array","description":"JSON objects representing attachments, see attachments documentation for the schema","items":{"type":"object","properties":{"type":{"type":"string","enum":["link"],"additionalProperties":{"type":"string"}}},"required":["type"]},"x-nullable":true}},"description":"Update a change event"},"ChangeTypeEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/ChangeTypeEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"ChangeTypeEntityPaginated model"},"ChangeTypeEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true}}},"EntitlementEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/EntitlementEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"EntitlementEntityPaginated model"},"EntitlementEntity":{"type":"object","properties":{"current_count":{"type":"integer","format":"int32","x-nullable":true},"errors":{"type":"array","items":{"type":"string"},"x-nullable":true},"exists":{"type":"boolean","x-nullable":true},"available":{"type":"boolean","x-nullable":true},"maximum":{"type":"integer","format":"int32","x-nullable":true},"name":{"type":"string","x-nullable":true},"slug":{"type":"string","x-nullable":true},"tier":{"type":"string","enum":["free","essentials","enterprise","signals_only"],"x-nullable":true}}},"create_incident":{"type":"object","properties":{"name":{"type":"string"},"summary":{"type":"string","x-nullable":true},"customer_impact_summary":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"priority":{"type":"string","x-nullable":true},"severity":{"type":"string","x-nullable":true},"severity_condition_id":{"type":"string","x-nullable":true},"severity_impact_id":{"type":"string","x-nullable":true},"alert_ids":{"type":"array","description":"List of alert IDs that this incident should be associated to","items":{"type":"string"},"x-nullable":true},"labels":{"type":"object","description":"Key:value pairs to track custom data for the incident","x-nullable":true},"runbook_ids":{"type":"array","description":"List of ids of Runbooks to attach to this incident. Foregoes any conditions these Runbooks may have guarding automatic attachment.","items":{"type":"string"},"x-nullable":true},"tag_list":{"type":"array","description":"List of tags for the incident","items":{"type":"string"},"x-nullable":true},"impacts":{"type":"array","description":"An array of impacted infrastructure","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of impacted infrastructure. One of: environment, functionality, or service"},"id":{"type":"string","description":"The ID of the impacted infrastructure"},"condition_id":{"type":"string","description":"The ID of the impact condition. Find these at /v1/severity_matrix/conditions"}},"required":["type","id","condition_id"]},"x-nullable":true},"milestones":{"type":"array","description":"An array of milestones to set on an incident. This can be used to create an already-resolved incident.","items":{"type":"object","properties":{"type":{"type":"string","description":"The type/slug of the milestone. Must be one of the currently configured milestones."},"occurred_at":{"type":"string","format":"date-time","description":"An ISO8601 formatted string for when this milestone occurred. If you are removing a milestone, this field still needs to be set to some value"}},"required":["type","occurred_at"]},"x-nullable":true},"restricted":{"type":"boolean","x-nullable":true},"team_ids":{"type":"array","description":"IDs of teams you wish to assign to this incident.","items":{"type":"string"},"x-nullable":true},"custom_fields":{"type":"array","description":"An array of custom fields to set on the incident.","items":{"type":"object","properties":{"field_id":{"type":"string","description":"The ID of the custom field you wish to set."},"value_string":{"type":"string","description":"The value you wish to set on the custom field if the type of the field accepts string values","x-nullable":true},"value_array":{"type":"array","description":"The value you wish to set on the custom field if the type of the field accepts array values","items":{"type":"string"},"x-nullable":true}},"required":["field_id"]},"x-nullable":true},"external_links":{"type":"string","x-nullable":true},"incident_type_id":{"type":"string","description":"The ID of the incident type. This will copy values from the incident type (if any) unless they are being overridden via parameters in this request.","x-nullable":true},"skip_incident_type_values":{"type":"boolean","description":"If true, the incident type values will not be copied to the incident. This is useful when creating an incident from an incident type, but you want to set the values manually.","default":false,"x-nullable":true}},"required":["name"],"description":"Create a new incident"},"IncidentEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/IncidentEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"IncidentEntityPaginated model"},"update_incident":{"type":"object","properties":{"name":{"type":"string","x-nullable":true},"summary":{"type":"string","x-nullable":true},"customer_impact_summary":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"labels":{"type":"object","description":"Key:value pairs to track custom data for the incident","x-nullable":true},"priority":{"type":"string","x-nullable":true},"severity":{"type":"string","x-nullable":true},"severity_condition_id":{"type":"string","x-nullable":true},"severity_impact_id":{"type":"string","x-nullable":true},"tag_list":{"type":"array","description":"List of tags for the incident","items":{"type":"string"},"x-nullable":true},"incident_type_id":{"type":"string","description":"The ID of the incident type. This will copy values from the incident type (if any) unless they are being overridden via parameters in this request.","x-nullable":true},"custom_fields":{"type":"array","description":"An array of custom fields to set on the incident.","items":{"type":"object","properties":{"field_id":{"type":"string","description":"The ID of the custom field you wish to set."},"value_string":{"type":"string","description":"The value you wish to set on the custom field if the type of the field accepts string values","x-nullable":true},"value_array":{"type":"array","description":"The value you wish to set on the custom field if the type of the field accepts array values","items":{"type":"string"},"x-nullable":true}},"required":["field_id"]},"x-nullable":true}},"description":"Updates an incident with provided parameters"},"Incidents_AlertEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Incidents_AlertEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"Incidents_AlertEntityPaginated model"},"Incidents_AlertEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"alert":{"$ref":"#/definitions/NullableAlerts_AlertEntity"},"primary":{"type":"boolean","description":"whether or not this is the primary alert for this incident","x-nullable":true}},"description":"Incidents_AlertEntity model"},"Alerts_AlertEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"summary":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"priority":{"type":"string","x-nullable":true},"integration_name":{"type":"string","x-nullable":true},"starts_at":{"type":"string","format":"date-time","x-nullable":true},"ends_at":{"type":"string","format":"date-time","x-nullable":true},"duration_ms":{"type":"integer","format":"int32","x-nullable":true},"duration_iso8601":{"type":"string","x-nullable":true},"status":{"type":"string","x-nullable":true},"remote_id":{"type":"string","x-nullable":true},"remote_url":{"type":"string","x-nullable":true},"labels":{"type":"object","description":"Arbitrary key:value pairs of labels.","x-nullable":true},"environments":{"type":"array","items":{"$ref":"#/definitions/SuccinctEntity"},"x-nullable":true},"services":{"type":"array","items":{"$ref":"#/definitions/SuccinctEntity"},"x-nullable":true},"tags":{"type":"array","items":{"type":"string"},"x-nullable":true},"source_icon":{"type":"string","x-nullable":true},"signal_id":{"type":"string","x-nullable":true},"signal_rule":{"$ref":"#/definitions/NullableSignals_API_RuleEntity"},"signal_target":{"$ref":"#/definitions/NullableSignals_API_TargetEntity"},"team_name":{"type":"string","x-nullable":true},"team_id":{"type":"string","x-nullable":true},"position":{"type":"integer","format":"int32","x-nullable":true},"notification_priority":{"type":"string","x-nullable":true},"incidents":{"type":"array","items":{"$ref":"#/definitions/PublicAPI_V1_Incidents_SuccinctEntity"},"x-nullable":true},"events":{"type":"array","items":{"$ref":"#/definitions/Alerts_SirenEventEntity"},"x-nullable":true},"is_expired":{"type":"boolean","x-nullable":true},"is_noise":{"type":"boolean","x-nullable":true},"parent_alerts":{"type":"array","items":{"$ref":"#/definitions/Alerts_SirenAlertEntity"},"x-nullable":true},"child_alerts":{"type":"array","items":{"$ref":"#/definitions/Alerts_SirenAlertEntity"},"x-nullable":true},"conversations":{"type":"array","items":{"$ref":"#/definitions/Conversations_API_Entities_Reference"},"x-nullable":true}},"description":"Alerts_AlertEntity model"},"Alerts_SirenEventEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"type":{"type":"string","x-nullable":true},"data":{"type":"object","description":"The event's payload","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true}}},"Alerts_SirenAlertEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"summary":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"starts_at":{"type":"string","format":"date-time","x-nullable":true},"ends_at":{"type":"string","format":"date-time","x-nullable":true},"status":{"type":"string","x-nullable":true},"remote_id":{"type":"string","x-nullable":true},"remote_url":{"type":"string","x-nullable":true},"labels":{"type":"object","description":"Arbitrary key:value pairs of labels.","x-nullable":true},"tags":{"type":"array","items":{"type":"string"},"x-nullable":true},"signal_id":{"type":"string","x-nullable":true},"signal_rule":{"$ref":"#/definitions/NullableSignals_API_RuleEntity"}}},"update_incident_alert_primary":{"type":"object","properties":{"primary":{"type":"boolean"}},"required":["primary"],"description":"Setting an alert as primary will overwrite milestone times in the FireHydrant incident with times included in the primary alert. Services attached to the primary alert will also be automatically added to the incident."},"bulk_update_incident_milestones":{"type":"object","properties":{"bulk":{"type":"string","enum":["true"],"x-nullable":true},"milestones":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"The type/slug of the milestone. Must be one of the currently configured milestones for the given incident."},"occurred_at":{"type":"string","format":"date-time","description":"An ISO8601 formatted string for when this milestone occurred. If you are removing a milestone, this field still needs to be set to some value"},"remove":{"type":"boolean","description":"If set to true, the milestone will be removed from the incident","x-nullable":true}},"required":["type","occurred_at"]}}},"required":["milestones"],"description":"Update milestone times in bulk for a given incident. All milestone\ntimes for an incident must occur in chronological order\ncorresponding to the configured order of milestones. If the result\nof this request would cause any milestone(s) to appear out of place,\na 422 response will instead be returned. This includes milestones\nnot explicitly submitted or updated in this request.\n"},"Incidents_MilestoneEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Incidents_MilestoneEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"Incidents_MilestoneEntityPaginated model"},"create_incident_change_event":{"type":"object","properties":{"change_event_id":{"type":"string","description":"The ID of the change event to associate"},"type":{"type":"string","enum":["caused","fixed","suspect","dismissed"]},"why":{"type":"string","description":"A short description about why this change event is related","x-nullable":true}},"required":["change_event_id","type"],"description":"Add a related change to an incident. Changes added to an incident can be causes, fixes, or suspects. To remove a change from an incident, the type field should be set to dismissed."},"Incidents_RelatedChangeEventEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"why":{"type":"string","description":"The reason why this change event is related to this incident","x-nullable":true},"type":{"type":"string","enum":["caused","fixed","suspect","dismissed"],"x-nullable":true},"change_event":{"$ref":"#/definitions/NullableChangeEventEntity"},"incident_id":{"type":"string","x-nullable":true},"created_by":{"$ref":"#/definitions/NullableAuthorEntity"}},"description":"Incidents_RelatedChangeEventEntity model"},"Incidents_RelatedChangeEventEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Incidents_RelatedChangeEventEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"Incidents_RelatedChangeEventEntityPaginated model"},"update_incident_change_event":{"type":"object","properties":{"type":{"type":"string","enum":["caused","fixed","suspect","dismissed"],"x-nullable":true},"why":{"type":"string","description":"A short description about why this change event is related","x-nullable":true}},"description":"Update a change attached to an incident"},"create_incident_status_page":{"type":"object","properties":{"integration_slug":{"type":"string"},"integration_id":{"type":"string"},"title":{"type":"string","x-nullable":true}},"required":["integration_slug","integration_id"],"description":"Add a status page to an incident."},"Incidents_StatusPageEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Incidents_StatusPageEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"Incidents_StatusPageEntityPaginated model"},"create_incident_task_list":{"type":"object","properties":{"task_list_id":{"type":"string","description":"The id of the task list."},"assignee_id":{"type":"string","description":"The ID of the user assigned to the tasks in this list.","x-nullable":true}},"required":["task_list_id"],"description":"Add all tasks from list to incident"},"TaskEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"title":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"state":{"type":"string","x-nullable":true},"assignee":{"$ref":"#/definitions/NullableAuthorEntity"},"created_by":{"$ref":"#/definitions/NullableAuthorEntity"},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"due_at":{"type":"string","format":"date-time","x-nullable":true}},"description":"TaskEntity model"},"create_incident_task":{"type":"object","properties":{"title":{"type":"string","description":"The title of the task."},"state":{"type":"string","description":"The state of the task. One of: open, in_progress, cancelled, done","x-nullable":true},"description":{"type":"string","description":"A description of what the task is for.","x-nullable":true},"assignee_id":{"type":"string","description":"The ID of the user assigned to the task.","x-nullable":true},"due_at":{"type":"string","description":"The due date of the task. Relative values are supported such as '5m'","x-nullable":true}},"required":["title"],"description":"Create a task"},"TaskEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/TaskEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"TaskEntityPaginated model"},"update_incident_task":{"type":"object","properties":{"title":{"type":"string","description":"The title of the task.","x-nullable":true},"description":{"type":"string","description":"A description of what the task is for.","x-nullable":true},"state":{"type":"string","description":"The state of the task. One of: open, in_progress, cancelled, done","x-nullable":true},"assignee_id":{"type":"string","description":"The ID of the user assigned to the task.","x-nullable":true},"due_at":{"type":"string","description":"The due date of the task. Relative values are supported such as '5m'","x-nullable":true}},"description":"Update a task's attributes"},"convert_incident_task":{"type":"object","properties":{"summary":{"type":"string","x-nullable":true},"project_id":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"state":{"type":"string","x-nullable":true},"tag_list":{"type":"array","description":"List of tags for the ticket","items":{"type":"string"},"x-nullable":true}},"description":"Convert a task to a follow-up"},"Attachments_LinkEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Attachments_LinkEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"Attachments_LinkEntityPaginated model"},"create_incident_link":{"type":"object","properties":{"display_text":{"type":"string","x-nullable":true},"icon_url":{"type":"string","x-nullable":true},"href":{"type":"string"}},"required":["href"],"description":"Allows adding adhoc links to an incident as an attachment"},"update_incident_link":{"type":"object","properties":{"display_text":{"type":"string","x-nullable":true},"icon_url":{"type":"string","x-nullable":true},"href_url":{"type":"string","x-nullable":true}},"description":"Update the external incident link attributes"},"PublicAPI_V1_Incidents_TranscriptEntity":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the transcript entry","x-nullable":true},"speaker":{"type":"string","description":"The speaker for the transcript entry","x-nullable":true},"start":{"type":"integer","format":"int32","description":"The start time for the transcript entry","x-nullable":true},"until":{"type":"integer","format":"int32","description":"The end time for the transcript entry","x-nullable":true},"words":{"type":"string","description":"The words spoken for the transcript entry","x-nullable":true},"created_at":{"type":"string","format":"date-time","description":"The time the transcript entry was created","x-nullable":true},"updated_at":{"type":"string","format":"date-time","description":"The time the transcript entry was last updated","x-nullable":true},"author":{"$ref":"#/definitions/NullableAuthorEntity","description":"The author of the transcript entry"}},"description":"PublicAPI_V1_Incidents_TranscriptEntity model"},"SimilarIncidentEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/PublicAPI_V1_SimilarIncidentEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"SimilarIncidentEntityPaginated model"},"PublicAPI_V1_SimilarIncidentEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"distance":{"type":"number","format":"float","x-nullable":true}}},"Attachments_TypedAttachmentEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Attachments_TypedAttachmentEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"Attachments_TypedAttachmentEntityPaginated model"},"Attachments_TypedAttachmentEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"type":{"type":"string","x-nullable":true},"attached_to_id":{"type":"string","x-nullable":true},"attached_to_type":{"type":"string","x-nullable":true},"secondary_attached_to_id":{"type":"string","x-nullable":true},"secondary_attached_to_type":{"type":"string","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"attributes":{"type":"object","description":"Can be one of: Attachments::LinkEntity, Integrations::CustomerSupportIssueEntity, Attachments::GenericAttachmentEntity","x-nullable":true}}},"IncidentAttachmentEntity":{"type":"object","properties":{"file_name":{"type":"string","x-nullable":true},"file_content_type":{"type":"string","x-nullable":true},"signed_url":{"type":"string","x-nullable":true},"media_type":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"external_id":{"type":"string","x-nullable":true},"file_size":{"type":"integer","format":"int32","x-nullable":true},"status":{"type":"string","enum":["pending_upload","uploaded"],"x-nullable":true},"versions":{"type":"object","description":"An object with keys that designate a specific version or size of the attachment","x-nullable":true}},"description":"IncidentAttachmentEntity model"},"IncidentEventEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/IncidentEventEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"IncidentEventEntityPaginated model"},"IncidentEventEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"incident_id":{"type":"string","x-nullable":true},"type":{"type":"string","x-nullable":true},"context":{"type":"string","x-nullable":true},"data":{"type":"object","description":"Can be one of: NoteEntity, TourStepEntity, RootCauseEntity, ChangeTypeEntity, RoleUpdateEntity, TaskUpdateEntity, AlertLinkedEntity, ChatMessageEntity, AddTaskListEntity, ImpactUpdateEntity, TicketUpdateEntity, GeneralUpdateEntity, ChangelogEntryEntity, IncidentStatusEntity, TeamAssignmentEntity, BulkUpdateEntity","x-nullable":true},"occurred_at":{"type":"string","format":"date-time","x-nullable":true},"visibility":{"type":"string","enum":["private_to_org","open_to_public","internal_status_page"],"x-nullable":true},"author":{"$ref":"#/definitions/NullableAuthorEntity"},"votes":{"$ref":"#/definitions/NullableVotesEntity"},"conversations":{"type":"array","items":{"$ref":"#/definitions/Conversations_API_Entities_Reference"},"x-nullable":true}},"description":"IncidentEventEntity model"},"VotesEntity":{"type":"object","properties":{"voted":{"type":"boolean","description":"Whether or not the current actor has voted","x-nullable":true},"liked":{"type":"boolean","description":"Whether or not the current actor has voted positively","x-nullable":true},"disliked":{"type":"boolean","description":"Whether or not the current actor has voted negatively","x-nullable":true},"likes":{"type":"integer","format":"int32","x-nullable":true},"dislikes":{"type":"integer","format":"int32","x-nullable":true}},"description":"VotesEntity model"},"update_vote":{"type":"object","properties":{"direction":{"type":"string","description":"The direction you would like to vote, or if you dig it","enum":["up","down","dig"]}},"required":["direction"],"description":"Upvote or downvote an object"},"update_incident_impact_patch":{"type":"object","properties":{"note":{"type":"string","x-nullable":true},"milestone":{"type":"string","x-nullable":true},"impact":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"condition_id":{"type":"string"}},"required":["id","condition_id"]},"x-nullable":true},"status_pages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"integration_slug":{"type":"string"}},"required":["id","integration_slug"]},"x-nullable":true},"notify_email_subscribers":{"type":"boolean","description":"When posting to a public status page, whether to also email its subscribers. Defaults to true.","x-nullable":true}},"description":"Allows updating an incident's impacted infrastructure, with the option to\nmove the incident into a different milestone and provide a note to update\nthe incident timeline and any attached status pages. If this method is\nrequested with the PUT verb, impacts will be completely replaced with the\ninformation in the request body, even if not provided (effectively clearing\nall impacts). If this method is requested with the PATCH verb, the provided\nimpacts will be added or updated, but no impacts will be removed.\n"},"update_incident_impact_put":{"type":"object","properties":{"note":{"type":"string","x-nullable":true},"milestone":{"type":"string","x-nullable":true},"impact":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"condition_id":{"type":"string"}},"required":["id","condition_id"]},"x-nullable":true},"status_pages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"integration_slug":{"type":"string"}},"required":["id","integration_slug"]},"x-nullable":true},"notify_email_subscribers":{"type":"boolean","description":"When posting to a public status page, whether to also email its subscribers. Defaults to true.","x-nullable":true}},"description":"Allows updating an incident's impacted infrastructure, with the option to\nmove the incident into a different milestone and provide a note to update\nthe incident timeline and any attached status pages. If this method is\nrequested with the PUT verb, impacts will be completely replaced with the\ninformation in the request body, even if not provided (effectively clearing\nall impacts). If this method is requested with the PATCH verb, the provided\nimpacts will be added or updated, but no impacts will be removed.\n"},"create_incident_impact":{"type":"object","properties":{"id":{"type":"string"},"condition_id":{"type":"string","x-nullable":true}},"required":["id"],"description":"Add impacted infrastructure to an incident"},"IncidentImpactEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"type":{"type":"string","x-nullable":true},"infrastructure":{"$ref":"#/definitions/NullableSuccinctEntity"}},"description":"IncidentImpactEntity model"},"IncidentImpactEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/IncidentImpactEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"IncidentImpactEntityPaginated model"},"create_incident_note":{"type":"object","properties":{"body":{"type":"string"},"occurred_at":{"type":"string","format":"date-time","description":"ISO8601 timestamp for when the note occurred","x-nullable":true},"visibility":{"type":"string","enum":["private_to_org","open_to_public","internal_status_page"],"default":"private_to_org","x-nullable":true},"status_pages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"integration_slug":{"type":"string"}},"required":["id","integration_slug"]},"x-nullable":true},"notify_email_subscribers":{"type":"boolean","description":"When posting to a public status page, whether to also email its subscribers. Defaults to true.","x-nullable":true}},"required":["body"],"description":"Create a new note on for an incident. The visibility field on a note determines where it gets posted."},"update_incident_note":{"type":"object","properties":{"body":{"type":"string"}},"required":["body"],"description":"Updates the body of a note"},"create_incident_chat_message":{"type":"object","properties":{"body":{"type":"string"},"occurred_at":{"type":"string","format":"date-time","description":"ISO8601 timestamp for when the chat message occurred","x-nullable":true},"vote_direction":{"type":"string","enum":["up","down"],"x-nullable":true}},"required":["body"],"description":"Create a new generic chat message on an incident timeline. These are independent of any specific chat provider."},"Event_GenericChatMessageEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"body":{"type":"string","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true}},"description":"Event_GenericChatMessageEntity model"},"update_incident_chat_message":{"type":"object","properties":{"body":{"type":"string"}},"required":["body"],"description":"Update an existing generic chat message on an incident."},"Incidents_RoleAssignmentEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Incidents_RoleAssignmentEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"Incidents_RoleAssignmentEntityPaginated model"},"create_incident_role_assignment":{"type":"object","properties":{"user_id":{"type":"string","description":"The user ID to assign the role to"},"incident_role_id":{"type":"string","description":"The Incident Role ID to assign the role to"}},"required":["user_id","incident_role_id"],"description":"Assign a role to a user for this incident"},"create_incident_team_assignment":{"type":"object","properties":{"team_id":{"type":"string","description":"The team ID to associate to the incident"}},"required":["team_id"],"description":"Assign a team for this incident"},"Incidents_RelationshipsEntity":{"type":"object","properties":{"parent":{"$ref":"#/definitions/NullablePublicAPI_V1_Incidents_SuccinctEntity","description":"A root level incident."},"children":{"type":"array","items":{"$ref":"#/definitions/PublicAPI_V1_Incidents_SuccinctEntity"},"description":"The root incident's child incidents.","x-nullable":true},"siblings":{"type":"array","items":{"$ref":"#/definitions/PublicAPI_V1_Incidents_SuccinctEntity"},"description":"A list of incidents that share the root incident's parent.","x-nullable":true}},"description":"Incidents_RelationshipsEntity model"},"Incidents_ShareRetrospectivesResultEntity":{"type":"object","properties":{"retrospective_ids":{"type":"array","items":{"type":"string"},"description":"The IDs of the retrospectives that were shared.","x-nullable":true},"user_ids":{"type":"array","items":{"type":"string"},"description":"The IDs of the users with whom the retrospectives were shared.","x-nullable":true}},"description":"Incidents_ShareRetrospectivesResultEntity model"},"Incidents_ExportRetrospectiveMarkdownEntity":{"type":"object","properties":{"markdown":{"type":"string","description":"The retrospective content rendered as markdown.","x-nullable":true}},"description":"Incidents_ExportRetrospectiveMarkdownEntity model"},"Incidents_ExportRetrospectivesResultEntity":{"type":"object","properties":{"external_resource":{"$ref":"#/definitions/NullableExternalResourceEntity","description":"URL to the external resource where the retrospective was exported."}},"description":"Incidents_ExportRetrospectivesResultEntity model"},"Incidents_RetrospectiveEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"sections":{"type":"array","items":{"$ref":"#/definitions/Incidents_RetrospectiveEntity_SectionEntity"},"x-nullable":true},"is_hidden":{"type":"boolean","x-nullable":true},"fields":{"type":"array","items":{"$ref":"#/definitions/Incidents_RetrospectiveFieldEntity"},"x-nullable":true},"exports":{"type":"array","items":{"type":"string"},"x-nullable":true},"retrospective_template_id":{"type":"string","x-nullable":true}},"description":"Incidents_RetrospectiveEntity model"},"Incidents_RetrospectiveEntity_SectionEntity":{"type":"object","properties":{"slug":{"type":"string","x-nullable":true},"elements":{"type":"array","items":{"type":"string"},"x-nullable":true}}},"Incidents_RetrospectiveFieldEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"label":{"type":"string","x-nullable":true},"type":{"type":"string","enum":["text","single_select","multi_select","numeric","datetime","dynamic_input_group","markdown","markdown_text"],"x-nullable":true},"help_text":{"type":"string","x-nullable":true},"permissible_values":{"type":"array","items":{"type":"string"},"x-nullable":true},"is_required":{"type":"boolean","x-nullable":true},"value":{"type":"string","x-nullable":true},"retrospective_field_id":{"type":"string","x-nullable":true},"schema":{"type":"array","items":{"type":"object"},"x-nullable":true},"required_at_milestone_id":{"type":"string","x-nullable":true}},"description":"Incidents_RetrospectiveFieldEntity model"},"Incidents_RetrospectiveEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Incidents_RetrospectiveEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"Incidents_RetrospectiveEntityPaginated model"},"update_incident_retrospective":{"type":"object","properties":{"is_hidden":{"type":"boolean","description":"To hide or unhide the retrospective.","x-nullable":true}},"description":"Update a retrospective attached to an incident"},"update_incident_retrospective_field":{"type":"object","properties":{"dynamic_input_field_id":{"type":"string","description":"The ID of the dynamic input field to update.","x-nullable":true},"value":{"type":"integer","format":"int64","description":"The value to set for the field."}},"required":["value"],"description":"Update retrospective field value"},"IncidentRoleEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/IncidentRoleEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"IncidentRoleEntityPaginated model"},"create_incident_role":{"type":"object","properties":{"name":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string","x-nullable":true}},"required":["name","summary"],"description":"Create a new incident role"},"update_incident_role":{"type":"object","properties":{"name":{"type":"string","x-nullable":true},"summary":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true}},"description":"Update a single incident role from its ID"},"TagEntity":{"type":"object","properties":{"name":{"type":"string","x-nullable":true}},"description":"TagEntity model"},"TagEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/TagEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"TagEntityPaginated model"},"create_incident_type":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","description":"A description of the incident type","x-nullable":true},"template":{"type":"object","properties":{"description":{"type":"string","x-nullable":true},"customer_impact_summary":{"type":"string","x-nullable":true},"labels":{"type":"object","description":"A labels hash of keys and values","additionalProperties":{"type":"string"},"x-nullable":true},"severity":{"type":"string","x-nullable":true},"priority":{"type":"string","x-nullable":true},"tag_list":{"type":"array","description":"List of tags for the incident","items":{"type":"string"},"x-nullable":true},"runbook_ids":{"type":"array","description":"List of ids of Runbooks to attach to incidents created from this type","items":{"type":"string"},"x-nullable":true},"private_incident":{"type":"boolean","x-nullable":true},"team_ids":{"type":"array","description":"List of ids of teams to be assigned to incidents","items":{"type":"string"},"x-nullable":true},"impacts":{"type":"array","description":"An array of impact/condition combinations","items":{"type":"object","properties":{"id":{"type":"string","description":"The id of impact"},"condition_id":{"type":"string","description":"The id of the condition"}},"required":["id","condition_id"]},"x-nullable":true}}}},"required":["name","template"],"description":"Create a new incident type"},"IncidentTypeEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"allowed_role_ids":{"type":"array","items":{"type":"string"},"description":"IDs of roles allowed to create incidents of this type. Empty array means all roles are allowed.","x-nullable":true},"template":{"$ref":"#/definitions/NullableIncidentTypeEntity_TemplateEntity"},"template_values":{"$ref":"#/definitions/NullableIncidentTypeEntity_TemplateValuesEntity"},"required_fields":{"type":"array","items":{"$ref":"#/definitions/Incidents_RequiredFieldEntity"},"description":"A list of fields that are required on incidents of this type.","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true}},"description":"IncidentTypeEntity model"},"IncidentTypeEntity_TemplateEntity":{"type":"object","properties":{"incident_name":{"type":"string","x-nullable":true},"summary":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"customer_impact_summary":{"type":"string","x-nullable":true},"labels":{"type":"object","description":"Arbitrary key:value pairs of labels for your incidents.","additionalProperties":true,"x-nullable":true},"severity":{"type":"string","x-nullable":true},"priority":{"type":"string","x-nullable":true},"tag_list":{"type":"array","items":{"type":"string"},"x-nullable":true},"runbook_ids":{"type":"array","items":{"type":"string"},"x-nullable":true},"team_ids":{"type":"array","items":{"type":"string"},"x-nullable":true},"private_incident":{"type":"boolean","x-nullable":true},"custom_fields":{"type":"string","x-nullable":true},"impacts":{"type":"array","items":{"$ref":"#/definitions/IncidentTypeEntity_TemplateImpactEntity"},"x-nullable":true}}},"IncidentTypeEntity_TemplateImpactEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"condition_id":{"type":"string","x-nullable":true},"condition_name":{"type":"string","x-nullable":true},"type":{"type":"string","enum":["customer","environment","functionality","service"],"x-nullable":true}}},"IncidentTypeEntity_TemplateValuesEntity":{"type":"object","properties":{"services":{"type":"array","items":{"$ref":"#/definitions/IncidentTypeEntity_TemplateImpactEntity"},"x-nullable":true},"functionalities":{"type":"array","items":{"$ref":"#/definitions/IncidentTypeEntity_TemplateImpactEntity"},"x-nullable":true},"environments":{"type":"array","items":{"$ref":"#/definitions/IncidentTypeEntity_TemplateImpactEntity"},"x-nullable":true},"runbooks":{"type":"object","description":"A hash mapping runbook IDs to runbook names.","x-nullable":true},"teams":{"type":"array","items":{"$ref":"#/definitions/TeamEntityLite"},"x-nullable":true}}},"Incidents_RequiredFieldEntity":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier for the field. For built-in fields, this will be human-readable. For custom fields or milestone timestamps, it will be a prefixed version of the field or milestone's UUID.","x-nullable":true},"required_at_milestone_id":{"type":"string","description":"The milestone at which this field is required. If null, this field is always required.","x-nullable":true}}},"IncidentTypeEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/IncidentTypeEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"IncidentTypeEntityPaginated model"},"update_incident_type":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","description":"A description of the incident type","x-nullable":true},"template":{"type":"object","properties":{"description":{"type":"string","x-nullable":true},"customer_impact_summary":{"type":"string","x-nullable":true},"labels":{"type":"object","description":"A labels hash of keys and values","additionalProperties":{"type":"string"},"x-nullable":true},"severity":{"type":"string","x-nullable":true},"priority":{"type":"string","x-nullable":true},"tag_list":{"type":"array","description":"List of tags for the incident","items":{"type":"string"},"x-nullable":true},"runbook_ids":{"type":"array","description":"List of ids of Runbooks to attach to incidents created from this type","items":{"type":"string"},"x-nullable":true},"private_incident":{"type":"boolean","x-nullable":true},"team_ids":{"type":"array","description":"List of ids of teams to be assigned to incidents","items":{"type":"string"},"x-nullable":true},"impacts":{"type":"array","description":"An array of impact/condition combinations","items":{"type":"object","properties":{"id":{"type":"string","description":"The id of impact"},"condition_id":{"type":"string","description":"The id of the condition"}},"required":["id","condition_id"]},"x-nullable":true}}}},"required":["name","template"],"description":"Update a single incident type from its ID"},"Integrations_IntegrationEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Integrations_IntegrationEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"Integrations_IntegrationEntityPaginated model"},"Integrations_IntegrationEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"slug":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"setup_url":{"type":"string","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"connections":{"type":"array","items":{"$ref":"#/definitions/Integrations_ConnectionEntity"},"x-nullable":true},"enabled":{"type":"boolean","x-nullable":true},"installed":{"type":"boolean","x-nullable":true},"deprecated":{"type":"boolean","x-nullable":true},"logo":{"$ref":"#/definitions/NullableIntegrations_IntegrationEntity_LogoEntity"},"nat_ip":{"type":"string","x-nullable":true}},"description":"Integrations_IntegrationEntity model"},"Integrations_ConnectionEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"integration_slug":{"type":"string","x-nullable":true},"integration_id":{"type":"string","x-nullable":true},"display_name":{"type":"string","x-nullable":true},"configuration_url":{"type":"string","x-nullable":true},"authorized_by":{"type":"string","x-nullable":true},"authorized_by_id":{"type":"string","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"details":{"type":"object","description":"Integration-specific details of this connection. As identified by the integration_slug, this object will be represented by that integration's ConnectionEntity.","x-nullable":true},"default_authorized_actor":{"$ref":"#/definitions/NullableAuthorEntity"}},"description":"Integrations_ConnectionEntity model"},"Integrations_IntegrationEntity_LogoEntity":{"type":"object","properties":{"logo_url":{"type":"string","x-nullable":true}}},"FieldMapping_FieldMapEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"connection_id":{"type":"string","x-nullable":true},"connection_type":{"type":"string","x-nullable":true},"entity_id":{"type":"string","x-nullable":true},"entity_type":{"type":"string","x-nullable":true},"body":{"type":"object","x-nullable":true},"available_fields_url":{"type":"string","x-nullable":true},"data_bag_url":{"type":"string","x-nullable":true}},"description":"FieldMapping_FieldMapEntity model"},"FieldMapping_MappableFieldEntity":{"type":"object","properties":{"value":{"type":"string","description":"The ID of the field","x-nullable":true},"label":{"type":"string","description":"The human-readable name of the field","x-nullable":true},"type":{"type":"string","description":"The allowed type of the field","x-nullable":true},"allowed_values":{"type":"array","items":{"type":"string"},"description":"The allowed values of the field","x-nullable":true},"required":{"type":"string","description":"If the field is required to be mapped","x-nullable":true},"help_text":{"type":"string","description":"Short, inline documentation for the present field","x-nullable":true}},"description":"FieldMapping_MappableFieldEntity model"},"Integrations_AuthedProviderEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/PublicAPI_V1_Integrations_AuthedProviderEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"Integrations_AuthedProviderEntityPaginated model"},"PublicAPI_V1_Integrations_AuthedProviderEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"user":{"$ref":"#/definitions/NullableSuccinctEntity"},"integration_default":{"type":"boolean","x-nullable":true},"authorized_email":{"type":"string","description":"The email of the user who authorized the integration","x-nullable":true},"is_expired":{"type":"boolean","x-nullable":true},"authorized_at":{"type":"string","format":"date-time","description":"When the user last authorized or reauthorized the integration","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true}},"description":"PublicAPI_V1_Integrations_AuthedProviderEntity model"},"Integrations_ConnectionEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Integrations_ConnectionEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"Integrations_ConnectionEntityPaginated model"},"Integrations_ConnectionStatusEntity":{"type":"object","properties":{"checked_at":{"type":"string","format":"date-time","x-nullable":true},"status":{"type":"string","enum":["ok","info","warning","error"],"x-nullable":true},"message":{"type":"string","x-nullable":true},"check_type":{"type":"string","x-nullable":true},"error_type":{"type":"string","x-nullable":true},"integration_slug":{"type":"string","x-nullable":true},"connection_id":{"type":"string","x-nullable":true},"data":{"type":"object","description":"Additional unstructured data about the status check.","x-nullable":true},"performed_by":{"$ref":"#/definitions/NullableAuthorEntity"}},"description":"Integrations_ConnectionStatusEntity model"},"Integrations_Aws_ConnectionEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Integrations_Aws_ConnectionEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"Integrations_Aws_ConnectionEntityPaginated model"},"Integrations_Aws_ConnectionEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"aws_account_id":{"type":"string","x-nullable":true},"target_arn":{"type":"string","x-nullable":true},"external_id":{"type":"string","x-nullable":true},"connection_status":{"type":"string","enum":["pending_setup","role_assumed","cant_assume_role","invalid_permissions","validated"],"x-nullable":true},"status_text":{"type":"string","x-nullable":true},"status_description":{"type":"string","x-nullable":true},"environment_id":{"type":"string","x-nullable":true},"environment_name":{"type":"string","x-nullable":true},"regions":{"type":"array","items":{"type":"string"},"x-nullable":true}},"description":"Integrations_Aws_ConnectionEntity model"},"update_aws_connection":{"type":"object","properties":{"aws_account_id":{"type":"string","x-nullable":true},"target_arn":{"type":"string","x-nullable":true},"connection_status":{"type":"string","x-nullable":true}},"description":"Update the AWS connection with the provided data."},"Integrations_Aws_CloudtrailBatchEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Integrations_Aws_CloudtrailBatchEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"Integrations_Aws_CloudtrailBatchEntityPaginated model"},"Integrations_Aws_CloudtrailBatchEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"events_created":{"type":"integer","format":"int32","x-nullable":true},"status":{"type":"string","enum":["in_progress","failed","successful","pending","retried"],"x-nullable":true},"starts_at":{"type":"string","format":"date-time","x-nullable":true},"ends_at":{"type":"string","format":"date-time","x-nullable":true},"connection":{"$ref":"#/definitions/NullableIntegrations_Aws_ConnectionEntity"},"created_at":{"type":"string","format":"date-time","x-nullable":true}},"description":"Integrations_Aws_CloudtrailBatchEntity model"},"update_aws_cloudtrail_batch":{"type":"object","properties":{"events_created":{"type":"integer","format":"int32","x-nullable":true},"status":{"type":"string","x-nullable":true},"error":{"type":"string","x-nullable":true},"ends_at":{"type":"string","format":"date-time","x-nullable":true}},"description":"Update a CloudTrail batch with new information."},"Integrations_ConfluenceCloud_SpaceEntity":{"type":"object","properties":{"id":{"type":"integer","format":"int32","x-nullable":true},"name":{"type":"string","x-nullable":true}},"description":"Integrations_ConfluenceCloud_SpaceEntity model"},"Integrations_Slack_WorkspaceEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"team_id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true}},"description":"Integrations_Slack_WorkspaceEntity model"},"Integrations_Slack_UsergroupEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"handle":{"type":"string","x-nullable":true},"is_disabled":{"type":"boolean","x-nullable":true},"workspace_id":{"type":"string","x-nullable":true},"workspace_name":{"type":"string","x-nullable":true}},"description":"Integrations_Slack_UsergroupEntity model"},"Integrations_Statuspage_ConnectionEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Integrations_Statuspage_ConnectionEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"Integrations_Statuspage_ConnectionEntityPaginated model"},"Integrations_Statuspage_ConnectionEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"page_name":{"type":"string","x-nullable":true},"page_id":{"type":"string","x-nullable":true},"conditions":{"type":"array","items":{"$ref":"#/definitions/Integrations_Statuspage_ConditionEntity"},"x-nullable":true},"severities":{"type":"array","items":{"$ref":"#/definitions/Integrations_Statuspage_SeverityEntity"},"x-nullable":true},"milestone_mappings":{"type":"array","items":{"$ref":"#/definitions/Integrations_Statuspage_MilestoneMappingEntity"},"x-nullable":true}},"description":"Integrations_Statuspage_ConnectionEntity model"},"Integrations_Statuspage_ConditionEntity":{"type":"object","properties":{"condition_id":{"type":"string","x-nullable":true},"condition_name":{"type":"string","x-nullable":true},"statuspageio_condition":{"type":"string","enum":["operational","major_outage","minor_outage","degraded_performance"],"x-nullable":true}}},"Integrations_Statuspage_SeverityEntity":{"type":"object","properties":{"severity_slug":{"type":"string","x-nullable":true},"remote_status":{"type":"string","x-nullable":true}}},"Integrations_Statuspage_MilestoneMappingEntity":{"type":"object","properties":{"milestone_id":{"type":"string","x-nullable":true},"status":{"type":"string","x-nullable":true}}},"update_statuspage_connection":{"type":"object","properties":{"page_id":{"type":"string","x-nullable":true},"severities":{"type":"array","items":{"type":"object","properties":{"severity_slug":{"type":"string","description":"FireHydrant severity slug"},"remote_status":{"type":"string","description":"Statuspage.io severity name"}},"required":["severity_slug","remote_status"]},"x-nullable":true},"conditions":{"type":"array","items":{"type":"object","properties":{"condition_id":{"type":"string","description":"FireHydrant condition id"},"statuspageio_condition":{"type":"string","description":"Statuspage.io condition name"}},"required":["condition_id","statuspageio_condition"]},"x-nullable":true},"milestone_mappings":{"type":"array","items":{"type":"object","properties":{"milestone_id":{"type":"string","description":"FireHydrant milestone id"},"status":{"type":"string","description":"Statuspage.io status","enum":["investigating","identified","monitoring","resolved"]}},"required":["milestone_id","status"]},"x-nullable":true}},"description":"Update the given Statuspage integration connection."},"Integrations_Statuspage_PageEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true}},"description":"Integrations_Statuspage_PageEntity model"},"Integrations_Zendesk_SearchTickets_PaginatedEntity":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Integrations_Zendesk_SupportIssueEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"Integrations_Zendesk_SearchTickets_PaginatedEntity model"},"Integrations_Zendesk_SupportIssueEntity":{"type":"object","properties":{"remote_id":{"type":"string","description":"The ID of this support issue in the system that originated this issue, eg Zendesk.","x-nullable":true},"title":{"type":"string","description":"Title or name of this issue.","x-nullable":true},"description":{"type":"string","description":"Longer description of the issue.","x-nullable":true},"remote_url":{"type":"string","description":"Browser-accessible url for this issue in the originating system, eg Zendesk.","x-nullable":true},"data":{"type":"object","description":"Raw data associated with this issue from originating system.","x-nullable":true},"attachments":{"type":"string","description":"Attachment information for this issue.","x-nullable":true},"customers":{"$ref":"#/definitions/NullableIntegrations_Zendesk_SupportIssueEntity_CustomerEntity"},"priority":{"type":"string","x-nullable":true},"attached_incidents":{"type":"array","items":{"$ref":"#/definitions/IncidentEntity"},"x-nullable":true},"type":{"type":"string","description":"Type designator for this entity","x-nullable":true}}},"Integrations_Zendesk_SupportIssueEntity_CustomerEntity":{"type":"object","properties":{"id":{"type":"string","description":"UUID of the Customer","x-nullable":true},"name":{"type":"string","description":"Name of the Customer","x-nullable":true}}},"UserEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/UserEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"UserEntityPaginated model"},"CurrentUserEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"source":{"type":"string","x-nullable":true},"email":{"type":"string","x-nullable":true},"role":{"type":"string","x-nullable":true},"teams":{"type":"array","items":{"$ref":"#/definitions/SuccinctEntity"},"x-nullable":true},"organization_id":{"type":"string","x-nullable":true},"organization_name":{"type":"string","x-nullable":true},"account_id":{"type":"integer","format":"int32","x-nullable":true},"region":{"type":"string","x-nullable":true},"instance":{"type":"string","x-nullable":true},"organization":{"$ref":"#/definitions/NullableOrganizationEntity"}},"description":"CurrentUserEntity model"},"PermissionEntityList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/PublicAPI_V1_PermissionEntity"},"x-nullable":true}},"description":"PermissionEntityList model"},"PublicAPI_V1_PermissionEntity":{"type":"object","properties":{"slug":{"type":"string","x-nullable":true},"display_name":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"category_display_name":{"type":"string","x-nullable":true},"category_slug":{"type":"string","x-nullable":true},"parent_slug":{"type":"string","x-nullable":true},"required":{"type":"boolean","x-nullable":true},"available":{"type":"boolean","x-nullable":true},"dependency_slugs":{"type":"array","items":{"type":"string"},"x-nullable":true}}},"ReportEntity":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Reports_BucketEntity"},"x-nullable":true},"start_date":{"type":"string","format":"date","x-nullable":true},"end_date":{"type":"string","format":"date","x-nullable":true},"bucket_period":{"type":"string","x-nullable":true}},"description":"ReportEntity model"},"Reports_BucketEntity":{"type":"object","properties":{"bucket":{"type":"string","x-nullable":true},"points":{"type":"array","items":{"$ref":"#/definitions/Reports_DataPointEntity"},"x-nullable":true}}},"Reports_DataPointEntity":{"type":"object","properties":{"key":{"type":"string","x-nullable":true},"value":{"type":"integer","format":"int32","x-nullable":true}}},"create_role":{"type":"object","properties":{"name":{"type":"string","description":"The name of the role."},"slug":{"type":"string","description":"A unique identifier for the role. If not provided, one will be generated from the name.","x-nullable":true},"description":{"type":"string","description":"A long-form description of the role's purpose.","x-nullable":true},"permissions":{"type":"array","description":"An array of permission slugs to assign to the role.","items":{"type":"string","enum":["create_alerts","respond_to_alerts","read_alerts","manage_alert_grouping","read_alert_grouping","manage_alert_rules","read_alert_rules","manage_call_routes","read_call_routes","manage_escalation_policies","read_escalation_policies","manage_event_sources","read_event_sources","manage_on_call_schedules","read_on_call_schedules","manage_on_call_shifts","claim_on_call_shifts","read_signals_pii","manage_organization_notification_policies","read_organization_notification_policies","read_notification_policy_compliance","manage_webhook_targets","read_webhook_targets","read_analytics","manage_api_keys","read_api_keys","manage_audiences","read_audiences","read_audit_events","manage_change_events","read_change_events","manage_incidents","create_incidents","read_incidents","update_incidents","manage_incident_settings","read_incident_settings","manage_integrations","read_integrations","manage_private_incidents","manage_organization_secrets","read_organization_secrets","manage_organization_settings","read_organization_settings","manage_roles","read_roles","manage_runbooks","read_runbooks","manage_service_catalog","read_service_catalog","manage_status_templates","read_status_templates","manage_status_page_updates","manage_support_hours","read_support_hours","manage_teams","read_teams","manage_users","read_users","manage_webhooks","read_webhooks"]},"x-nullable":true}},"required":["name"],"description":"Create a new role"},"PublicAPI_V1_RoleEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"slug":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"built_in":{"type":"boolean","x-nullable":true},"read_only":{"type":"boolean","x-nullable":true},"permissions":{"type":"array","items":{"$ref":"#/definitions/PublicAPI_V1_PermissionEntity"},"x-nullable":true}},"description":"PublicAPI_V1_RoleEntity model"},"RoleEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/PublicAPI_V1_RoleEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"RoleEntityPaginated model"},"update_role":{"type":"object","properties":{"name":{"type":"string","description":"The name of the role."},"description":{"type":"string","description":"A long-form description of the role's purpose.","x-nullable":true},"permissions":{"type":"array","description":"An array of permission slugs to assign to the role.","items":{"type":"string","enum":["create_alerts","respond_to_alerts","read_alerts","manage_alert_grouping","read_alert_grouping","manage_alert_rules","read_alert_rules","manage_call_routes","read_call_routes","manage_escalation_policies","read_escalation_policies","manage_event_sources","read_event_sources","manage_on_call_schedules","read_on_call_schedules","manage_on_call_shifts","claim_on_call_shifts","read_signals_pii","manage_organization_notification_policies","read_organization_notification_policies","read_notification_policy_compliance","manage_webhook_targets","read_webhook_targets","read_analytics","manage_api_keys","read_api_keys","manage_audiences","read_audiences","read_audit_events","manage_change_events","read_change_events","manage_incidents","create_incidents","read_incidents","update_incidents","manage_incident_settings","read_incident_settings","manage_integrations","read_integrations","manage_private_incidents","manage_organization_secrets","read_organization_secrets","manage_organization_settings","read_organization_settings","manage_roles","read_roles","manage_runbooks","read_runbooks","manage_service_catalog","read_service_catalog","manage_status_templates","read_status_templates","manage_status_page_updates","manage_support_hours","read_support_hours","manage_teams","read_teams","manage_users","read_users","manage_webhooks","read_webhooks"]},"x-nullable":true}},"required":["name"],"description":"Update a role"},"Metrics_TicketFunnelMetricsEntity":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Metrics_TicketFunnelMetricsEntity_DataBucketEntity"},"x-nullable":true},"groupings":{"$ref":"#/definitions/NullableMetrics_TicketFunnelMetricsEntity_GroupingsEntity"}},"description":"Metrics_TicketFunnelMetricsEntity model"},"Metrics_TicketFunnelMetricsEntity_DataBucketEntity":{"type":"object","properties":{"time_bucket":{"type":"string","format":"date-time","description":"The start datetime for the period","x-nullable":true},"filter_params":{"$ref":"#/definitions/NullableMetrics_TicketFunnelMetricsEntity_DataBucketFilterParamsEntity"},"tasks_created":{"type":"integer","format":"int32","description":"The number of tasks created","x-nullable":true},"tasks_done":{"type":"integer","format":"int32","description":"The number of tasks completed","x-nullable":true},"follow_ups_created":{"type":"integer","format":"int32","description":"The number of follow ups created","x-nullable":true},"follow_ups_done":{"type":"integer","format":"int32","description":"The number of follow ups completed","x-nullable":true}}},"Metrics_TicketFunnelMetricsEntity_DataBucketFilterParamsEntity":{"type":"object","properties":{"start_date":{"type":"string","format":"date-time","description":"The start datetime for the period","x-nullable":true},"end_date":{"type":"string","format":"date","description":"The end datetime for the period not inclusive","x-nullable":true}}},"Metrics_TicketFunnelMetricsEntity_GroupingsEntity":{"type":"object","properties":{"bucket_size":{"type":"string","description":"The bucket size for the data","x-nullable":true}}},"Metrics_RetrospectiveEntity":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Metrics_RetrospectiveEntity_DataEntity"},"x-nullable":true},"summary":{"$ref":"#/definitions/NullableMetrics_RetrospectiveEntity_SummaryEntity"}},"description":"Metrics_RetrospectiveEntity model"},"Metrics_RetrospectiveEntity_DataEntity":{"type":"object","properties":{"x":{"type":"string","x-nullable":true},"y":{"type":"number","format":"float","x-nullable":true}}},"Metrics_RetrospectiveEntity_SummaryEntity":{"type":"object","properties":{"completed":{"type":"integer","format":"int32","x-nullable":true},"total":{"type":"integer","format":"int32","x-nullable":true},"incomplete":{"type":"integer","format":"int32","x-nullable":true},"mean":{"type":"number","format":"float","x-nullable":true},"shortest":{"type":"number","format":"float","x-nullable":true},"longest":{"type":"number","format":"float","x-nullable":true},"completion_percentage":{"type":"number","format":"float","x-nullable":true}}},"Metrics_MilestonesFunnelEntity":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Metrics_MilestonesFunnelEntity_DataBucketEntity"},"x-nullable":true},"columns":{"type":"array","items":{"$ref":"#/definitions/Metrics_MilestonesFunnelEntity_ColumnEntity"},"x-nullable":true},"groupings":{"$ref":"#/definitions/NullableMetrics_MilestonesFunnelEntity_GroupingsEntity"},"meta":{"$ref":"#/definitions/NullableMetrics_MilestonesFunnelEntity_MetaEntity"}},"description":"Metrics_MilestonesFunnelEntity model"},"Metrics_MilestonesFunnelEntity_DataBucketEntity":{"type":"object","properties":{"time_bucket":{"type":"string","format":"date-time","description":"The start datetime for the period","x-nullable":true},"filter_params":{"$ref":"#/definitions/NullableMetrics_MilestonesFunnelEntity_DataBucketFilterParamsEntity"},"milestone_counts":{"type":"array","items":{"$ref":"#/definitions/Metrics_MilestonesFunnelEntity_DataBucketMilestoneCountEntity"},"x-nullable":true}}},"Metrics_MilestonesFunnelEntity_DataBucketFilterParamsEntity":{"type":"object","properties":{"start_date":{"type":"string","format":"date-time","description":"The start datetime for the period","x-nullable":true},"end_date":{"type":"string","format":"date","description":"The end datetime for the period not inclusive","x-nullable":true}}},"Metrics_MilestonesFunnelEntity_DataBucketMilestoneCountEntity":{"type":"object","properties":{"milestone_id":{"type":"string","description":"The UUID of the milestone","x-nullable":true},"count":{"type":"integer","format":"int32","description":"The frequency count of that milestone for the period","x-nullable":true}}},"Metrics_MilestonesFunnelEntity_ColumnEntity":{"type":"object","properties":{"name":{"type":"string","description":"The slug of the milestone","x-nullable":true},"label":{"type":"string","description":"The name of the milestone","x-nullable":true},"tooltip":{"type":"string","description":"The description of the milestone","x-nullable":true},"id":{"type":"string","description":"The UUID of the milestone","x-nullable":true}}},"Metrics_MilestonesFunnelEntity_GroupingsEntity":{"type":"object","properties":{"bucket_size":{"type":"string","description":"The bucket size for the data","x-nullable":true}}},"Metrics_MilestonesFunnelEntity_MetaEntity":{"type":"object","properties":{"deleted_milestones":{"type":"array","items":{"type":"string"},"x-nullable":true},"added_milestones":{"type":"array","items":{"type":"string"},"x-nullable":true}}},"Metrics_MetricsEntity":{"type":"object","properties":{"type":{"type":"string","x-nullable":true},"by":{"type":"string","description":"The field by which the metrics are grouped. Can be one of: total, severity, priority, functionality, service, environment, or user.","x-nullable":true},"bucket_size":{"type":"integer","format":"int32","description":"The size of returned buckets. Can be one of: day, week, month, or all_time.","x-nullable":true},"display_information":{"type":"object","x-nullable":true},"keys":{"type":"array","items":{"type":"string"},"x-nullable":true},"buckets":{"type":"array","items":{"type":"object"},"x-nullable":true},"sort":{"$ref":"#/definitions/NullableMetrics_MetricsEntity_SortEntity"}},"description":"Metrics_MetricsEntity model"},"Metrics_MetricsEntity_SortEntity":{"type":"object","properties":{"field":{"type":"string","x-nullable":true},"direction":{"type":"string","x-nullable":true},"limit":{"type":"integer","format":"int32","x-nullable":true}}},"Metrics_MttxDataEntity":{"type":"object","properties":{"groupings":{"type":"array","items":{"$ref":"#/definitions/Metrics_MttxDataEntity_GroupingEntity"},"x-nullable":true},"data":{"type":"array","items":{"$ref":"#/definitions/Metrics_MttxGroupEntity"},"x-nullable":true}},"description":"Metrics_MttxDataEntity model"},"Metrics_MttxDataEntity_GroupingEntity":{"type":"object","properties":{"type":{"type":"string","x-nullable":true},"id_attribute":{"type":"string","x-nullable":true},"name_attribute":{"type":"string","x-nullable":true}}},"Metrics_MttxGroupEntity":{"type":"object","properties":{"group_attributes":{"type":"string","x-nullable":true},"filter_params":{"type":"object","x-nullable":true},"count":{"type":"integer","format":"int32","x-nullable":true},"mttd":{"type":"number","format":"float","x-nullable":true},"mtta":{"type":"number","format":"float","x-nullable":true},"mttm":{"type":"number","format":"float","x-nullable":true},"mttr":{"type":"number","format":"float","x-nullable":true},"count_diff":{"type":"integer","format":"int32","x-nullable":true},"count_percent_diff":{"type":"number","format":"float","x-nullable":true},"mttd_diff":{"type":"number","format":"float","x-nullable":true},"mtta_diff":{"type":"number","format":"float","x-nullable":true},"mttm_diff":{"type":"number","format":"float","x-nullable":true},"mttr_diff":{"type":"number","format":"float","x-nullable":true},"mttd_percent_diff":{"type":"number","format":"float","x-nullable":true},"mtta_percent_diff":{"type":"number","format":"float","x-nullable":true},"mttm_percent_diff":{"type":"number","format":"float","x-nullable":true},"mttr_percent_diff":{"type":"number","format":"float","x-nullable":true},"healthiness":{"type":"number","format":"float","x-nullable":true}}},"Metrics_InfrastructureListEntity":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Metrics_InfrastructureMetricsEntity"},"description":"List of infrastructure metrics","x-nullable":true}},"description":"Metrics_InfrastructureListEntity model"},"Metrics_InfrastructureMetricsEntity":{"type":"object","properties":{"id":{"type":"string","description":"The UUID of the component","x-nullable":true},"name":{"type":"string","description":"The name of the component","x-nullable":true},"mttd":{"type":"integer","format":"int32","description":"Mean Time To Detection (seconds) for all incidents for this component in this time period","x-nullable":true},"mtta":{"type":"integer","format":"int32","description":"Mean Time To Acknowledgement (seconds) for all incidents for this component in this time period","x-nullable":true},"mttm":{"type":"integer","format":"int32","description":"Mean Time To Mitigation (seconds) for all incidents for this component in this time period","x-nullable":true},"mttr":{"type":"integer","format":"int32","description":"Mean Time To Resolution (seconds) for all incidents for this component in this time period","x-nullable":true},"count":{"type":"integer","format":"int32","description":"Number of incidents in this time period for this component","x-nullable":true},"total_time":{"type":"integer","format":"int32","description":"Total time (seconds) the component was impacted (MTTR x Incident Count)","x-nullable":true}},"description":"Metrics_InfrastructureMetricsEntity model"},"Runbooks_ActionsEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Runbooks_ActionsEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"Runbooks_ActionsEntityPaginated model"},"Runbooks_ActionsEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"slug":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"config":{"$ref":"#/definitions/NullableRunbooks_ActionConfigEntity"},"category":{"type":"string","x-nullable":true},"prerequisites":{"type":"array","items":{"type":"object"},"x-nullable":true},"integration":{"$ref":"#/definitions/NullableIntegrations_IntegrationEntity"},"supported_runbook_types":{"type":"array","items":{"type":"string"},"x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"automatable":{"type":"boolean","x-nullable":true},"rerunnable":{"type":"boolean","x-nullable":true},"repeatable":{"type":"boolean","x-nullable":true},"default_logic":{"type":"object","x-nullable":true},"default_rule_data":{"type":"object","x-nullable":true}}},"Runbooks_ActionConfigEntity":{"type":"object","properties":{"elements":{"type":"array","items":{"$ref":"#/definitions/Runbooks_ElementEntity"},"description":"A list of elements that can be used in this action configuration","x-nullable":true},"documentation_url":{"type":"string","description":"Location of documentation for this action","x-nullable":true}}},"Runbooks_ElementEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"type":{"type":"string","x-nullable":true},"markdown":{"$ref":"#/definitions/NullableRunbooks_ElementMarkdownEntity"},"textarea":{"$ref":"#/definitions/NullableRunbooks_ElementTextareaEntity"},"input":{"$ref":"#/definitions/NullableRunbooks_ElementInputEntity"},"plain_text":{"$ref":"#/definitions/NullableRunbooks_ElementMarkdownEntity"},"dynamic_select":{"$ref":"#/definitions/NullableRunbooks_ElementDynamicSelectEntity"}}},"Runbooks_ElementMarkdownEntity":{"type":"object","properties":{"text":{"type":"string","x-nullable":true}}},"Runbooks_ElementTextareaEntity":{"type":"object","properties":{"label":{"type":"string","x-nullable":true},"placeholder":{"type":"string","x-nullable":true},"default_value":{"type":"string","x-nullable":true}}},"Runbooks_ElementInputEntity":{"type":"object","properties":{"label":{"type":"string","x-nullable":true},"placeholder":{"type":"string","x-nullable":true},"default_value":{"type":"string","x-nullable":true},"required":{"type":"boolean","x-nullable":true}}},"Runbooks_ElementDynamicSelectEntity":{"type":"object","properties":{"label":{"type":"string","x-nullable":true},"placeholder":{"type":"string","x-nullable":true},"async_url":{"type":"string","x-nullable":true},"required":{"type":"boolean","x-nullable":true},"clearable":{"type":"boolean","x-nullable":true},"is_multi":{"type":"boolean","x-nullable":true},"options":{"type":"array","items":{"$ref":"#/definitions/Runbooks_ElementDynamicSelectEntity_SelectOptionEntity"},"x-nullable":true}}},"Runbooks_ElementDynamicSelectEntity_SelectOptionEntity":{"type":"object","properties":{"label":{"type":"string","x-nullable":true},"value":{"type":"string","x-nullable":true}}},"create_runbook_execution":{"type":"object","properties":{"execute_for":{"type":"string","description":"The incident to attach the runbook to. Format must be: `incident/${incidentId}`"},"runbook_id":{"type":"string","description":"ID of runbook to attach"}},"required":["execute_for","runbook_id"],"description":"Attaches a runbook to an incident and executes it"},"Runbooks_ExecutionEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"status":{"type":"string","x-nullable":true},"status_reason":{"type":"string","x-nullable":true},"status_reason_message":{"type":"string","x-nullable":true},"has_been_rerun":{"type":"boolean","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"created_by":{"type":"string","x-nullable":true},"runbook":{"$ref":"#/definitions/NullableSlimRunbookEntity"},"steps":{"$ref":"#/definitions/NullableRunbooks_ExecutionStepEntity"},"executed_for":{"$ref":"#/definitions/NullableRunbooks_ExecutionEntity_ExecutedForEntity"}},"description":"Runbooks_ExecutionEntity model"},"Runbooks_ExecutionStepEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"action_slug":{"type":"string","x-nullable":true},"action_type":{"type":"string","x-nullable":true},"integration_name":{"type":"string","x-nullable":true},"integration_slug":{"type":"string","x-nullable":true},"automatic":{"type":"boolean","x-nullable":true},"config":{"type":"object","x-nullable":true},"step_elements":{"type":"array","items":{"type":"object"},"x-nullable":true},"executable":{"type":"boolean","x-nullable":true},"repeats":{"type":"boolean","x-nullable":true},"repeats_duration":{"type":"string","description":"ISO8601 formatted duration string","x-nullable":true},"repeats_at":{"type":"string","format":"date-time","x-nullable":true},"has_been_rerun":{"type":"boolean","x-nullable":true},"has_been_retried":{"type":"boolean","x-nullable":true},"execution":{"$ref":"#/definitions/NullableRunbooks_ExecutionStepExecutionEntity"},"repeatable":{"type":"boolean","x-nullable":true},"conference_bridge":{"$ref":"#/definitions/NullableIncidents_ConferenceBridgeEntity"},"rule":{"$ref":"#/definitions/NullableRules_RuleEntity"}}},"Runbooks_ExecutionStepExecutionEntity":{"type":"object","properties":{"state":{"type":"string","enum":["initial","pending","scheduled","started","dismissed","completed","errored"],"x-nullable":true},"data":{"type":"object","x-nullable":true},"performed_by":{"$ref":"#/definitions/NullableActorEntity"},"performed_at":{"type":"string","format":"date-time","x-nullable":true},"scheduled_for":{"type":"string","format":"date-time","x-nullable":true},"error":{"type":"string","x-nullable":true},"webhook_delivery":{"$ref":"#/definitions/NullableRunbooks_WebhookDeliveryEntity"},"expired":{"type":"boolean","description":"The step's conditions are no longer being evaluated and it can no longer start","x-nullable":true}}},"Runbooks_WebhookDeliveryEntity":{"type":"object","properties":{"headers":{"type":"string","x-nullable":true},"status_code":{"type":"string","x-nullable":true}}},"Runbooks_ExecutionEntity_ExecutedForEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"type":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true}}},"Runbooks_ExecutionEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Runbooks_ExecutionEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"Runbooks_ExecutionEntityPaginated model"},"update_runbook_execution_step":{"type":"object","properties":{"state":{"type":"string"},"schedule_for":{"type":"string","format":"date-time","x-nullable":true},"data":{"type":"object","description":"Data for execution of this step","additionalProperties":true,"x-nullable":true},"repeats_at":{"type":"string","format":"date-time","x-nullable":true}},"required":["state"],"description":"Updates a runbook step execution, especially for changing the state of a step execution."},"create_runbook":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","description":"Deprecated, but still required. Please just use 'incident'","enum":["incident","general","infrastructure","incident_role"]},"summary":{"type":"string","description":"Deprecated. Use description","x-nullable":true},"description":{"type":"string","description":"A longer description about the Runbook. Supports markdown format","x-nullable":true},"auto_attach_to_restricted_incidents":{"type":"boolean","description":"Whether or not this runbook should be automatically attached to restricted incidents. Note that setting this to `true` will prevent it from being attached to public incidents, even manually. Defaults to `false`.","x-nullable":true},"tutorial":{"type":"boolean","description":"Whether or not this runbook is a tutorial runbook","x-nullable":true},"owner":{"type":"object","description":"An object representing a Team that owns the runbook","properties":{"id":{"type":"string"}},"required":["id"],"x-nullable":true},"attachment_rule":{"type":"object","properties":{"logic":{"type":"string","description":"The JSON logic for the attaching the runbook"},"user_data":{"type":"string","description":"The user data for the rule","x-nullable":true}},"required":["logic"],"x-nullable":true},"steps":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name for step"},"action_id":{"type":"string","description":"ID of action to use for this step."},"rule":{"type":"object","properties":{"logic":{"type":"string","description":"The JSON logic for the rule"},"user_data":{"type":"string","description":"The user data for the rule","x-nullable":true}},"required":["logic"],"x-nullable":true}},"required":["name","action_id"]},"x-nullable":true}},"required":["name","type"],"description":"Create a new runbook for use with incidents."},"RunbookEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"summary":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"type":{"type":"string","x-nullable":true},"runbook_template_id":{"type":"string","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"created_by":{"$ref":"#/definitions/NullableAuthorEntity"},"updated_by":{"$ref":"#/definitions/NullableAuthorEntity"},"steps":{"type":"array","items":{"$ref":"#/definitions/RunbookStepEntity"},"x-nullable":true},"attachment_rule":{"$ref":"#/definitions/NullableRules_RuleEntity"},"votes":{"$ref":"#/definitions/NullableEmptyVotesEntity"},"is_editable":{"type":"boolean","x-nullable":true},"owner":{"$ref":"#/definitions/NullableTeamEntityLite","description":"Team that owns the runbook"},"categories":{"type":"array","items":{"type":"string"},"description":"categories the runbook applies to","x-nullable":true},"auto_attach_to_restricted_incidents":{"type":"boolean","x-nullable":true},"tutorial":{"type":"boolean","x-nullable":true},"last_executed_at":{"type":"string","format":"date-time","description":"The timestamp when this runbook was last executed","x-nullable":true},"last_executed_for_incident":{"$ref":"#/definitions/NullablePublicAPI_V1_Incidents_SuccinctEntity","description":"The incident for which this runbook was most recently executed, if accessible"}},"description":"RunbookEntity model"},"RunbookStepEntity":{"type":"object","properties":{"name":{"type":"string","x-nullable":true},"action_id":{"type":"string","x-nullable":true},"step_id":{"type":"string","x-nullable":true},"config":{"type":"object","description":"An unstructured object of key/value pairs describing the config settings for the step.","x-nullable":true},"action_elements":{"type":"array","items":{"type":"object"},"description":"A list of action elements","x-nullable":true},"step_elements":{"type":"array","items":{"type":"object"},"description":"A list of step elements","x-nullable":true},"automatic":{"type":"boolean","x-nullable":true},"delay_duration":{"type":"string","x-nullable":true},"action":{"$ref":"#/definitions/NullableRunbooks_ActionsEntity"},"reruns":{"type":"boolean","x-nullable":true},"repeats":{"type":"boolean","x-nullable":true},"repeats_duration":{"type":"string","x-nullable":true},"votes":{"$ref":"#/definitions/NullableEmptyVotesEntity"},"rule":{"$ref":"#/definitions/NullableRules_RuleEntity"}}},"EmptyVotesEntity":{"type":"object","properties":{"voted":{"type":"boolean","description":"Whether or not the current actor has voted","x-nullable":true},"liked":{"type":"boolean","description":"Whether or not the current actor has voted positively","x-nullable":true},"disliked":{"type":"boolean","description":"Whether or not the current actor has voted negatively","x-nullable":true},"likes":{"type":"integer","format":"int32","x-nullable":true},"dislikes":{"type":"integer","format":"int32","x-nullable":true}}},"SlimRunbookEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/SlimRunbookEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"SlimRunbookEntityPaginated model"},"update_runbook":{"type":"object","properties":{"name":{"type":"string","x-nullable":true},"summary":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"tutorial":{"type":"boolean","description":"Whether or not this runbook is a tutorial runbook","x-nullable":true},"owner":{"type":"object","description":"An object representing a Team that owns the runbook","properties":{"id":{"type":"string","x-nullable":true}},"x-nullable":true},"severities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","x-nullable":true}}},"x-nullable":true},"services":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","x-nullable":true}}},"x-nullable":true},"environments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","x-nullable":true}}},"x-nullable":true},"attachment_rule":{"type":"object","properties":{"logic":{"type":"string","description":"The JSON logic for the attaching the runbook"},"user_data":{"type":"string","description":"The user data for the rule","x-nullable":true}},"required":["logic"],"x-nullable":true},"steps":{"type":"array","items":{"type":"object","properties":{"step_id":{"type":"string","description":"ID of step to be updated","x-nullable":true},"name":{"type":"string","description":"Name for step"},"action_id":{"type":"string","description":"ID of action to use for this step."},"rule":{"type":"object","properties":{"logic":{"type":"string","description":"The JSON logic for the rule"},"user_data":{"type":"string","description":"The user data for the rule","x-nullable":true}},"required":["logic"],"x-nullable":true}},"required":["name","action_id"]},"x-nullable":true},"auto_attach_to_restricted_incidents":{"type":"boolean","description":"Whether or not this runbook should be automatically attached to restricted incidents. Note that setting this to `true` will prevent it from being attached to public incidents, even manually. Defaults to `false`.","x-nullable":true}},"description":"Update a runbook and any attachment rules associated with it. This endpoint is used to configure nearly everything\nabout a runbook, including but not limited to the steps, environments, attachment rules, and severities.\n"},"NuncConnectionEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/NuncConnectionEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"NuncConnectionEntityPaginated model"},"NuncConnectionEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"domain":{"type":"string","x-nullable":true},"company_name":{"type":"string","x-nullable":true},"company_website":{"type":"string","x-nullable":true},"cname":{"type":"string","x-nullable":true},"greeting_title":{"type":"string","x-nullable":true},"greeting_body":{"type":"string","x-nullable":true},"operational_message":{"type":"string","x-nullable":true},"company_tos_url":{"type":"string","x-nullable":true},"primary_color":{"type":"string","x-nullable":true},"secondary_color":{"type":"string","x-nullable":true},"button_background_color":{"type":"string","x-nullable":true},"button_text_color":{"type":"string","x-nullable":true},"link_color":{"type":"string","x-nullable":true},"title":{"type":"string","x-nullable":true},"exposed_fields":{"type":"array","items":{"type":"string"},"x-nullable":true},"conditions":{"$ref":"#/definitions/NullableNuncConditionEntity"},"components":{"$ref":"#/definitions/NullableNuncComponentEntity"},"component_groups":{"$ref":"#/definitions/NullableNuncComponentGroupEntity"},"logo":{"$ref":"#/definitions/NullableMediaImageEntity"},"cover_image":{"$ref":"#/definitions/NullableMediaImageEntity"},"favicon":{"$ref":"#/definitions/NullableMediaImageEntity"},"open_graph_image":{"$ref":"#/definitions/NullableMediaImageEntity"},"dark_logo":{"$ref":"#/definitions/NullableMediaImageEntity"},"enable_histogram":{"type":"boolean","x-nullable":true},"ui_version":{"type":"integer","format":"int32","x-nullable":true},"links":{"type":"array","items":{"$ref":"#/definitions/LinksEntity"},"description":"List of links attached to this status page.","x-nullable":true},"is_dns_verified":{"type":"boolean","x-nullable":true},"publish_state":{"type":"string","enum":["published","unpublished"],"x-nullable":true},"authentication_method":{"type":"string","x-nullable":true},"oidc_authentication_config":{"$ref":"#/definitions/NullableNuncOidcAuthenticationConfigEntity"},"has_custom_configuration":{"type":"boolean","x-nullable":true},"auto_publish":{"type":"boolean","x-nullable":true},"only_display_active_incidents":{"type":"boolean","x-nullable":true},"last_verified_at":{"type":"string","format":"date-time","x-nullable":true}},"description":"NuncConnectionEntity model"},"NuncConditionEntity":{"type":"object","properties":{"nunc_condition":{"type":"string","x-nullable":true},"condition_name":{"type":"string","x-nullable":true},"condition_id":{"type":"string","x-nullable":true}}},"NuncComponentEntity":{"type":"object","properties":{"infrastructure_type":{"type":"string","x-nullable":true},"infrastructure_id":{"type":"string","x-nullable":true},"label":{"type":"string","x-nullable":true},"position":{"type":"integer","format":"int32","x-nullable":true},"component_group_id":{"type":"string","x-nullable":true}}},"NuncComponentGroupEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"component_group_id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"position":{"type":"integer","format":"int32","x-nullable":true}}},"MediaImageEntity":{"type":"object","properties":{"original_url":{"type":"string","x-nullable":true},"versions_urls":{"type":"object","description":"An object with keys that can have different versions of an image","x-nullable":true}}},"NuncOidcAuthenticationConfigEntity":{"type":"object","properties":{"issuer_url":{"type":"string","x-nullable":true},"client_id":{"type":"string","x-nullable":true}}},"NuncEmailSubscribersEntity":{"type":"object","properties":{"id":{"type":"string","description":"UUID of the subscriber","x-nullable":true},"email":{"type":"string","description":"Email of the subscriber","x-nullable":true},"created_at":{"type":"string","format":"date-time","description":"The time the subscriber was created","x-nullable":true}},"description":"NuncEmailSubscribersEntity model"},"update_nunc_link":{"type":"object","properties":{"display_text":{"type":"string","x-nullable":true},"icon_url":{"type":"string","x-nullable":true},"href_url":{"type":"string","x-nullable":true}},"description":"Update a link to be displayed on a FireHydrant status page"},"update_saved_search":{"type":"object","properties":{"is_private":{"type":"boolean","x-nullable":true},"name":{"type":"string","x-nullable":true},"filter_values":{"type":"object","additionalProperties":true,"x-nullable":true}},"description":"Update a specific saved search"},"SavedSearchEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"resource_type":{"type":"string","x-nullable":true},"user_id":{"type":"string","x-nullable":true},"is_private":{"type":"boolean","description":"Whether or not this saved search is private","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"filter_values":{"type":"object","description":"An unstructured key/value pair of saved values for searching","additionalProperties":true,"x-nullable":true}},"description":"SavedSearchEntity model"},"create_saved_search":{"type":"object","properties":{"name":{"type":"string"},"is_private":{"type":"boolean","x-nullable":true},"filter_values":{"type":"object","additionalProperties":true}},"required":["name","filter_values"],"description":"Create a new saved search for a particular resource type"},"Lifecycles_PhaseEntityList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Lifecycles_PhaseEntity"},"x-nullable":true}},"description":"Lifecycles_PhaseEntityList model"},"Lifecycles_PhaseEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"type":{"type":"string","x-nullable":true},"position":{"type":"integer","format":"int32","x-nullable":true},"milestones":{"type":"array","items":{"$ref":"#/definitions/Lifecycles_MilestoneEntity"},"x-nullable":true}}},"Lifecycles_MilestoneEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"slug":{"type":"string","x-nullable":true},"auto_assign_timestamp_on_create":{"type":"string","x-nullable":true},"position":{"type":"integer","format":"int32","x-nullable":true},"created_by":{"$ref":"#/definitions/NullableAuthorEntity"},"updated_by":{"$ref":"#/definitions/NullableAuthorEntity"},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true}},"description":"Lifecycles_MilestoneEntity model"},"create_priority":{"type":"object","properties":{"slug":{"type":"string"},"description":{"type":"string","x-nullable":true},"default":{"type":"boolean","x-nullable":true}},"required":["slug"],"description":"Create a new priority"},"PriorityEntity":{"type":"object","properties":{"slug":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"position":{"type":"integer","format":"int32","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"default":{"type":"boolean","x-nullable":true}},"description":"PriorityEntity model"},"update_priority":{"type":"object","properties":{"slug":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"default":{"type":"boolean","x-nullable":true}},"description":"Update a specific priority"},"create_severity":{"type":"object","properties":{"slug":{"type":"string"},"description":{"type":"string","x-nullable":true},"position":{"type":"integer","format":"int32","x-nullable":true},"color":{"type":"string","enum":["red","orange","yellow","blue","teal","grey","green"],"x-nullable":true},"allowed_role_ids":{"type":"array","description":"IDs of roles allowed to use this severity. Empty array means all roles are allowed.","items":{"type":"string"},"x-nullable":true}},"required":["slug"],"description":"Create a new severity"},"SeverityEntity":{"type":"object","properties":{"slug":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"type":{"type":"string","x-nullable":true},"position":{"type":"integer","format":"int32","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"system_record":{"type":"boolean","x-nullable":true},"color":{"type":"string","x-nullable":true},"allowed_role_ids":{"type":"array","items":{"type":"string"},"description":"IDs of roles allowed to use this severity. Empty array means all roles are allowed.","x-nullable":true}},"description":"SeverityEntity model"},"SeverityEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/SeverityEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"SeverityEntityPaginated model"},"update_severity":{"type":"object","properties":{"slug":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"position":{"type":"integer","format":"int32","x-nullable":true},"color":{"type":"string","enum":["red","orange","yellow","blue","teal","grey","green"],"x-nullable":true},"allowed_role_ids":{"type":"array","description":"IDs of roles allowed to use this severity. Empty array means all roles are allowed.","items":{"type":"string"},"x-nullable":true}},"description":"Update a specific severity"},"update_severity_matrix":{"type":"object","properties":{"summary":{"type":"string","x-nullable":true},"data":{"type":"array","items":{"type":"object","properties":{"severity":{"type":"string","description":"Slug of a severity"},"impact_id":{"type":"string","description":"Impact id"},"condition_id":{"type":"string","description":"Condition id"}},"required":["severity","impact_id","condition_id"]}}},"required":["data"],"description":"Update available severities and impacts in your organization's severity matrix."},"SeverityMatrix_SeverityMatrixEntity":{"type":"object","properties":{"matrix":{"type":"array","items":{"$ref":"#/definitions/SeverityMatrix_ItemEntity"},"x-nullable":true},"impacts":{"type":"array","items":{"$ref":"#/definitions/SeverityMatrix_ImpactEntity"},"x-nullable":true},"conditions":{"type":"array","items":{"$ref":"#/definitions/SeverityMatrix_ConditionEntity"},"x-nullable":true}},"description":"SeverityMatrix_SeverityMatrixEntity model"},"SeverityMatrix_ItemEntity":{"type":"object","properties":{"severity":{"type":"string","x-nullable":true},"condition_id":{"type":"string","x-nullable":true},"impact_id":{"type":"string","x-nullable":true},"impact_type":{"type":"string","x-nullable":true}}},"create_severity_matrix_condition":{"type":"object","properties":{"name":{"type":"string"},"position":{"type":"integer","format":"int32","description":"Position is used to determine ordering of conditions in API responses and dropdowns. The condition with the lowest position (typically 0) will be considered the Default Condition","x-nullable":true}},"required":["name"],"description":"Create a new condition"},"update_severity_matrix_condition":{"type":"object","properties":{"name":{"type":"string","x-nullable":true},"position":{"type":"integer","format":"int32","description":"Position is used to determine ordering of conditions in API responses and dropdowns. The condition with the lowest position (typically 0) will be considered the Default Condition","x-nullable":true}},"description":"Update a severity matrix condition"},"create_severity_matrix_impact":{"type":"object","properties":{"affects_type":{"type":"string"},"affects_id":{"type":"string"},"position":{"type":"integer","format":"int32","x-nullable":true}},"required":["affects_type","affects_id"],"description":"Create a new impact"},"update_severity_matrix_impact":{"type":"object","properties":{"name":{"type":"string","x-nullable":true},"position":{"type":"integer","format":"int32","x-nullable":true}},"description":"Update a severity matrix impact"},"create_scheduled_maintenance":{"type":"object","properties":{"name":{"type":"string"},"starts_at":{"type":"string","format":"date-time","description":"ISO8601 timestamp for the start time of the scheduled maintenance"},"ends_at":{"type":"string","format":"date-time","description":"ISO8601 timestamp for the end time of the scheduled maintenance"},"summary":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"labels":{"type":"object","description":"A json object of label keys and values","additionalProperties":{"type":"string"},"x-nullable":true},"status_pages":{"type":"array","description":"An array of status pages to display this maintenance on","items":{"type":"object","properties":{"integration_slug":{"type":"string","description":"The slug identifying the type of status page","x-nullable":true},"connection_id":{"type":"string","description":"The UUID of the status page to display this maintenance on"}},"required":["connection_id"]},"x-nullable":true},"impacts":{"type":"array","description":"An array of impact/condition combinations","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of impact"},"id":{"type":"string","description":"The id of impact"},"condition_id":{"type":"string","description":"The id of the condition"}},"required":["type","id","condition_id"]},"x-nullable":true}},"required":["name","starts_at","ends_at"],"description":"Create a new scheduled maintenance event"},"ScheduledMaintenanceEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"summary":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"starts_at":{"type":"string","format":"date-time","x-nullable":true},"ends_at":{"type":"string","format":"date-time","x-nullable":true},"incident":{"$ref":"#/definitions/NullableIncidentEntity"},"status_pages":{"type":"array","items":{"$ref":"#/definitions/ScheduledMaintenancesStatusPageEntity"},"x-nullable":true},"impacts":{"type":"array","items":{"$ref":"#/definitions/ScheduledMaintenancesImpactEntity"},"x-nullable":true},"labels":{"type":"object","description":"An object of label key and values","x-nullable":true}},"description":"ScheduledMaintenanceEntity model"},"ScheduledMaintenancesStatusPageEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"integration_id":{"type":"string","x-nullable":true},"integration_slug":{"type":"string","x-nullable":true},"integration_name":{"type":"string","x-nullable":true}}},"ScheduledMaintenancesImpactEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"type":{"type":"string","x-nullable":true},"impact":{"$ref":"#/definitions/NullableSuccinctEntity"},"condition":{"$ref":"#/definitions/NullableSeverityMatrix_ConditionEntity"}}},"update_scheduled_maintenance":{"type":"object","properties":{"name":{"type":"string","x-nullable":true},"summary":{"type":"string","x-nullable":true},"starts_at":{"type":"string","format":"date-time","description":"ISO8601 timestamp for the start time of the scheduled maintenance","x-nullable":true},"ends_at":{"type":"string","format":"date-time","description":"ISO8601 timestamp for the end time of the scheduled maintenance","x-nullable":true},"description":{"type":"string","x-nullable":true},"labels":{"type":"object","description":"A json object of label keys and values","additionalProperties":{"type":"string"},"x-nullable":true},"status_pages":{"type":"array","description":"An array of status pages to display this maintenance on","items":{"type":"object","properties":{"integration_slug":{"type":"string","description":"The slug identifying the type of status page","x-nullable":true},"connection_id":{"type":"string","description":"The UUID of the status page to display this maintenance on"}},"required":["connection_id"]},"x-nullable":true},"impacts":{"type":"array","description":"An array of impact/condition combinations","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of impact"},"id":{"type":"string","description":"The id of impact"},"condition_id":{"type":"string","description":"The id of the condition"}},"required":["type","id","condition_id"]},"x-nullable":true}},"description":"Change the conditions of a scheduled maintenance event, including updating any status page announcements of changes."},"ScheduleEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/ScheduleEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"ScheduleEntityPaginated model"},"InfrastructureSearchEntity":{"type":"object","properties":{"type":{"type":"string","x-nullable":true},"infrastructure":{"type":"string","x-nullable":true}},"description":"InfrastructureSearchEntity model"},"create_nunc_subscription":{"type":"object","properties":{"email":{"type":"string"}},"required":["email"],"description":"Subscribe to status page updates"},"Nunc_NuncSubscription":{"type":"object","properties":{"response":{"type":"string","x-nullable":true}},"description":"Nunc_NuncSubscription model"},"create_status_update_template":{"type":"object","properties":{"name":{"type":"string"},"body":{"type":"string"}},"required":["name","body"],"description":"Create a status update template for your organization"},"StatusUpdateTemplateEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"body":{"type":"string","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"discarded_at":{"type":"string","format":"date-time","x-nullable":true}},"description":"StatusUpdateTemplateEntity model"},"update_status_update_template":{"type":"object","properties":{"name":{"type":"string","x-nullable":true},"body":{"type":"string","x-nullable":true}},"description":"Update a single status update template"},"update_custom_field_definition":{"type":"object","properties":{"description":{"type":"string","x-nullable":true},"display_name":{"type":"string","x-nullable":true},"permissible_values":{"type":"array","items":{"type":"string"},"x-nullable":true},"required":{"type":"boolean","x-nullable":true},"required_at_milestone_id":{"type":"string","description":"An optional milestone ID to specify when the field should become required, if `required` is set to `true`. If not provided, required fields are always required.","x-nullable":true}},"description":"Update a single custom field definition"},"Organizations_CustomFieldDefinitionEntity":{"type":"object","properties":{"display_name":{"type":"string","x-nullable":true},"field_id":{"type":"string","x-nullable":true},"field_type":{"type":"string","x-nullable":true},"slug":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"required":{"type":"boolean","description":"Whether this field is required for all incidents.","x-nullable":true},"required_at_milestone_id":{"type":"string","description":"The milestone at which this field is required, if `required` is set to `true`. When null, a required field is always required.","x-nullable":true},"permissible_values":{"type":"array","items":{"type":"string"},"x-nullable":true}},"description":"Organizations_CustomFieldDefinitionEntity model"},"create_custom_field_definition":{"type":"object","properties":{"display_name":{"type":"string"},"description":{"type":"string","x-nullable":true},"field_type":{"type":"string"},"permissible_values":{"type":"array","items":{"type":"string"},"x-nullable":true},"required":{"type":"boolean","description":"Whether this field should be required for all incidents.","x-nullable":true},"required_at_milestone_id":{"type":"string","description":"An optional milestone ID to specify when the field should become required, if `required` is set to `true`. If not provided, required fields are always required.","x-nullable":true}},"required":["display_name","field_type"],"description":"Create a new custom field definition"},"create_post_mortem_report":{"type":"object","properties":{"incident_id":{"type":"string"}},"required":["incident_id"],"description":"Create a report"},"PostMortems_PostMortemReportEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"summary":{"type":"string","x-nullable":true},"incident_id":{"type":"string","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"tag_list":{"type":"array","items":{"type":"string"},"x-nullable":true},"additional_details":{"type":"array","items":{"type":"string"},"x-nullable":true},"incident":{"$ref":"#/definitions/NullableIncidentEntity"},"questions":{"$ref":"#/definitions/NullablePostMortems_QuestionEntity"},"calendar_events":{"$ref":"#/definitions/NullableCalendars_EventEntity"},"retrospective_shim":{"type":"boolean","x-nullable":true},"retrospective_id":{"type":"string","x-nullable":true},"retrospective_note":{"type":"string","x-nullable":true}},"description":"PostMortems_PostMortemReportEntity model"},"PostMortems_QuestionEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"title":{"type":"string","x-nullable":true},"body":{"type":"string","x-nullable":true},"tooltip":{"type":"string","x-nullable":true},"kind":{"type":"string","x-nullable":true},"question_type_id":{"type":"string","x-nullable":true},"is_required":{"type":"boolean","x-nullable":true},"available_options":{"type":"array","items":{"type":"string"},"x-nullable":true},"conversations":{"type":"array","items":{"$ref":"#/definitions/Conversations_API_Entities_Reference"},"x-nullable":true}}},"Calendars_EventEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"summary":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"starts_at":{"type":"string","x-nullable":true},"ends_at":{"type":"string","x-nullable":true},"created_at":{"type":"string","x-nullable":true},"updated_at":{"type":"string","x-nullable":true},"provider_url":{"type":"string","x-nullable":true},"provider_icon_url":{"type":"string","x-nullable":true}}},"PostMortems_PostMortemReportEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/PostMortems_PostMortemReportEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"PostMortems_PostMortemReportEntityPaginated model"},"update_post_mortem_report":{"type":"object","properties":{"name":{"type":"string","x-nullable":true},"summary":{"type":"string","x-nullable":true},"additional_details":{"type":"string","x-nullable":true},"questions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of a question","x-nullable":true},"body":{"type":"string","description":"Answer to question","x-nullable":true}}},"x-nullable":true}},"description":"Update a report"},"create_post_mortem_reason":{"type":"object","properties":{"summary":{"type":"string"}},"required":["summary"],"description":"Add a new contributing factor to an incident"},"PostMortems_ReasonEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"summary":{"type":"string","x-nullable":true},"position":{"type":"integer","format":"int32","x-nullable":true},"created_by":{"$ref":"#/definitions/NullableAuthorEntity"},"conversations":{"type":"array","items":{"$ref":"#/definitions/Conversations_API_Entities_Reference"},"x-nullable":true}},"description":"PostMortems_ReasonEntity model"},"PostMortems_ReasonEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/PostMortems_ReasonEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"PostMortems_ReasonEntityPaginated model"},"update_post_mortem_reason":{"type":"object","properties":{"summary":{"type":"string","x-nullable":true}},"description":"Update a contributing factor"},"reorder_post_mortem_reasons":{"type":"object","properties":{"old_position":{"type":"integer","format":"int32"},"new_position":{"type":"integer","format":"int32"}},"required":["old_position","new_position"],"description":"Update the order of contributing factors in a retrospective report"},"publish_post_mortem_report":{"type":"object","properties":{"publish":{"type":"string","enum":["true"],"x-nullable":true},"user_ids":{"type":"array","description":"An array of user IDs with whom to share the report","items":{"type":"string"},"x-nullable":true},"team_ids":{"type":"array","description":"An array of team IDs with whom to share the report","items":{"type":"string"},"x-nullable":true}},"description":"Marks an incident retrospective as published and emails all of the participants in the report the summary"},"update_post_mortem_field":{"type":"object","properties":{"value":{"type":"string"}},"required":["value"],"description":"Update a field value on a post mortem report"},"PostMortems_SectionFieldEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"value":{"type":"string","x-nullable":true}},"description":"PostMortems_SectionFieldEntity model"},"update_post_mortem_questions":{"type":"object","properties":{"_make_swagger_work_":{"type":"string","x-nullable":true},"questions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of a question","x-nullable":true},"title":{"type":"string","description":"title of a question","x-nullable":true},"tooltip":{"type":"string","description":"tooltip of a question","x-nullable":true}}},"x-nullable":true}},"description":"Update the questions configured to be provided and filled out on future retrospective reports."},"PostMortems_QuestionTypeEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"title":{"type":"string","x-nullable":true},"tooltip":{"type":"string","x-nullable":true},"kind":{"type":"string","x-nullable":true},"is_required":{"type":"boolean","x-nullable":true},"available_options":{"type":"array","items":{"type":"string"},"x-nullable":true}},"description":"PostMortems_QuestionTypeEntity model"},"PostMortems_QuestionTypeEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/PostMortems_QuestionTypeEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"PostMortems_QuestionTypeEntityPaginated model"},"Retrospectives_TemplateEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"is_default":{"type":"boolean","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"sections":{"type":"array","items":{"$ref":"#/definitions/Retrospectives_TemplateEntity_IncidentSectionEntity"},"x-nullable":true},"fields":{"type":"array","items":{"$ref":"#/definitions/Retrospectives_FieldEntity"},"x-nullable":true}},"description":"Retrospectives_TemplateEntity model"},"Retrospectives_TemplateEntity_IncidentSectionEntity":{"type":"object","properties":{"slug":{"type":"string","x-nullable":true},"elements":{"type":"array","items":{"type":"string"},"x-nullable":true}}},"Retrospectives_FieldEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"label":{"type":"string","x-nullable":true},"type":{"type":"string","enum":["text","single_select","multi_select","numeric","datetime","dynamic_input_group","markdown","markdown_text"],"x-nullable":true},"help_text":{"type":"string","x-nullable":true},"permissible_values":{"type":"array","items":{"type":"string"},"x-nullable":true},"is_required":{"type":"boolean","x-nullable":true},"required_at_milestone_id":{"type":"string","x-nullable":true},"schema":{"type":"array","items":{"type":"string"},"x-nullable":true}}},"Retrospectives_IndexTemplateEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Retrospectives_IndexTemplateEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"Retrospectives_IndexTemplateEntityPaginated model"},"Retrospectives_IndexTemplateEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"is_default":{"type":"boolean","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"report_elements":{"type":"array","items":{"$ref":"#/definitions/Retrospectives_TemplateEntity_ReportElementEntity"},"x-nullable":true}}},"Retrospectives_TemplateEntity_ReportElementEntity":{"type":"object","properties":{"type":{"type":"string","x-nullable":true},"data":{"type":"string","x-nullable":true},"id":{"type":"string","x-nullable":true},"field_id":{"type":"string","x-nullable":true},"label":{"type":"string","x-nullable":true},"content":{"type":"object","x-nullable":true}}},"Alerts_AlertEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Alerts_AlertEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"Alerts_AlertEntityPaginated model"},"Alerts_ProcessingLogEntryEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Alerts_ProcessingLogEntryEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"Alerts_ProcessingLogEntryEntityPaginated model"},"Alerts_ProcessingLogEntryEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"context":{"type":"object","description":"An unstructured representation of this log entry's context.","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"level":{"type":"string","enum":["unknown","debug","info","warn","error","fatal"],"x-nullable":true},"message":{"type":"string","x-nullable":true},"message_type":{"type":"string","enum":["i18n_key","custom"],"x-nullable":true}}},"create_signals_page":{"type":"object","properties":{"summary":{"type":"string"},"target_type":{"type":"string","enum":["EscalationPolicy","OnCallSchedule","Team","User"]},"target_id":{"type":"string","description":"The ID of the target. Should be a UUID for the target type."},"body":{"type":"string","x-nullable":true},"priority":{"type":"string","description":"The notification priority to page at.","enum":["HIGH","MEDIUM","LOW"],"default":"HIGH","x-nullable":true}},"required":["summary","target_type","target_id"],"description":"Used for paging an on-call target within FireHydrant's signals product. This can be used for paging users, teams, on-call schedules, and escalation policies."},"create_ticket":{"type":"object","properties":{"summary":{"type":"string"},"related_to":{"type":"string","description":"Which incident this ticket is related to, in the format of 'incident/UUID'","x-nullable":true},"project_id":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"state":{"type":"string","x-nullable":true},"type":{"type":"string","x-nullable":true},"priority_id":{"type":"string","x-nullable":true},"tag_list":{"type":"array","description":"List of tags for the ticket","items":{"type":"string"},"x-nullable":true},"remote_url":{"type":"string","description":"The remote URL for an existing ticket in a supported and configured ticketing integration","x-nullable":true},"assignees":{"type":"array","description":"An array of assignees for the ticket","items":{"type":"object","properties":{"source":{"type":"string","description":"The source of the assignee","x-nullable":true},"id":{"type":"string","description":"The uesr id of the assignee"}},"required":["id"]},"x-nullable":true}},"required":["summary"],"description":"Creates a ticket for a project"},"update_ticket":{"type":"object","properties":{"summary":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"state":{"type":"string","x-nullable":true},"type":{"type":"string","x-nullable":true},"priority_id":{"type":"string","x-nullable":true},"tag_list":{"type":"array","description":"List of tags for the ticket","items":{"type":"string"},"x-nullable":true},"assignees":{"type":"array","description":"An array of assignees for the ticket","items":{"type":"object","properties":{"source":{"type":"string","description":"The source of the assignee","x-nullable":true},"id":{"type":"string","description":"The uesr id of the assignee"}},"required":["id"]},"x-nullable":true}},"description":"Update a ticket's attributes"},"Ticketing_Projects_ProjectListItemEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"config":{"$ref":"#/definitions/NullableTicketing_ProjectConfigEntity"},"field_map":{"$ref":"#/definitions/NullableTicketing_ProjectFieldMapEntity"},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"connection_slug":{"type":"string","x-nullable":true}},"description":"Ticketing_Projects_ProjectListItemEntity model"},"Ticketing_ProjectConfigEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"connection_id":{"type":"string","x-nullable":true},"connection_type":{"type":"string","x-nullable":true},"ticketing_project_id":{"type":"string","x-nullable":true},"ticketing_project_name":{"type":"string","x-nullable":true},"details":{"type":"object","description":"A config object containing details about the project config. Can be one of: Ticketing::JiraCloud::ProjectConfigEntity, Ticketing::JiraOnprem::ProjectConfigEntity, or Ticketing::Shortcut::ProjectConfigEntity","x-nullable":true}},"description":"Ticketing_ProjectConfigEntity model"},"Ticketing_ProjectFieldMapEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"connection_id":{"type":"string","x-nullable":true},"connection_type":{"type":"string","x-nullable":true},"ticketing_project_id":{"type":"string","x-nullable":true},"body":{"type":"array","items":{"$ref":"#/definitions/Ticketing_ProjectFieldMapBodyEntity"},"x-nullable":true}},"description":"Ticketing_ProjectFieldMapEntity model"},"Ticketing_ProjectFieldMapBodyEntity":{"type":"object","properties":{"strategy":{"type":"string","enum":["basic","logic"],"x-nullable":true},"external_field":{"type":"string","x-nullable":true},"external_value":{"$ref":"#/definitions/NullableTicketing_ProjectFieldMapExternalValueEntity"},"user_data":{"type":"object","x-nullable":true},"cases":{"type":"array","items":{"$ref":"#/definitions/Ticketing_ProjectFieldMapCasesEntity"},"x-nullable":true},"else":{"$ref":"#/definitions/NullableTicketing_ProjectFieldMapCasesElseEntity"}}},"Ticketing_ProjectFieldMapExternalValueEntity":{"type":"object","properties":{"type":{"type":"string","enum":["literal","fh-attribute","fh-type"],"x-nullable":true},"value":{"type":"string","x-nullable":true},"attribute":{"type":"string","x-nullable":true},"presentation":{"type":"string","x-nullable":true}}},"Ticketing_ProjectFieldMapCasesEntity":{"type":"object","properties":{"logic":{"type":"object","description":"An unstructured object of key/value pairs describing the logic for applying the rule.","x-nullable":true},"external_value":{"$ref":"#/definitions/NullableTicketing_ProjectFieldMapExternalValueEntity"}}},"Ticketing_ProjectFieldMapCasesElseEntity":{"type":"object","properties":{"external_value":{"$ref":"#/definitions/NullableTicketing_ProjectFieldMapExternalValueEntity"}}},"Ticketing_FieldMaps_MappableFieldEntity":{"type":"object","properties":{"value":{"type":"string","description":"The ID of the field","x-nullable":true},"label":{"type":"string","description":"The human-readable name of the field","x-nullable":true},"type":{"type":"string","description":"The allowed type of the field","x-nullable":true},"allowed_values":{"type":"array","items":{"type":"string"},"description":"The allowed values of the field","x-nullable":true},"required":{"type":"string","description":"If the field is required to be mapped","x-nullable":true},"supported":{"type":"boolean","description":"If the field type is supported for mapping","x-nullable":true}},"description":"Ticketing_FieldMaps_MappableFieldEntity model"},"Ticketing_ProjectInboundMappableFieldEntity":{"type":"object","properties":{"value":{"type":"string","description":"The ID of the field","x-nullable":true},"label":{"type":"string","description":"The human-readable name of the field","x-nullable":true}},"description":"Ticketing_ProjectInboundMappableFieldEntity model"},"Ticketing_ProjectInboundFieldMapEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"connection_id":{"type":"string","x-nullable":true},"connection_type":{"type":"string","x-nullable":true},"ticketing_project_id":{"type":"string","x-nullable":true},"external_field_name":{"type":"string","x-nullable":true},"internal_field_name":{"type":"string","x-nullable":true},"ticket_type":{"type":"string","enum":["incident","task","follow_up"],"x-nullable":true}},"description":"Ticketing_ProjectInboundFieldMapEntity model"},"create_ticketing_priority":{"type":"object","properties":{"name":{"type":"string"},"position":{"type":"integer","format":"int32","description":"The position that this priority should take in your list of priorities. Priorities should be ordered from highest to lowest, with the highest priority at 0. If a position isn't specified, the new priority will be added to the end of the list; if another priority already exists at the specified position, that priority and all priorities following it will automatically be moved down the list to make room for the new priority.","x-nullable":true}},"required":["name"],"description":"Create a single ticketing priority"},"update_ticketing_priority":{"type":"object","properties":{"name":{"type":"string","x-nullable":true},"position":{"type":"integer","format":"int32","description":"The position that this priority should take in your list of priorities. Priorities should be ordered from highest to lowest, with the highest priority at 0. If a position isn't specified, the new priority will be added to the end of the list; if another priority already exists at the specified position, this priority will shift that priority and all priorities down the list.","x-nullable":true}},"description":"Update a single ticketing priority's attributes"},"Ticketing_TicketFormConfigurationEntity":{"type":"object","properties":{"fields":{"type":"string","x-nullable":true}},"description":"Ticketing_TicketFormConfigurationEntity model"},"create_ticketing_custom_definition":{"type":"object","properties":{"display_name":{"type":"string","description":"The display name of the ticketing custom field definition"},"description":{"type":"string","description":"The description of the ticketing custom field definition","x-nullable":true},"field_type":{"type":"string","description":"The field type of the ticketing custom field definition (datetime, string, single_select, multi_select)"},"permissible_values":{"type":"array","description":"The permissible values of the ticketing custom field definition (for single_select and multi_select field types)","items":{"type":"string"},"x-nullable":true},"required":{"type":"boolean","description":"Whether the ticketing custom field definition should be required for all follow-up tickets. If not specified, the custom field will be set as optional.","x-nullable":true}},"required":["display_name","field_type"],"description":"Creates a ticketing custom field for the organization"},"Organizations_TicketingCustomFieldDefinitionEntity":{"type":"object","properties":{"display_name":{"type":"string","description":"The display name of the custom field","x-nullable":true},"field_id":{"type":"string","description":"The field id of the custom field","x-nullable":true},"field_type":{"type":"string","description":"The type of the custom field (datetime, string, single_select, or multi_select)","x-nullable":true},"required":{"type":"string","description":"Whether this field is required for all follow-up tickets","x-nullable":true},"slug":{"type":"string","description":"The slug of the custom field","x-nullable":true},"description":{"type":"string","description":"The description of the custom field","x-nullable":true},"permissible_values":{"type":"array","items":{"type":"string"},"description":"An array of strings representing selections for single_select or multi_select fields","x-nullable":true}},"description":"Organizations_TicketingCustomFieldDefinitionEntity model"},"update_ticketing_custom_definition":{"type":"object","properties":{"display_name":{"type":"string","description":"The display name of the ticketing custom field definition","x-nullable":true},"description":{"type":"string","description":"The description of the ticketing custom field definition","x-nullable":true},"permissible_values":{"type":"array","description":"The permissible values of the ticketing custom field definition (for single_select and multi_select field types)","items":{"type":"string"},"x-nullable":true},"required":{"type":"boolean","description":"Whether the ticketing custom field definition should be required for all follow-up tickets. If not specified, the custom field will be set as optional.","x-nullable":true}},"description":"Update a ticketing custom field for the organization"},"create_task_list":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","x-nullable":true},"task_list_items":{"type":"array","items":{"type":"object","properties":{"summary":{"type":"string","description":"A summary of the task"},"description":{"type":"string","description":"A long-form description for the task if additional context is helpful","x-nullable":true}},"required":["summary"]}}},"required":["name","task_list_items"],"description":"Creates a new task list"},"TaskListEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"created_by":{"$ref":"#/definitions/NullableAuthorEntity"},"task_list_items":{"type":"array","items":{"$ref":"#/definitions/TaskListItemEntity"},"x-nullable":true}},"description":"TaskListEntity model"},"TaskListItemEntity":{"type":"object","properties":{"summary":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true}}},"update_task_list":{"type":"object","properties":{"name":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"task_list_items":{"type":"array","items":{"type":"object","properties":{"summary":{"type":"string","description":"A summary of the task"},"description":{"type":"string","description":"A long-form description for the task if additional context is helpful","x-nullable":true}},"required":["summary"]},"x-nullable":true}},"description":"Updates a task list's attributes and task list items"},"patch_scim_group":{"type":"object","properties":{"trail":{"type":"string","description":"An optional trail to log the request","x-nullable":true},"Operations":{"type":"array","description":"An array of operations to perform on the group","items":{"type":"object","properties":{"op":{"type":"string","description":"The operation to perform. Options are add, remove, replace"},"path":{"type":"string","description":"The path to the attribute to be modified","x-nullable":true}},"required":["op"]}}},"required":["Operations"],"description":"SCIM endpoint to partially update a Team (Colloquial for Group in the SCIM protocol). Supports adding, removing, or replacing members using SCIM PATCH operations."},"update_scim_group":{"type":"object","properties":{"displayName":{"type":"string","description":"The name of the team being updated"},"members":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"String that represents the user's UUID to assign to the team"}},"required":["value"]}}},"required":["displayName","members"],"description":"SCIM endpoint to update a Team (Colloquial for Group in the SCIM protocol). Any members defined in the payload will be assigned to the team with no defined role, any missing members will be removed from the team."},"create_scim_group":{"type":"object","properties":{"displayName":{"type":"string","description":"The name of the team being created"},"members":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"String that represents the user's UUID to assign to the team"}},"required":["value"]}}},"required":["displayName","members"],"description":"SCIM endpoint to create a new Team (Colloquial for Group in the SCIM protocol). Any members defined in the payload will be assigned to the team with no defined role."},"patch_scim_user":{"type":"object","properties":{"trail":{"type":"string","description":"An optional trail to log the request","x-nullable":true},"Operations":{"type":"array","description":"An array of operations to perform on the user","items":{"type":"object","properties":{"op":{"type":"string","description":"The operation to perform on the user. Options are add, remove, replace"},"path":{"type":"string","description":"The path to the attribute to be modified. Optional for Okta OIN format where value contains the full update object","x-nullable":true}},"required":["op"]}}},"required":["Operations"],"description":"PATCH SCIM endpoint to update a User. This endpoint is used to update a resource's attributes."},"update_scim_user":{"type":"object","properties":{"userName":{"type":"string","description":"A service provider's unique identifier for the user","x-nullable":true},"name":{"type":"object","description":"The components of the user's name","properties":{"givenName":{"type":"string","description":"The family name of the User, or last name in most Western languages"},"familyName":{"type":"string","description":"The given name of the User, or first name in most Western languages"}},"required":["givenName","familyName"],"x-nullable":true},"emails":{"type":"array","description":"Email addresses for the User","items":{"type":"object","properties":{"value":{"type":"string","description":"String that represents an email address for the User"},"primary":{"type":"boolean","description":"Boolean which signifies if an email is intended as the primary email for the User","x-nullable":true}},"required":["value"]},"x-nullable":true},"roles":{"type":"object","description":"Roles for the User. Options are owner, member, collaborator, or viewer. Roles may be specified as strings or SCIM role objects.","x-nullable":true},"active":{"type":"boolean","description":"Boolean that represents whether user is active","x-nullable":true},"phoneNumbers":{"type":"array","description":"Phone numbers for the User","items":{"type":"object","properties":{"value":{"type":"string","description":"String that represents a phone number for the User"},"type":{"type":"string","description":"Type of phone number (mobile, work, home, etc.)","x-nullable":true},"primary":{"type":"boolean","description":"Boolean which signifies if a phone number is intended as the primary phone for the User","x-nullable":true}},"required":["value"]},"x-nullable":true}},"description":"PUT SCIM endpoint to update a User. This endpoint is used to replace a resource's attributes."},"create_scim_user":{"type":"object","properties":{"userName":{"type":"string","description":"A service provider's unique identifier for the user"},"externalId":{"type":"string","description":"A unique identifier for the user from the external provisioning system","x-nullable":true},"name":{"type":"object","description":"The components of the user's name","properties":{"familyName":{"type":"string","description":"The family name of the User, or last name in most Western languages"},"givenName":{"type":"string","description":"The given name of the User, or first name in most Western languages"}},"required":["familyName","givenName"]},"emails":{"type":"array","description":"Email addresses for the User","items":{"type":"object","properties":{"value":{"type":"string","description":"String that represents an email address for the User"},"primary":{"type":"boolean","description":"Boolean which signifies if an email is intended as the primary email for the User"}},"required":["value","primary"]}},"roles":{"type":"object","description":"Roles for the User. Options are owner, member, collaborator, or viewer. Roles may be specified as strings or SCIM role objects.","x-nullable":true},"password":{"type":"string","description":"This attribute is intended to be used as a means to set, replace, or compare (i.e., filter for equality) a password","x-nullable":true},"phoneNumbers":{"type":"array","description":"Phone numbers for the User","items":{"type":"object","properties":{"value":{"type":"string","description":"String that represents a phone number for the User"},"type":{"type":"string","description":"Type of phone number (mobile, work, home, etc.)","x-nullable":true},"primary":{"type":"boolean","description":"Boolean which signifies if a phone number is intended as the primary phone for the User","x-nullable":true}},"required":["value"]},"x-nullable":true}},"required":["userName","name","emails"],"description":"SCIM endpoint to create and provision a new User. This endpoint will provision the User, which allows them to accept their account throught their IDP or via the Forgot Password flow."},"ingest_catalog_data":{"type":"object","properties":{"encoding":{"type":"string","description":"Encoding for submitted data","enum":["text/yaml","application/x-yaml","application/json"]},"data":{"type":"string","description":"Service data"}},"required":["encoding","data"],"description":"Accepts catalog data in the configured format and asyncronously processes the data to incorporate changes into service catalog."},"Imports_ImportEntity":{"type":"object","properties":{"state":{"type":"string","enum":["preprocessing","ready_for_import","importing","completed","failed"],"x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true}},"description":"Imports_ImportEntity model"},"create_checklist_template":{"type":"object","properties":{"name":{"type":"string"},"checks":{"type":"array","description":"An array of checks for the checklist template","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check"},"description":{"type":"string","description":"The description of the check","x-nullable":true}},"required":["name"]}},"description":{"type":"string","x-nullable":true},"team_id":{"type":"string","description":"The ID of the Team that owns the checklist template","x-nullable":true},"connected_services":{"type":"array","description":"Array of service IDs to attach checklist template to","items":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"x-nullable":true}},"required":["name","checks"],"description":"Creates a checklist template for the organization"},"ChecklistTemplateEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/ChecklistTemplateEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"ChecklistTemplateEntityPaginated model"},"update_checklist_template":{"type":"object","properties":{"name":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"checks":{"type":"array","description":"An array of checks for the checklist template","items":{"type":"object","properties":{"id":{"type":"string","description":"Specify the check ID when updating an already existing check","x-nullable":true},"description":{"type":"string","description":"The description of the check","x-nullable":true},"name":{"type":"string","description":"The name of the check"}},"required":["name"]},"x-nullable":true},"team_id":{"type":"string","description":"The ID of the Team that owns the checklist template","x-nullable":true},"connected_services":{"type":"array","description":"Array of service IDs to attach checklist template to","items":{"type":"object","properties":{"id":{"type":"string"},"remove":{"type":"boolean","description":"Set to `true` to remove checklist from service","x-nullable":true}},"required":["id"]},"x-nullable":true},"remove_remaining_connected_services":{"type":"boolean","description":"If set to true, any services tagged on the checklist that are not included in the given array will be removed. Set this to true if you want to do a replacement operation for the services","x-nullable":true}},"description":"Update a checklist templates attributes"},"PublicAPI_V1_BootstrapEntity":{"type":"object","properties":{"posthog_write_key":{"type":"string","x-nullable":true}},"description":"PublicAPI_V1_BootstrapEntity model"},"PublicAPI_V1_FormConfigurations_SelectedValueEntity":{"type":"object","properties":{"template":{"type":"object","description":"The template for the selected value","x-nullable":true}},"description":"PublicAPI_V1_FormConfigurations_SelectedValueEntity model"},"FormConfigurationEntity":{"type":"object","properties":{"fields":{"type":"string","x-nullable":true},"show_incident_types":{"type":"string","x-nullable":true}},"description":"FormConfigurationEntity model"},"create_comment_reaction":{"type":"object","properties":{"reaction":{"type":"string","description":"CLDR short name of Unicode emojis"}},"required":["reaction"],"description":"Create a reaction on a comment"},"update_comment":{"type":"object","properties":{"body":{"type":"string","description":"Text body of comment","x-nullable":true}},"description":"Update a comment's attributes"},"create_comment":{"type":"object","properties":{"body":{"type":"string","description":"Text body of comment"}},"required":["body"],"description":"Creates a comment for a project"},"update_signals_alert":{"type":"object","properties":{"noise":{"type":"boolean","description":"Whether the alert is noisy"}},"required":["noise"],"description":"Update a Signal alert"},"Alerts_SignalAlertEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"summary":{"type":"string","x-nullable":true},"is_noise":{"type":"boolean","x-nullable":true}},"description":"Alerts_SignalAlertEntity model"},"Signals_API_Analytics_TimeseriesPointEntity":{"type":"object","properties":{"data":{"$ref":"#/definitions/NullableSignals_API_Analytics_TimeseriesPointEntity_MetricEntity"}},"description":"Signals_API_Analytics_TimeseriesPointEntity model"},"Signals_API_Analytics_TimeseriesPointEntity_MetricEntity":{"type":"object","properties":{"bucket":{"type":"string","description":"The time bucket","x-nullable":true},"total_opened_alerts":{"type":"integer","format":"int32","description":"The total number of opened alerts","x-nullable":true},"total_acked_alerts":{"type":"integer","format":"int32","description":"The total number of acknowledged alerts","x-nullable":true},"total_incidents":{"type":"integer","format":"int32","description":"The total number of incidents","x-nullable":true},"total_billable_alerts":{"type":"integer","format":"int32","description":"The total number of billable alerts (SMS/voice notifications sent)","x-nullable":true}}},"Signals_API_Analytics_GroupedMetricsEntity":{"type":"object","properties":{"data":{"$ref":"#/definitions/NullableSignals_API_Analytics_GroupedMetricsEntity_MetricEntity"}},"description":"Signals_API_Analytics_GroupedMetricsEntity model"},"Signals_API_Analytics_GroupedMetricsEntity_MetricEntity":{"type":"object","properties":{"grouped_id":{"type":"integer","format":"int32","description":"The ID of the group","x-nullable":true},"grouped_name":{"type":"string","description":"The name of the group","x-nullable":true},"total_opened_alerts":{"type":"integer","format":"int32","description":"The total number of opened alerts","x-nullable":true},"total_acked_alerts":{"type":"integer","format":"int32","description":"The total number of acknowledged alerts","x-nullable":true},"total_incidents":{"type":"integer","format":"int32","description":"The total number of incidents","x-nullable":true},"total_billable_alerts":{"type":"integer","format":"int32","description":"The total number of billable alerts (SMS/voice notifications sent)","x-nullable":true},"total_resolved_alerts":{"type":"integer","format":"int32","description":"The total number of currently-resolved alerts","x-nullable":true},"acked_percentage":{"type":"number","format":"float","description":"The percentage of acknowledged alerts","x-nullable":true},"incidents_percentage":{"type":"number","format":"float","description":"The percentage of alerts that have incidents","x-nullable":true}}},"Signals_API_Analytics_MttxMetricsEntity":{"type":"object","properties":{"data":{"$ref":"#/definitions/NullableSignals_API_Analytics_MttxMetricsEntity_MetricEntity"}},"description":"Signals_API_Analytics_MttxMetricsEntity model"},"Signals_API_Analytics_MttxMetricsEntity_MetricEntity":{"type":"object","properties":{"mtta":{"type":"number","format":"float","description":"The mean time to acknowledge (MTTA) alerts in seconds","x-nullable":true},"mttr":{"type":"number","format":"float","description":"The mean time to resolve (MTTR) alerts in seconds","x-nullable":true}}},"Signals_API_Analytics_NoiseMetricsEntity":{"type":"object","properties":{"data":{"$ref":"#/definitions/NullableSignals_API_Analytics_NoiseMetricsEntity_MetricEntity"}},"description":"Signals_API_Analytics_NoiseMetricsEntity model"},"Signals_API_Analytics_NoiseMetricsEntity_MetricEntity":{"type":"object","properties":{"bucket":{"type":"string","description":"The time bucket","x-nullable":true},"total_alerts":{"type":"integer","format":"int32","description":"The total number of alerts","x-nullable":true},"noisy_alerts":{"type":"integer","format":"int32","description":"The number of alerts marked as noise","x-nullable":true},"percentage":{"type":"number","format":"float","description":"The percentage of alerts that are noise","x-nullable":true}}},"update_call_route":{"type":"object","properties":{"name":{"type":"string","description":"Name of the call route","x-nullable":true},"routing_mode":{"type":"string","description":"Routing mode for the call route","enum":["ROUTING_MODE_TAKE_MESSAGE","ROUTING_MODE_DIRECT_CONNECT"],"x-nullable":true},"connect_mode":{"type":"string","description":"Connect mode for the call route","enum":["CONNECT_MODE_CONFERENCE","CONNECT_MODE_DIRECT_DIAL"],"x-nullable":true},"description":{"type":"string","description":"Description of the call route","x-nullable":true},"greeting_message":{"type":"string","description":"Greeting message for the call route","x-nullable":true},"steps":{"type":"array","description":"Steps for the call route","items":{"type":"object","properties":{"target_type":{"type":"string","description":"Type of target","enum":["User","OnCallSchedule"]},"target_id":{"type":"string","description":"ID of the target"},"timeout":{"type":"string","description":"Timeout in seconds for the step"},"on_call_rotation_id":{"type":"string","description":"The ID of a specific on-call rotation that should be routed to if the `target_type` is `OnCallSchedule`. If not provided, the schedule's first rotation will be used.","x-nullable":true}},"required":["target_type","target_id","timeout"]},"x-nullable":true},"target":{"type":"object","description":"Target for the call route (required unless connect_mode is direct_dial)","properties":{"type":{"type":"string","description":"Type of target","enum":["EscalationPolicy","OnCallSchedule","User","Webhook","SlackChannel","MicrosoftTeamsChannel"]},"id":{"type":"string","description":"ID of the target"}},"required":["type","id"],"x-nullable":true}},"description":"Update a call route by ID"},"create_signals_event_source":{"type":"object","properties":{"name":{"type":"string","description":"Name of the transposer"},"description":{"type":"string","description":"Description of the transposer","x-nullable":true},"slug":{"type":"string","description":"Slug of the transposer"},"example_payload":{"type":"object","description":"Example payload as input to transpose function","properties":{"headers":{"type":"object","description":"Hash of HTTP headers with values as Array, e.g. { 'Content-Type' => ['application/json'] }","x-nullable":true},"data":{"type":"object","description":"JSON body of request.","x-nullable":true}}},"javascript":{"type":"string","description":"Javascript code to convert payload into Signal object"}},"required":["name","slug","example_payload","javascript"],"description":"Create a Signals event source for the authenticated user."},"Signals_API_TransposerEntity":{"type":"object","properties":{"name":{"type":"string","x-nullable":true},"slug":{"type":"string","x-nullable":true},"example_payload":{"type":"object","x-nullable":true},"expression":{"type":"string","x-nullable":true},"expected":{"type":"string","x-nullable":true},"website":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"tags":{"type":"array","items":{"type":"string"},"x-nullable":true},"ingest_url":{"type":"string","x-nullable":true},"editable":{"type":"boolean","x-nullable":true},"created_by":{"$ref":"#/definitions/NullableAuthorEntity"},"updated_by":{"$ref":"#/definitions/NullableAuthorEntity"}},"description":"Signals_API_TransposerEntity model"},"Signals_API_TransposerListEntity":{"type":"object","properties":{"data":{"$ref":"#/definitions/NullableSignals_API_TransposerEntity"}},"description":"Signals_API_TransposerListEntity model"},"Signals_API_HackerModeEntity":{"type":"object","properties":{"enabled":{"type":"boolean","x-nullable":true},"url_key":{"type":"string","x-nullable":true},"url":{"type":"string","x-nullable":true}},"description":"Signals_API_HackerModeEntity model"},"create_signals_alert_grouping_configuration":{"type":"object","properties":{"strategy":{"type":"object","description":"The strategy to use for grouping alerts","properties":{"substring":{"type":"object","description":"The type of strategy to use for grouping alerts","properties":{"field_name":{"type":"string","description":"The field to use for grouping alerts","enum":["summary","body","tags"]},"values":{"type":"array","description":"Multiple values to use for grouping alerts","items":{"type":"string"}},"match_type":{"type":"string","description":"Match type for multiple values","enum":["and","or"],"x-nullable":true}},"required":["field_name","values"],"x-nullable":true}}},"action":{"type":"object","description":"The action to take when grouping alerts","properties":{"link":{"type":"boolean","description":"Link the alerts and do not notify anyone","x-nullable":true},"fyi":{"type":"object","description":"Send FYI notification","properties":{"slack_channel_ids":{"type":"array","description":"The slack channel ids to send the notification to","items":{"type":"string"}}},"required":["slack_channel_ids"],"x-nullable":true}},"x-nullable":true},"reference_alert_time_period":{"type":"string","description":"How long to group alerts for"}},"required":["strategy","reference_alert_time_period"],"description":"Create a Signals alert grouping rule for the organization."},"Signals_API_GroupingEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"strategy":{"$ref":"#/definitions/NullableSignals_API_GroupingEntity_StrategyEntity"},"action":{"$ref":"#/definitions/NullableSignals_API_GroupingEntity_ActionEntity"},"reference_alert_time_period":{"type":"string","x-nullable":true}},"description":"Signals_API_GroupingEntity model"},"Signals_API_GroupingEntity_StrategyEntity":{"type":"object","properties":{"substring":{"$ref":"#/definitions/NullableSignals_API_GroupingEntity_StrategyEntity_SubstringEntity"}}},"Signals_API_GroupingEntity_StrategyEntity_SubstringEntity":{"type":"object","properties":{"field_name":{"type":"string","x-nullable":true},"value":{"type":"string","x-nullable":true},"values":{"type":"array","items":{"type":"string"},"x-nullable":true},"match_type":{"type":"string","x-nullable":true}}},"Signals_API_GroupingEntity_ActionEntity":{"type":"object","properties":{"link":{"type":"boolean","x-nullable":true},"fyi":{"$ref":"#/definitions/NullableSignals_API_GroupingEntity_ActionEntity_FyiEntity"}}},"Signals_API_GroupingEntity_ActionEntity_FyiEntity":{"type":"object","properties":{"slack_channels":{"type":"array","items":{"$ref":"#/definitions/Integrations_Slack_SlackChannelEntity"},"x-nullable":true}}},"Signals_API_GroupingEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Signals_API_GroupingEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"Signals_API_GroupingEntityPaginated model"},"update_signals_alert_grouping_configuration":{"type":"object","properties":{"strategy":{"type":"object","description":"The strategy to use for grouping alerts","properties":{"substring":{"type":"object","description":"The type of strategy to use for grouping alerts","properties":{"field_name":{"type":"string","description":"The field to use for grouping alerts","enum":["summary","body","tags"]},"values":{"type":"array","description":"Multiple values to use for grouping alerts","items":{"type":"string"}},"match_type":{"type":"string","description":"Match type for multiple values","enum":["and","or"],"x-nullable":true}},"required":["field_name","values"],"x-nullable":true}},"x-nullable":true},"action":{"type":"object","description":"The action to take when grouping alerts","properties":{"link":{"type":"boolean","description":"Link the alerts and do not notify anyone","x-nullable":true},"fyi":{"type":"object","description":"Send FYI notification","properties":{"slack_channel_ids":{"type":"array","description":"The slack channel ids to send the notification to","items":{"type":"string"}}},"required":["slack_channel_ids"],"x-nullable":true}},"x-nullable":true},"reference_alert_time_period":{"type":"string","description":"How long to group alerts for","x-nullable":true}},"description":"Update a Signals alert grouping rule for the organization."},"create_signals_email_target":{"type":"object","properties":{"name":{"type":"string","description":"The email target's name."},"slug":{"type":"string","description":"The email address that will be listening to events.","x-nullable":true},"description":{"type":"string","description":"A detailed description of the email target.","x-nullable":true},"target":{"type":"object","description":"The target that the email target will notify. This object must contain a `type`\nfield that specifies the type of target and an `id` field that specifies the ID of\nthe target. The `type` field must be one of \"escalation_policy\", \"on_call_schedule\",\n\"team\", \"user\", or \"slack_channel\".\n","properties":{"type":{"type":"string","description":"The type of target that the inbound email will notify when matched.","enum":["Team","EntireTeam","EscalationPolicy","OnCallSchedule","User","SlackChannel","MicrosoftTeamsChannel","Webhook"]},"id":{"type":"string","description":"The ID of the target that the inbound email will notify when matched."}},"required":["type","id"],"x-nullable":true},"allowed_senders":{"type":"array","description":"A list of email addresses that are allowed to send events to the target. Must be exact match.","items":{"type":"string"},"x-nullable":true},"rules":{"type":"array","description":"A list of CEL expressions that should be evaluated and matched to determine if the target should be notified.","items":{"type":"string"},"x-nullable":true},"rule_matching_strategy":{"type":"string","description":"Whether or not all rules must match, or if only one rule must match.","enum":["all","any"],"x-nullable":true},"status_cel":{"type":"string","description":"The CEL expression that defines the status of an incoming email that is sent to the target.","x-nullable":true},"level_cel":{"type":"string","description":"The CEL expression that defines the level of an incoming email that is sent to the target.","x-nullable":true}},"required":["name"],"description":"Create a Signals email target for a team."},"Signals_API_EmailTargetEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"slug":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"email":{"type":"string","x-nullable":true},"status_cel":{"type":"string","x-nullable":true},"level_cel":{"type":"string","x-nullable":true},"target":{"$ref":"#/definitions/NullableSignals_API_TargetEntity"},"allowed_senders":{"type":"array","items":{"type":"string"},"x-nullable":true},"rules":{"type":"array","items":{"type":"string"},"x-nullable":true},"rule_matching_strategy":{"type":"string","x-nullable":true},"created_by":{"$ref":"#/definitions/NullableAuthorEntity"},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"team_id":{"type":"string","description":"The team ID that the email target belongs to, if applicable","x-nullable":true}},"description":"Signals_API_EmailTargetEntity model"},"Signals_API_EmailTargetEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Signals_API_EmailTargetEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"Signals_API_EmailTargetEntityPaginated model"},"update_signals_email_target":{"type":"object","properties":{"name":{"type":"string","description":"The email target's name.","x-nullable":true},"slug":{"type":"string","description":"The email address that will be listening to events.","x-nullable":true},"description":{"type":"string","description":"A detailed description of the email target.","x-nullable":true},"target":{"type":"object","description":"The target that the email target will notify. This object must contain a `type`\nfield that specifies the type of target and an `id` field that specifies the ID of\nthe target. The `type` field must be one of \"escalation_policy\", \"on_call_schedule\",\n\"team\", \"user\", or \"slack_channel\".\n","properties":{"type":{"type":"string","description":"The type of target that the inbound email will notify when matched.","enum":["Team","EntireTeam","EscalationPolicy","OnCallSchedule","User","SlackChannel","MicrosoftTeamsChannel","Webhook"]},"id":{"type":"string","description":"The ID of the target that the inbound email will notify when matched."}},"required":["type","id"],"x-nullable":true},"allowed_senders":{"type":"array","description":"A list of email addresses that are allowed to send events to the target. Must be exact match.","items":{"type":"string"},"x-nullable":true},"status_cel":{"type":"string","description":"The CEL expression that defines the status of an incoming email that is sent to the target.","x-nullable":true},"level_cel":{"type":"string","description":"The CEL expression that defines the level of an incoming email that is sent to the target.","x-nullable":true},"rules":{"type":"array","description":"A list of CEL expressions that should be evaluated and matched to determine if the target should be notified.","items":{"type":"string"},"x-nullable":true},"rule_matching_strategy":{"type":"string","description":"Whether or not all rules must match, or if only one rule must match.","enum":["all","any"],"x-nullable":true}},"description":"Update a Signals email target by ID"},"create_signals_webhook_target":{"type":"object","properties":{"name":{"type":"string","description":"The webhook target's name."},"description":{"type":"string","description":"An optional detailed description of the webhook target.","x-nullable":true},"url":{"type":"string","description":"The URL that the webhook target will notify."},"signing_key":{"type":"string","description":"An optional secret we will provide in the `FH-Signature` header\nwhen sending a payload to the webhook target. This key will not be\nshown in any response once configured.\n","x-nullable":true}},"required":["name","url"],"description":"Create a Signals webhook target."},"Signals_API_WebhookTargetEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"url":{"type":"string","x-nullable":true},"created_by":{"$ref":"#/definitions/NullableAuthorEntity"},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true}},"description":"Signals_API_WebhookTargetEntity model"},"Signals_API_WebhookTargetEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Signals_API_WebhookTargetEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"Signals_API_WebhookTargetEntityPaginated model"},"update_signals_webhook_target":{"type":"object","properties":{"name":{"type":"string","description":"The webhook target's name.","x-nullable":true},"description":{"type":"string","description":"An optional detailed description of the webhook target.","x-nullable":true},"url":{"type":"string","description":"The URL that the webhook target will notify.","x-nullable":true},"signing_key":{"type":"string","description":"An optional secret we will provide in the `FH-Signature` header\nwhen sending a payload to the webhook target. This key will not be\nshown in any response once configured.\n","x-nullable":true}},"description":"Update a Signals webhook target by ID"},"create_signals_heartbeat_endpoint_configuration":{"type":"object","properties":{"slug":{"type":"string","description":"Unique URL path segment for the heartbeat endpoint"},"enabled":{"type":"boolean","description":"Whether the endpoint is active"},"description":{"type":"string","description":"Optional description of the endpoint's purpose","x-nullable":true},"expect_interval":{"type":"string","description":"Time interval in which heartbeats are expected (minimum '5m', maximum '24h')"},"template_signal":{"type":"object","description":"Signal template to be used when generating alerts for missed heartbeats","properties":{"body":{"type":"string","x-nullable":true},"annotations":{"type":"object","x-nullable":true},"tags":{"type":"array","items":{"type":"string"},"x-nullable":true},"links":{"type":"array","items":{"type":"object","properties":{"href":{"type":"string","x-nullable":true},"text":{"type":"string","x-nullable":true}}},"x-nullable":true}}},"kind":{"type":"string","description":"Type of heartbeat endpoint (e.g. 'http')","enum":["http","email"]},"allowed_http_methods":{"type":"array","description":"HTTP methods allowed for this endpoint","items":{"type":"string"},"x-nullable":true},"allowed_user_agent_substring":{"type":"string","description":"User agent substring that must be present in requests","x-nullable":true},"allowed_email_senders":{"type":"array","description":"Email addresses allowed to send heartbeats","items":{"type":"string"},"x-nullable":true},"team_id":{"type":"string","description":"ID of the team the heartbeat belongs to","x-nullable":true},"rule_id":{"type":"string","description":"ID of an existing alert rule to link to this heartbeat","x-nullable":true}},"required":["slug","enabled","expect_interval","template_signal","kind"],"description":"Create a new heartbeat endpoint configuration for your organization"},"update_signals_heartbeat_endpoint_configuration":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the endpoint is active","x-nullable":true},"description":{"type":"string","description":"Optional description of the endpoint's purpose","x-nullable":true},"expect_interval":{"type":"string","description":"Time interval in which heartbeats are expected (minimum '5m', maximum '24h')","x-nullable":true},"template_signal":{"type":"object","description":"Signal template to be used when generating alerts for missed heartbeats","properties":{"body":{"type":"string","x-nullable":true},"annotations":{"type":"object","x-nullable":true},"tags":{"type":"array","items":{"type":"string"},"x-nullable":true},"links":{"type":"array","items":{"type":"object","properties":{"href":{"type":"string","x-nullable":true},"text":{"type":"string","x-nullable":true}}},"x-nullable":true}},"x-nullable":true},"kind":{"type":"string","description":"Type of heartbeat endpoint (e.g. 'http')","enum":["http","email"],"x-nullable":true},"allowed_http_methods":{"type":"array","description":"HTTP methods allowed for this endpoint","items":{"type":"string"},"x-nullable":true},"allowed_user_agent_substring":{"type":"string","description":"User agent substring that must be present in requests","x-nullable":true},"allowed_email_senders":{"type":"array","description":"Email addresses allowed to send heartbeats","items":{"type":"string"},"x-nullable":true}},"description":"Update an existing heartbeat endpoint configuration"},"Signals_API_NotificationPolicyItemEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"notification_group_method":{"type":"string","enum":["any","push","email","voice","mobile_text","chat"],"x-nullable":true},"max_delay":{"type":"string","description":"The maximum delay for notifications","x-nullable":true},"priority":{"type":"string","enum":["HIGH","MEDIUM","LOW"],"x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true}},"description":"Signals_API_NotificationPolicyItemEntity model"},"Signals_API_NotificationPolicyItemEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Signals_API_NotificationPolicyItemEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"Signals_API_NotificationPolicyItemEntityPaginated model"},"Signals_API_UserNotificationSettingEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Signals_API_UserNotificationSettingEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"Signals_API_UserNotificationSettingEntityPaginated model"},"Signals_API_UserNotificationSettingEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"notification_type":{"type":"string","x-nullable":true},"delay":{"type":"string","x-nullable":true},"notification_priority":{"type":"string","x-nullable":true},"destination":{"$ref":"#/definitions/NullableSignals_API_DestinationEntity"}}},"Signals_API_DestinationEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"type":{"type":"string","x-nullable":true},"label":{"type":"string","x-nullable":true},"value":{"type":"string","x-nullable":true}}},"Signals_API_IngestKeyEntity":{"type":"object","properties":{"url":{"type":"string","x-nullable":true}},"description":"Signals_API_IngestKeyEntity model"},"debug_signals_expression":{"type":"object","properties":{"expression":{"type":"string","description":"CEL expression"},"signals":{"type":"array","description":"List of signals to evaluate rule expression against","items":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"organization_id":{"type":"string","x-nullable":true},"summary":{"type":"string","x-nullable":true},"body":{"type":"string","x-nullable":true},"level":{"type":"string","x-nullable":true},"annotations":{"type":"object","x-nullable":true},"tags":{"type":"array","items":{"type":"string"},"x-nullable":true},"images":{"type":"array","items":{"type":"object","properties":{"src":{"type":"string","x-nullable":true},"alt":{"type":"string","x-nullable":true}}},"x-nullable":true},"links":{"type":"array","items":{"type":"object","properties":{"href":{"type":"string","x-nullable":true},"text":{"type":"string","x-nullable":true}}},"x-nullable":true}}}}},"required":["expression","signals"],"description":"Debug Signals expressions"},"Signals_API_OrganizationOnCallScheduleEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Signals_API_OrganizationOnCallScheduleEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"Signals_API_OrganizationOnCallScheduleEntityPaginated model"},"Signals_API_OrganizationOnCallScheduleEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"rotations":{"type":"array","items":{"$ref":"#/definitions/Signals_API_OrganizationOnCallRotationEntity"},"x-nullable":true},"team":{"$ref":"#/definitions/NullableSuccinctEntity"},"created_by":{"$ref":"#/definitions/NullableAuthorEntity"},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"time_zone":{"type":"string","x-nullable":true},"current_shift":{"$ref":"#/definitions/NullableSignals_API_OnCallShiftEntity"},"next_shift":{"$ref":"#/definitions/NullableSignals_API_OnCallShiftEntity"}}},"Signals_API_OrganizationOnCallRotationEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"description":{"type":"string","x-nullable":true},"time_zone":{"type":"string","x-nullable":true},"current_shift":{"$ref":"#/definitions/NullableSignals_API_OnCallShiftEntity"},"next_shift":{"$ref":"#/definitions/NullableSignals_API_OnCallShiftEntity"},"created_by":{"$ref":"#/definitions/NullableAuthorEntity"},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true}}},"create_webhook":{"type":"object","properties":{"url":{"type":"string"}},"required":["url"],"description":"Create a new webhook"},"Webhooks_Entities_WebhookEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"url":{"type":"string","x-nullable":true},"state":{"type":"string","x-nullable":true},"created_by":{"$ref":"#/definitions/NullableAuthorEntity"},"created_at":{"type":"string","format":"date-time","x-nullable":true},"updated_at":{"type":"string","format":"date-time","x-nullable":true},"subscriptions":{"type":"string","x-nullable":true}},"description":"Webhooks_Entities_WebhookEntity model"},"Webhooks_Entities_WebhookEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Webhooks_Entities_WebhookEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"Webhooks_Entities_WebhookEntityPaginated model"},"Webhooks_Entities_DeliveryEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Webhooks_Entities_DeliveryEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"Webhooks_Entities_DeliveryEntityPaginated model"},"Webhooks_Entities_DeliveryEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"created_at":{"type":"string","format":"date-time","x-nullable":true},"expires_after":{"type":"string","format":"date-time","x-nullable":true},"status_code":{"type":"integer","format":"int32","x-nullable":true},"headers":{"type":"object","x-nullable":true},"duration":{"type":"integer","format":"int32","x-nullable":true},"attempts":{"type":"integer","format":"int32","x-nullable":true},"error":{"type":"string","x-nullable":true}}},"update_webhook":{"type":"object","properties":{"url":{"type":"string","x-nullable":true},"state":{"type":"string","enum":["active","inactive"],"x-nullable":true}},"description":"Update a specific webhook"},"AI_Entities_IncidentSummaryEntity":{"type":"object","properties":{"id":{"type":"string","x-nullable":true},"content":{"type":"string","x-nullable":true},"source_hash":{"type":"string","x-nullable":true},"type":{"type":"string","x-nullable":true},"created_at":{"type":"string","x-nullable":true},"incident_updated_at":{"type":"string","format":"date-time","x-nullable":true}},"description":"AI_Entities_IncidentSummaryEntity model"},"AI_Entities_PreferencesEntity":{"type":"object","properties":{"ai":{"type":"boolean","x-nullable":true},"description":{"type":"boolean","x-nullable":true},"followups":{"type":"boolean","x-nullable":true},"impact":{"type":"boolean","x-nullable":true},"retros":{"type":"boolean","x-nullable":true},"similar_incidents":{"type":"boolean","x-nullable":true},"similar_incidents_cooldown_minutes":{"type":"integer","format":"int32","x-nullable":true},"similar_incidents_max_per_incident":{"type":"integer","format":"int32","x-nullable":true},"summaries":{"type":"boolean","x-nullable":true},"conference_bridge_summary_min_interval_minutes":{"type":"integer","format":"int32","x-nullable":true},"updates":{"type":"boolean","x-nullable":true}},"description":"AI_Entities_PreferencesEntity model"},"Audiences_Entities_AudienceEntityPaginated":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Audiences_Entities_AudienceEntity"},"x-nullable":true},"pagination":{"$ref":"#/definitions/NullablePaginationEntity"}},"description":"Audiences_Entities_AudienceEntityPaginated model"},"Audiences_Entities_AudienceEntity":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the audience","x-nullable":true},"name":{"type":"string","description":"Name of the audience (maximum 255 characters)","x-nullable":true},"slug":{"type":"string","description":"Slug of the audience, unique and autogenerated","x-nullable":true},"description":{"type":"string","description":"Description of the audience and its purpose (maximum 4000 characters)","x-nullable":true},"default":{"type":"boolean","description":"Whether this is the organization's default audience","x-nullable":true},"created_at":{"type":"string","format":"date-time","description":"When the audience was created","x-nullable":true},"updated_at":{"type":"string","format":"date-time","description":"When the audience was last updated","x-nullable":true},"discarded_at":{"type":"string","format":"date-time","description":"When the audience was discarded (soft deleted)","x-nullable":true},"details":{"type":"array","items":{"$ref":"#/definitions/Audiences_Entities_DetailEntity"},"description":"List of incident details for this audience","x-nullable":true}},"description":"Audiences_Entities_AudienceEntity model"},"Audiences_Entities_DetailEntity":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the detail item","x-nullable":true},"question":{"type":"string","description":"The need-to-know question (maximum 255 characters)","x-nullable":true},"prompt":{"type":"string","description":"AI prompt used to gather this information","x-nullable":true},"position":{"type":"integer","format":"int32","description":"Order position of this item in the list","x-nullable":true},"slug":{"type":"string","description":"Slug of the detail, unique and autogenerated","x-nullable":true}}},"create_audience":{"type":"object","properties":{"name":{"type":"string","description":"Name of the audience (max 255 characters)"},"description":{"type":"string","description":"Description of the audience (max 4000 characters)"},"default":{"type":"boolean","description":"Whether this is the default audience","default":false,"x-nullable":true},"details":{"type":"array","items":{"type":"object","properties":{"question":{"type":"string","description":"The incident detail question (max 255 characters)"},"prompt":{"type":"string","description":"The prompt to display when collecting this detail"},"slug":{"type":"string","description":"Optional unique identifier for this detail","x-nullable":true}},"required":["question","prompt"]},"x-nullable":true},"settings":{"type":"object","description":"audience settings for initial audience creation","properties":{"id":{"type":"boolean","description":"Include the incident's id in summarization"},"name":{"type":"boolean","description":"Include the incident's name in summarization"},"started_at":{"type":"boolean","description":"Include the datetime the incident started in summarization"},"status":{"type":"boolean","description":"Include the incident's status in summarization"},"severity":{"type":"boolean","description":"Include the incident's severity in summarization"},"description":{"type":"boolean","description":"Include the incident's description in summarization"},"customer_impact_summary":{"type":"boolean","description":"Include the incident's customer impact summary in summarization"},"current_milestone":{"type":"boolean","description":"Include the incident's current milestone in summarization"},"timeline":{"type":"boolean","description":"Include each milestone change and any high or medium value event in summarization"},"communications":{"type":"boolean","description":"Include all communication (starred or not) in summarization"},"work_items":{"type":"boolean","description":"Include all tickets and tasks in summarization"},"services":{"type":"boolean","description":"Include all impacted catalog items in summarization"},"custom_fields":{"type":"boolean","description":"Include all custom fields for the incident in summarization"},"alerts":{"type":"boolean","description":"Include all alerts related to the incident in summarization"},"responders":{"type":"boolean","description":"Include all information on responders, their roles, and any assigned teams"},"high_value_events":{"type":"object","properties":{"incident_status":{"type":"boolean","description":"Include incident status change events in the timeline"},"bulk_milestone_update":{"type":"boolean","description":"Include bulk updates (including runbook or automation events) in the timeline"},"impact_update":{"type":"boolean","description":"Include any catalog item impact events in the timeline"},"handoff":{"type":"boolean","description":"Include any handoff events in the timeline"},"add_task_list":{"type":"boolean","description":"Include any additions to the task list in the timeline"},"external_link":{"type":"boolean","description":"Include any external link events in the timeline"}},"required":["incident_status","bulk_milestone_update","impact_update","handoff","add_task_list","external_link"]},"medium_value_events":{"type":"object","properties":{"parent_changed":{"type":"boolean","description":"Include any events where the incident's parent changes in the timeline"},"child_changed":{"type":"boolean","description":"Include any events where the incident's children change in the timeline"},"new_related_change_event":{"type":"boolean","description":"Include any related change events in the timeline"},"runbook_step_execution_update":{"type":"boolean","description":"Include any runbook step updates in the timeline"},"change_type":{"type":"boolean","description":"Include any incident type change events in the timeline"}},"required":["parent_changed","child_changed","new_related_change_event","runbook_step_execution_update","change_type"]}},"required":["id","name","started_at","status","severity","description","customer_impact_summary","current_milestone","timeline","communications","work_items","services","custom_fields","alerts","responders","high_value_events","medium_value_events"],"x-nullable":true}},"required":["name","description"],"description":"Create a new audience"},"Audiences_Entities_AudienceShowEntity":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the audience","x-nullable":true},"name":{"type":"string","description":"Name of the audience (maximum 255 characters)","x-nullable":true},"slug":{"type":"string","description":"Slug of the audience, unique and autogenerated","x-nullable":true},"description":{"type":"string","description":"Description of the audience and its purpose (maximum 4000 characters)","x-nullable":true},"default":{"type":"boolean","description":"Whether this is the organization's default audience","x-nullable":true},"created_at":{"type":"string","format":"date-time","description":"When the audience was created","x-nullable":true},"updated_at":{"type":"string","format":"date-time","description":"When the audience was last updated","x-nullable":true},"discarded_at":{"type":"string","format":"date-time","description":"When the audience was discarded (soft deleted)","x-nullable":true},"details":{"type":"array","items":{"$ref":"#/definitions/Audiences_Entities_DetailEntity"},"description":"List of incident details for this audience","x-nullable":true},"settings":{"$ref":"#/definitions/NullableAudiences_Entities_SettingEntity","description":"The audience's data settings"}},"description":"Audiences_Entities_AudienceShowEntity model"},"Audiences_Entities_SettingEntity":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the audience setting","x-nullable":true},"incident_data":{"$ref":"#/definitions/NullableAudiences_Entities_SettingEntity_IncidentDataSettingEntity","description":"An object of data types and boolean values"}}},"Audiences_Entities_SettingEntity_IncidentDataSettingEntity":{"type":"object","properties":{"id":{"type":"boolean","description":"Include the incident's id in summarization","x-nullable":true},"name":{"type":"boolean","description":"Include the incident's name in summarization","x-nullable":true},"started_at":{"type":"boolean","description":"Include the datetime the incident started in summarization","x-nullable":true},"status":{"type":"boolean","description":"Include the incident's status in summarization","x-nullable":true},"severity":{"type":"boolean","description":"Include the incident's severity in summarization","x-nullable":true},"description":{"type":"boolean","description":"Include the incident's description in summarization","x-nullable":true},"customer_impact_summary":{"type":"boolean","description":"Include the incident's customer impact summary in summarization","x-nullable":true},"current_milestone":{"type":"boolean","description":"Include the incident's current milestone in summarization","x-nullable":true},"timeline":{"type":"boolean","description":"Include each milestone change and any high or medium value event in summarization","x-nullable":true},"communications":{"type":"boolean","description":"Include all communication (starred or not) in summarization","x-nullable":true},"work_items":{"type":"boolean","description":"Include all tickets and tasks in summarization","x-nullable":true},"services":{"type":"boolean","description":"Include all impacted catalog items in summarization","x-nullable":true},"custom_fields":{"type":"boolean","description":"Include all custom fields for the incident in summarization","x-nullable":true},"alerts":{"type":"boolean","description":"Include all alerts related to the incident in summarization","x-nullable":true},"responders":{"type":"boolean","description":"Include all information on responders, their roles, and any assigned teams","x-nullable":true},"high_value_events":{"$ref":"#/definitions/NullableAudiences_Entities_SettingEntity_HighValueEventsSettingEntity","description":"Which high-value events to include in the timeline summarization"},"medium_value_events":{"$ref":"#/definitions/NullableAudiences_Entities_SettingEntity_MediumValueEventsSettingEntity","description":"Which medium-value events to include in the timeline summarization"}}},"Audiences_Entities_SettingEntity_HighValueEventsSettingEntity":{"type":"object","properties":{"incident_status":{"type":"boolean","description":"Include incident status change events in the timeline","x-nullable":true},"bulk_milestone_update":{"type":"boolean","description":"Include bulk updates (including runbook or automation events) in the timeline","x-nullable":true},"impact_update":{"type":"boolean","description":"Include any catalog item impact events in the timeline","x-nullable":true},"handoff":{"type":"boolean","description":"Include any handoff events in the timeline","x-nullable":true},"add_task_list":{"type":"boolean","description":"Include any additions to the task list in the timeline","x-nullable":true},"external_link":{"type":"boolean","description":"Include any external link events in the timeline","x-nullable":true}}},"Audiences_Entities_SettingEntity_MediumValueEventsSettingEntity":{"type":"object","properties":{"parent_changed":{"type":"boolean","description":"Include any events where the incident's parent changes in the timeline","x-nullable":true},"child_changed":{"type":"boolean","description":"Include any events where the incident's children change in the timeline","x-nullable":true},"new_related_change_event":{"type":"boolean","description":"Include any related change events in the timeline","x-nullable":true},"runbook_step_execution_update":{"type":"boolean","description":"Include any runbook step updates in the timeline","x-nullable":true},"change_type":{"type":"boolean","description":"Include any incident type change events in the timeline","x-nullable":true}}},"update_audience":{"type":"object","properties":{"name":{"type":"string","description":"Name of the audience (max 255 characters)","x-nullable":true},"description":{"type":"string","description":"Description of the audience (max 4000 characters)","x-nullable":true},"default":{"type":"boolean","description":"Whether this is the default audience","x-nullable":true},"active":{"type":"boolean","description":"Whether the audience is active or discarded","x-nullable":true},"details":{"type":"array","items":{"type":"object","properties":{"question":{"type":"string","description":"The incident detail question (max 255 characters)","x-nullable":true},"prompt":{"type":"string","description":"The prompt to display when collecting this detail","x-nullable":true},"slug":{"type":"string","description":"Optional unique identifier for this detail","x-nullable":true},"position":{"type":"integer","format":"int32","description":"Position of the question in the list (1-based indexing)","x-nullable":true}}},"x-nullable":true},"settings":{"type":"object","description":"audience data settings updated alongside the audience","properties":{"id":{"type":"boolean","description":"Include the incident's id in summarization"},"name":{"type":"boolean","description":"Include the incident's name in summarization"},"started_at":{"type":"boolean","description":"Include the datetime the incident started in summarization"},"status":{"type":"boolean","description":"Include the incident's status in summarization"},"severity":{"type":"boolean","description":"Include the incident's severity in summarization"},"description":{"type":"boolean","description":"Include the incident's description in summarization"},"customer_impact_summary":{"type":"boolean","description":"Include the incident's customer impact summary in summarization"},"current_milestone":{"type":"boolean","description":"Include the incident's current milestone in summarization"},"timeline":{"type":"boolean","description":"Include each milestone change and any high or medium value event in summarization"},"communications":{"type":"boolean","description":"Include all communication (starred or not) in summarization"},"work_items":{"type":"boolean","description":"Include all tickets and tasks in summarization"},"services":{"type":"boolean","description":"Include all impacted catalog items in summarization"},"custom_fields":{"type":"boolean","description":"Include all custom fields for the incident in summarization"},"alerts":{"type":"boolean","description":"Include all alerts related to the incident in summarization"},"responders":{"type":"boolean","description":"Include all information on responders, their roles, and any assigned teams"},"priority":{"type":"boolean","description":"Whether to include priority in the summary","x-nullable":true},"high_value_events":{"type":"object","properties":{"incident_status":{"type":"boolean","description":"Include incident status change events in the timeline"},"bulk_milestone_update":{"type":"boolean","description":"Include bulk updates (including runbook or automation events) in the timeline"},"impact_update":{"type":"boolean","description":"Include any catalog item impact events in the timeline"},"handoff":{"type":"boolean","description":"Include any handoff events in the timeline"},"add_task_list":{"type":"boolean","description":"Include any additions to the task list in the timeline"},"external_link":{"type":"boolean","description":"Include any external link events in the timeline"}},"required":["incident_status","bulk_milestone_update","impact_update","handoff","add_task_list","external_link"]},"medium_value_events":{"type":"object","properties":{"parent_changed":{"type":"boolean","description":"Include any events where the incident's parent changes in the timeline"},"child_changed":{"type":"boolean","description":"Include any events where the incident's children change in the timeline"},"new_related_change_event":{"type":"boolean","description":"Include any related change events in the timeline"},"runbook_step_execution_update":{"type":"boolean","description":"Include any runbook step updates in the timeline"},"change_type":{"type":"boolean","description":"Include any incident type change events in the timeline"}},"required":["parent_changed","child_changed","new_related_change_event","runbook_step_execution_update","change_type"]}},"required":["id","name","started_at","status","severity","description","customer_impact_summary","current_milestone","timeline","communications","work_items","services","custom_fields","alerts","responders","high_value_events","medium_value_events"],"x-nullable":true}},"description":"Update an existing audience"},"Audiences_Entities_AudienceSummariesEntity":{"type":"object","properties":{"incident_id":{"type":"string","x-nullable":true},"audiences":{"type":"string","description":"JSON-encoded map of audience summaries","x-nullable":true}},"description":"Audiences_Entities_AudienceSummariesEntity model"},"NullableErrorEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/ErrorEntity"}]},"NullablePongEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/PongEntity"}]},"NullableActorEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/ActorEntity"}]},"NullableOrganizationEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/OrganizationEntity"}]},"Nullablecreate_environment":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_environment"}]},"NullableEnvironmentEntryEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/EnvironmentEntryEntity"}]},"NullableExternalResourceEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/ExternalResourceEntity"}]},"NullableFunctionalityEntityLite":{"nullable":true,"allOf":[{"$ref":"#/definitions/FunctionalityEntityLite"}]},"NullableLinksEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/LinksEntity"}]},"NullableTeamEntityLite":{"nullable":true,"allOf":[{"$ref":"#/definitions/TeamEntityLite"}]},"NullableAuthorEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/AuthorEntity"}]},"NullableServiceEntityLite":{"nullable":true,"allOf":[{"$ref":"#/definitions/ServiceEntityLite"}]},"NullableEnvironmentEntryEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/EnvironmentEntryEntityPaginated"}]},"NullablePaginationEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/PaginationEntity"}]},"Nullableupdate_environment":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_environment"}]},"NullableServiceEntityLitePaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/ServiceEntityLitePaginated"}]},"NullableFunctionalityEntityLitePaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/FunctionalityEntityLitePaginated"}]},"Nullablecreate_service":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_service"}]},"NullableServiceEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/ServiceEntity"}]},"NullableChecklistTemplateEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/ChecklistTemplateEntity"}]},"NullableChecklistCheckEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/ChecklistCheckEntity"}]},"NullableServiceEntityChecklist":{"nullable":true,"allOf":[{"$ref":"#/definitions/ServiceEntityChecklist"}]},"NullableFunctionalityEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/FunctionalityEntity"}]},"NullableImports_ImportableResourceEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Imports_ImportableResourceEntity"}]},"NullableImports_ImportErrorEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Imports_ImportErrorEntity"}]},"NullableImports_ImportErrorEntity_ResourceEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Imports_ImportErrorEntity_ResourceEntity"}]},"NullableServiceEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/ServiceEntityPaginated"}]},"Nullablecreate_service_links":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_service_links"}]},"NullableServiceLinkEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/ServiceLinkEntity"}]},"Nullableupdate_service":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_service"}]},"NullableServiceWithAllDependenciesEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/ServiceWithAllDependenciesEntity"}]},"NullableServiceChildDependencyEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/ServiceChildDependencyEntity"}]},"NullableServiceParentDependencyEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/ServiceParentDependencyEntity"}]},"Nullablecreate_service_checklist_response":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_service_checklist_response"}]},"Nullablecreate_service_dependency":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_service_dependency"}]},"NullableServiceDependencyEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/ServiceDependencyEntity"}]},"Nullableupdate_service_dependency":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_service_dependency"}]},"Nullablecreate_functionality":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_functionality"}]},"NullableFunctionalityEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/FunctionalityEntityPaginated"}]},"Nullableupdate_functionality":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_functionality"}]},"NullableFunctionalityWithAllServicesEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/FunctionalityWithAllServicesEntity"}]},"Nullablecreate_team":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_team"}]},"NullableTeamEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/TeamEntity"}]},"NullableIntegrations_Slack_SlackChannelEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Integrations_Slack_SlackChannelEntity"}]},"NullableIntegrations_MicrosoftTeamsV2_ChannelEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Integrations_MicrosoftTeamsV2_ChannelEntity"}]},"NullableIncidentEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/IncidentEntity"}]},"NullableSuccinctEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/SuccinctEntity"}]},"NullableSeverityMatrix_ImpactEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/SeverityMatrix_ImpactEntity"}]},"NullableSeverityMatrix_ConditionEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/SeverityMatrix_ConditionEntity"}]},"NullableIncidents_MilestoneEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Incidents_MilestoneEntity"}]},"NullableIncidents_LifecyclePhaseEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Incidents_LifecyclePhaseEntity"}]},"NullableIncidents_LifecycleMilestoneEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Incidents_LifecycleMilestoneEntity"}]},"NullableIncidents_LifecycleMeasurementEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Incidents_LifecycleMeasurementEntity"}]},"NullableIncidents_RoleAssignmentEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Incidents_RoleAssignmentEntity"}]},"NullableIncidentRoleEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/IncidentRoleEntity"}]},"NullableUserEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/UserEntity"}]},"NullableSignals_API_NotificationPolicyItemComplianceEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_NotificationPolicyItemComplianceEntity"}]},"NullableIncidents_StatusPageEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Incidents_StatusPageEntity"}]},"NullableIntegrationEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/IntegrationEntity"}]},"NullableEvent_NoteEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Event_NoteEntity"}]},"NullableConversations_API_Entities_Reference":{"nullable":true,"allOf":[{"$ref":"#/definitions/Conversations_API_Entities_Reference"}]},"NullableConversations_API_Entities_Channel":{"nullable":true,"allOf":[{"$ref":"#/definitions/Conversations_API_Entities_Channel"}]},"NullableTicketing_TicketEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Ticketing_TicketEntity"}]},"NullableTicketing_PriorityEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Ticketing_PriorityEntity"}]},"NullableTicketing_CustomFields_FieldValue":{"nullable":true,"allOf":[{"$ref":"#/definitions/Ticketing_CustomFields_FieldValue"}]},"NullableAttachments_LinkEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Attachments_LinkEntity"}]},"NullableIncidents_ImpactEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Incidents_ImpactEntity"}]},"NullableIncidents_ConferenceBridgeEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Incidents_ConferenceBridgeEntity"}]},"NullableIncidents_ChannelEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Incidents_ChannelEntity"}]},"NullableIncidents_ContextObjectEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Incidents_ContextObjectEntity"}]},"NullableIncidents_TeamAssignmentEntityLite":{"nullable":true,"allOf":[{"$ref":"#/definitions/Incidents_TeamAssignmentEntityLite"}]},"NullableCustomFields_FieldValue":{"nullable":true,"allOf":[{"$ref":"#/definitions/CustomFields_FieldValue"}]},"NullableIncidentEntity_FieldRequirementEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/IncidentEntity_FieldRequirementEntity"}]},"NullableMembershipEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/MembershipEntity"}]},"NullableScheduleEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/ScheduleEntity"}]},"NullableSlimRunbookEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/SlimRunbookEntity"}]},"NullableRules_RuleEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Rules_RuleEntity"}]},"NullableFHTypes_GenericEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/FHTypes_GenericEntity"}]},"NullablePublicAPI_V1_Incidents_SuccinctEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/PublicAPI_V1_Incidents_SuccinctEntity"}]},"NullableTeamEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/TeamEntityPaginated"}]},"Nullableupdate_team":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_team"}]},"Nullableupdate_support_hours_schedule":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_support_hours_schedule"}]},"NullableSupportHoursScheduleEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/SupportHoursScheduleEntity"}]},"NullableSupportHoursShiftEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/SupportHoursShiftEntity"}]},"Nullablecreate_team_call_route":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_team_call_route"}]},"NullableSignals_API_CallRouteEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_CallRouteEntity"}]},"NullableSignals_API_CallRouteStepEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_CallRouteStepEntity"}]},"NullableSignals_API_TargetEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_TargetEntity"}]},"NullableSignals_API_CallRouteEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_CallRouteEntityPaginated"}]},"Nullablecreate_team_escalation_policy":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_team_escalation_policy"}]},"NullableSignals_API_EscalationPolicyEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_EscalationPolicyEntity"}]},"NullableSignals_API_EscalationPolicyStepEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_EscalationPolicyStepEntity"}]},"NullableSignals_API_EscalationPolicyHandoffStepEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_EscalationPolicyHandoffStepEntity"}]},"NullableSignals_API_NotificationPriorityPolicyEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_NotificationPriorityPolicyEntity"}]},"NullableSignals_API_EscalationPolicyEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_EscalationPolicyEntityPaginated"}]},"Nullableupdate_team_escalation_policy":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_team_escalation_policy"}]},"Nullablepreview_team_on_call_schedule":{"nullable":true,"allOf":[{"$ref":"#/definitions/preview_team_on_call_schedule"}]},"NullableSignals_API_OnCallSchedulePreviewEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_OnCallSchedulePreviewEntity"}]},"NullableSignals_API_OnCallSchedulePreviewEntity_RotationPreviewEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_OnCallSchedulePreviewEntity_RotationPreviewEntity"}]},"NullableSignals_API_OnCallSchedulePreviewEntity_OriginalShiftPreviewEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_OnCallSchedulePreviewEntity_OriginalShiftPreviewEntity"}]},"NullableSignals_API_OnCallSchedulePreviewEntity_OverridePreviewEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_OnCallSchedulePreviewEntity_OverridePreviewEntity"}]},"NullableSignals_API_OnCallSchedulePreviewEntity_ShiftPreviewEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_OnCallSchedulePreviewEntity_ShiftPreviewEntity"}]},"Nullablecreate_team_on_call_schedule":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_team_on_call_schedule"}]},"NullableSignals_API_OnCallScheduleEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_OnCallScheduleEntity"}]},"NullableSignals_API_OnCallRotationEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_OnCallRotationEntity"}]},"NullableSignals_API_OnCallStrategyEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_OnCallStrategyEntity"}]},"NullableSignals_API_OnCallRestrictionEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_OnCallRestrictionEntity"}]},"NullableSignals_API_OriginalOnCallShiftEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_OriginalOnCallShiftEntity"}]},"NullableSignals_API_OnCallOverrideEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_OnCallOverrideEntity"}]},"NullableSignals_API_OnCallShiftEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_OnCallShiftEntity"}]},"NullableSignals_API_OnCallScheduleEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_OnCallScheduleEntityPaginated"}]},"Nullableupdate_team_on_call_schedule":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_team_on_call_schedule"}]},"Nullablepreview_on_call_schedule_rotation":{"nullable":true,"allOf":[{"$ref":"#/definitions/preview_on_call_schedule_rotation"}]},"Nullablecreate_on_call_schedule_rotation":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_on_call_schedule_rotation"}]},"Nullablecopy_on_call_schedule_rotation":{"nullable":true,"allOf":[{"$ref":"#/definitions/copy_on_call_schedule_rotation"}]},"Nullableupdate_on_call_schedule_rotation":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_on_call_schedule_rotation"}]},"Nullablecreate_on_call_schedule_rotation_override":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_on_call_schedule_rotation_override"}]},"Nullablecreate_on_call_shift":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_on_call_shift"}]},"Nullableupdate_on_call_shift":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_on_call_shift"}]},"Nullablecreate_team_signal_rule":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_team_signal_rule"}]},"NullableSignals_API_RuleEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_RuleEntity"}]},"NullableSignals_API_RuleEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_RuleEntityPaginated"}]},"Nullableupdate_team_signal_rule":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_team_signal_rule"}]},"Nullablecreate_change":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_change"}]},"NullableChangeEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/ChangeEntity"}]},"Nullableupdate_change":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_change"}]},"Nullablecreate_change_identity":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_change_identity"}]},"NullableChangeIdentityEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/ChangeIdentityEntity"}]},"NullableChangeIdentityEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/ChangeIdentityEntityPaginated"}]},"Nullableupdate_change_identity":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_change_identity"}]},"Nullablecreate_change_event":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_change_event"}]},"NullableChangeEventEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/ChangeEventEntity"}]},"NullableChangeEventSlimEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/ChangeEventSlimEntityPaginated"}]},"NullableChangeEventSlimEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/ChangeEventSlimEntity"}]},"Nullableupdate_change_event":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_change_event"}]},"NullableChangeTypeEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/ChangeTypeEntityPaginated"}]},"NullableChangeTypeEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/ChangeTypeEntity"}]},"NullableEntitlementEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/EntitlementEntityPaginated"}]},"NullableEntitlementEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/EntitlementEntity"}]},"Nullablecreate_incident":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_incident"}]},"NullableIncidentEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/IncidentEntityPaginated"}]},"Nullableupdate_incident":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_incident"}]},"NullableIncidents_AlertEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/Incidents_AlertEntityPaginated"}]},"NullableIncidents_AlertEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Incidents_AlertEntity"}]},"NullableAlerts_AlertEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Alerts_AlertEntity"}]},"NullableAlerts_SirenEventEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Alerts_SirenEventEntity"}]},"NullableAlerts_SirenAlertEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Alerts_SirenAlertEntity"}]},"Nullableupdate_incident_alert_primary":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_incident_alert_primary"}]},"Nullablebulk_update_incident_milestones":{"nullable":true,"allOf":[{"$ref":"#/definitions/bulk_update_incident_milestones"}]},"NullableIncidents_MilestoneEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/Incidents_MilestoneEntityPaginated"}]},"Nullablecreate_incident_change_event":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_incident_change_event"}]},"NullableIncidents_RelatedChangeEventEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Incidents_RelatedChangeEventEntity"}]},"NullableIncidents_RelatedChangeEventEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/Incidents_RelatedChangeEventEntityPaginated"}]},"Nullableupdate_incident_change_event":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_incident_change_event"}]},"Nullablecreate_incident_status_page":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_incident_status_page"}]},"NullableIncidents_StatusPageEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/Incidents_StatusPageEntityPaginated"}]},"Nullablecreate_incident_task_list":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_incident_task_list"}]},"NullableTaskEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/TaskEntity"}]},"Nullablecreate_incident_task":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_incident_task"}]},"NullableTaskEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/TaskEntityPaginated"}]},"Nullableupdate_incident_task":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_incident_task"}]},"Nullableconvert_incident_task":{"nullable":true,"allOf":[{"$ref":"#/definitions/convert_incident_task"}]},"NullableAttachments_LinkEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/Attachments_LinkEntityPaginated"}]},"Nullablecreate_incident_link":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_incident_link"}]},"Nullableupdate_incident_link":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_incident_link"}]},"NullablePublicAPI_V1_Incidents_TranscriptEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/PublicAPI_V1_Incidents_TranscriptEntity"}]},"NullableSimilarIncidentEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/SimilarIncidentEntityPaginated"}]},"NullablePublicAPI_V1_SimilarIncidentEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/PublicAPI_V1_SimilarIncidentEntity"}]},"NullableAttachments_TypedAttachmentEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/Attachments_TypedAttachmentEntityPaginated"}]},"NullableAttachments_TypedAttachmentEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Attachments_TypedAttachmentEntity"}]},"NullableIncidentAttachmentEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/IncidentAttachmentEntity"}]},"NullableIncidentEventEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/IncidentEventEntityPaginated"}]},"NullableIncidentEventEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/IncidentEventEntity"}]},"NullableVotesEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/VotesEntity"}]},"Nullableupdate_vote":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_vote"}]},"Nullableupdate_incident_impact_patch":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_incident_impact_patch"}]},"Nullableupdate_incident_impact_put":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_incident_impact_put"}]},"Nullablecreate_incident_impact":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_incident_impact"}]},"NullableIncidentImpactEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/IncidentImpactEntity"}]},"NullableIncidentImpactEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/IncidentImpactEntityPaginated"}]},"Nullablecreate_incident_note":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_incident_note"}]},"Nullableupdate_incident_note":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_incident_note"}]},"Nullablecreate_incident_chat_message":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_incident_chat_message"}]},"NullableEvent_GenericChatMessageEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Event_GenericChatMessageEntity"}]},"Nullableupdate_incident_chat_message":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_incident_chat_message"}]},"NullableIncidents_RoleAssignmentEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/Incidents_RoleAssignmentEntityPaginated"}]},"Nullablecreate_incident_role_assignment":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_incident_role_assignment"}]},"Nullablecreate_incident_team_assignment":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_incident_team_assignment"}]},"NullableIncidents_RelationshipsEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Incidents_RelationshipsEntity"}]},"NullableIncidents_ShareRetrospectivesResultEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Incidents_ShareRetrospectivesResultEntity"}]},"NullableIncidents_ExportRetrospectiveMarkdownEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Incidents_ExportRetrospectiveMarkdownEntity"}]},"NullableIncidents_ExportRetrospectivesResultEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Incidents_ExportRetrospectivesResultEntity"}]},"NullableIncidents_RetrospectiveEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Incidents_RetrospectiveEntity"}]},"NullableIncidents_RetrospectiveEntity_SectionEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Incidents_RetrospectiveEntity_SectionEntity"}]},"NullableIncidents_RetrospectiveFieldEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Incidents_RetrospectiveFieldEntity"}]},"NullableIncidents_RetrospectiveEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/Incidents_RetrospectiveEntityPaginated"}]},"Nullableupdate_incident_retrospective":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_incident_retrospective"}]},"Nullableupdate_incident_retrospective_field":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_incident_retrospective_field"}]},"NullableIncidentRoleEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/IncidentRoleEntityPaginated"}]},"Nullablecreate_incident_role":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_incident_role"}]},"Nullableupdate_incident_role":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_incident_role"}]},"NullableTagEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/TagEntity"}]},"NullableTagEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/TagEntityPaginated"}]},"Nullablecreate_incident_type":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_incident_type"}]},"NullableIncidentTypeEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/IncidentTypeEntity"}]},"NullableIncidentTypeEntity_TemplateEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/IncidentTypeEntity_TemplateEntity"}]},"NullableIncidentTypeEntity_TemplateImpactEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/IncidentTypeEntity_TemplateImpactEntity"}]},"NullableIncidentTypeEntity_TemplateValuesEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/IncidentTypeEntity_TemplateValuesEntity"}]},"NullableIncidents_RequiredFieldEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Incidents_RequiredFieldEntity"}]},"NullableIncidentTypeEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/IncidentTypeEntityPaginated"}]},"Nullableupdate_incident_type":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_incident_type"}]},"NullableIntegrations_IntegrationEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/Integrations_IntegrationEntityPaginated"}]},"NullableIntegrations_IntegrationEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Integrations_IntegrationEntity"}]},"NullableIntegrations_ConnectionEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Integrations_ConnectionEntity"}]},"NullableIntegrations_IntegrationEntity_LogoEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Integrations_IntegrationEntity_LogoEntity"}]},"NullableFieldMapping_FieldMapEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/FieldMapping_FieldMapEntity"}]},"NullableFieldMapping_MappableFieldEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/FieldMapping_MappableFieldEntity"}]},"NullableIntegrations_AuthedProviderEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/Integrations_AuthedProviderEntityPaginated"}]},"NullablePublicAPI_V1_Integrations_AuthedProviderEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/PublicAPI_V1_Integrations_AuthedProviderEntity"}]},"NullableIntegrations_ConnectionEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/Integrations_ConnectionEntityPaginated"}]},"NullableIntegrations_ConnectionStatusEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Integrations_ConnectionStatusEntity"}]},"NullableIntegrations_Aws_ConnectionEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/Integrations_Aws_ConnectionEntityPaginated"}]},"NullableIntegrations_Aws_ConnectionEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Integrations_Aws_ConnectionEntity"}]},"Nullableupdate_aws_connection":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_aws_connection"}]},"NullableIntegrations_Aws_CloudtrailBatchEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/Integrations_Aws_CloudtrailBatchEntityPaginated"}]},"NullableIntegrations_Aws_CloudtrailBatchEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Integrations_Aws_CloudtrailBatchEntity"}]},"Nullableupdate_aws_cloudtrail_batch":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_aws_cloudtrail_batch"}]},"NullableIntegrations_ConfluenceCloud_SpaceEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Integrations_ConfluenceCloud_SpaceEntity"}]},"NullableIntegrations_Slack_WorkspaceEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Integrations_Slack_WorkspaceEntity"}]},"NullableIntegrations_Slack_UsergroupEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Integrations_Slack_UsergroupEntity"}]},"NullableIntegrations_Statuspage_ConnectionEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/Integrations_Statuspage_ConnectionEntityPaginated"}]},"NullableIntegrations_Statuspage_ConnectionEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Integrations_Statuspage_ConnectionEntity"}]},"NullableIntegrations_Statuspage_ConditionEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Integrations_Statuspage_ConditionEntity"}]},"NullableIntegrations_Statuspage_SeverityEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Integrations_Statuspage_SeverityEntity"}]},"NullableIntegrations_Statuspage_MilestoneMappingEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Integrations_Statuspage_MilestoneMappingEntity"}]},"Nullableupdate_statuspage_connection":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_statuspage_connection"}]},"NullableIntegrations_Statuspage_PageEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Integrations_Statuspage_PageEntity"}]},"NullableIntegrations_Zendesk_SearchTickets_PaginatedEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Integrations_Zendesk_SearchTickets_PaginatedEntity"}]},"NullableIntegrations_Zendesk_SupportIssueEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Integrations_Zendesk_SupportIssueEntity"}]},"NullableIntegrations_Zendesk_SupportIssueEntity_CustomerEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Integrations_Zendesk_SupportIssueEntity_CustomerEntity"}]},"NullableUserEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/UserEntityPaginated"}]},"NullableCurrentUserEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/CurrentUserEntity"}]},"NullablePermissionEntityList":{"nullable":true,"allOf":[{"$ref":"#/definitions/PermissionEntityList"}]},"NullablePublicAPI_V1_PermissionEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/PublicAPI_V1_PermissionEntity"}]},"NullableReportEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/ReportEntity"}]},"NullableReports_BucketEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Reports_BucketEntity"}]},"NullableReports_DataPointEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Reports_DataPointEntity"}]},"Nullablecreate_role":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_role"}]},"NullablePublicAPI_V1_RoleEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/PublicAPI_V1_RoleEntity"}]},"NullableRoleEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/RoleEntityPaginated"}]},"Nullableupdate_role":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_role"}]},"NullableMetrics_TicketFunnelMetricsEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Metrics_TicketFunnelMetricsEntity"}]},"NullableMetrics_TicketFunnelMetricsEntity_DataBucketEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Metrics_TicketFunnelMetricsEntity_DataBucketEntity"}]},"NullableMetrics_TicketFunnelMetricsEntity_DataBucketFilterParamsEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Metrics_TicketFunnelMetricsEntity_DataBucketFilterParamsEntity"}]},"NullableMetrics_TicketFunnelMetricsEntity_GroupingsEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Metrics_TicketFunnelMetricsEntity_GroupingsEntity"}]},"NullableMetrics_RetrospectiveEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Metrics_RetrospectiveEntity"}]},"NullableMetrics_RetrospectiveEntity_DataEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Metrics_RetrospectiveEntity_DataEntity"}]},"NullableMetrics_RetrospectiveEntity_SummaryEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Metrics_RetrospectiveEntity_SummaryEntity"}]},"NullableMetrics_MilestonesFunnelEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Metrics_MilestonesFunnelEntity"}]},"NullableMetrics_MilestonesFunnelEntity_DataBucketEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Metrics_MilestonesFunnelEntity_DataBucketEntity"}]},"NullableMetrics_MilestonesFunnelEntity_DataBucketFilterParamsEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Metrics_MilestonesFunnelEntity_DataBucketFilterParamsEntity"}]},"NullableMetrics_MilestonesFunnelEntity_DataBucketMilestoneCountEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Metrics_MilestonesFunnelEntity_DataBucketMilestoneCountEntity"}]},"NullableMetrics_MilestonesFunnelEntity_ColumnEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Metrics_MilestonesFunnelEntity_ColumnEntity"}]},"NullableMetrics_MilestonesFunnelEntity_GroupingsEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Metrics_MilestonesFunnelEntity_GroupingsEntity"}]},"NullableMetrics_MilestonesFunnelEntity_MetaEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Metrics_MilestonesFunnelEntity_MetaEntity"}]},"NullableMetrics_MetricsEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Metrics_MetricsEntity"}]},"NullableMetrics_MetricsEntity_SortEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Metrics_MetricsEntity_SortEntity"}]},"NullableMetrics_MttxDataEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Metrics_MttxDataEntity"}]},"NullableMetrics_MttxDataEntity_GroupingEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Metrics_MttxDataEntity_GroupingEntity"}]},"NullableMetrics_MttxGroupEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Metrics_MttxGroupEntity"}]},"NullableMetrics_InfrastructureListEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Metrics_InfrastructureListEntity"}]},"NullableMetrics_InfrastructureMetricsEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Metrics_InfrastructureMetricsEntity"}]},"NullableRunbooks_ActionsEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/Runbooks_ActionsEntityPaginated"}]},"NullableRunbooks_ActionsEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Runbooks_ActionsEntity"}]},"NullableRunbooks_ActionConfigEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Runbooks_ActionConfigEntity"}]},"NullableRunbooks_ElementEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Runbooks_ElementEntity"}]},"NullableRunbooks_ElementMarkdownEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Runbooks_ElementMarkdownEntity"}]},"NullableRunbooks_ElementTextareaEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Runbooks_ElementTextareaEntity"}]},"NullableRunbooks_ElementInputEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Runbooks_ElementInputEntity"}]},"NullableRunbooks_ElementDynamicSelectEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Runbooks_ElementDynamicSelectEntity"}]},"NullableRunbooks_ElementDynamicSelectEntity_SelectOptionEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Runbooks_ElementDynamicSelectEntity_SelectOptionEntity"}]},"Nullablecreate_runbook_execution":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_runbook_execution"}]},"NullableRunbooks_ExecutionEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Runbooks_ExecutionEntity"}]},"NullableRunbooks_ExecutionStepEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Runbooks_ExecutionStepEntity"}]},"NullableRunbooks_ExecutionStepExecutionEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Runbooks_ExecutionStepExecutionEntity"}]},"NullableRunbooks_WebhookDeliveryEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Runbooks_WebhookDeliveryEntity"}]},"NullableRunbooks_ExecutionEntity_ExecutedForEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Runbooks_ExecutionEntity_ExecutedForEntity"}]},"NullableRunbooks_ExecutionEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/Runbooks_ExecutionEntityPaginated"}]},"Nullableupdate_runbook_execution_step":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_runbook_execution_step"}]},"Nullablecreate_runbook":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_runbook"}]},"NullableRunbookEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/RunbookEntity"}]},"NullableRunbookStepEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/RunbookStepEntity"}]},"NullableEmptyVotesEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/EmptyVotesEntity"}]},"NullableSlimRunbookEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/SlimRunbookEntityPaginated"}]},"Nullableupdate_runbook":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_runbook"}]},"NullableNuncConnectionEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/NuncConnectionEntityPaginated"}]},"NullableNuncConnectionEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/NuncConnectionEntity"}]},"NullableNuncConditionEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/NuncConditionEntity"}]},"NullableNuncComponentEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/NuncComponentEntity"}]},"NullableNuncComponentGroupEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/NuncComponentGroupEntity"}]},"NullableMediaImageEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/MediaImageEntity"}]},"NullableNuncOidcAuthenticationConfigEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/NuncOidcAuthenticationConfigEntity"}]},"NullableNuncEmailSubscribersEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/NuncEmailSubscribersEntity"}]},"Nullableupdate_nunc_link":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_nunc_link"}]},"Nullableupdate_saved_search":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_saved_search"}]},"NullableSavedSearchEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/SavedSearchEntity"}]},"Nullablecreate_saved_search":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_saved_search"}]},"NullableLifecycles_PhaseEntityList":{"nullable":true,"allOf":[{"$ref":"#/definitions/Lifecycles_PhaseEntityList"}]},"NullableLifecycles_PhaseEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Lifecycles_PhaseEntity"}]},"NullableLifecycles_MilestoneEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Lifecycles_MilestoneEntity"}]},"Nullablecreate_priority":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_priority"}]},"NullablePriorityEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/PriorityEntity"}]},"Nullableupdate_priority":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_priority"}]},"Nullablecreate_severity":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_severity"}]},"NullableSeverityEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/SeverityEntity"}]},"NullableSeverityEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/SeverityEntityPaginated"}]},"Nullableupdate_severity":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_severity"}]},"Nullableupdate_severity_matrix":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_severity_matrix"}]},"NullableSeverityMatrix_SeverityMatrixEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/SeverityMatrix_SeverityMatrixEntity"}]},"NullableSeverityMatrix_ItemEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/SeverityMatrix_ItemEntity"}]},"Nullablecreate_severity_matrix_condition":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_severity_matrix_condition"}]},"Nullableupdate_severity_matrix_condition":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_severity_matrix_condition"}]},"Nullablecreate_severity_matrix_impact":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_severity_matrix_impact"}]},"Nullableupdate_severity_matrix_impact":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_severity_matrix_impact"}]},"Nullablecreate_scheduled_maintenance":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_scheduled_maintenance"}]},"NullableScheduledMaintenanceEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/ScheduledMaintenanceEntity"}]},"NullableScheduledMaintenancesStatusPageEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/ScheduledMaintenancesStatusPageEntity"}]},"NullableScheduledMaintenancesImpactEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/ScheduledMaintenancesImpactEntity"}]},"Nullableupdate_scheduled_maintenance":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_scheduled_maintenance"}]},"NullableScheduleEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/ScheduleEntityPaginated"}]},"NullableInfrastructureSearchEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/InfrastructureSearchEntity"}]},"Nullablecreate_nunc_subscription":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_nunc_subscription"}]},"NullableNunc_NuncSubscription":{"nullable":true,"allOf":[{"$ref":"#/definitions/Nunc_NuncSubscription"}]},"Nullablecreate_status_update_template":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_status_update_template"}]},"NullableStatusUpdateTemplateEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/StatusUpdateTemplateEntity"}]},"Nullableupdate_status_update_template":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_status_update_template"}]},"Nullableupdate_custom_field_definition":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_custom_field_definition"}]},"NullableOrganizations_CustomFieldDefinitionEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Organizations_CustomFieldDefinitionEntity"}]},"Nullablecreate_custom_field_definition":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_custom_field_definition"}]},"Nullablecreate_post_mortem_report":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_post_mortem_report"}]},"NullablePostMortems_PostMortemReportEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/PostMortems_PostMortemReportEntity"}]},"NullablePostMortems_QuestionEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/PostMortems_QuestionEntity"}]},"NullableCalendars_EventEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Calendars_EventEntity"}]},"NullablePostMortems_PostMortemReportEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/PostMortems_PostMortemReportEntityPaginated"}]},"Nullableupdate_post_mortem_report":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_post_mortem_report"}]},"Nullablecreate_post_mortem_reason":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_post_mortem_reason"}]},"NullablePostMortems_ReasonEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/PostMortems_ReasonEntity"}]},"NullablePostMortems_ReasonEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/PostMortems_ReasonEntityPaginated"}]},"Nullableupdate_post_mortem_reason":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_post_mortem_reason"}]},"Nullablereorder_post_mortem_reasons":{"nullable":true,"allOf":[{"$ref":"#/definitions/reorder_post_mortem_reasons"}]},"Nullablepublish_post_mortem_report":{"nullable":true,"allOf":[{"$ref":"#/definitions/publish_post_mortem_report"}]},"Nullableupdate_post_mortem_field":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_post_mortem_field"}]},"NullablePostMortems_SectionFieldEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/PostMortems_SectionFieldEntity"}]},"Nullableupdate_post_mortem_questions":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_post_mortem_questions"}]},"NullablePostMortems_QuestionTypeEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/PostMortems_QuestionTypeEntity"}]},"NullablePostMortems_QuestionTypeEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/PostMortems_QuestionTypeEntityPaginated"}]},"NullableRetrospectives_TemplateEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Retrospectives_TemplateEntity"}]},"NullableRetrospectives_TemplateEntity_IncidentSectionEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Retrospectives_TemplateEntity_IncidentSectionEntity"}]},"NullableRetrospectives_FieldEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Retrospectives_FieldEntity"}]},"NullableRetrospectives_IndexTemplateEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/Retrospectives_IndexTemplateEntityPaginated"}]},"NullableRetrospectives_IndexTemplateEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Retrospectives_IndexTemplateEntity"}]},"NullableRetrospectives_TemplateEntity_ReportElementEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Retrospectives_TemplateEntity_ReportElementEntity"}]},"NullableAlerts_AlertEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/Alerts_AlertEntityPaginated"}]},"NullableAlerts_ProcessingLogEntryEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/Alerts_ProcessingLogEntryEntityPaginated"}]},"NullableAlerts_ProcessingLogEntryEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Alerts_ProcessingLogEntryEntity"}]},"Nullablecreate_signals_page":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_signals_page"}]},"Nullablecreate_ticket":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_ticket"}]},"Nullableupdate_ticket":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_ticket"}]},"NullableTicketing_Projects_ProjectListItemEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Ticketing_Projects_ProjectListItemEntity"}]},"NullableTicketing_ProjectConfigEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Ticketing_ProjectConfigEntity"}]},"NullableTicketing_ProjectFieldMapEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Ticketing_ProjectFieldMapEntity"}]},"NullableTicketing_ProjectFieldMapBodyEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Ticketing_ProjectFieldMapBodyEntity"}]},"NullableTicketing_ProjectFieldMapExternalValueEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Ticketing_ProjectFieldMapExternalValueEntity"}]},"NullableTicketing_ProjectFieldMapCasesEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Ticketing_ProjectFieldMapCasesEntity"}]},"NullableTicketing_ProjectFieldMapCasesElseEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Ticketing_ProjectFieldMapCasesElseEntity"}]},"NullableTicketing_FieldMaps_MappableFieldEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Ticketing_FieldMaps_MappableFieldEntity"}]},"NullableTicketing_ProjectInboundMappableFieldEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Ticketing_ProjectInboundMappableFieldEntity"}]},"NullableTicketing_ProjectInboundFieldMapEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Ticketing_ProjectInboundFieldMapEntity"}]},"Nullablecreate_ticketing_priority":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_ticketing_priority"}]},"Nullableupdate_ticketing_priority":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_ticketing_priority"}]},"NullableTicketing_TicketFormConfigurationEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Ticketing_TicketFormConfigurationEntity"}]},"Nullablecreate_ticketing_custom_definition":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_ticketing_custom_definition"}]},"NullableOrganizations_TicketingCustomFieldDefinitionEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Organizations_TicketingCustomFieldDefinitionEntity"}]},"Nullableupdate_ticketing_custom_definition":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_ticketing_custom_definition"}]},"Nullablecreate_task_list":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_task_list"}]},"NullableTaskListEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/TaskListEntity"}]},"NullableTaskListItemEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/TaskListItemEntity"}]},"Nullableupdate_task_list":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_task_list"}]},"Nullablepatch_scim_group":{"nullable":true,"allOf":[{"$ref":"#/definitions/patch_scim_group"}]},"Nullableupdate_scim_group":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_scim_group"}]},"Nullablecreate_scim_group":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_scim_group"}]},"Nullablepatch_scim_user":{"nullable":true,"allOf":[{"$ref":"#/definitions/patch_scim_user"}]},"Nullableupdate_scim_user":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_scim_user"}]},"Nullablecreate_scim_user":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_scim_user"}]},"Nullableingest_catalog_data":{"nullable":true,"allOf":[{"$ref":"#/definitions/ingest_catalog_data"}]},"NullableImports_ImportEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Imports_ImportEntity"}]},"Nullablecreate_checklist_template":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_checklist_template"}]},"NullableChecklistTemplateEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/ChecklistTemplateEntityPaginated"}]},"Nullableupdate_checklist_template":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_checklist_template"}]},"NullablePublicAPI_V1_BootstrapEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/PublicAPI_V1_BootstrapEntity"}]},"NullablePublicAPI_V1_FormConfigurations_SelectedValueEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/PublicAPI_V1_FormConfigurations_SelectedValueEntity"}]},"NullableFormConfigurationEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/FormConfigurationEntity"}]},"Nullablecreate_comment_reaction":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_comment_reaction"}]},"Nullableupdate_comment":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_comment"}]},"Nullablecreate_comment":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_comment"}]},"Nullableupdate_signals_alert":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_signals_alert"}]},"NullableAlerts_SignalAlertEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Alerts_SignalAlertEntity"}]},"NullableSignals_API_Analytics_TimeseriesPointEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_Analytics_TimeseriesPointEntity"}]},"NullableSignals_API_Analytics_TimeseriesPointEntity_MetricEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_Analytics_TimeseriesPointEntity_MetricEntity"}]},"NullableSignals_API_Analytics_GroupedMetricsEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_Analytics_GroupedMetricsEntity"}]},"NullableSignals_API_Analytics_GroupedMetricsEntity_MetricEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_Analytics_GroupedMetricsEntity_MetricEntity"}]},"NullableSignals_API_Analytics_MttxMetricsEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_Analytics_MttxMetricsEntity"}]},"NullableSignals_API_Analytics_MttxMetricsEntity_MetricEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_Analytics_MttxMetricsEntity_MetricEntity"}]},"NullableSignals_API_Analytics_NoiseMetricsEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_Analytics_NoiseMetricsEntity"}]},"NullableSignals_API_Analytics_NoiseMetricsEntity_MetricEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_Analytics_NoiseMetricsEntity_MetricEntity"}]},"Nullableupdate_call_route":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_call_route"}]},"Nullablecreate_signals_event_source":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_signals_event_source"}]},"NullableSignals_API_TransposerEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_TransposerEntity"}]},"NullableSignals_API_TransposerListEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_TransposerListEntity"}]},"NullableSignals_API_HackerModeEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_HackerModeEntity"}]},"Nullablecreate_signals_alert_grouping_configuration":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_signals_alert_grouping_configuration"}]},"NullableSignals_API_GroupingEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_GroupingEntity"}]},"NullableSignals_API_GroupingEntity_StrategyEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_GroupingEntity_StrategyEntity"}]},"NullableSignals_API_GroupingEntity_StrategyEntity_SubstringEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_GroupingEntity_StrategyEntity_SubstringEntity"}]},"NullableSignals_API_GroupingEntity_ActionEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_GroupingEntity_ActionEntity"}]},"NullableSignals_API_GroupingEntity_ActionEntity_FyiEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_GroupingEntity_ActionEntity_FyiEntity"}]},"NullableSignals_API_GroupingEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_GroupingEntityPaginated"}]},"Nullableupdate_signals_alert_grouping_configuration":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_signals_alert_grouping_configuration"}]},"Nullablecreate_signals_email_target":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_signals_email_target"}]},"NullableSignals_API_EmailTargetEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_EmailTargetEntity"}]},"NullableSignals_API_EmailTargetEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_EmailTargetEntityPaginated"}]},"Nullableupdate_signals_email_target":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_signals_email_target"}]},"Nullablecreate_signals_webhook_target":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_signals_webhook_target"}]},"NullableSignals_API_WebhookTargetEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_WebhookTargetEntity"}]},"NullableSignals_API_WebhookTargetEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_WebhookTargetEntityPaginated"}]},"Nullableupdate_signals_webhook_target":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_signals_webhook_target"}]},"Nullablecreate_signals_heartbeat_endpoint_configuration":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_signals_heartbeat_endpoint_configuration"}]},"Nullableupdate_signals_heartbeat_endpoint_configuration":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_signals_heartbeat_endpoint_configuration"}]},"NullableSignals_API_NotificationPolicyItemEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_NotificationPolicyItemEntity"}]},"NullableSignals_API_NotificationPolicyItemEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_NotificationPolicyItemEntityPaginated"}]},"NullableSignals_API_UserNotificationSettingEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_UserNotificationSettingEntityPaginated"}]},"NullableSignals_API_UserNotificationSettingEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_UserNotificationSettingEntity"}]},"NullableSignals_API_DestinationEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_DestinationEntity"}]},"NullableSignals_API_IngestKeyEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_IngestKeyEntity"}]},"Nullabledebug_signals_expression":{"nullable":true,"allOf":[{"$ref":"#/definitions/debug_signals_expression"}]},"NullableSignals_API_OrganizationOnCallScheduleEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_OrganizationOnCallScheduleEntityPaginated"}]},"NullableSignals_API_OrganizationOnCallScheduleEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_OrganizationOnCallScheduleEntity"}]},"NullableSignals_API_OrganizationOnCallRotationEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Signals_API_OrganizationOnCallRotationEntity"}]},"Nullablecreate_webhook":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_webhook"}]},"NullableWebhooks_Entities_WebhookEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Webhooks_Entities_WebhookEntity"}]},"NullableWebhooks_Entities_WebhookEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/Webhooks_Entities_WebhookEntityPaginated"}]},"NullableWebhooks_Entities_DeliveryEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/Webhooks_Entities_DeliveryEntityPaginated"}]},"NullableWebhooks_Entities_DeliveryEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Webhooks_Entities_DeliveryEntity"}]},"Nullableupdate_webhook":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_webhook"}]},"NullableAI_Entities_IncidentSummaryEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/AI_Entities_IncidentSummaryEntity"}]},"NullableAI_Entities_PreferencesEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/AI_Entities_PreferencesEntity"}]},"NullableAudiences_Entities_AudienceEntityPaginated":{"nullable":true,"allOf":[{"$ref":"#/definitions/Audiences_Entities_AudienceEntityPaginated"}]},"NullableAudiences_Entities_AudienceEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Audiences_Entities_AudienceEntity"}]},"NullableAudiences_Entities_DetailEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Audiences_Entities_DetailEntity"}]},"Nullablecreate_audience":{"nullable":true,"allOf":[{"$ref":"#/definitions/create_audience"}]},"NullableAudiences_Entities_AudienceShowEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Audiences_Entities_AudienceShowEntity"}]},"NullableAudiences_Entities_SettingEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Audiences_Entities_SettingEntity"}]},"NullableAudiences_Entities_SettingEntity_IncidentDataSettingEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Audiences_Entities_SettingEntity_IncidentDataSettingEntity"}]},"NullableAudiences_Entities_SettingEntity_HighValueEventsSettingEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Audiences_Entities_SettingEntity_HighValueEventsSettingEntity"}]},"NullableAudiences_Entities_SettingEntity_MediumValueEventsSettingEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Audiences_Entities_SettingEntity_MediumValueEventsSettingEntity"}]},"Nullableupdate_audience":{"nullable":true,"allOf":[{"$ref":"#/definitions/update_audience"}]},"NullableAudiences_Entities_AudienceSummariesEntity":{"nullable":true,"allOf":[{"$ref":"#/definitions/Audiences_Entities_AudienceSummariesEntity"}]}}}