POST
/
location-outages
/
search

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-fabric-tenant-id
string
required

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

x-fabric-request-id
string

Unique request ID

x-fabric-channel-id
string

x-fabric-channel-id identifies the sales channel through which the API request is being made; primarily for multichannel use cases. It is an optional field. The default US channel is 12 while the default Canada channel is 13.

Query Parameters

offset
number
default: 0

The number of records to skip before returning all records. The default is 0 when no value is specified.

limit
number
default: 10

The maximum number of records per page.

Body

application/json

outage search request

filters
object[]
required
sort
string
default: -outage.createdAt

Resource property on which data needed to be sorted on.

Response

200 - application/json

Outage search response

data
object[]
pagination
object

An object containing the pagination response data.

Was this page helpful?

Create OutageUpdate an outage by outageNumber