{"openapi":"3.0.1","info":{"contact":{"email":"agurtan@atlassian.com"},"description":"Operations APIs for Jira Service Management","title":"JSM Operations API","version":"1"},"servers":[{"url":"https://api.atlassian.com","description":"Generated server url"}],"tags":[{"name":"Integration events","description":"This resource represents the contract to create/acknowledge/close/add note actions of alerts in Jira Service Management. API key is the basic authentication method used by the integration event APIs. Hence, use API keys in your integration events instead of API tokens."}],"paths":{"/jsm/ops/integration/v2/alerts":{"post":{"tags":["Integration events"],"summary":"Create alert","description":"The endpoint allows users to programmatically generate alerts with customized parameters. It integrates with existing systems to transform raw data into actionable alerts, ensuring timely notifications.","operationId":"createAlertWithIntegrationEvent","parameters":[{"in":"header","name":"Authorization","required":true,"schema":{"type":"string","example":"GenieKey {apiKey}"},"description":"GenieKey {apiKey}","example":"GenieKey {apiKey}"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAlertRequest"}}},"required":true},"responses":{"202":{"description":"Returned if the request validation is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncSuccessResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect."},"422":{"description":"Returned if the payload or header format is not valid."}}}},"/jsm/ops/integration/v2/alerts/{id}/acknowledge":{"post":{"tags":["Integration events"],"operationId":"ackAlertWithIntegrationEvent","summary":"Acknowledge alert","description":"This endpoint is used to acknowledge an existing alert. Acknowledging an alert indicates that it has been received and is being acted upon, preventing duplicate efforts and coordinating response actions.","parameters":[{"in":"header","name":"Authorization","required":true,"schema":{"type":"string","example":"GenieKey {apiKey}"},"description":"GenieKey {apiKey}","example":"GenieKey {apiKey}"},{"name":"id","in":"path","required":true,"description":"Identifier of the alert.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcknowledgeAlertRequest"}}}},"responses":{"202":{"description":"Returned if the request validation is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncSuccessResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect."},"422":{"description":"Returned if the payload or header format is not valid."}}}},"/jsm/ops/integration/v2/alerts/{id}/close":{"post":{"tags":["Integration events"],"operationId":"closeAlertWithIntegrationEvent","summary":"Close alert","description":"This endpoint is used to close an existing alert. Closing an alert indicates that the issue has been resolved and no further action is necessary. This operation is essential for maintaining an accurate overview of the operational status and for ensuring that only active, unresolved issues remain open.","parameters":[{"in":"header","name":"Authorization","required":true,"schema":{"type":"string","example":"GenieKey {apiKey}"},"description":"GenieKey {apiKey}","example":"GenieKey {apiKey}"},{"name":"id","in":"path","required":true,"description":"Identifier of the alert.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloseAlertRequest"}}}},"responses":{"202":{"description":"Returned if the request validation is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncSuccessResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect."},"422":{"description":"Returned if the payload or header format is not valid."}}}},"/jsm/ops/integration/v2/alerts/{id}/notes":{"post":{"tags":["Integration events"],"operationId":"addAlertNoteWithIntegrationEvent","description":"This endpoint is used to add a note to an existing alert.","summary":"Add note","parameters":[{"in":"header","name":"Authorization","required":true,"schema":{"type":"string","example":"GenieKey {apiKey}"},"description":"GenieKey {apiKey}","example":"GenieKey {apiKey}"},{"name":"id","in":"path","required":true,"description":"Identifier of the alert.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddNoteRequest"}}},"required":true},"responses":{"202":{"description":"Returned if the request validation is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncSuccessResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect."},"422":{"description":"Returned if the payload or header format is not valid."}}}}},"components":{"schemas":{"ErrorResponse":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"}},"example":{"took":0,"requestId":"c1b85a37-2c39-48c8-8ef7-d620b4927a66","message":"Request method 'POST' is not supported"}},"AsyncSuccessResponse":{"type":"object","properties":{"result":{"type":"string","description":"Indicates the outcome of the request.","example":"Request will be processed"},"requestId":{"type":"string","description":"Identifier of the request. This ID can be used to trace or track the request in the system logs or for debugging purposes in case the request fails or causes an error.","example":"d383c6e9-b1e7-4b59-9c35-72f1a2187777"},"took":{"type":"integer","format":"int32","example":0.195}}},"Message":{"type":"string","description":"Brief summary of the alert that provides enough information to understand the nature of the issue at a glance.","example":"The CPU usage on Server XYZ has exceeded 80% for over 5 minutes.","maximum":130},"Alias":{"type":"string","description":"Client-defined identifier of the alert, that is also the key element of <a target=\"_self\" href=\"https://support.atlassian.com/atlassian/docs/what-is-alert-de-duplication/\">Alert De-Duplication</a>.","example":"DatabaseConnectionFailure_DatabaseServer1","maximum":512},"Description":{"type":"string","description":"Detailed information contains more comprehensive information than the 'message' field, including the implications of the alert, steps to reproduce the issue, or suggestions for resolving the problem. It serves as a guide for the person or team responding to the alert to better understand the situation and take appropriate actions.","example":"The alert is triggered due to the high CPU usage on Server XYZ. The CPU usage has consistently been above 80% for more than 5 minutes which could potentially lead to server slowdown or even a crash. Suggested action is to investigate the processes consuming high CPU and optimize or terminate them as needed. If the issue persists, consider upgrading the server resources.","maximum":15000},"Responders":{"maxItems":50,"minItems":0,"type":"array","description":"Teams, users, escalations and schedules that the alert will be routed to send notifications.","example":[{"id":"4513b7ea-3b91-438f-b7e4-e3e54af9147c","type":"team"},{"id":"bb4d9938-c3c2-455d-aaab-727aa701c0d8","type":"user"},{"id":"aee8a0de-c80f-4515-a232-501c0bc9d715","type":"escalation"},{"id":"80564037-1984-4f38-b98e-8a1f662df552","type":"schedule"}],"items":{"$ref":"#/components/schemas/Responder"}},"Responder":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of the responder.","example":"ac140ae4-757c-48a4-a079-041eb3bfe8d7"},"type":{"type":"string","description":"Type of the responder.","enum":["team","user","escalation","schedule"]}}},"VisibleTo":{"type":"object","properties":{"id":{"type":"string","example":"ac140ae4-757c-48a4-a079-041eb3bfe8d7"},"type":{"type":"string","enum":["team","user"]}}},"Actions":{"type":"array","description":"A list of actions that can be executed on the alert. These actions are custom to your organization and can be used to automate responses to specific alerts.","example":["RestartServer"],"items":{"type":"string"}},"Tags":{"type":"array","description":"Additional categorizing information. These tags can then be used for searching or grouping alerts, making it easier to manage and prioritize them.","example":["OverwriteQuietHours","Critical"],"items":{"type":"string"}},"ExtraProperties":{"type":"object","description":"Map of key-value pairs to use as custom properties of the alert. This can include context-specific data, diagnostic information, or other metadata that can assist in understanding and resolving the alert.","maximum":8000,"example":{"backend":false,"browser":"Firefox 113.0","browser.name":"Firefox","bundler":"parcel@2.10.3","environment":"production"},"additionalProperties":{"type":"string"}},"Entity":{"type":"string","example":"DatabaseServer1","description":"Entity that the alert is related to. It could be a server, service, application or another source that's being monitored. The 'entity' helps in identifying and categorizing the origin of the alert, enabling quicker diagnostics and resolution of the issue.","maximum":512},"Source":{"type":"string","example":"DBMonitoringTool","description":"Origin of the alert, i.e., the system or application where the alert was generated. This field is useful for tracking and sorting alerts according to their originating sources, which can help in troubleshooting and determining the cause of the alerts.","maximum":100,"default":"IP address of the incoming request."},"Priority":{"type":"string","description":"Urgency level of the alert. The priority can be set as 'P1', 'P2', 'P3', 'P4', or 'P5', with 'P1' being the highest and 'P5' the lowest. The 'priority' attribute aids in effective alert management by allowing alerts to be categorized and handled according to their importance.","enum":["P1","P2","P3","P4","P5"],"default":"P3"},"CreateAlertRequest":{"required":["message"],"type":"object","properties":{"message":{"$ref":"#/components/schemas/Message"},"alias":{"$ref":"#/components/schemas/Alias"},"description":{"$ref":"#/components/schemas/Description"},"responders":{"$ref":"#/components/schemas/Responders"},"visibleTo":{"maxItems":50,"minItems":0,"type":"array","example":[{"id":"4513b7ea-3b91-438f-b7e4-e3e54af9147c","type":"team"},{"id":"bb4d9938-c3c2-455d-aaab-727aa701c0d8","type":"user"}],"items":{"$ref":"#/components/schemas/VisibleTo"}},"actions":{"$ref":"#/components/schemas/Actions"},"tags":{"$ref":"#/components/schemas/Tags"},"details":{"$ref":"#/components/schemas/ExtraProperties"},"entity":{"$ref":"#/components/schemas/Entity"},"source":{"$ref":"#/components/schemas/Source"},"priority":{"$ref":"#/components/schemas/Priority"},"user":{"type":"string","description":"Display name of the request owner.","example":"John Smith","maximum":100},"note":{"type":"string","description":"Additional context or information about the alert that isn't captured in other fields. This could include steps taken to address the alert, details about the potential cause, or other relevant information.","example":"This server has experienced high CPU usage multiple times in the past week. A server upgrade has been recommended to prevent future occurrences.","maximum":25000}}},"AcknowledgeAlertRequest":{"type":"object","properties":{"user":{"type":"string","description":"Display name of the request owner.","example":"John Smith","maximum":100},"source":{"$ref":"#/components/schemas/Source"},"note":{"type":"string","description":"Additional alert note to add.","example":"Action executed via script.","maximum":25000}}},"CloseAlertRequest":{"type":"object","properties":{"user":{"type":"string","description":"Display name of the request owner.","example":"John Smith","maximum":100},"source":{"$ref":"#/components/schemas/Source"},"note":{"type":"string","description":"Additional alert note to add.","example":"Action executed via script.","maximum":25000}}},"AddNoteRequest":{"type":"object","properties":{"user":{"type":"string","description":"Display name of the request owner.","example":"John Smith","maximum":100},"source":{"$ref":"#/components/schemas/Source"},"note":{"type":"string","description":"Additional alert note to add.","example":"Action executed via script.","maximum":25000}}}}}}