Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

xMatters Plans API

The Plans API from xMatters — 2 operation(s) for plans.

xMatters Plans API is one of 11 APIs that xMatters publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Plans. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 3 operations across 2 paths. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against a single base URL, https://{company}.{deployment}.xmatters.com/api/xm/1.

3 operations 2 paths 0 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://{company}.xmatters.com/api/xm/1
Authentication
HTTP Basic, OAuth 2.0
Resource Areas
1

Authentication & Security 2

xMatters Plans API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (BasicAuth). It supports OAuth 2.0 (OAuth2) using the password flow. By default, every request must be authenticated.

  • BasicAuth — HTTP Basic authentication using a username and password or API key.

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Plans 3
GET
/plans
List communication plans
listPlans → 200
POST
/plans
Create a communication plan
createPlan → 201
GET
/plans/{planId}
Get a specific plan
getPlan 1 param → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xmatters-plans-api-openapi.yml Raw ↑

Other APIs xMatters publishes across the network.

xMatters REST API
xMatters Devices API
xMatters Events API
xMatters Groups API
xMatters Integrations API
xMatters OnCall API
xMatters People API
xMatters Scenarios API
xMatters Services API
xMatters Shifts API