{ "info": { "_postman_id": "489d3cb9-24ae-4532-a3fd-b56a013dc36c", "name": "JSM Incident API", "description": "Incident Management APIs for Jira Service Management", "schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json" }, "item": [ { "name": "Affected Services", "description": "This resource represents affected services of a Jira Service Management Incident. Use this resource to get, add and remove affected services to an incident issue.", "item": [ { "name": "Add affected services", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}jsm/incidents/cloudId/:cloudId/v1/incident/:issueID/affected-service/add", "query": [], "variable": [ { "key": "issueID", "value": "{{issueID}}", "description": "The ID of the incident issue.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Adds affected services to a Jira Service Management Incident", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get affected services", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}jsm/incidents/cloudId/:cloudId/v1/incident/:issueID/affected-service", "query": [], "variable": [ { "key": "issueID", "value": "{{issueID}}", "description": "The ID of the incident issue.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns affected services to a Jira Service Management Incident." }, "response": [] }, { "name": "Remove affected services", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}jsm/incidents/cloudId/:cloudId/v1/incident/:issueID/affected-service/remove", "query": [], "variable": [ { "key": "issueID", "value": "{{issueID}}", "description": "The ID of the incident issue.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Removes affected services to a Jira Service Management Incident", "body": { "mode": "raw", "raw": "" } }, "response": [] } ] }, { "name": "Linked alerts", "description": "This resource represents Linked alerts to a Jira Service Management Incident. Use this resource to helps you manage linked alerts to a Jira Service Management Incident. Use this resource to add, remove and fetch linked alerts to an Incident. See [What are linked alerts?](https://support.atlassian.com/jira-service-management-cloud/docs/what-are-linked-alerts/) for details.", "item": [ { "name": "Get linked alerts", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}jsm/incidents/cloudId/:cloudId/v1/incident/:issueID/alert", "query": [ { "key": "startKey", "value": "{{startKey}}", "disabled": true, "description": "Pagination parameter for the next page." } ], "variable": [ { "key": "issueID", "value": "{{issueID}}", "description": "The ID of the incident issue.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns linked alerts to a Jira Service Management Incident." }, "response": [] }, { "name": "Remove linked alerts", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}jsm/incidents/cloudId/:cloudId/v1/incident/:issueID/alert/remove", "query": [], "variable": [ { "key": "issueID", "value": "{{issueID}}", "description": "The ID of the incident issue.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Removes linked alerts to a Jira Service Management Incident.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Add linked alerts", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}jsm/incidents/cloudId/:cloudId/v1/incident/:issueID/alert/add", "query": [], "variable": [ { "key": "issueID", "value": "{{issueID}}", "description": "The ID of the incident issue.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Adds linked alerts to a Jira Service Management Incident.", "body": { "mode": "raw", "raw": "" } }, "response": [] } ] }, { "name": "Request status", "description": "This resource represents request status of Jira Service Management Incident API asynchronous actions. Use this resource to fetch request status of Jira Service Management Incident API asynchronous actions.", "item": [ { "name": "Get request status", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}jsm/incidents/cloudId/:cloudId/v1/request/:requestId", "query": [], "variable": [ { "key": "requestId", "value": "{{requestId}}", "description": "Unique ID returned by API that returns 202 - Accepted.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns request status for asynchronous operations, which return HTTP status 202 - Accepted and a requestId attribute in response payload. " }, "response": [] } ] }, { "name": "Chat tools", "description": "This resource represents chat tools to a Jira Service Management Incident. Use this resource to create, remove and fetch chat channels to an Incident. See how to [Connect Slack with Jira Service Management](https://support.atlassian.com/jira-service-management-cloud/docs/connect-a-new-slack-workspace-to-your-service-project/) for details. One you've connected Slack, you can use this resource to create Slack channel to the Incident. Once a Slack channel has been created, you can perform several [incident actions](https://support.atlassian.com/jira-service-management-cloud/docs/create-a-chat-channel-from-an-incident/) through that channel.", "item": [ { "name": "Get chat channels", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}jsm/incidents/cloudId/:cloudId/v1/incident/:issueID/chat/channel", "query": [], "variable": [ { "key": "issueID", "value": "{{issueID}}", "description": "The ID of the incident issue.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns all chat channels available to a Jira Service Management Incident.\n **License required:** Premium or Enterprise" }, "response": [] }, { "name": "Create chat channel", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}jsm/incidents/cloudId/:cloudId/v1/incident/:issueID/chat/channel/create", "query": [], "variable": [ { "key": "issueID", "value": "{{issueID}}", "description": "The ID of the incident issue.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Create a new chat channel to a Jira Service Management Incident.\n **License required:** Premium or Enterprise", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Unlink chat channel", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}jsm/incidents/cloudId/:cloudId/v1/incident/:issueID/chat/channel/unlink", "query": [], "variable": [ { "key": "issueID", "value": "{{issueID}}", "description": "The ID of the incident issue.", "disabled": false } ] }, "method": "DELETE", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Unlinks the chat channel from the Jira Service Management Incident.\n **License required:** Premium or Enterprise", "body": { "mode": "raw", "raw": "" } }, "response": [] } ] }, { "name": "Incident bulk actions", "description": "This resource represents bulk actions to a Jira Service Management Incident", "item": [ { "name": "Add linked alerts", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}jsm/incidents/cloudId/:cloudId/v1/incident/bulk/link-alerts", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Adds linked alerts to multiple Jira Service Management Incidents. See [What are linked alerts?](https://support.atlassian.com/jira-service-management-cloud/docs/what-are-linked-alerts/) for details.", "body": { "mode": "raw", "raw": "" } }, "response": [] } ] }, { "name": "Incident", "description": "This resource represents Jira Service Management Incident. Use this resource to create, delete and fetch an Incident.", "item": [ { "name": "Get incident", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}jsm/incidents/cloudId/:cloudId/v1/incident/:issueID", "query": [], "variable": [ { "key": "issueID", "value": "{{issueID}}", "description": "The ID of the incident issue.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns a Jira Service Management Incident." }, "response": [] }, { "name": "Delete Incident", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}jsm/incidents/cloudId/:cloudId/v1/incident/:issueID", "query": [], "variable": [ { "key": "issueID", "value": "{{issueID}}", "description": "The ID of the incident issue.", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Deletes a Jira Service Management Incident." }, "response": [] }, { "name": "Create Incident", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}jsm/incidents/cloudId/:cloudId/v1/incident", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Creates a new Incident in a service desk. ", "body": { "mode": "raw", "raw": "" } }, "response": [] } ] }, { "name": "Major Incident", "description": "This resource represents Major Incidents in Jira Service Management. Use this resource to escalate / de-escalator a Jira Service Management Incident as a major incident. See [What are major incidents?](https://support.atlassian.com/jira-service-management-cloud/docs/what-are-major-incidents/) for details.", "item": [ { "name": "Major incident status", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}jsm/incidents/cloudId/:cloudId/v1/incident/:issueID/major", "query": [], "variable": [ { "key": "issueID", "value": "{{issueID}}", "description": "The ID of the incident issue.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns the major incident status of a Jira Service Management Incident.\n **License required:** Premium or Enterprise" }, "response": [] }, { "name": "Update major incident status", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}jsm/incidents/cloudId/:cloudId/v1/incident/:issueID/major", "query": [], "variable": [ { "key": "issueID", "value": "{{issueID}}", "description": "The ID of the incident issue.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "\"Updates the major incident status of a Jira Service Management Incident.\n **License required:** Premium or Enterprise", "body": { "mode": "raw", "raw": "" } }, "response": [] } ] }, { "name": "Post-incident review", "description": "This resource represents Post-incident review of a Jira Service Management Incident. Use this resource to get, link and unlink an incident to a Post-incident review. See [Post-incident review](https://support.atlassian.com/jira-service-management-cloud/docs/what-are-post-incident-reviews/) for details.", "item": [ { "name": "Get primary incident", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}jsm/incidents/cloudId/:cloudId/v1/post-incident-review/:issueID/primary-incident", "query": [], "variable": [ { "key": "issueID", "value": "{{issueID}}", "description": "JSM Post-incident review Issue ID.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns primary incident to a Jira Service Management Post-incident review\n **License required:** Premium or Enterprise" }, "response": [] }, { "name": "Remove primary incident", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}jsm/incidents/cloudId/:cloudId/v1/post-incident-review/:issueID/primary-incident/remove", "query": [], "variable": [ { "key": "issueID", "value": "{{issueID}}", "description": "JSM Post-incident review Issue ID.", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "\"Remove primary incident to a Jira Service Management Post-incident review\n **License required:** Premium or Enterprise" }, "response": [] }, { "name": "Add primary incident", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}jsm/incidents/cloudId/:cloudId/v1/post-incident-review/:issueID/primary-incident/add", "query": [], "variable": [ { "key": "issueID", "value": "{{issueID}}", "description": "JSM Post-incident review Issue ID.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Add primary incident to a Jira Service Management Post-incident review.\n **License required:** Premium or Enterprise", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Create Post-incident review", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}jsm/incidents/cloudId/:cloudId/v1/post-incident-review", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Creates a Post-incident review to a Jira Service Management Incident.\n **License required:** Premium or Enterprise", "body": { "mode": "raw", "raw": "" } }, "response": [] } ] }, { "name": "Responders", "description": "This resource represents Responders to a Jira Service Management Incident. Use this resource to add, remove and fetch responders to an Incident. See [Incident responders](https://support.atlassian.com/jira-service-management-cloud/docs/add-and-manage-incident-responders/) for details.", "item": [ { "name": "Remove responders", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}jsm/incidents/cloudId/:cloudId/v1/incident/:issueID/responder/remove", "query": [], "variable": [ { "key": "issueID", "value": "{{issueID}}", "description": "The ID of the incident issue.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Removes responders to a Jira Service Management Incident. Note that responders can be both user and team responders.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get responders", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}jsm/incidents/cloudId/:cloudId/v1/incident/:issueID/responder", "query": [], "variable": [ { "key": "issueID", "value": "{{issueID}}", "description": "The ID of the incident issue.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns responders to a Jira Service Management Incident. Note that responders can be both user and team responders." }, "response": [] }, { "name": "Add responders", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}jsm/incidents/cloudId/:cloudId/v1/incident/:issueID/responder/add", "query": [], "variable": [ { "key": "issueID", "value": "{{issueID}}", "description": "The ID of the incident issue.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Adds responders to a Jira Service Management Incident. Note that responders can be both user and team responders.", "body": { "mode": "raw", "raw": "" } }, "response": [] } ] }, { "name": "Stakeholders", "description": "This resource represents Stakeholders to a Jira Service Management Incident. Use this resource to add, remove and fetch stakeholders to an Incident. See [Incident stakeholders](https://support.atlassian.com/jira-service-management-cloud/docs/how-can-i-add-and-manage-internal-stakeholders/) for details.", "item": [ { "name": "Add stakeholders", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}jsm/incidents/cloudId/:cloudId/v1/incident/:issueID/stakeholder/add", "query": [], "variable": [ { "key": "issueID", "value": "{{issueID}}", "description": "The ID of the incident issue.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Adds stakeholders to a Jira Service Management Incident.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Remove stakeholders", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}jsm/incidents/cloudId/:cloudId/v1/incident/:issueID/stakeholder/remove", "query": [], "variable": [ { "key": "issueID", "value": "{{issueID}}", "description": "The ID of the incident issue.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Removes stakeholders to a Jira Service Management Incident.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get stakeholders", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}jsm/incidents/cloudId/:cloudId/v1/incident/:issueID/stakeholder", "query": [], "variable": [ { "key": "issueID", "value": "{{issueID}}", "description": "The ID of the incident issue.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns stakeholders to a Jira Service Management Incident." }, "response": [] } ] } ], "variable": [ { "key": "protocol", "name": "Protocol", "description": "The HTTP Protocol that should be used for this REST API.", "type": "string", "value": "https" }, { "key": "host", "name": "Host", "description": "The HTTP host that should be used for this REST API.", "type": "string", "value": "api.atlassian.com" }, { "key": "basePath", "name": "Base Path", "description": "The path, after the host, of the base of the REST API.", "type": "string", "value": "" } ] }