API Overview

The OpsFusion API lets you send alerts to your on-call teams and manage your account from your own tools. Use it to connect monitoring systems, build automation, or pull data into reports.

What You Can Do

With the API you can:

• Push alerts from monitoring tools and custom applications, in OpsFusion’s native format or the Prometheus Alertmanager format.
• Manage alerts: list them, read the details and timeline, acknowledge them, and close them.
• Manage teams: create, update, and delete teams, and add or remove members.
• Manage users and invites: list and delete users, and create, list, and delete invites.
• Read audit logs: see who did what in your account.
• List API keys: see the names and roles of your keys.
• Read account info: name, status, plan limits, and retention settings.

Base URL

All API requests use this base URL:

https://api.opsfusion.cloud/v1

Every path starts with /account/{accountId}, where {accountId} is your OpsFusion account ID.

Authentication

Send your API key in the Authorization header. Both the raw key and the Bearer format are accepted. A key only works for its own account. See Authentication and Roles for the details.

Security

Never share your API keys or commit them to version control. Treat them like passwords.

Roles

Each API key has between one and three roles. The roles decide which endpoints the key can call.

Role	What it can do
Admin	Call every endpoint, including pushing alerts
Read Only	Call the GET endpoints only
Alert Push	Call only the two push endpoints

See Create an API Key to choose roles for your use case.

Server-Side Only

The API is built for server-to-server use. It does not support browser requests (there is no CORS), so don’t call it from front-end code. Keep your key on a server or in your automation platform.

What You Need

To use the API, you’ll need:

1. An API key - Authenticates your requests (Create an API Key)
2. Account ID - Your OpsFusion account identifier
3. Team ID - The team that should receive alerts, or whose alerts you want to read
4. HTTP client - Any tool or library that can make HTTPS requests

Finding Your Account ID and Team ID

Account ID:

1. Log in to OpsFusion
2. Click on your name at the top-right corner and select Account
3. Your Account ID is displayed in the Account Details

Team ID:

1. Navigate to Teams
2. Click on the team you want to send alerts to
3. Click on Settings and the team ID is displayed in the menu

Quick Start

Send your first alert with the Send Alerts guide. It starts with a ready-to-run example.

Documentation Map

Guides and Concepts

Page	Description
Create an API Key	Create a key in the app and choose its roles
Send Alerts	Push alerts, with code examples
Authentication and Roles	Header formats, roles, and which endpoints each role can call
Pagination	Page through alerts, audit logs, teams, and users
Errors	Status codes, error bodies, and common causes

Reference

Page	Description
Account	Read account details and limits
Alerts	List alerts, get one alert, and acknowledge or close it
API Keys	List your API keys
Audit Logs	List and read audit entries
Invites	List, create, and delete invites
Teams	Manage teams, schedules, escalations, and members
Users	List, get, and delete users

Integrations

See Integrations for setup guides for Prometheus Alertmanager, AWS CloudWatch, Datadog, Dynatrace, Freshservice, Grafana Alerting, New Relic, SolarWinds Observability, and Zabbix.

Quotas

Your plan has monthly alert and notification quotas. If a push request goes over a quota, the API returns 429 Too Many Requests. See Errors for details.

API Versions

The current API version is v1. We maintain backwards compatibility and will announce any breaking changes well in advance.

Support

For API support:

• Check the reference pages above for detailed information
• Contact support at support@opsfusion.cloud

Next Steps

1. Create an API key in your OpsFusion account
2. Send your first alert
3. Explore the reference pages to manage your account