Skip to main content

Effective 10 September 2024, API Documentation can be found on our Equinix Product Documentation site.
The content on this page will not be updated after 1 Oct 2024 and will be inaccessible after 31st Dec 2024.


IBX Notifications

IBX Notifications are near real-time notifications for any planned and unplanned Equinix IBX data center maintenance. These notifications are also triggered for any Equinix IBX data center incidents and advisory.

EMG supports below IBX notifications variants:

  1. IBX Maintenance Notifications
  2. IBX Incidents Notifications
  3. IBX Advisory Notifications
  4. IBX Security Incident Notifications

Watch the video below to know how to receive IBX data center notifications.



IBX Maintenance Notifications

Sample IBX Maintenance Notifications

{
"Task": {
"Id": "370da978-b9bd-4030-b012-9dc97e2fdf98",
"Source": "3e095d30-40ff-11e9-8959-5be078353003",
"Verb": "Update",
"Resource": "DataCenter.Maintenance",
"ContentType": "application/json",
"CreationTimeUTC": "2021-06-09T07:42:45.396Z",
"Version": "1.0",
"Body": {
"RequestorId": "97ae4427-70cb-4162-bf52-c3c7f9d7b2d8",
"ServicerId": "5-204454471282",
"State": "CONFIRMED",
"Description": "Equinix Test Maintenance",
"Sequence": "2",
"StartDateTime": "2021-03-29T17:33:00",
"EndDateTime": "2021-03-31T18:00:00",
"AccountNumber": "123456",
"Impact": "NON_SERVICE_IMPACTING",
"ProdID": "DataCenter Notification https://developer.equinix.com",
"Organizer": "Global Service Desk:mailto:support@equinix.com",
"Assets": []
}
},
"Signature": "RWNobwp7CiAgIklkIjogIjM1MGFlZjcwLTc4MWItMTFlOSogIH0KfQ==
"
}

IBX Incidents Notifications

Sample IBX Incidents Notifications

{
"Task": {
"Id": "045074a9-5e6a-478e-b2af-e9462bfa7e62",
"Source": "3e095d30-40ff-11e9-8959-5be078353003",
"Verb": "Update",
"Resource": "DataCenter.Incident",
"ContentType": "application/json",
"CreationTimeUTC": "2021-06-09T07:54:43.578Z",
"Version": "1.0",
"Body": {
"RequestorId": "97ae4427-70cb-4162-bf52-c3c7f9d7b2d8",
"ServicerId": "5-204454471282",
"State": "CONFIRMED",
"Description": "Equinix Test Incident",
"Sequence": "1",
"StartDateTime": "2021-03-23T05:56:34",
"EndDateTime": "",
"AccountNumber": "123456",
"Impact": "NON_SERVICE_IMPACTING",
"ProdID": "DataCenter Notification https://developer.equinix.com",
"Organizer": "Global Service Desk:mailto:support@equinix.com",
"Assets": []
}
},
"Signature": "RWNobwp7CiAgIklkIjogIjM1MGFlZjcwLTc4MWItMTFlOSogIH0KfQ=="
}

IBX Advisory Notifications

Sample IBX Advisory Notifications

{
"Task": {
"Id": "045074a9-5e6a-478e-b2af-e9462bfa7e62",
"Source": "3e095d30-40ff-11e9-8959-5be078353003",
"Verb": "Update",
"Resource": "DataCenter.Advisory",
"ContentType": "application/json",
"CreationTimeUTC": "2021-06-09T07:54:43.578Z",
"Version": "1.0",
"Body": {
"RequestorId": "97ae4427-70cb-4162-bf52-c3c7f9d7b2d8",
"ServicerId": "5-204454471282",
"State": "CONFIRMED",
"Description": "Equinix Test Advisory",
"Sequence": "1",
"StartDateTime": "2021-03-23T05:56:34",
"EndDateTime": "",
"AccountNumber": "103167",
"Impact": "NON_SERVICE_IMPACTING",
"ProdID": "DataCenter Notification https://developer.equinix.com",
"Organizer": "Global Service Desk:mailto:support@equinix.com",
"Assets": []
}
},
"Signature": "RWNobwp7CiAgIklkIjogIjM1MGFlZjcwLTc4MWItMTFlOSogIH0KfQ=="
}

IBX Security Incident Notifications

Sample IBX Security Incident Notifications

{
"Task": {
"Id": "045074a9-5e6a-478e-b2af-e9462bfa7e62",
"Source": "3e095d30-40ff-11e9-8959-5be078353003",
"Verb": "Update",
"Resource": "DataCenter.SecurityIncident",
"ContentType": "application/json",
"CreationTimeUTC": "2021-06-09T07:54:43.578Z",
"Version": "1.0",
"Body": {
"RequestorId": "97ae4427-70cb-4162-bf52-c3c7f9d7b2d8",
"ServicerId": "5-204454471282",
"State": "CONFIRMED",
"Description": "Equinix Test Security Incident",
"Sequence": "1",
"StartDateTime": "2021-03-23T05:56:34",
"EndDateTime": "",
"AccountNumber": "103167",
"Impact": "NON_SERVICE_IMPACTING",
"ProdID": "DataCenter Notification https://developer.equinix.com",
"Organizer": "Global Service Desk:mailto:support@equinix.com",
"Assets": []
}
},
"Signature": "RWNobwp7CiAgIklkIjogIjM1MGFlZjcwLTc4MWItMTFlOSogIH0KfQ=="
}

The description of the datacenter notification schema is as follows:

NameTypeApplicable Value(s)Description
TaskObjectThe task object comprises a common set of header attributes and a unique set of body attributes. The header attributes are applicable to all order types, whereas the body attributes vary for each order.
IDString (Guid)The unique identifier of the message. Equinix will send a unique value for each message.
SourceString (Guid)A unique value to identify the message sender. This value will be shared with the customer during the onboarding process.
VerbStringUpdateThis indicates there is an update from Equinix.
ResourceString"DataCenter.Maintenance", "DataCenter.Incident", "DataCenter.SecurityIncident", "DataCenter.Advisory"

Indicates the Type of Notification:

DataCenter.Maintenance : notifies that Equinix DataCenter is going under planned/unplanned Maintenance

DataCenter.Incident : notifies about Incident occurred at Equinix DataCenter.

DataCenter.SecurityIncident : notifies about Security Incident occurred at Equinix DataCenter.

DataCenter.Advisory : Notifies about Advisory issued for Equinix DataCenter.
ContentTypeStringapplication/json
CreateTimeUTCStringIndicates the date and time at which the notification is sent by Equinix.
VersionString1.0The version of the notification schema.
BodyObjectAn object containing the details of the notification. The attributes within the object will vary based on the resource and verb.
RequestorIdStringTBDCustomer reference number for the maintenance (if any)
ServicerIdStringIndicates the unique id supplied by Equinix for the datacenter maintenance/incident.
StateString
  • CONFIRMED
  • IN-PROCESS
  • COMPLETED
  • CANCELLED

Current State of the ticket

Supported Values:

CONFIRMED - DataCenter Maintenance/Incident is Confirmed

IN-PROCESS - DataCenter Maintenance/Incident currently in progress

COMPLETED - DataCenter Maintenance/Incident is Completed

CANCELLED - DataCenter Maintenance/Incident has been Cancelled
DescriptionObjectSummary of the ticket from Equinix DataCenter Technician.
SequenceNumberIncrementing number for the related notifications
The number starts from 0
StartDateTimeStringIndicates the Start Date and Time of maintenance
EndDateTimeString

Indicates the End Date and Time of maintenance.

This value will always be populated for Resource of Type "DataCenter.Maintenance"

This value will only be populated for State as "COMPLETED" for the below Resource Types -  DataCenter.Incident, DataCenter.SecurityIncident and DataCenter.Advisory
AccountNumberStringIndicates the Customer's Account Number related to the maintenance activity.
ImpactString
  • SERVICE_IMPACTING
  • NON_SERVICE_IMPACTING

Indicates the level/severity of impact to the customer due to the maintenance activity or incident.

Supported Values:

SERVICE_IMPACTING - indicates the activity or incident that affects your services

NON_SERVICE_IMPACTING - indicates the activity or incident that does not disrupt your services, like when backup servers keep things running despite repairs.

ProdIDStringDataCenter Notification https://developer.equinix.comIndicates the link to refer the more information on the maintenance activity.
OrganizerStringGlobal Service Desk:mailto:support@equinix.comIndicates the name of maintenance organizer with Email Id
AssetsObject

An object containing the details of the impacted customer assets with the below attributes

  • IBX
  • Cage
  • Cabinet
  • Serial Number
  • Circuit Type
This value will be populated for Resource of Types "DataCenter.Maintenance" and "DataCenter.Incident"
SignatureStringBase64 encoded signature signed with Equinix key