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 Notification Rules API

Operations for managing user notification rules and their steps.

OpsGenie Notification Rules 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 Notification Rules. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and 3 JSON Schemas.

This API exposes 12 operations across 6 paths, and defines 15 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.

12 operations 6 paths 15 schemas 2 DELETE4 GET2 PATCH4 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 Notification Rules 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 12

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

Notification Rules 12

Operations for managing user notification rules and their steps.

POST
/v2/users/{identifier}/notification-rules
Create notification rule
createNotificationRule 1 param body → 201400401
GET
/v2/users/{identifier}/notification-rules
List notification rules
listNotificationRules 1 param → 200401
GET
/v2/users/{identifier}/notification-rules/{ruleId}
Get notification rule
getNotificationRule 2 params → 200401404
PATCH
/v2/users/{identifier}/notification-rules/{ruleId}
Update notification rule
updateNotificationRule 2 params body → 200400401404
DELETE
/v2/users/{identifier}/notification-rules/{ruleId}
Delete notification rule
deleteNotificationRule 2 params → 200401404
POST
/v2/users/{identifier}/notification-rules/{ruleId}/enable
Enable notification rule
enableNotificationRule 2 params → 200401
POST
/v2/users/{identifier}/notification-rules/{ruleId}/disable
Disable notification rule
disableNotificationRule 2 params → 200401
POST
/v2/users/{identifier}/notification-rules/{ruleId}/steps
Create notification rule step
createNotificationRuleStep 2 params body → 201400401
GET
/v2/users/{identifier}/notification-rules/{ruleId}/steps
List notification rule steps
listNotificationRuleSteps 2 params → 200401
GET
/v2/users/{identifier}/notification-rules/{ruleId}/steps/{stepId}
Get notification rule step
getNotificationRuleStep 3 params → 200401404
PATCH
/v2/users/{identifier}/notification-rules/{ruleId}/steps/{stepId}
Update notification rule step
updateNotificationRuleStep 3 params body → 200400401
DELETE
/v2/users/{identifier}/notification-rules/{ruleId}/steps/{stepId}
Delete notification rule step
deleteNotificationRuleStep 3 params → 200401

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are CreateNotificationRuleRequest (10 properties), NotificationRule (9 properties), UpdateNotificationRuleRequest (9 properties), NotificationRuleStep (4 properties). Each schema is shown below with its type and property counts.

CreateNotificationRuleResponse
object
3 properties
CreateNotificationRuleRequest
object
10 properties 2 required
TimeRestriction
object
2 properties
ErrorResponse
object
3 properties
ListNotificationRulesResponse
object
3 properties
NotificationRuleStep
object
4 properties
GetNotificationRuleResponse
object
3 properties
NotificationRule
object
9 properties
NotificationCriteria
object
2 properties
ListNotificationRuleStepsResponse
object
3 properties
UpdateNotificationRuleRequest
object
9 properties
UpdateNotificationRuleStepRequest
object
3 properties
CreateNotificationRuleStepRequest
object
3 properties 1 required
GetNotificationRuleStepResponse
object
3 properties
SuccessResponse
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

opsgenie-notification-rules-api-openapi.yml Raw ↑

Other APIs OpsGenie publishes across the network.

OpsGenie Account API
OpsGenie Alerts API
OpsGenie Escalations API
OpsGenie Heartbeats API
OpsGenie Incidents API
OpsGenie Integrations API
OpsGenie Maintenance 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 Notification Rules 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.