Opsgenie REST API
Opsgenie OpenAPI Specification
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Opsgenie OpenAPI Specification
Endpoints 170
alert
- GETGet Request Status of Alert
/v2/alerts/requests/:requestIdUsed to track the status and alert details (if any) of the request whose identifier is given - GETList Alerts
/v2/alerts?query=string&searchIdentifier=string&searchIdentifierType=id&offset=0&limit=1&sort=createdAt&order=descReturns list of alerts - POSTCreate Alert
/v2/alertsCreates a new alert - GETGet Alert
/v2/alerts/:identifier?identifierType=idReturns alert with given id, tiny id or alias - DELETEDelete Alert
/v2/alerts/:identifier?identifierType=id&user=string&source=stringDeletes an alert using alert id, tiny id or alias - POSTAcknowledge Alert
/v2/alerts/:identifier/acknowledge?identifierType=idAcknowledges alert with given identifier - POSTUnAcknowledge Alert
/v2/alerts/:identifier/unacknowledge?identifierType=idUnAcknowledge alert with given identifier - POSTClose Alert
/v2/alerts/:identifier/close?identifierType=idCloses alert with given identifier - POSTSnooze Alert
/v2/alerts/:identifier/snooze?identifierType=idSnooze alert with given identifier - POSTEscalate Alert
/v2/alerts/:identifier/escalate?identifierType=idEscalate alert with given identifier - POSTAssign Alert
/v2/alerts/:identifier/assign?identifierType=idAssign alert with given identifier - POSTAdd Responder
/v2/alerts/:identifier/responders?identifierType=idAdd responder to alert with given identifier - POSTAdd Team
/v2/alerts/:identifier/teams?identifierType=idAdd team to alert with given identifier - POSTCustom Alert Action
/v2/alerts/:identifier/actions/:actionName?identifierType=idCustom actions for the alert - GETList Alert Recipients
/v2/alerts/:identifier/recipients?identifierType=idList alert recipients for the given alert identifier - GETList Alert Logs
/v2/alerts/:identifier/logs?identifierType=id&offset=string&direction=next&limit=1&order=descList alert logs for the given alert identifier - GETList Alert Attachments
/v2/alerts/:identifier/attachments?alertIdentifierType=idList alert attachment names and urls for related alert - POSTAdd Alert Attachment
/v2/alerts/:identifier/attachments?alertIdentifierType=idAdd Alert Attachment to related alert - GETGet Alert Attachment
/v2/alerts/:identifier/attachments/:attachmentId?alertIdentifierType=idGet alert attachment name and url for the given identifier - DELETERemove Alert Attachment
/v2/alerts/:identifier/attachments/:attachmentId?alertIdentifierType=id&user=stringRemove alert attachment for the given identifier - POSTAdd Tags
/v2/alerts/:identifier/tags?identifierType=idAdd tags to the alert with given identifier - DELETERemove Tags
/v2/alerts/:identifier/tags?identifierType=id&user=string¬e=string&source=string&tags=stringRemove tags of the alert with given identifier - POSTAdd Details
/v2/alerts/:identifier/details?identifierType=idAdd details to the alert with given identifier - DELETERemove Details
/v2/alerts/:identifier/details?identifierType=id&user=string¬e=string&source=string&keys=stringRemove details of the alert with given identifier - GETList Alert Notes
/v2/alerts/:identifier/notes?identifierType=id&offset=string&direction=next&limit=1&order=descList alert notes for the given alert identifier - POSTAdd Note
/v2/alerts/:identifier/notes?identifierType=idAdds note to alert with given identifier - GETLists Saved Searches
/v2/alerts/saved-searchesList all saved searches - POSTCreate Saved Search
/v2/alerts/saved-searchesCreate saved search with given fields - GETGet Saved Search
/v2/alerts/saved-searches/:identifier?identifierType=idGet saved search for the given search identifier - DELETEDelete Saved Search
/v2/alerts/saved-searches/:identifier?identifierType=idDeletes saved search using given search identifier - PATCHUpdate Saved Search
/v2/alerts/saved-searches/:identifier?identifierType=idUpdate saved search for the given search identifier - GETCount Alerts
/v2/alerts/count?query=string&searchIdentifier=string&searchIdentifierType=idCount alerts in Opsgenie - PUTUpdate Alert Message
/v2/alerts/:identifier/message?identifierType=idUpdate the message of the alert with given identifier - PUTUpdate Alert Description
/v2/alerts/:identifier/description?identifierType=idUpdate the description of the alert with given identifier - PUTUpdate Alert Priority
/v2/alerts/:identifier/priority?identifierType=idUpdate the priority of the alert with given identifier
integration
- GETList Integrations
/v2/integrations?type=string&teamId=string&teamName=stringReturns list of integrations with given parameters - POSTCreate Integration
/v2/integrationsCreates a new integration - GETGet Integration
/v2/integrations/:idReturns integration with given id - PUTUpdate Integration
/v2/integrations/:idUpdate integration with given id - DELETEDelete Integration
/v2/integrations/:idDelete integration with given id - POSTEnable Integration
/v2/integrations/:id/enableEnable integration with given ID - POSTDisable Integration
/v2/integrations/:id/disableDisable integration with given ID - POSTAuthenticate Integration
/v2/integrations/authenticateAuthenticates integration with given type
integration-action
- GETList Integration Actions
/v2/integrations/:id/actionsList integration actions of given integration id - PUTUpdate Integration Actions
/v2/integrations/:id/actionsUpdates integration actions of given integration id - POSTCreate Integration Action
/v2/integrations/:id/actionsCreates integration actions of given integration id
heartbeat
- GETPing Heartbeat
/v2/heartbeats/:name/pingPing Heartbeat for given heartbeat name - GETList Heartbeats
/v2/heartbeatsReturns list of Heartbeats - POSTCreate Heartbeat
/v2/heartbeatsCreate a new heartbeat - GETGet Heartbeat
/v2/heartbeats/:nameReturns heartbeat with given name - DELETEDelete Heartbeat
/v2/heartbeats/:nameDelete heartbeat with given name - PATCHUpdate Heartbeat (Partial)
/v2/heartbeats/:nameUpdate Heartbeatwith given name - POSTEnable Heartbeat
/v2/heartbeats/:name/enableEnable heartbeat request with given name - POSTDisable Heartbeat
/v2/heartbeats/:name/disableDisable heartbeat request with given name
deprecatedPolicy
- GETList Alert Policies
/v1/policiesReturns list alert policies - POSTCreate Alert Policy
/v1/policiesCreates a new alert policy - GETGet Alert Policy
/v1/policies/:policyIdUsed to get details of a single policy with id - PUTUpdate Alert Policy
/v1/policies/:policyIdUpdate alert policy with given id - DELETEDelete Alert Policy
/v1/policies/:policyIdDelete alert policy with given id - POSTEnable Alert Policy
/v1/policies/:policyId/enableEnable the alert policy with given id - POSTDisable Alert Policy
/v1/policies/:policyId/disableDisable the alert policy with given id - POSTChange Alert Policy Order
/v1/policies/:policyId/change-orderChange execution order of the alert policy with given id
maintenance
- GETList Maintenance
/v1/maintenance?type=allList maintenance by type - POSTCreate Maintenance
/v1/maintenanceCreates a new maintenance - GETGet Maintenance
/v1/maintenance/:idReturns maintenance with given id - PUTUpdate Maintenance
/v1/maintenance/:idUpdate maintenance with given id - DELETEDelete Maintenance
/v1/maintenance/:idDelete maintenance with given identifier - POSTCancel Maintenance
/v1/maintenance/:id/cancelCancel maintenance with given id
account
- GETGet Account Info
/v2/accountUsed to search and retrieve account information in Opsgenie
user
- GETList users
/v2/users?limit=100&offset=0&sortField=string&order=asc&query=stringList users with given parameters - POSTCreate User
/v2/usersCreates a user with the given payload - GETGet User
/v2/users/:identifier?expand=stringGet user for the given identifier - DELETEDelete User
/v2/users/:identifierDelete user with the given identifier - PATCHUpdate User (Partial)
/v2/users/:identifierUpdate user with the given identifier - GETList User Teams
/v2/users/:identifier/teamsList user teams for the given user identifier - GETList User Forwarding Rules
/v2/users/:identifier/forwarding-rulesList user forwarding rules for the given user identifier - GETList User Escalations
/v2/users/:identifier/escalationsList escalations of the user for the given identifier - GETList User Schedules
/v2/users/:identifier/schedulesList schedules of the user for the given identifier
contact
- GETList Contacts
/v2/users/:identifier/contactsReturns list of contacts - POSTCreate Contact
/v2/users/:identifier/contactsCreates a new contact - GETGet Contact
/v2/users/:identifier/contacts/:contactIdReturns contact with given id - DELETEDelete Contact
/v2/users/:identifier/contacts/:contactIdDelete contact using contact id - PATCHUpdate Contact (Partial)
/v2/users/:identifier/contacts/:contactIdUpdate contact of the user - POSTEnable Contact
/v2/users/:identifier/contacts/:contactId/enableEnable the contact of the user - POSTDisable Contact
/v2/users/:identifier/contacts/:contactId/disableDisable the contact of the user
notification-rule
- GETList Notification Rules
/v2/users/:identifier/notification-rulesReturns list of notification rules - POSTCreate Notification Rule
/v2/users/:identifier/notification-rulesCreates a new notification rule - GETGet Notification Rule
/v2/users/:identifier/notification-rules/:ruleIdReturns notification rule with given id - DELETEDelete Notification Rule
/v2/users/:identifier/notification-rules/:ruleIdDeletes a notification rule with given notification rule id - PATCHUpdate Notification Rule (Partial)
/v2/users/:identifier/notification-rules/:ruleIdUpdates the notification rule with given notification rule id - POSTEnable Notification Rule
/v2/users/:identifier/notification-rules/:ruleId/enableEnables a notification rule with given notification rule id - POSTDisable Notification Rule
/v2/users/:identifier/notification-rules/:ruleId/disableDisables a notification rule with given notification rule id - POSTChange order of Notification Rule
/v2/users/:identifier/notification-rules/:ruleId/change-orderChanges order of a notification rule with given notification rule id
notification-rule-step
- GETList Notification Rule Steps
/v2/users/:identifier/notification-rules/:ruleId/stepsReturns list of notification rule steps - POSTCreate Notification Rule Step
/v2/users/:identifier/notification-rules/:ruleId/stepsCreates a new notification rule step - GETGet Notification Rule Step
/v2/users/:identifier/notification-rules/:ruleId/steps/:idReturns notification rule step with given user identifier and rule id - DELETEDelete Notification Rule Step
/v2/users/:identifier/notification-rules/:ruleId/steps/:idDeletes a notification rule step using user identifier, rule id, notification rule step id - PATCHUpdate Notification Rule Step (Partial)
/v2/users/:identifier/notification-rules/:ruleId/steps/:idUpdate a notification rule step with given user identifier, rule id, and notification rule step id - POSTDisable Notification Rule Step
/v2/users/:identifier/notification-rules/:ruleId/steps/:id/disableDisables a new notification rule step - POSTEnable Notification Rule Step
/v2/users/:identifier/notification-rules/:ruleId/steps/:id/enableEnables a new notification rule step
team
- GETList Teams
/v2/teamsReturn list of teams - POSTCreate Team
/v2/teamsCreates a new team - GETGet Team
/v2/teams/:identifier?identifierType=idReturns team with given 'id' or 'name' - DELETEDelete Team
/v2/teams/:identifier?identifierType=idDelete team with given id or name - PATCHUpdate Team (Partial)
/v2/teams/:identifierUpdate team with given id - GETList Team Logs
/v2/teams/:identifier/logs?identifierType=id&limit=1&order=desc&offset=stringReturn logs of a team given with identifier
team-member
- POSTAdd Team Member
/v2/teams/:identifier/members?teamIdentifierType=idAdds a member to team with given identifier - DELETEDelete Team Member
/v2/teams/:identifier/members/:memberIdentifier?teamIdentifierType=idDeletes the member of team with given identifier
team-role
- GETList Team Roles
/v2/teams/:identifier/roles?teamIdentifierType=idReturns list of team roles - POSTCreate Team Role
/v2/teams/:identifier/roles?teamIdentifierType=idCreates a new team role - GETGet Team Role
/v2/teams/:identifier/roles/:teamRoleIdentifier?teamIdentifierType=id&identifierType=idReturns team role with given 'id' or 'name' - DELETEDelete Team Role
/v2/teams/:identifier/roles/:teamRoleIdentifier?teamIdentifierType=id&identifierType=idDeletes a team role using team role 'id' or 'name' - PATCHUpdate Team Role (Partial)
/v2/teams/:identifier/roles/:teamRoleIdentifier?teamIdentifierType=id&identifierType=idUpdates the team role using team role 'id' or 'name'
team-routing-rule
- GETList Team Routing Rules
/v2/teams/:identifier/routing-rules?teamIdentifierType=idReturns list of team routing rules - POSTCreate Team Routing Rule
/v2/teams/:identifier/routing-rules?teamIdentifierType=idCreates a new team routing rule - GETGet Team Routing Rule
/v2/teams/:identifier/routing-rules/:id?teamIdentifierType=idReturns team routing rule with given id - DELETEDelete Team Routing Rule
/v2/teams/:identifier/routing-rules/:id?teamIdentifierType=idDelete team routing rule with given id - PATCHUpdate Team Routing Rule (Partial)
/v2/teams/:identifier/routing-rules/:id?teamIdentifierType=idUpdate routing rule of the team - POSTChange Team Routing Rule Order
/v2/teams/:identifier/routing-rules/:id/change-order?teamIdentifierType=idChange the order of team routing rule with given id
schedule
- GETList Schedules
/v2/schedules?expand=stringReturns list of schedule - POSTCreate Schedule
/v2/schedulesCreates a new schedule - GETGet Schedule
/v2/schedules/:identifier?identifierType=idReturns schedule with given id or name - DELETEDelete Schedule
/v2/schedules/:identifier?identifierType=idDelete schedule with given identifier - PATCHUpdate Schedule (Partial)
/v2/schedules/:identifier?identifierType=idUpdate schedule with given id or name - GETGet Schedule Timeline
/v2/schedules/:identifier/timeline?identifierType=id&expand=string&interval=1&intervalUnit=days&date=2024-01-01T00:00:00ZReturns schedule timeline with given id or name - GETExport Schedule
/v2/schedules/:identifier.ics?identifierType=idReturns an .ics file as byte array
schedule-rotation
- GETList Schedule Rotations
/v2/schedules/:identifier/rotations?scheduleIdentifierType=idReturns list of schedule rotations - POSTCreate Schedule Rotation
/v2/schedules/:identifier/rotations?scheduleIdentifierType=idCreates a new schedule rotation - GETGet Schedule Rotation
/v2/schedules/:identifier/rotations/:id?scheduleIdentifierType=idReturns schedule rotation with given id - DELETEDelete Schedule Rotation
/v2/schedules/:identifier/rotations/:id?scheduleIdentifierType=idDelete schedule rotation with given identifier - PATCHUpdate Schedule Rotation (Partial)
/v2/schedules/:identifier/rotations/:id?scheduleIdentifierType=idUpdate schedule rotation with given id
schedule-override
- GETList Schedule Overrides
/v2/schedules/:identifier/overrides?scheduleIdentifierType=idReturns list of schedule overrides - POSTCreate Schedule Override
/v2/schedules/:identifier/overrides?scheduleIdentifierType=idCreates a schedule override for the specified user and schedule - GETGet Schedule Override
/v2/schedules/:identifier/overrides/:alias?scheduleIdentifierType=idGets schedule override details with given alias - PUTUpdate Schedule Override
/v2/schedules/:identifier/overrides/:alias?scheduleIdentifierType=idUpdate schedule override with given alias - DELETEDelete Schedule Override
/v2/schedules/:identifier/overrides/:alias?scheduleIdentifierType=idDelete schedule override with given alias
who-is-on-call
- GETList On Calls
/v2/schedules/on-calls?flat=true&date=2024-01-01T00:00:00ZLists current on-call participants of all schedules - GETGet On Calls
/v2/schedules/:identifier/on-calls?scheduleIdentifierType=id&flat=true&date=2024-01-01T00:00:00ZGets current on-call participants of a specific schedule - GETGet Next On Calls
/v2/schedules/:identifier/next-on-calls?scheduleIdentifierType=id&flat=true&date=2024-01-01T00:00:00ZGets next on-call participants of a specific schedule - GETExport On-Call User
/v2/schedules/on-calls/:identifier.icsExports personal on-call timeline of 3 months to a .ics file
escalation
- GETList Escalations
/v2/escalationsReturns list of escalations - POSTCreate Escalation
/v2/escalationsCreates a new escalation - GETGet Escalation
/v2/escalations/:identifier?identifierType=idReturns escalation with given 'id' or 'name' - DELETEDelete Escalation
/v2/escalations/:identifier?identifierType=idDeletes an escalation using escalation 'id' or 'name' - PATCHUpdate Escalation (Partial)
/v2/escalations/:identifier?identifierType=idUpdates the escalation using escalation 'id' or 'name'
forwarding-rule
- GETList Forwarding Rules
/v2/forwarding-rulesReturns list of forwarding rules - POSTCreate Forwarding Rule
/v2/forwarding-rulesCreates a new forwarding rule - GETGet Forwarding Rule
/v2/forwarding-rules/:identifier?identifierType=idReturns forwarding rule with given id or alias - PUTUpdate Forwarding Rule
/v2/forwarding-rules/:identifier?identifierType=idUpdate forwarding rule with given rule id or alias - DELETEDelete Forwarding Rule
/v2/forwarding-rules/:identifier?identifierType=idDeletes forwarding rule with given identifier
custom-user-role
- GETList Custom User Roles
/v2/rolesReturns list of custom user roles - POSTCreate Custom User Role
/v2/rolesCreates a new custom user role - GETGet Custom User Role
/v2/roles/:identifier?identifierType=idReturns custom user role with given 'id' or 'name' - PUTUpdate Custom User Role
/v2/roles/:identifier?identifierType=idUpdates the custom user role using role 'id' or 'name' - DELETEDelete Custom User Role
/v2/roles/:identifier?identifierType=idDeletes a custom user role using role 'id' or 'name'
policy
- POSTCreate Policy
/v2/policies?teamId=Creates a new policy - GETList Alert Policies
/v2/policies/alert?teamId=Returns the list of alert policies - GETList Notification Policies
/v2/policies/notification?teamId=Returns the list of notification policies - GETGet Policy
/v2/policies/:policyId?teamId=Used to get details of a single policy with id - PUTUpdate Policy
/v2/policies/:policyId?teamId=stringUpdate alert policy with given id - DELETEDelete Policy
/v2/policies/:policyId?teamId=Delete policy with given id - POSTEnable Policy
/v2/policies/:policyId/enable?teamId=Enable the policy with given id - POSTDisable Policy
/v2/policies/:policyId/disable?teamId=Disable the policy with given id - POSTChange Policy Order
/v2/policies/:policyId/change-order?teamId=stringChange execution order of the policy with given id
incident
- GETGet Request Status of Incident
/v1/incidents/requests/:requestIdUsed to track the status and incident details (if any) of the request whose identifier is given - POSTCreate Incident
/v1/incidents/createCreates a new incident - GETGet Incident
/v1/incidents/:identifier?identifierType=idReturns incident with given id, tiny id or alias - DELETEDelete Incident
/v1/incidents/:identifier?identifierType=idDeletes an incident using incident id or the tiny id - GETList incidents
/v1/incidents/?query=string&offset=0&limit=1&sort=createdAt&order=descReturn list of incidents - POSTClose Incident
/v1/incidents/:identifier/close?identifierType=idCloses incident with given identifier
API details
- Base URL
https://api.opsgenie.com- Authentication
- An API key in the Authorization header
- Operations
- 170 operations on 104 pathsGET 65POST 57DELETE 25PATCH 12PUT 11
- Main resources
- alert 35policy 9user 9deprecatedPolicy 8heartbeat 8integration 8notification-rule 8contact 7notification-rule-step 7schedule 7
- Response formats
application/json- Description format
- Swagger 2.0, API version
2.0.0 - Links
- OpenAPI document
- Listed from
- Opsgenie's published OpenAPI description (opsgenie/opsgenie-oas) (Apache-2.0)
How to test the Opsgenie REST API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Opsgenie REST API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get Request Status of Alert” (GET /v2/alerts/requests/:requestId), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Opsgenie REST API?
Opsgenie OpenAPI Specification It is listed under Developer tools and has 170 endpoints.
Who publishes the Opsgenie REST API?
It is listed from Opsgenie's public API description (an OpenAPI document), not published by Opsgenie on Swastik Codes. Anyone who controls opsgenie.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Opsgenie REST API?
Requests go to https://api.opsgenie.com. Endpoint paths are added to this base URL.
How do I authenticate with the Opsgenie REST API?
With an API key in the Authorization header.
How many endpoints does the Opsgenie REST API have?
170 operations on 104 paths (65 GET, 57 POST, 25 DELETE, 12 PATCH, 11 PUT). The largest groups are alert, policy, user, deprecatedPolicy.
Is forking the Opsgenie REST API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.