Integrator > Introduction to xMatters REST APIs

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

Get comments

xMatters REST API

 

Get responses

xMatters REST API

 

Calendar

Get who is on call

xMatters REST API

See Get who is on call

(deprecated)

Devices

Get a device

xMatters REST API

 

Create a device

xMatters REST API

 

Modify a device

xMatters REST API

 

Delete a device

xMatters REST API

 
Device Types

Get device types

xMatters REST API

 
Device Names

Get device names

xMatters REST API

 
Events

Initiate an event

Additional REST Endpoints

 

Get a list of events

xMatters REST API

 

Get an event

xMatters REST API

 

Suspend, resume, and stop an event

xMatters REST API

 

Get a list of notifications

Additional REST Endpoints

 
Forms

Subscribe to a form

Additional REST Endpoints

 

Set the value of form properties

Additional REST Endpoints

 
Groups

Get a group

xMatters REST API

 

Create a group

xMatters REST API

 

Modify a group

xMatters REST API

 

Delete a group

xMatters REST API

 

Get groups

xMatters REST API

 

Get the group roster

xMatters REST API

 

Add a member to the group roster

xMatters REST API

 

Remove a group member

xMatters REST API

 
On-call

Get who is on call

xMatters REST API

Get who is on call

(deprecated)

People

Get a person

xMatters REST API

 

Get people

xMatters REST API

 

Create a person

xMatters REST API

 

Modify a person

xMatters REST API

 

Delete a person

xMatters REST API

 

Get a person's devices

xMatters REST API

 

Get groups a person belongs to

xMatters REST API

 
Shifts

Get a shift

xMatters REST API

 

Add a shift

xMatters REST API

 

Add a member to a shift

xMatters REST API

 
Sites

Get a site

xMatters REST API

 

Get a list of sites

Additional REST Endpoints

 

Create a site

Additional REST Endpoints

Modify a site

Additional REST Endpoints