f2332a7682
## Rewrapping - Calendly - Airtable - Squareup - PagerDuty - Trello - Miro --------- Co-authored-by: Francisco Liberal <francisco@arcade.dev>
193 lines
52 KiB
JSON
193 lines
52 KiB
JSON
{
|
|
"name": "CreateNewService",
|
|
"fully_qualified_name": "PagerdutyApi.CreateNewService@2.0.0",
|
|
"description": "Create a new service for incident management.\n\nUse this tool to create a new service within an account for incident management, representing an application, component, or team. Ensure the status is set to 'active' during creation. This tool is essential for managing services and handling incidents efficiently.",
|
|
"toolkit": {
|
|
"name": "ArcadePagerdutyApi",
|
|
"description": null,
|
|
"version": "2.0.0"
|
|
},
|
|
"input": {
|
|
"parameters": [
|
|
{
|
|
"name": "accept_header",
|
|
"required": true,
|
|
"description": "The `Accept` header used for specifying the API version.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The `Accept` header is used as a versioning header."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "Accept"
|
|
},
|
|
{
|
|
"name": "content_type_header",
|
|
"required": true,
|
|
"description": "Specify the content type of the request. Must be 'application/json'.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": [
|
|
"application/json"
|
|
],
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": ""
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "Content-Type"
|
|
},
|
|
{
|
|
"name": "service_details",
|
|
"required": false,
|
|
"description": "JSON object containing details about the service to be created, such as name, description, type, etc.",
|
|
"value_schema": {
|
|
"val_type": "json",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": {
|
|
"service": {
|
|
"val_type": "json",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": null
|
|
}
|
|
},
|
|
"inner_properties": null,
|
|
"description": "The service to be created"
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "requestBody"
|
|
}
|
|
]
|
|
},
|
|
"output": {
|
|
"description": "Response from the API endpoint 'createService'.",
|
|
"available_modes": [
|
|
"value",
|
|
"error",
|
|
"null"
|
|
],
|
|
"value_schema": {
|
|
"val_type": "json",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": null
|
|
}
|
|
},
|
|
"requirements": {
|
|
"authorization": {
|
|
"provider_id": "arcade-pagerduty",
|
|
"provider_type": "oauth2",
|
|
"id": null,
|
|
"oauth2": null
|
|
},
|
|
"secrets": null,
|
|
"metadata": null
|
|
},
|
|
"deprecation_message": null,
|
|
"metadata": {
|
|
"object_type": "api_wrapper_tool",
|
|
"version": "1.1.0",
|
|
"description": "Tools that enable LLMs to interact directly with the Pagerduty API."
|
|
},
|
|
"http_endpoint": {
|
|
"metadata": {
|
|
"object_type": "http_endpoint",
|
|
"version": "1.2.0",
|
|
"description": ""
|
|
},
|
|
"url": "https://api.pagerduty.com/services",
|
|
"http_method": "POST",
|
|
"headers": {},
|
|
"parameters": [
|
|
{
|
|
"name": "Accept",
|
|
"tool_parameter_name": "accept_header",
|
|
"description": "The `Accept` header is used as a versioning header.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The `Accept` header is used as a versioning header."
|
|
},
|
|
"accepted_as": "header",
|
|
"required": true,
|
|
"deprecated": false,
|
|
"default": "application/vnd.pagerduty+json;version=2",
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "Content-Type",
|
|
"tool_parameter_name": "content_type_header",
|
|
"description": "",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": [
|
|
"application/json"
|
|
],
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": ""
|
|
},
|
|
"accepted_as": "header",
|
|
"required": true,
|
|
"deprecated": false,
|
|
"default": "application/json",
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "requestBody",
|
|
"tool_parameter_name": "service_details",
|
|
"description": "The service to be created",
|
|
"value_schema": {
|
|
"val_type": "json",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": {
|
|
"service": {
|
|
"val_type": "json",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": null
|
|
}
|
|
},
|
|
"inner_properties": null,
|
|
"description": "The service to be created"
|
|
},
|
|
"accepted_as": "body",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
}
|
|
],
|
|
"documentation_urls": [],
|
|
"secrets": [
|
|
{
|
|
"arcade_key": "auth_token",
|
|
"parameter_name": "Authorization",
|
|
"accepted_as": "header",
|
|
"formatted_value": "Bearer {authorization}",
|
|
"description": "The OAuth token to use for authentication.",
|
|
"is_auth_token": true
|
|
}
|
|
],
|
|
"request_body_spec": "{\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"service\": {\n \"allOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"readOnly\": true\n },\n \"summary\": {\n \"type\": \"string\",\n \"nullable\": true,\n \"readOnly\": true,\n \"description\": \"A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.\"\n },\n \"type\": {\n \"type\": \"string\",\n \"readOnly\": true,\n \"description\": \"A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.\"\n },\n \"self\": {\n \"type\": \"string\",\n \"nullable\": true,\n \"readOnly\": true,\n \"format\": \"url\",\n \"description\": \"the API show URL at which the object is accessible\"\n },\n \"html_url\": {\n \"type\": \"string\",\n \"nullable\": true,\n \"readOnly\": true,\n \"format\": \"url\",\n \"description\": \"a URL at which the entity is uniquely displayed in the Web app\"\n }\n }\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"description\": \"The type of object being created.\",\n \"default\": \"service\",\n \"enum\": [\n \"service\"\n ]\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"The name of the service.\"\n },\n \"description\": {\n \"type\": \"string\",\n \"description\": \"The user-provided description of the service.\"\n },\n \"auto_resolve_timeout\": {\n \"type\": \"integer\",\n \"description\": \"Time in seconds that an incident is automatically resolved if left open for that long. Value is `null` if the feature is disabled. Value must not be negative. Setting this field to `0`, `null` (or unset in POST request) will disable the feature.\",\n \"default\": 14400\n },\n \"acknowledgement_timeout\": {\n \"type\": \"integer\",\n \"description\": \"Time in seconds that an incident changes to the Triggered State after being Acknowledged. Value is `null` if the feature is disabled. Value must not be negative. Setting this field to `0`, `null` (or unset in POST request) will disable the feature.\",\n \"default\": 1800\n },\n \"created_at\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"description\": \"The date/time when this service was created\",\n \"readOnly\": true\n },\n \"status\": {\n \"type\": \"string\",\n \"description\": \"The current state of the Service. Valid statuses are:\\n\\n\\n- `active`: The service is enabled and has no open incidents. This is the only status a service can be created with.\\n- `warning`: The service is enabled and has one or more acknowledged incidents.\\n- `critical`: The service is enabled and has one or more triggered incidents.\\n- `maintenance`: The service is under maintenance, no new incidents will be triggered during maintenance mode.\\n- `disabled`: The service is disabled and will not have any new triggered incidents.\\n\",\n \"enum\": [\n \"active\",\n \"warning\",\n \"critical\",\n \"maintenance\",\n \"disabled\"\n ],\n \"default\": \"active\"\n },\n \"last_incident_timestamp\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"description\": \"The date/time when the most recent incident was created for this service.\",\n \"readOnly\": true\n },\n \"escalation_policy\": {\n \"allOf\": [\n {\n \"allOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"readOnly\": true\n },\n \"summary\": {\n \"type\": \"string\",\n \"nullable\": true,\n \"readOnly\": true,\n \"description\": \"A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.\"\n },\n \"type\": {\n \"type\": \"string\",\n \"readOnly\": true,\n \"description\": \"A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.\"\n },\n \"self\": {\n \"type\": \"string\",\n \"nullable\": true,\n \"readOnly\": true,\n \"format\": \"url\",\n \"description\": \"the API show URL at which the object is accessible\"\n },\n \"html_url\": {\n \"type\": \"string\",\n \"nullable\": true,\n \"readOnly\": true,\n \"format\": \"url\",\n \"description\": \"a URL at which the entity is uniquely displayed in the Web app\"\n }\n }\n },\n {\n \"type\": \"object\",\n \"required\": [\n \"type\",\n \"id\"\n ]\n }\n ]\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"escalation_policy_reference\"\n ]\n }\n }\n }\n ]\n },\n \"response_play\": {\n \"deprecated\": true,\n \"description\": \"Response plays associated with this service.\"\n },\n \"teams\": {\n \"type\": \"array\",\n \"description\": \"The set of teams associated with this service.\",\n \"items\": {\n \"allOf\": [\n {\n \"allOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"readOnly\": true\n },\n \"summary\": {\n \"type\": \"string\",\n \"nullable\": true,\n \"readOnly\": true,\n \"description\": \"A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.\"\n },\n \"type\": {\n \"type\": \"string\",\n \"readOnly\": true,\n \"description\": \"A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.\"\n },\n \"self\": {\n \"type\": \"string\",\n \"nullable\": true,\n \"readOnly\": true,\n \"format\": \"url\",\n \"description\": \"the API show URL at which the object is accessible\"\n },\n \"html_url\": {\n \"type\": \"string\",\n \"nullable\": true,\n \"readOnly\": true,\n \"format\": \"url\",\n \"description\": \"a URL at which the entity is uniquely displayed in the Web app\"\n }\n }\n },\n {\n \"type\": \"object\",\n \"required\": [\n \"type\",\n \"id\"\n ]\n }\n ]\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"team_reference\"\n ]\n }\n }\n }\n ]\n },\n \"readOnly\": true\n },\n \"integrations\": {\n \"type\": \"array\",\n \"description\": \"An array containing Integration objects that belong to this service. If `integrations` is passed as an argument, these are full objects - otherwise, these are references.\",\n \"items\": {\n \"allOf\": [\n {\n \"allOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"readOnly\": true\n },\n \"summary\": {\n \"type\": \"string\",\n \"nullable\": true,\n \"readOnly\": true,\n \"description\": \"A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.\"\n },\n \"type\": {\n \"type\": \"string\",\n \"readOnly\": true,\n \"description\": \"A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.\"\n },\n \"self\": {\n \"type\": \"string\",\n \"nullable\": true,\n \"readOnly\": true,\n \"format\": \"url\",\n \"description\": \"the API show URL at which the object is accessible\"\n },\n \"html_url\": {\n \"type\": \"string\",\n \"nullable\": true,\n \"readOnly\": true,\n \"format\": \"url\",\n \"description\": \"a URL at which the entity is uniquely displayed in the Web app\"\n }\n }\n },\n {\n \"type\": \"object\",\n \"required\": [\n \"type\",\n \"id\"\n ]\n }\n ]\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"aws_cloudwatch_inbound_integration_reference\",\n \"cloudkick_inbound_integration_reference\",\n \"event_transformer_api_inbound_integration_reference\",\n \"generic_email_inbound_integration_reference\",\n \"generic_events_api_inbound_integration_reference\",\n \"keynote_inbound_integration_reference\",\n \"nagios_inbound_integration_reference\",\n \"pingdom_inbound_integration_reference\",\n \"sql_monitor_inbound_integration_reference\",\n \"events_api_v2_inbound_integration_reference\",\n \"inbound_integration_reference\"\n ]\n }\n }\n }\n ]\n },\n \"readOnly\": true\n },\n \"incident_urgency_rule\": {\n \"allOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"description\": \"The type of incident urgency: whether it's constant, or it's dependent on the support hours.\",\n \"default\": \"constant\",\n \"enum\": [\n \"constant\",\n \"use_support_hours\"\n ]\n },\n \"urgency\": {\n \"type\": \"string\",\n \"description\": \"The incidents' urgency, if type is constant.\",\n \"default\": \"high\",\n \"enum\": [\n \"low\",\n \"high\",\n \"severity_based\"\n ]\n }\n }\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"during_support_hours\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"description\": \"The type of incident urgency: whether it's constant, or it's dependent on the support hours.\",\n \"default\": \"constant\",\n \"enum\": [\n \"constant\",\n \"use_support_hours\"\n ]\n },\n \"urgency\": {\n \"type\": \"string\",\n \"description\": \"The incidents' urgency, if type is constant.\",\n \"default\": \"high\",\n \"enum\": [\n \"low\",\n \"high\",\n \"severity_based\"\n ]\n }\n }\n },\n \"outside_support_hours\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"description\": \"The type of incident urgency: whether it's constant, or it's dependent on the support hours.\",\n \"default\": \"constant\",\n \"enum\": [\n \"constant\",\n \"use_support_hours\"\n ]\n },\n \"urgency\": {\n \"type\": \"string\",\n \"description\": \"The incidents' urgency, if type is constant.\",\n \"default\": \"high\",\n \"enum\": [\n \"low\",\n \"high\",\n \"severity_based\"\n ]\n }\n }\n }\n }\n }\n ]\n },\n \"support_hours\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"description\": \"The type of support hours\",\n \"default\": \"fixed_time_per_day\",\n \"enum\": [\n \"fixed_time_per_day\"\n ]\n },\n \"time_zone\": {\n \"type\": \"string\",\n \"format\": \"activesupport-time-zone\",\n \"description\": \"The time zone for the support hours\"\n },\n \"days_of_week\": {\n \"type\": \"array\",\n \"readOnly\": true,\n \"items\": {\n \"type\": \"integer\",\n \"readOnly\": true,\n \"description\": \"The days of the week (1 through 7, for Monday through Sunday)\"\n }\n },\n \"start_time\": {\n \"type\": \"string\",\n \"format\": \"time\",\n \"description\": \"The support hours' starting time of day (date portion is ignored)\"\n },\n \"end_time\": {\n \"type\": \"string\",\n \"format\": \"time\",\n \"description\": \"The support hours' ending time of day (date portion is ignored)\"\n }\n }\n },\n \"scheduled_actions\": {\n \"type\": \"array\",\n \"description\": \"An array containing scheduled actions for the service.\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"description\": \"The type of schedule action. Must be set to urgency_change.\",\n \"enum\": [\n \"urgency_change\"\n ]\n },\n \"at\": {\n \"type\": \"object\",\n \"description\": \"Represents when scheduled action will occur.\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"description\": \"Must be set to named_time.\",\n \"enum\": [\n \"named_time\"\n ]\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Designates either the start or the end of support hours.\",\n \"enum\": [\n \"support_hours_start\",\n \"support_hours_end\"\n ]\n }\n },\n \"required\": [\n \"type\",\n \"name\"\n ]\n },\n \"to_urgency\": {\n \"type\": \"string\",\n \"description\": \"Urgency level. Must be set to high.\",\n \"enum\": [\n \"high\"\n ]\n }\n },\n \"required\": [\n \"type\",\n \"at\",\n \"to_urgency\"\n ]\n }\n },\n \"addons\": {\n \"type\": \"array\",\n \"description\": \"The array of Add-ons associated with this service.\",\n \"items\": {\n \"allOf\": [\n {\n \"allOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"readOnly\": true\n },\n \"summary\": {\n \"type\": \"string\",\n \"nullable\": true,\n \"readOnly\": true,\n \"description\": \"A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier.\"\n },\n \"type\": {\n \"type\": \"string\",\n \"readOnly\": true,\n \"description\": \"A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference.\"\n },\n \"self\": {\n \"type\": \"string\",\n \"nullable\": true,\n \"readOnly\": true,\n \"format\": \"url\",\n \"description\": \"the API show URL at which the object is accessible\"\n },\n \"html_url\": {\n \"type\": \"string\",\n \"nullable\": true,\n \"readOnly\": true,\n \"format\": \"url\",\n \"description\": \"a URL at which the entity is uniquely displayed in the Web app\"\n }\n }\n },\n {\n \"type\": \"object\",\n \"required\": [\n \"type\",\n \"id\"\n ]\n }\n ]\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"src\": {\n \"type\": \"string\",\n \"format\": \"url\",\n \"description\": \"The URL source of the Addon\"\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"The user entered name of the Addon.\"\n },\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"full_page_addon_reference\",\n \"incident_show_addon_reference\"\n ]\n }\n }\n }\n ]\n },\n \"readOnly\": true\n },\n \"alert_creation\": {\n \"type\": \"string\",\n \"deprecated\": true,\n \"description\": \"Whether a service creates only incidents, or both alerts and incidents. A service must create alerts in order to enable incident merging.\\n* \\\"create_incidents\\\" - The service will create one incident and zero alerts for each incoming event.\\n* \\\"create_alerts_and_incidents\\\" - The service will create one incident and one associated alert for each incoming event.\\nThis attribute has been deprecated as all services will be migrated to use alerts and incidents. Afterward, the incident only service setting will no longer be available. For details, please refer to the knowledge base: https://support.pagerduty.com/docs/alerts#enable-and-disable-alerts-on-a-service.\\n\",\n \"enum\": [\n \"create_incidents\",\n \"create_alerts_and_incidents\"\n ],\n \"default\": \"create_alerts_and_incidents\"\n },\n \"alert_grouping_parameters\": {\n \"description\": \"Alert Grouping Parameters\",\n \"deprecated\": true,\n \"oneOf\": [\n {\n \"type\": \"object\",\n \"title\": \"Alert Grouping Parameters\",\n \"deprecated\": true,\n \"description\": \"Defines how alerts on this service will be automatically grouped into incidents. Note that the alert grouping features are available only on certain plans. To turn grouping off set the type to null.\\nThis attribute has been deprecated and configuration via [Alert Grouping Settings](https://developer.pagerduty.com/api-reference/587edbc8ff416-create-an-alert-grouping-setting) resource is encouraged.\\n\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"nullable\": true,\n \"enum\": [\n \"time\",\n \"intelligent\",\n \"content_based\",\n null\n ]\n },\n \"config\": {\n \"oneOf\": [\n {\n \"type\": \"object\",\n \"title\": \"Intelligent Alert Grouping\",\n \"description\": \"The configuration for Intelligent Alert Grouping. Note that this configuration is only available for certain plans.\",\n \"properties\": {\n \"time_window\": {\n \"type\": \"integer\",\n \"minimum\": 300,\n \"maximum\": 3600,\n \"description\": \"The maximum amount of time allowed between Alerts. Any Alerts arriving greater than `time_window` seconds apart will not be grouped together. This is a rolling time window and is counted from the most recently grouped alert. The window is extended every time a new alert is added to the group, up to 24 hours. To use the \\\"recommended_time_window,\\\" set the value to 0, otherwise the value must be between 300 and 3600.\"\n },\n \"recommended_time_window\": {\n \"readOnly\": true,\n \"type\": \"integer\",\n \"description\": \"In order to ensure your Service has the optimal grouping window, we use data science to calculate your Service`s average Alert inter-arrival time. We encourage customer`s to use this value, please set `time_window` to 0 to use the `recommended_time_window`.\"\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Time Grouping\",\n \"description\": \"The configuration for Time Based Alert Grouping\",\n \"properties\": {\n \"timeout\": {\n \"type\": \"integer\",\n \"minimum\": 1,\n \"maximum\": 1440,\n \"description\": \"The duration in minutes within which to automatically group incoming Alerts. To continue grouping Alerts until the Incident is resolved, set this value to 0.\"\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Content Only Grouping\",\n \"description\": \"The configuration for Content Based Alert Grouping\",\n \"properties\": {\n \"aggregate\": {\n \"type\": \"string\",\n \"description\": \"Whether Alerts should be grouped if `all` or `any` specified fields match. If `all` is selected, an exact match on every specified field name must occur for Alerts to be grouped. If `any` is selected, Alerts will be grouped when there is an exact match on at least one of the specified fields.\",\n \"enum\": [\n \"all, any\"\n ]\n },\n \"fields\": {\n \"type\": \"array\",\n \"description\": \"An array of strings which represent the fields with which to group against. Depending on the aggregate, Alerts will group if some or all the fields match.\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"time_window\": {\n \"type\": \"integer\",\n \"minimum\": 300,\n \"maximum\": 86400,\n \"description\": \"The maximum amount of time allowed between Alerts. Any Alerts arriving greater than `time_window` seconds apart will not be grouped together. This is a rolling time window up to 24 hours and is counted from the most recently grouped alert. The window is extended every time a new alert is added to the group, up to 24 hours (24 hours only applies to single-service settings). To use the \\\"recommended_time_window,\\\" set the value to 0, otherwise the value must be between 300 <= time_window <= 3600 or 86400(i.e. 24 hours).\"\n },\n \"recommended_time_window\": {\n \"readOnly\": true,\n \"type\": \"integer\",\n \"description\": \"In order to ensure your Service has the optimal grouping window, we use data science to calculate your Service's average Alert inter-arrival time. We encourage customer's to use this value, please set `time_window` to 0 to use the `recommended_time_window`.\"\n }\n }\n }\n ]\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Alert Grouping Settings Reference\",\n \"deprecated\": true,\n \"description\": \"When a service uses alert grouping configuration that is unsupported via the services api, and can only be configured via the [Alert Grouping Settings API](https://developer.pagerduty.com/api-reference/587edbc8ff416-create-an-alert-grouping-setting). The reference object includes the new location details for the service's Alert Grouping Setting. When an `alert_grouping_settings_reference` is included in a create or update request it will be ignored and no changes are applied to the service.\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"readOnly\": true,\n \"description\": \"id of the related alert grouping setting\"\n },\n \"type\": {\n \"readOnly\": true,\n \"type\": \"string\",\n \"description\": \"type of reference eg. alert_grouping_setting_reference\"\n },\n \"summary\": {\n \"readOnly\": true,\n \"type\": \"string\",\n \"description\": \"an explanation of this reference\"\n },\n \"self\": {\n \"readOnly\": true,\n \"type\": \"string\",\n \"description\": \"link to api endpoint for this setting\"\n },\n \"html_url\": {\n \"readOnly\": true,\n \"type\": \"string\",\n \"description\": \"link to the ui page to edit the setting\"\n }\n }\n }\n ]\n },\n \"alert_grouping\": {\n \"type\": \"string\",\n \"deprecated\": true,\n \"description\": \"Defines how alerts on this service will be automatically grouped into incidents. Note that the alert grouping features are available only on certain plans. There are three available options:\\n* null - No alert grouping on the service. Each alert will create a separate incident;\\n* \\\"time\\\" - All alerts within a specified duration will be grouped into the same incident. This duration is set in the `alert_grouping_timeout` setting (described below). Available on Standard, Enterprise, and Event Intelligence plans;\\n* \\\"intelligent\\\" - Alerts will be intelligently grouped based on a machine learning model that looks at the alert summary, timing, and the history of grouped alerts. Available on Enterprise and Event Intelligence plans\\n\\nThis attribute has been deprecated and configuration via [Alert Grouping Settings](https://developer.pagerduty.com/api-reference/587edbc8ff416-create-an-alert-grouping-setting) resource is encouraged.\\n\",\n \"enum\": [\n \"time\",\n \"intelligent\"\n ]\n },\n \"alert_grouping_timeout\": {\n \"type\": \"integer\",\n \"deprecated\": true,\n \"description\": \"The duration in minutes within which to automatically group incoming alerts. This setting applies only when `alert_grouping` is set to `time`. To continue grouping alerts until the Incident is resolved, set this value to `0`.\\n\\nThis attribute has been deprecated and configuration via [Alert Grouping Settings](https://developer.pagerduty.com/api-reference/587edbc8ff416-create-an-alert-grouping-setting) resource is encouraged.\\n\"\n },\n \"auto_pause_notifications_parameters\": {\n \"title\": \"AutoPauseNotificationsParameters\",\n \"type\": \"object\",\n \"description\": \"Defines how alerts on this service are automatically suspended for a period of time before triggering, when identified as likely being transient. Note that automatically pausing notifications is only available on certain plans.\",\n \"properties\": {\n \"enabled\": {\n \"type\": \"boolean\",\n \"default\": false,\n \"description\": \"Indicates whether alerts should be automatically suspended when identified as transient\"\n },\n \"timeout\": {\n \"type\": \"integer\",\n \"enum\": [\n 0,\n 120,\n 180,\n 300,\n 600,\n 900\n ],\n \"description\": \"Indicates in seconds how long alerts should be suspended before triggering. To automatically select the recommended timeout for a service, set this value to `0`.\"\n },\n \"recommended_timeout\": {\n \"type\": \"integer\",\n \"enum\": [\n 120,\n 180,\n 300,\n 600,\n 900\n ],\n \"description\": \"The recommended timeout setting for this service based on prior alert patterns.\"\n }\n },\n \"example\": {\n \"enabled\": true,\n \"timeout\": 300\n }\n }\n },\n \"required\": [\n \"type\",\n \"escalation_policy\"\n ],\n \"example\": {\n \"id\": \"PSI2I2O\",\n \"summary\": \"string\",\n \"type\": \"service\",\n \"self\": \"string\",\n \"html_url\": \"string\",\n \"name\": \"My Web App\",\n \"description\": \"My cool web application that does things.\",\n \"auto_resolve_timeout\": 14400,\n \"acknowledgement_timeout\": 600,\n \"status\": \"active\",\n \"escalation_policy\": {\n \"id\": \"PWIP6CQ\",\n \"type\": \"escalation_policy_reference\"\n },\n \"incident_urgency_rule\": {\n \"type\": \"use_support_hours\",\n \"during_support_hours\": {\n \"type\": \"constant\",\n \"urgency\": \"high\"\n },\n \"outside_support_hours\": {\n \"type\": \"constant\",\n \"urgency\": \"low\"\n }\n },\n \"support_hours\": {\n \"type\": \"fixed_time_per_day\",\n \"time_zone\": \"America/Lima\",\n \"start_time\": \"09:00:00\",\n \"end_time\": \"17:00:00\",\n \"days_of_week\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ]\n },\n \"scheduled_actions\": [\n {\n \"type\": \"urgency_change\",\n \"at\": {\n \"type\": \"named_time\",\n \"name\": \"support_hours_start\"\n },\n \"to_urgency\": \"high\"\n }\n ],\n \"alert_creation\": \"create_alerts_and_incidents\",\n \"auto_pause_notifications_parameters\": {\n \"enabled\": true,\n \"timeout\": 300\n }\n }\n }\n ]\n }\n },\n \"required\": [\n \"service\"\n ]\n },\n \"examples\": {\n \"request\": {\n \"summary\": \"Request Example\",\n \"value\": {\n \"service\": {\n \"type\": \"service\",\n \"name\": \"My Web App\",\n \"description\": \"My cool web application that does things.\",\n \"auto_resolve_timeout\": 14400,\n \"acknowledgement_timeout\": 600,\n \"status\": \"active\",\n \"escalation_policy\": {\n \"id\": \"PWIP6CQ\",\n \"type\": \"escalation_policy_reference\"\n },\n \"incident_urgency_rule\": {\n \"type\": \"use_support_hours\",\n \"during_support_hours\": {\n \"type\": \"constant\",\n \"urgency\": \"high\"\n },\n \"outside_support_hours\": {\n \"type\": \"constant\",\n \"urgency\": \"low\"\n }\n },\n \"support_hours\": {\n \"type\": \"fixed_time_per_day\",\n \"time_zone\": \"America/Lima\",\n \"start_time\": \"09:00:00\",\n \"end_time\": \"17:00:00\",\n \"days_of_week\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ]\n },\n \"scheduled_actions\": [\n {\n \"type\": \"urgency_change\",\n \"at\": {\n \"type\": \"named_time\",\n \"name\": \"support_hours_start\"\n },\n \"to_urgency\": \"high\"\n }\n ],\n \"alert_creation\": \"create_alerts_and_incidents\",\n \"alert_grouping_parameters\": {\n \"type\": \"time\",\n \"config\": {\n \"timeout\": 2\n }\n },\n \"auto_pause_notifications_parameters\": {\n \"enabled\": true,\n \"timeout\": 300\n }\n }\n }\n }\n }\n }\n },\n \"description\": \"The service to be created\"\n}",
|
|
"use_request_body_schema_mode": true,
|
|
"validate_request_body_schema": true
|
|
}
|
|
}
|