Skip to content
Support Portal
  • There are no suggestions because the search field is empty.

Accessing the AlertOps API

Call the AlertOps REST API with your user API key in the api-key header, and download the AlertOps API Reference Documentation for every endpoint and payload.

Overview

Relevant for Developers and App Admins automating AlertOps

The AlertOps REST API lets you read and change the same objects you manage in the app: users, groups, schedules, escalation policies, integrations and alerts. Every request goes to api.alertops.com and is authenticated with an API key tied to an AlertOps user.

This article covers how to connect. The full list of endpoints, request bodies and responses is in the downloadable API reference.

  • One base URL — all requests start with https://api.alertops.com/api/v2.
  • One header — send your key as api-key on every request.
  • Full reference — a Word document with every endpoint and payload.

API Reference Documentation

Relevant for Anyone who needs endpoint, payload and response details

Swagger link

Download the AlertOps API Reference Documentation (.docx)

Use it to look up the path, method, fields and example responses for each endpoint.

Before you start

Relevant for Developers setting up API access

You need:

  • An AlertOps account and a user with permission to manage the objects you want to automate. Use an App Admin or Owner user for configuration work.
  • That user's API key.
  • Any HTTP client (curl, Postman, or your language's HTTP library).

Get your API key

Relevant for Developers generating a key for scripts and integrations

Each AlertOps user has their own API key.

  1. Sign in to AlertOps.
  2. Open your user profile (or, as an admin, open the user under Users).
  3. Find the API Key section.
  4. Click Generate API Key (or Regenerate API Key if one already exists).
  5. Copy the key and store it in a secrets manager or environment variable.

Your API key acts as you
Requests made with the key have the same permissions as the user who owns it. Never commit it to source control or share it in tickets or chat. If you regenerate it, update every script and integration that uses the old key.

Make your first request

Relevant for Developers testing connectivity

Send the key in the api-key header. This request lists your groups:

curl -H "api-key: $ALERTOPS_API_KEY" \
     -H "Accept: application/json" \
     "https://api.alertops.com/api/v2/groups?limit=25"

The same call in JavaScript:

const res = await fetch("https://api.alertops.com/api/v2/groups?limit=25", {
  headers: { "api-key": process.env.ALERTOPS_API_KEY, Accept: "application/json" },
});
const groups = await res.json();

Connection settings

Field Value
Base URL https://api.alertops.com/api/v2
Auth header api-key: <your API key>
Content type application/json for request and response bodies

Best Practices

Relevant for Anyone running API automation in production

Keys

  • Keep the key in an environment variable such as ALERTOPS_API_KEY, not in code.
  • Use a dedicated user for integrations so a person leaving doesn't break automation.

Changes

  • Read an object with GET before you update it, and send back every field the API reference marks as required.
  • Try new scripts in a test account before running them against production.

Troubleshooting

Relevant for Anyone debugging API calls

I get 401 Unauthorized

  • The header name is wrong → it must be api-key, not Authorization or apikey.
  • The key was regenerated → copy the current key from the user profile.
  • The URL is wrong → check it starts with https://api.alertops.com/api/v2.

I can't find an endpoint

Need help?

Email support@alertops.com or contact your AlertOps representative.