| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Opsgenie REST | rest | https://api.opsgenie.com/ | link | — | — | — |
Actions (52)
Alerts · 17
- Acknowledge alertPOST /v2/alerts/{identifier}/acknowledge
Acknowledge an alert.
documented - Add note to alertPOST /v2/alerts/{identifier}/notes
Attach a note to an alert.
documented - Add responder to alertPOST /v2/alerts/{identifier}/responders
Add a responder (user/escalation/schedule/team) to the alert.
documented - Add tags to alertPOST /v2/alerts/{identifier}/tags
Attach tags to an alert.
documented - Add team to alertPOST /v2/alerts/{identifier}/teams
Add a team as a responder to the alert.
documented - Assign alert ownershipPOST /v2/alerts/{identifier}/assign
Assign an owner/handler to the alert.
documented - Close alertPOST /v2/alerts/{identifier}/close
Close an alert (signal completion).
documented - Create alertPOST /v2/alerts
Create a new alert with responders/visibility/labels and other metadata.
documented - Delete alertDELETE /v2/alerts/{identifier}
Delete an alert.
documented - Escalate alert to nextPOST /v2/alerts/{identifier}/escalate
Escalate the alert to the next recipient in the escalation chain.
documented - Execute custom actionPOST /v2/alerts/{identifier}/actions/{action}
Execute a named action on the alert.
documented - Get alertGET /v2/alerts/{identifier}
Retrieve a single alert by id, tiny, or alias.
documented - Get request status (alert)GET /v2/alerts/requests/{requestId}
Check the status of a previously submitted alert request.
documented - List alertsGET /v2/alerts
List or filter alerts (with optional query or saved searches).
documented - Remove tags from alertDELETE /v2/alerts/{identifier}/tags
Remove tags from an alert.
documented - Snooze alertPOST /v2/alerts/{identifier}/snooze
Snooze an alert for a period.
documented - Unacknowledge alertPOST /v2/alerts/{identifier}/unacknowledge
Remove acknowledgment on an alert.
documented
Incidents · 11
- Add comment to incidentPOST /v1/incidents/{identifier}/comments
Add a comment to an incident.
documented - Add note to incidentPOST /v1/incidents/{identifier}/notes
Attach a note to an incident.
documented - Add responder to incidentPOST /v1/incidents/{identifier}/responders
Add responders to an incident.
documented - Add tags to incidentPOST /v1/incidents/{identifier}/tags
Add tags to an incident.
documented - Close incidentPOST /v1/incidents/{identifier}/close
Close an incident.
documented - Create incidentPOST /v1/incidents/create
Create a new incident with responders and details.
documented - Delete incidentDELETE /v1/incidents/{identifier}
Delete an incident.
documented - Get incidentGET /v1/incidents/{identifier}
Retrieve a specific incident.
documented - Get incident timelineGET /v1/incidents/{identifier}/timeline
Retrieve the timeline for an incident.
documented - Get request status (incident)GET /v1/incidents/requests/{requestId}
Track the status of an incident request.
documented - Resolve incidentPOST /v1/incidents/{identifier}/resolve
Resolve an incident.
documented
Heartbeats · 9
- Add heartbeatPOST /v2/heartbeats
Create a new heartbeat definition.
documented - Delete heartbeatDELETE /v2/heartbeats/{heartbeatName}
Delete a heartbeat.
documented - Disable heartbeatPOST /v2/heartbeats/{heartbeatName}/disable
Disable a heartbeat.
documented - Enable heartbeatPOST /v2/heartbeats/{heartbeatName}/enable
Enable a heartbeat.
documented - Get heartbeatGET /v2/heartbeats/{heartbeatName}
Get a specific heartbeat.
documented - List heartbeatsGET /v2/heartbeats
List all defined heartbeats.
documented - Ping heartbeatGET /v2/heartbeats/{heartbeatName}/ping
Ping a heartbeat (check-in).
documented - Update heartbeatPUT /v2/heartbeats/{heartbeatName}
Update a heartbeat (partial).
documented - Update heartbeat (partial)PATCH /v2/heartbeats/{heartbeatName}
Partial update of a heartbeat.
documented
Services · 6
- Create servicePOST /v2/services
Create a new service.
documented - Delete serviceDELETE /v2/services/{serviceId}
Delete a service.
documented - Get serviceGET /v2/services/{serviceId}
Retrieve a service.
documented - List service incident rulesGET /v2/services/{serviceId}/incident-rules
List incident rules for a service.
documented - List servicesGET /v2/services
List all services.
documented - Update servicePATCH /v2/services/{serviceId}
Update a service.
documented
Integrations · 4
- Create API-based integrationPOST /v2/integrations
Create a new API-based integration.
documented - Create Email-based integrationPOST /v2/integrations
Create an email-based integration.
documented - Get integrationGET /v2/integrations/{integrationId}
Retrieve a specific integration.
documented - List integrationsGET /v2/integrations
List integrations; can filter by type or team.
documented
Notifications · 4
- Create notification rulePOST /v2/users/{userId}/notification-rules
Create a notification rule for a user.
documented - Create notification rule stepPOST /v2/users/{userId}/notification-rules/{ruleId}/steps
Add a step to a user's notification rule.
documented - Get notification ruleGET /v2/users/{userId}/notification-rules/{ruleId}
Get a notification rule for a user.
documented - Update notification rulePATCH /v2/users/{userId}/notification-rules/{ruleId}
Update a notification rule.
documented