How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

OpsGenie Alerts API

Operations for creating, retrieving, updating, and managing alerts within the OpsGenie platform.

OpsGenie Alerts API is one of 15 APIs that OpsGenie publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include Alerts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and 3 JSON Schemas.

This API exposes 22 operations across 17 paths, and defines 24 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against 2 base URLs: https://api.opsgenie.com, https://api.eu.opsgenie.com.

22 operations 17 paths 24 schemas 2 DELETE8 GET12 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.opsgenie.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

OpsGenie Alerts API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (genieKey). By default, every request must be authenticated.

  • genieKey — API key authentication using the GenieKey scheme.

Paths & Operations 22

Across 17 paths, the API surfaces 22 operations — 2 DELETE, 8 GET, 12 POST. Each is listed below with its method, path, parameters, and response codes.

Alerts 22

Operations for creating, retrieving, updating, and managing alerts within the OpsGenie platform.

POST
/v2/alerts
Create alert
createAlert body → 202400401422
GET
/v2/alerts
List alerts
listAlerts 7 params → 200400401
GET
/v2/alerts/{identifier}
Get alert
getAlert 2 params → 200401404
DELETE
/v2/alerts/{identifier}
Delete alert
deleteAlert 2 params → 202401404
POST
/v2/alerts/{identifier}/close
Close alert
closeAlert 2 params body → 202401404
POST
/v2/alerts/{identifier}/acknowledge
Acknowledge alert
acknowledgeAlert 2 params body → 202401404
POST
/v2/alerts/{identifier}/unacknowledge
Unacknowledge alert
unacknowledgeAlert 2 params body → 202401
POST
/v2/alerts/{identifier}/snooze
Snooze alert
snoozeAlert 2 params body → 202401
POST
/v2/alerts/{identifier}/escalate
Escalate alert
escalateAlert 2 params body → 202401
POST
/v2/alerts/{identifier}/assign
Assign alert
assignAlert 2 params body → 202401
POST
/v2/alerts/{identifier}/tags
Add tags to alert
addTags 2 params body → 202401
DELETE
/v2/alerts/{identifier}/tags
Remove tags from alert
removeTags 3 params → 202401
POST
/v2/alerts/{identifier}/notes
Add note to alert
addNote 2 params body → 202401
GET
/v2/alerts/{identifier}/notes
List alert notes
listAlertNotes 5 params → 200401
POST
/v2/alerts/{identifier}/details
Add details to alert
addDetails 2 params body → 202401
POST
/v2/alerts/{identifier}/responders
Add responder to alert
addResponder 2 params body → 202401
POST
/v2/alerts/{identifier}/attachments
Add attachment to alert
addAttachment 2 params body → 200401
GET
/v2/alerts/{identifier}/attachments
List alert attachments
listAttachments 2 params → 200401
GET
/v2/alerts/{identifier}/logs
List alert logs
listAlertLogs 5 params → 200401
GET
/v2/alerts/{identifier}/recipients
List alert recipients
listAlertRecipients 2 params → 200401
GET
/v2/alerts/count
Count alerts
countAlerts 3 params → 200401
GET
/v2/alerts/requests/{requestId}
Get request status
getRequestStatus 1 param → 200401404

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are Alert (24 properties), CreateAlertRequest (13 properties), EscalateAlertRequest (4 properties), SnoozeAlertRequest (4 properties). Each schema is shown below with its type and property counts.

GetAlertResponse
object
3 properties
ListAlertsResponse
object
4 properties
Responder
object
4 properties 1 required
AddDetailsRequest
object
4 properties 1 required
SuccessResponse
object
3 properties
AddNoteRequest
object
3 properties 1 required
ListAlertRecipientsResponse
object
3 properties
ListAlertNotesResponse
object
4 properties
Paging
object
3 properties
Alert
object
24 properties
SnoozeAlertRequest
object
4 properties 1 required
AssignAlertRequest
object
4 properties 1 required
CountAlertsResponse
object
3 properties
RequestStatusResponse
object
3 properties
AddResponderRequest
object
4 properties 1 required
AlertActionRequest
object
3 properties
CreateAlertRequest
object
13 properties 1 required
EscalateAlertRequest
object
4 properties 1 required
AddTagsRequest
object
4 properties 1 required
ListAttachmentsResponse
object
3 properties
AsyncRequestResponse
object
3 properties
ErrorResponse
object
3 properties
CloseAlertRequest
object
3 properties
ListAlertLogsResponse
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

opsgenie-alerts-api-openapi.yml Raw ↑

Other APIs OpsGenie publishes across the network.

OpsGenie Account API
OpsGenie Escalations API
OpsGenie Heartbeats API
OpsGenie Incidents API
OpsGenie Integrations API
OpsGenie Maintenance API
OpsGenie Notification Rules API
OpsGenie On-Call API
OpsGenie Overrides API
OpsGenie Rotations API
OpsGenie Schedules API
OpsGenie Services API
Where this information came from

This is an independent, third-party profile of OpsGenie Alerts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.