Notifications (V1)

Notifications (V1) API allows a user with IBX Services Notifications permission to search for notifications based on a given criteria, and to fetch specific notification details.

To search for your notifications, see Notification Management in the Getting Started section.

GET Notifications IBX {id}

	GET /notifications/ibx/{id}
Method	GET
URL or End Point	/v1/notifications/ibx/{id}
Headers	Authorization, Content-Type
Query Parameters	Not applicable
Body	Not applicable

This method returns all details for a specific IBX notification by its identification (ID) number. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.

If you are unaware of how to obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Access Token section.

The following screenshots show a sample curl request and JSON response for this API. The response indicates the details returned for ibxId, GBL000006121231.

Copy

curl -X
GET "https://api.equinix.com/v1/notifications/ibx/GBL000006121231"
-H "content-type: application/json"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

The description of the URL parameter is as follows:

URL Parameter name	Mandatory	Type	Example	Description
id	Yes	string	GBL000006121231	ID number of the IBX notification. To get the id, refer to Retrieve IBX Notifications under the Getting Started for ECP use cases. Only 1 IBX ID number may be passed at a time.

Copy

{
    "notificationNumber": "5-195822495668",
    "id": "GBL000006121231",
    "type": "IBX_MAINTENANCE",
    "startTimestamp": "2020-03-19T06:00:00Z",
    "endTimestamp": "2020-03-20T18:00:00Z",
    "ibxs": [
        "SV5"
    ],
    "globalNotification": false,
    "status": "COMPLETED",
    "priority": null,
    "summary": "Equinix and service vendor will be performing annual preventive maintenance on UPS / ASTS system B-2. Loads from the B-2 system will be transferred to the "Reserve" UPS system during this maintenance.  Redundancy will be reduced.",
    "emails": [
      {
        "subject": "COMPLETED - Scheduled UPS / ASTS System B-2 Annual PM at the SV5 IBX  [5-195822495668]",
        "body": "<p><span style=\"font-family:Arial, Helvetica, sans-serif; font-size:12px; color:#555555; \" >\nDear Equinix Customer,<br />\n<br />\nThe maintenance listed below has now been completed.<br />\n<br />\n</p></span>\n<hr>\n<p><span style=\"font-family:Arial, Helvetica, sans-serif; font-size:12px; color:#555555; \" ><br />\nDear Equinix Customer,<br />\n<br />\n<b>DATE:</b>\t\t19-MAR-2020 - 20-MAR-2020<br />\n<br />\n<b>SPAN:\t\t19-MAR-2020 - 20-MAR-2020</b><br />\n<br />\n<b>LOCAL:</b>\t\tTHURSDAY, 19 MAR 06:00 - THURSDAY, 19 MAR 18:00<br />\n<b>UTC:</b>\t\tTHURSDAY, 19 MAR 13:00 - FRIDAY, 20 MAR 01:00<br />\n<br />\n<b>LOCAL:</b>\t\tFRIDAY, 20 MAR 06:00 - FRIDAY, 20 MAR 18:00<br />\n<b>UTC:</b>\t\tFRIDAY, 20 MAR 13:00 - SATURDAY, 21 MAR 01:00<br />\n<br />\n<b>IBX:</b>\t\tSV5<br />\n<br />\n<b>DESCRIPTION:</b>\tEquinix and service vendor will be performing annual preventive maintenance on UPS / ASTS system B-2. Loads from the B-2 system will be transferred to the “Reserve” UPS system during this maintenance.  Redundancy will be reduced.<br/><br/>\nThe equipment being maintained supports your circuits indicated in the table.\n<br/>\n<table style=\"font-family:Arial, Helvetica, sans-serif; font-size:12px; color:#555555; width:100%\">\n\t<tr>\n\t\t<th>Account#</th>\n\t\t<th>Cage #</th>\n\t\t<th>Cabinet #</th>\n\t\t<th>Serial #</th>\n\t\t<th>Circuit Type</th>\n\t</tr>\n\t\t<tr>\t\t\n\t\t\t<td align=\"center\">570223</td>\n\t\t\n\t\t\t<td align=\"center\">051710</td>\n\t\t\n\t\t\t<td align=\"center\">0103</td>\n\t\t\n\t\t\t<td align=\"center\">21209982</td>\n\t\t\n\t\t\t<td align=\"center\">Primary</td>\n\t</tr>\n\t<tr>\t\t\n\t\t\t<td align=\"center\">570223</td>\n\t\t\n\t\t\t<td align=\"center\">051710</td>\n\t\t\n\t\t\t<td align=\"center\">0103</td>\n\t\t\n\t\t\t<td align=\"center\">21209983</td>\n\t\t\n\t\t\t<td align=\"center\">Redundant</td>\n\t</tr>\n</table>\n<span style=\"font-family:Arial, Helvetica, sans-serif; font-size:12px; color:#555555; \" >\n<br/>\n<br />Equinix engineers will work to ensure the maintenance does not impact your operations.  This activity is fully scripted and may include the use of equipment system vendors and service providers.<br />\n<br />\nDuring this period, all services (Smart Hands, installations, work visits, etc.) will continue in accordance with our normal procedures.<br />\n<br />\nThe EOC is available to provide up-to-date status information or additional details, should you have any questions regarding the maintenance.  Please reference 5-195822495668. <br />\n<br />\nSincerely,  <br> Equinix Operations Center </span></p><tr ><td height=\"20\"></td></tr><tr ><td height=\"35\" valign=\"top\" ><div style=\"font-family:Arial, Helvetica, sans-serif; font-size:12px; color:#555555; \" ><p><span style=\"font-family:Arial, Helvetica, sans-serif; font-size:13px; color:#000000; font-weight:bold; \">Contacts:</span></p>  <p>  To place orders, schedule site access, report trouble or manage your user list online, please visit: <a href=\"http://www.equinix.com/contact-us/customer-support/ \">http://www.equinix.com/contact-us/customer-support/ </a></p><p>Please do not reply to this email address. If you have any questions or concerns regarding this notification, please email  <a href=\"mailto:EquinixMaintenance@equinix.com\">Service Desk</a>  and include the ticket [5-195822495668] in the subject line. If the matter is urgent, you may contact the Service Desk North America  by phone at +1.866.EQUINIX (378.4649) (USA or Canada) or +1.408.451.5200 (outside USA or Canada)  for an up-to-date status.</p></div><tr ><td height=\"35\" valign=\"top\" ><div style=\"font-family:Arial, Helvetica, sans-serif; font-size:12px; color:#555555; \" ><br />\n<center>To unsubscribe from notifications, please log in to the <a href =\"https://customerportal.equinix.com/user/notifications\" target=\"_blank\">Equinix Customer Portal </a> and change your preferences.</center><br />\n<pre><font face=\"arial\"></font></pre></div>",
        "timestamp": "2020-03-21T01:15:05Z",
        "attachmentIds": []
     }
    ]
}

The description of the response payload is as follows:

Field name	Type	Example	Description
notificationNumber	string	5-195822495668	Notification ID number. One 'notificationNumber' can have various types of statuses.
id	string	GBL000006121231	An unique ID number of the IBX notification that relates to the specific notificationNumber.
type	string	IBX_MAINTENANCE	The notification type. To get the full set of IBX notification types, refer to Search for IBX Notifications under the Getting Started section.
startTimestamp	string	2020-03-19T06:00:00Z	The starting date and time of the notification.
endTimestamp	string	2020-03-20T18:00:00Z	The ending date and time of the notification. If no 'endTimestamp' is specified, the value 'null' is returned.
ibxs	array[strings]	SV5	The IBX location code(s) associated with this notification.
globalNotification	boolean	false	Indicates if the IBX notification is global. Default value: false
status	string	COMPLETED	The status of the IBX notification. To get the full set of IBX notification statuses, refer to Search for IBX Notifications under the Getting Started section.
priority	string	LOW	The priority level of the notification. All notification types are handled based on priority. Priority refers to events and incidents and specifies the order in which incidents should be addressed.
summary	string	Equinix and service vendor will be performing annual preventive maintenance on UPS / ASTS system B-2. Loads from the B2 system will be transferred to the "Reserve" UPS system during this maintenance. Redundancy will be reduced.	A summary description of the IBX notification at the time it was first created. This summary description of these notifications remain unchanged througout the various changes of notification status.
emails	array[objects]		The notification email(s) information. Emails array comprising object(s) with emial details. Each email object contains the following parameters where applicable: subject, body, timestamp, attachmentId(s). Multiple emails may be linked to the same IBX notification ID number.
subject	string	COMPLETED - Scheduled UPS / ASTS System B2 Annual PM at the SV5 IBX [5-195822495668]	Subject title of the notification email.
body	string		Body of the notification email in HTML format.
timestamp	string	2020-02-11T19:00:01Z	Date and time the notification email was received.
attachmentIds	array[strings]		The ID(s) of the email attachments.

If you get "Insufficient permissions" error, contact your Master Administrator.

GET Notifications Network {id}

	GET /notifications/network/{id}
Method	GET
URL or End Point	/v1/notifications/network/{id}
Headers	Authorization, Content-Type
Query Parameters	Not applicable
Body	Not applicable

This method returns all details for a specific network notification by its identification (ID) number. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.

If you are unaware of how to obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Access Token section.

The following screenshots show a sample curl request and JSON response for this API. The response indicates the details returned for network ID, GBL000007463303.

Copy

curl -X
GET "https://api.equinix.com/v1/notifications/network/GBL000007463303"
-H "content-type: application/json"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

The description of the URL parameter is as follows:

URL Parameter name	Mandatory	Type	Example	Description
id	Yes	string	GBL000007463303	ID number of the network notification. To get the id, refer to Retrieve Network Notifications under the Getting Started for ECP use cases. Only 1 network ID number may be passed at a time.

Copy

{
    "notificationNumber": "EQ-GL-20200904-00144",
    "id": "GBL000007463303",
    "type": "NETWORK_MAINTENANCE",
    "startTimestamp": "2020-09-14T00:01:00Z",
    "endTimestamp": "2020-09-14T05:00:00Z",
    "ibxs": [
        "SV1"
    ],
    "status": "COMPLETED",
    "priority": null,
    "productTypes": [
        "METRO_CONNECT"
    ],
    "summary": "Equinix dark fiber provider will be performing hot cut to roll off leased fibers onto their owned fibers.\n\nCustomers may experience a brief disruption of services during the maintenance window when the line side fiber switches to the protect path.",
    "emails": [
        {
            "subject": "COMPLETED - Scheduled Dark Fiber provider maintenance-SV Metro Area Network Maintenance (SERVICE IMPACTING)-14-SEP-2020 [EQ-GL-20200904-00144]",
            "body": "<p><span style=\"font-family:Arial, Helvetica, sans-serif; font-size:12px; color:#555555; \" >\nDear Equinix Customer,<br />\n<br />\nThe maintenance listed below has now been completed.<br />\n<br />\n</p></span>\n<hr>\n<p><span style=\"font-family:Arial, Helvetica, sans-serif; font-size:12px; color:#555555; \" ><br />\nDear Equinix Customer,<br />\n<br />\n<b>DATE:</b>\t\t14-SEP-2020<br />\n<br />\n<b>SPAN:\t\t14-SEP-2020 - 14-SEP-2020</b><br />\n<br />\n<b>LOCAL:</b>\t\tMONDAY, 14 SEP 00:01 - MONDAY, 14 SEP 05:00<br />\n<b>UTC:</b>\t\tMONDAY, 14 SEP 07:01 - MONDAY, 14 SEP 12:00<br />\n<br />\n<b>IBX(s): </b>SV2,SV4<br />\n<br />\n<Int Desc><br />\n<b>DESCRIPTION:</b>Equinix dark fiber provider will be performing hot cut to roll off leased fibers onto their owned fibers.<br />\n<br />\nCustomers may experience a brief disruption of services during the maintenance window when the line side fiber switches to the protect path.<br />\n<br/><br />\n<b>PRODUCTS:</b>\tMETRO CONNECT<br />\n<br />\n<b>IMPACT:</b>\t<font style=\"background-color: yellow;\">There will be service interruptions.</font><br />\n<br/>\n    <b><u>Metro Connect</u></b>\n\t\n\n\t\t\t<table style=\"font-family:Arial, Helvetica, sans-serif; font-size:12px; color:#555555; width:100%;border:1px solid black;border-collapse:collapse;table-layout:fixed\">\n\t\t\t<tr>\n\t\t\t\t    <th style=\"border:1px solid; width:33.333%\">Account #</th>\n\t\t\t\t    <th style=\"border:1px solid; width:33.333%\">Product</th>\n\t\t\t\t    <th style=\"border:1px solid; width:33.333%\">Service Serial #</th>\n\t\t\t</tr>\n\t\t\t\t<tr>\n\t\t\t\t\t\t <td align=\"center\" style=\"border:1px solid;word-wrap: break-word;  width:33.333%\">132575</td>\n\t\t\t\t\t\t <td align=\"center\" style=\"border:1px solid;word-wrap: break-word;  width:33.333%\">Metro Connect</td>\n\t\t\t\t\t\t <td align=\"center\" style=\"border:1px solid;word-wrap: break-word;  width:33.333%\">21446874-A</td>\n\t\t\t\t</tr>\n\t\t\t</table>\n\t<br/>\n<span style=\"font-family:Arial, Helvetica, sans-serif; font-size:12px; color:#555555; \" ><br />\nWe apologize for any inconvenience you may experience during this activity.  Your cooperation and understanding are greatly appreciated.<br />\n<br />\nTheEquinix NOC is available to provide up-to-date status information or additional details, should you have any questions regarding the maintenance.  Please reference EQ-GL-20200904-00144. <br />\n<br />\n<p>Sincerely,  <br>  Equinix NOC </p>  </span></p><tr ><td height=\"20\"></td>  </tr>  <tr ><td height=\"35\" valign=\"top\" ><div style=\"font-family:Arial, Helvetica, sans-serif; font-size:12px; color:#555555; \" ><span style=\"font-family:Arial, Helvetica, sans-serif; font-size:13px; color:#000000; font-weight:bold; \">Contacts:</span>   <p>  To place orders, schedule site access, report trouble or manage your user list online, please visit: <a href=\"http://www.equinix.com/contact-us/customer-support/ \">http://www.equinix.com/contact-us/customer-support/ </a></p><p>Please do not reply to this email address. If you have any questions or concerns regarding this notification, please email  <a href=\"mailto:servicedesk@equinix.com\">Service Desk</a>  and include the ticket [EQ-GL-20200904-00144] in the subject line. If the matter is urgent, you may contact the Service Desk North America  by phone at +1.866.EQUINIX (378.4649) (USA or Canada) or +1.408.451.5200 (outside USA or Canada)  for an up-to-date status.</p></div><tr ><td height=\"35\" valign=\"top\" ><div style=\"font-family:Arial, Helvetica, sans-serif; font-size:12px; color:#555555; \" ><br />\n<center>To unsubscribe from notifications, please log in to the <a href =\"https://customerportal.equinix.com/user/notifications\" target=\"_blank\">Equinix Customer Portal </a> and change your preferences.</center><br />\n<pre><font face=\"arial\"></font></pre></div>",
            "timestamp": "2020-09-14T12:15:06Z",
            "attachmentIds": []
        }
    ]
}

The description of the response payload is as follows:

Field name	Type	Example	Description
notificationNumber	string	EQ-GL-20200904-00144	Notification ID number. One 'notificationNumber' can have various types of statuses.
id	string	GBL000007463303	An unique ID number of the network notification that relates to the specific notificationNumber.
type	string	NETWORK_MAINTENANCE	The notification type. To get the full set of network notification types, refer to Search for Network Notifications under the Getting Started section.
startTimestamp	string	2020-09-14T00:01:00Z	The starting date and time of the notification.
endTimestamp	string	2020-09-14T05:00:00Z	The ending date and time of the notification. If no 'endTimestamp' is specified, the value 'null' is returned.
ibxs	array[strings]	SV1	The IBX location code(s) associated with this notification.
status	string	COMPLETED	The status of the notification. To get the full set of network notification statuses, refer to Search for Network Notifications under the Getting Started section.
priority	string	LOW	The priority level of the notification. All notification types are handled based on priority. Priority refers to events and incidents and specifies the order in which incidents should be addressed.
productTypes	array[strings]	METRO_CONNECT	The product types that the notifications relate to. To get the full set of product types, refer to Search for Network Notifications under the API Reference section.
summary	string	Equinix dark fiber provider will be performing hot cut to roll off leased fibers onto their owned fibers.\n\nCustomers may experience a brief disruption of services during the maintenance window when the line side fiber switches to the protect path.	A summary description of the network notification at the time it was first created. This summary description of these notifications remain unchanged througout the various changes of notification status.
emails	array[objects]		The notification email(s) information. Emails array comprising object(s) with emial details. Each email object contains the following parameters where applicable: subject, body, timestamp, attachmentId(s). Multiple emails may be linked to the same network notification ID number.
subject	string	COMPLETED - Scheduled Dark Fiber provider maintenance-SV Metro Area Network Maintenance (SERVICE IMPACTING)-14-SEP-2020 [EQ-GL-20200904-00144]	Subject title of the notification email.
body	string		Body of the notification email in HTML format.
timestamp	string	2020-02-11T19:00:01Z	Date and time the notification email was received.
attachmentIds	array[strings]		The ID(s) of the email attachments.

If you get "Insufficient permissions" error, contact your Master Administrator.

GET Notifications IBX {id}

GET Notifications Network {id}

Was this documentation helpful?