{
  "opencollection": "1.0.0",
  "info": {
    "name": "PagerDuty Abilities Schedules API",
    "version": "2.0.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Schedules",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "PagerDuty List schedules",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pagerduty.com/schedules",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              },
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The number of results per page."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Offset to start pagination search results."
              },
              {
                "name": "total",
                "value": "",
                "type": "query",
                "description": "By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated.\n\nSee our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.\n"
              },
              {
                "name": "query",
                "value": "",
                "type": "query",
                "description": "Filters the result, showing only the records whose name matches the query."
              },
              {
                "name": "include[]",
                "value": "",
                "type": "query",
                "description": "Array of additional details to include."
              },
              {
                "name": "time_zone",
                "value": "",
                "type": "query",
                "description": "Time zone in which results will be rendered. This will default to the current user's time zone and then the account's time zone."
              }
            ]
          },
          "docs": "List the on-call schedules.\n\nA Schedule determines the time periods that users are On-Call.\n\nFor more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#schedules)\n\nScoped OAuth requires: `schedules.read`\n"
        },
        {
          "info": {
            "name": "PagerDuty Create a schedule",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.pagerduty.com/schedules",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              },
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "overflow",
                "value": "",
                "type": "query",
                "description": "Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false.\nFor instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`:\n\n\n- If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`.\n- If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new on-call schedule.\n\nA Schedule determines the time periods that users are On-Call.\n\nFor more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#schedules)\n\nScoped OAuth requires: `schedules.write`\n"
        },
        {
          "info": {
            "name": "PagerDuty Get a schedule",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pagerduty.com/schedules/:id",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              },
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "time_zone",
                "value": "",
                "type": "query",
                "description": "Time zone in which results will be rendered. This will default to the schedule's time zone."
              },
              {
                "name": "since",
                "value": "",
                "type": "query",
                "description": "The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given."
              },
              {
                "name": "until",
                "value": "",
                "type": "query",
                "description": "The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given."
              },
              {
                "name": "overflow",
                "value": "",
                "type": "query",
                "description": "Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false.\nFor instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`:\n\n\n- If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`.\n- If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`.\n"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the resource."
              }
            ]
          },
          "docs": "Show detailed information about a schedule, including entries for each layer.\nScoped OAuth requires: `schedules.read`\n"
        },
        {
          "info": {
            "name": "PagerDuty Update a schedule",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.pagerduty.com/schedules/:id",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              },
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the resource."
              },
              {
                "name": "overflow",
                "value": "",
                "type": "query",
                "description": "Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false.\nFor instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`:\n\n\n- If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`.\n- If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an existing on-call schedule.\n\nA Schedule determines the time periods that users are On-Call.\n\nFor more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#schedules)\n\nScoped OAuth requires: `schedules.write`\n"
        },
        {
          "info": {
            "name": "PagerDuty Delete a schedule",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.pagerduty.com/schedules/:id",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              },
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the resource."
              }
            ]
          },
          "docs": "Delete an on-call schedule.\n\nA Schedule determines the time periods that users are On-Call.\n\nFor more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#schedules)\n\nScoped OAuth requires: `schedules.write`\n"
        },
        {
          "info": {
            "name": "PagerDuty List audit records for a schedule",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pagerduty.com/schedules/:id/audit/records",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              },
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the resource."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The minimum of the `limit` parameter used in the request or the maximum request size of the API."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "Optional parameter used to request the \"next\" set of results from an API.  The value provided here is most commonly obtained from the `next_cursor` field of the previous request.  When no value is provided, the request starts at the beginning of the result set.\n"
              },
              {
                "name": "since",
                "value": "",
                "type": "query",
                "description": "The start of the date range over which you want to search. If not specified, defaults to `now() - 24 hours` (past 24 hours)"
              },
              {
                "name": "until",
                "value": "",
                "type": "query",
                "description": "The end of the date range over which you want to search. If not specified, defaults to `now()`. May not be more than 31 days after `since`."
              }
            ]
          },
          "docs": "The returned records are sorted by the `execution_time` from newest to oldest.\n\nSee [`Cursor-based pagination`](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for instructions on how to paginate through the result set.\n\nFor more information see the [Audit API Document](https://developer.pagerduty.com/docs/rest-api-v2/audit-records-api/).\n\nScoped OAuth requires: `audit_records.read`\n"
        },
        {
          "info": {
            "name": "PagerDuty List overrides",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pagerduty.com/schedules/:id/overrides",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              },
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the resource."
              },
              {
                "name": "since",
                "value": "",
                "type": "query",
                "description": "The start of the date range over which you want to search."
              },
              {
                "name": "until",
                "value": "",
                "type": "query",
                "description": "The end of the date range over which you want to search."
              },
              {
                "name": "editable",
                "value": "",
                "type": "query",
                "description": "When this parameter is present, only editable overrides will be returned. The result will only include the id of the override if this parameter is present. Only future overrides are editable."
              },
              {
                "name": "overflow",
                "value": "",
                "type": "query",
                "description": "Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false."
              }
            ]
          },
          "docs": "List overrides for a given time range.\n\nA Schedule determines the time periods that users are On-Call.\n\nFor more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#schedules)\n\nScoped OAuth requires: `schedules.read`\n"
        },
        {
          "info": {
            "name": "PagerDuty Create one or more overrides",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.pagerduty.com/schedules/:id/overrides",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              },
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the resource."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create one or more overrides, each for a specific user covering a specified time range. If you create an override on top of an existing override, the last created override will have priority.\n\nA Schedule determines the time periods that users are On-Call.\n\nNote: An older implementation of this endpoint only supported creating a single ocverride per request. That functionality is still supported, but deprecated and may be removed in the future.\n\nFor more information see the [API Concepts Document"
        },
        {
          "info": {
            "name": "PagerDuty Delete an override",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.pagerduty.com/schedules/:id/overrides/:override_id",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              },
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the resource."
              },
              {
                "name": "override_id",
                "value": "",
                "type": "path",
                "description": "The override ID on the schedule."
              }
            ]
          },
          "docs": "Remove an override.\n\nYou cannot remove a past override.\n\nIf the override start time is before the current time, but the end time is after the current time, the override will be truncated to the current time.\n\nIf the override is truncated, the status code will be 200 OK, as opposed to a 204 No Content for a successful delete.\n\nA Schedule determines the time periods that users are On-Call.\n\nFor more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#schedu"
        },
        {
          "info": {
            "name": "PagerDuty List users on call.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pagerduty.com/schedules/:id/users",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              },
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the resource."
              },
              {
                "name": "since",
                "value": "",
                "type": "query",
                "description": "The start of the date range over which you want to search."
              },
              {
                "name": "until",
                "value": "",
                "type": "query",
                "description": "The end of the date range over which you want to search."
              }
            ]
          },
          "docs": "List all of the users on call in a given schedule for a given time range.\n\nA Schedule determines the time periods that users are On-Call.\n\nFor more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#schedules)\n\nScoped OAuth requires: `users.read`\n"
        },
        {
          "info": {
            "name": "PagerDuty Preview a schedule",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.pagerduty.com/schedules/preview",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              },
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "since",
                "value": "",
                "type": "query",
                "description": "The start of the date range over which you want to search."
              },
              {
                "name": "until",
                "value": "",
                "type": "query",
                "description": "The end of the date range over which you want to search."
              },
              {
                "name": "overflow",
                "value": "",
                "type": "query",
                "description": "Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false.\nFor instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`:\n\n\n- If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`.\n- If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Preview what an on-call schedule would look like without saving it.\n\nA Schedule determines the time periods that users are On-Call.\n\nFor more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#schedules)\n\nScoped OAuth requires: `schedules.write`\n"
        }
      ]
    }
  ],
  "bundled": true
}