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

Zayo Maintenance Cases API

Monitor upcoming outages with Maintenance Cases API. The Zayo Maintenance Cases API is composed of a series of API calls that are intended to be leveraged sequentially with each request/response cycle providing the required inputs for the next step in the Maintenance Case flow.

Zayo Maintenance Cases API is one of 8 APIs that Zayo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Maintenance Cases. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 7 operations across 7 paths, and defines 16 schemas. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against a single base URL, https://api.zayo.com.

7 operations 7 paths 16 schemas 2 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://api.zayo.com
Authentication
HTTP Bearer, OAuth 2.0
Resource Areas
1

Authentication & Security 2

Zayo Maintenance Cases API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerToken). It supports OAuth 2.0 (OAuthClientCredentials) using the clientCredentials flow, exposing 1 scope. By default, every request must be authenticated.

  • BearerToken — Bearer token authentication.
  • OAuthClientCredentials — OAuth 2.0 using the Client Credentials grant type.

Paths & Operations 7

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

Maintenance Cases 7

Monitor upcoming outages with Maintenance Cases API. The Zayo Maintenance Cases API is composed of a series of API calls that are intended to be leveraged sequentially with each r…

POST
/services/service-management/v1/maintenance-cases
Get all maintenance cases
getMaintenanceCases body → 200400
POST
/services/service-management/v1/maintenance-impacts
Get all maintenance impacts
getMaintenanceImpacts body → 200400
GET
/services/service-management/v1/maintenance-cases/{caseNumber}/notifications
Get maintenance notifications
getMaintenanceNotifications 1 param → 200400
GET
/services/service-management/v1/maintenance-cases/notifications/{maintenanceNotificationName}
Get maintenance notification details
getMaintenanceNotificationDetails 1 param → 200400
POST
/services/notifications/v1/generate-auth-token
Generate auth token
generateAuthToken body → 200400
POST
/services/notifications/v1/register-callback-url
Register callback URL
registerCallbackUrl body → 200400
POST
/services/notifications/v1/send-test-notification
Send test notification
sendTestNotification body → 200400

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are orFilter (14 properties), longitude (5 properties), latitude (5 properties), fromTime (5 properties). Each schema is shown below with its type and property counts.

x2ndPrimaryDate
object
Secondary date of maintenance event.
5 properties
status
string
Current status of maintenance event.
timeZone
string
Time zone of from and to times.
fromTime
object
Maintenance event start time.
5 properties
urgency
string
Urgency of the maintenance event.
orFilter
object
14 properties
latitude
object
Latitude of maintenance event.
5 properties
longitude
object
Longitude of maintenance event.
5 properties
caseId
string
Case unique identifier related the maintenance event.
toTime
object
Maintenance event start time.
5 properties
levelOfImpact
string
Impact level of the maintenance event.
caseNumber
string
Case unique identifier related the maintenance event.
400Response
object
Bad Request
2 properties
x3rdPrimaryDate
object
Tertiary date of maintenance event.
5 properties
primaryDate
object
Primary date of maintenance event.
5 properties
location
string
Maintenance event location.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zayo-maintenance-cases-api-openapi.yml Raw ↑

Other APIs Zayo publishes across the network.

Zayo Network Discovery API
Zayo Order API
Zayo Product Catalog API
Zayo Quote API
Zayo Service Inventory API
Zayo Ticket Catalog API
Zayo Ticketing API