
Introduction to xMatters REST APIs
xMatters provides REST APIs that you can use to integrate with xMatters using any programming language that has the ability to make HTTP requests.
- xMatters REST API: The xMatters REST API is currently under development and new functionality is added to it on an ongoing basis. For more information about working with the xMatters REST API, see xMatters REST API.
- Additional REST Endpoints: Our previous REST API implementation has some functionality not yet implemented in the xMatters REST API. For more information about working with the additional REST API methods, see Additional REST API methods.
Available endpoints
The xMatters REST API and the Additional REST methods are accessed with different URLs and have slightly different usage patterns. Refer to the documentation for each API to learn about authentication, error codes, results pagination and versioning as it applies to each API. The following table summarizes the actions available in the REST APIs.
CATEGORY | ENDPOINT | NOTES |
---|---|---|
Audits |
xMatters REST API |
|
xMatters REST API |
||
Devices |
xMatters REST API |
|
xMatters REST API |
||
xMatters REST API |
||
xMatters REST API |
||
xMatters REST API |
||
Device Names |
xMatters REST API |
|
Device Types |
xMatters REST API |
|
Dynamic Teams |
xMatters REST API |
|
xMatters REST API |
||
xMatters REST API |
||
xMatters REST API |
||
xMatters REST API |
||
xMatters REST API |
||
Events |
xMatters REST API |
|
xMatters REST API |
|
|
xMatters REST API |
||
xMatters REST API |
See Get notifications for information on the deprecated method that returned event notifications. |
|
Get user delivery data
xMatters REST API |
||
xMatters REST API |
See POST trigger for information on the deprecated method that called the form directly. | |
xMatters REST API |
||
xMatters REST API |
||
Additional REST Endpoints |
||
Event Suppressions |
xMatters REST API |
|
Forms |
Additional REST Endpoints |
|
Set the value of form properties Additional REST Endpoints |
||
Get forms
xMatters REST API |
||
Get forms in a plan
xMatters REST API |
||
Get form response options
xMatters REST API |
||
xMatters REST API |
||
Groups |
xMatters REST API |
|
xMatters REST API |
||
xMatters REST API |
||
xMatters REST API |
||
xMatters REST API |
||
xMatters REST API |
||
Group Roster |
xMatters REST API |
|
Add a member to the group roster xMatters REST API |
||
xMatters REST API |
||
Import Jobs | Get import jobs
xMatters REST API |
|
Get an import job
xMatters REST API |
||
Get import job messages
xMatters REST API |
||
Integrations |
xMatters REST API |
|
xMatters REST API |
||
xMatters REST API |
||
xMatters REST API |
||
xMatters REST API |
||
xMatters REST API |
||
OAuth |
Obtain an access token and refresh token xMatters REST API |
|
xMatters REST API |
||
xMatters REST API | ||
On-call |
xMatters REST API |
(deprecated) |
People |
xMatters REST API |
|
Get a person (by query)
xMatters REST API |
||
xMatters REST API |
||
xMatters REST API |
||
xMatters REST API |
||
xMatters REST API |
||
xMatters REST API |
||
xMatters REST API |
||
xMatters REST API |
||
Plans |
xMatters REST API |
|
xMatters REST API |
||
xMatters REST API |
||
xMatters REST API |
||
xMatters REST API |
||
Plan Constants | Get plan constants
xMatters REST API |
|
Create a plan constant
xMatters REST API |
||
xMatters REST API |
||
xMatters REST API |
||
Plan Endpoints | Get endpoint
xMatters REST API |
|
Create endpoint
xMatters REST API |
||
xMatters REST API |
||
xMatters REST API |
||
Plan Properties |
xMatters REST API |
|
xMatters REST API |
||
xMatters REST API |
||
Scenarios | Get a scenario
xMatters REST API |
|
Get scenarios
xMatters REST API |
||
Create a scenario
xMatters REST API |
||
Modify a scenario
xMatters REST API |
||
Shared Libraries | Get a shared library
xMatters REST API |
|
Get shared libraries
xMatters REST API |
||
Create a shared library
xMatters REST API |
||
Modify a shared library
xMatters REST API |
||
Delete a shared library
xMatters REST API |
||
Shifts |
xMatters REST API |
|
xMatters REST API |
||
xMatters REST API |
||
xMatters REST API |
||
xMatters REST API |
||
xMatters REST API |
||
Sites |
xMatters REST API |
|
xMatters REST API |
(deprecated) |
|
xMatters REST API |
Create a site, Modify site (deprecated) |
|
xMatters REST API |
||
xMatters REST API |
||
Subscription Forms | Get a subscription form
xMatters REST API |
|
Get subscription forms
xMatters REST API |
||
Get subscription forms in a plan
xMatters REST API |
||
Subscriptions | Get subscriptions
xMatters REST API |
|
Get a subscription
xMatters REST API |
||
Create a subscription
xMatters REST API |
||
Get subscription subscribers
xMatters REST API |
||
Modify a subscription
xMatters REST API |
||
Delete a subscription
xMatters REST API |
||
Unsusbcribe a user
xMatters REST API |
||
Temporary Absences | Get temporary absences
xMatters REST API |
|
Create a temporary absence
xMatters REST API |
||
Delete a temporary absence
xMatters REST API |
||
User Uploads | Upload Users
xMatters REST API |
|
Upload Epic ZipSync
xMatters REST API |