Notification API (1.0.0)

Download OpenAPI specification:Download

URL: https://docs.equinix.com/api-support.htm Terms of Service

Users can receive voice, SMS, or email notifications based on their notifications permissions in the Equinix Customer Portal. Once a user is granted notification permissions, they may view, subscribe, and select their notification preferences. Only email notifications will be returned in the notification APIs. These APIs search through these received notifications and can also retrieve the details for a specific notification.

IbxNotification

Ibx Notifications Search

Based on filtering criteria, this API returns a summary list of IBX notifications received by a user.

query Parameters

offset	integer >= 0 The start index from which the list is created.
limit	integer [ 1 .. 100 ] Number of entries in response.
sorts	Array of strings Default: "-startDate" Items Enum: "id" "status" "startDate" "endDate" "type" "-id" "-status" "-startDate" "-endDate" "-type" Notification sort to get the notification even in the response sorted in the particular order. for example, use '-id' to sort the notification by id in descending order. And 'id' for ascending order. For descending order, the field name should be prefixed with '-'. Default sort is -startDate.

header Parameters

Authorization

required

string >= 1

Specify the Access token with prefix 'Bearer '.

Request Body schema: application/json

object

IBX Notification filter.

ibxs

Array of strings[ items non-empty ]

List of IBX to be filtered.

types

Array of strings

Items Enum: "IBX_MAINTENANCE" "IBX_INCIDENT" "IBX_ADVISORY" "IBX_SMARTVIEW"

List of IBX Notification type to be filtered.

statuses

Array of strings

Items Enum: "EXTENDED" "RESCHEDULED" "CANCELLED" "COMPLETED" "IN_PROGRESS" "RESOLVED" "UPDATED" "NEW"

List of IBX Notification type to be filterd.

object

IBX Notification date Range filter.

fromDate	string <date-time> Start date to filter the Notification event. Default will be the date 1 year prior to current date.
toDate	string <date-time> End date to filter the Notification event.

Responses

Response Schema: application/json

Array of objects (IbxNotificationSummary)

Array

id required	string Notification Identification.
type required	string (ibx-notification-type) Enum: "IBX_MAINTENANCE" "IBX_INCIDENT" "IBX_ADVISORY" "IBX_SMARTVIEW" Notification Type
startTimestamp required	string <date-time> Event/Notification start date.
endTimestamp	string <date-time> Event/Notification start date
ibxs required	Array of strings List of IBX
status required	string (notification-status) Enum: "EXTENDED" "RESCHEDULED" "CANCELLED" "COMPLETED" "IN_PROGRESS" "RESOLVED" "UPDATED" "NEW" "OTHER" Event/Notification Status.
summary	string Summary information about the event / notification.

object (PageInfo)

limit	integer Starting count based on offset.
offset	integer Limit count per page.
total	integer Matching record count / total number records matched with filter.
sorts	Array of strings

object (_links)

object (ReferenceLink)

href

required

string

object (ReferenceLink)

href

required

string

object (ReferenceLink)

href

required

string

Request samples

Payload

Content type

application/json

{"filter": {"ibxs": ["SG2",
"SV1"
],
"types": ["IBX_INCIDENT",
"IBX_ADVISORY"
],
"statuses": ["RESCHEDULED",
"NEW"
],
"dateRange": {"fromDate": "2018-01-28T03:46:36.720Z",
"toDate": "2018-03-28T03:46:36.720Z"
}
}
}

Response samples

Content type

application/json

{"data": [{"id": "5-122719992195",
"type": "IBX_ADVISORY",
"startTimestamp": "2018-01-28T03:46:36.720Z",
"endTimestamp": "2018-01-29T03:46:36.720Z",
"ibxs": ["SG1",
"CH2"
],
"status": "RESOLVED",
"summary": "Fire Alarm - IBX was Evacuated"
}
],
"page": {"limit": 10,
"offset": 30,
"total": 223,
"sorts": ["id",
"-date"
]
},
"_links": {"next": {"href": "/v1/notifications/ibx?limit=10&offset=0"
},
"self": {"href": "/v1/notifications/ibx?limit=10&offset=0"
},
"previous": {"href": "/v1/notifications/ibx?limit=10&offset=0"
}
}
}

Get Ibx Notification

This API retrieves the details of a user's IBX notification by its identification (ID) number.

path Parameters

id

required

string

Ibx Notification Id of the record need to load.

header Parameters

Authorization

required

string >= 1

Specify the Access token with prefix 'Bearer '.

Responses

Response Schema: application/json

id

required

string

Notification Identification.

type

required

string (ibx-notification-type)

Enum: "IBX_MAINTENANCE" "IBX_INCIDENT" "IBX_ADVISORY" "IBX_SMARTVIEW"

Notification Type

startTimestamp

required

string <date-time>

Event/Notification start date.

endTimestamp

string <date-time>

Event/Notification start date

ibxs

required

Array of strings

List of IBX

status

required

string (notification-status)

Enum: "EXTENDED" "RESCHEDULED" "CANCELLED" "COMPLETED" "IN_PROGRESS" "RESOLVED" "UPDATED" "NEW" "OTHER"

Event/Notification Status.

summary

string

Summary information about the event / notification.

Array of objects (NotificationEmail)

Event/Notification Email Content

Array

subject	string Subject of ibx notification email.
body	string IBX Notification event Email body content.
timestamp	string <date-time> IBX Notification event Email information received time.

Response samples

Content type

application/json

{"id": "5-122719992195",
"type": "IBX_ADVISORY",
"startTimestamp": "2018-01-28T03:46:36.720Z",
"endTimestamp": "2018-01-29T03:46:36.720Z",
"ibxs": ["SG1",
"CH2"
],
"status": "RESOLVED",
"summary": "Fire Alarm - IBX was Evacuated",
"emails": [{"subject": "FR METRO AREA NEW INCIDENT NOTIFICATION - [5-122720103065]",
"body": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum",
"timestamp": "2018-01-28T03:46:36.720Z"
}
]
}

NetworkNotification

Network Notifications Search

Based on filtering criteria, this API returns a summary list of network notifications received by a user.

query Parameters

offset	integer >= 0 The start index from which the list is created.
limit	integer [ 1 .. 100 ] Number of entries in response.
sorts	Array of strings Default: "-startDate" Items Enum: "id" "status" "startDate" "endDate" "type" "-id" "-status" "-startDate" "-endDate" "-type" Notification sort to get the notification even in the response sorted in the particular order. for example, use '-id' to sort the notification by id in descending order. And 'id' for ascending order. For descending order, the field name should be prefixed with '-'. Default sort is -startDate.

header Parameters

Authorization

required

string >= 1

Specify the Access token with prefix 'Bearer '.

Request Body schema: application/json

object

Network Notification filter.

ibxs

Array of strings[ items non-empty ]

List of IBX to be filterd.

types

Array of strings

Items Enum: "NETWORK_INCIDENT" "NETWORK_MAINTENANCE"

List of Network Notification type to be filtered.

productTypes

Array of strings[ items non-empty ]

List of network product type (Possible values: EXPEDITE, CLOUD_EXCHANGE, CLOUD_IX, CROSS_CONNECT, EQUINIX_CONNECT, ETHERNET_EXCHANGE, INTER_METRO_CONNECT, INTERNET_EXCHANGE, MANAGEMENT_ACCESS, METRO_CONNECT, MOBILITY_EXCHANGE, NETWORK_TIMING, VMMR_SDH, VOIP, BI_VLAN, BI_CLOUD). It may return UNKNOWN if no known product type is found.

statuses

Array of strings

Items Enum: "EXTENDED" "RESCHEDULED" "CANCELLED" "COMPLETED" "IN_PROGRESS" "RESOLVED" "UPDATED" "NEW"

List of Network Notification type to be filterd.

object

Network Notification date Range filter.

fromDate	string <date-time> Start date to filter the Notification event. Default will be the date 1 year prior to current date.
toDate	string <date-time> End date to filter the Notification event.

Responses

Response Schema: application/json

Array of objects (NetworkNotification)

Array

id required	string Notification Identification.
type required	string (network-notification-type) Enum: "NETWORK_INCIDENT" "NETWORK_MAINTENANCE" Notification Type.
startTimestamp required	string <date-time> Event/Notification start date.
endTimestamp	string <date-time> Event/Notification start date.
ibxs required	Array of strings List of IBX
status required	string (notification-status) Enum: "EXTENDED" "RESCHEDULED" "CANCELLED" "COMPLETED" "IN_PROGRESS" "RESOLVED" "UPDATED" "NEW" "OTHER" Event/Notification Status.
productTypes	Array of strings[ items non-empty ] List of network product type (example: ETHERNET_EXCHANGE, INTERNET_EXCHANGE, CROSS_CONNECT, METRO_CONNECT, CLOUD_IX). It may return UNKNOWN if no known product type is found.
summary	string Summary information about the event / notification.

object (PageInfo)

limit	integer Starting count based on offset.
offset	integer Limit count per page.
total	integer Matching record count / total number records matched with filter.
sorts	Array of strings

object (_links)

object (ReferenceLink)

href

required

string

object (ReferenceLink)

href

required

string

object (ReferenceLink)

href

required

string

Request samples

Payload

Content type

application/json

{"filter": {"ibxs": ["CH2",
"SG1"
],
"types": ["NETWORK_INCIDENT"
],
"productTypes": ["CLOUD_EXCHANGE",
"METRO_CONNECT"
],
"statuses": ["RESCHEDULED",
"NEW"
],
"dateRange": {"fromDate": "2018-01-28T03:46:36.720Z",
"toDate": "2018-03-28T03:46:36.720Z"
}
}
}

Response samples

Content type

application/json

{"data": [{"id": "5-122662504647",
"type": "NETWORK_MAINTENANCE",
"startTimestamp": "2018-01-28T03:46:36.720Z",
"endTimestamp": "2018-01-29T03:46:36.720Z",
"ibxs": ["SG1",
"SG2"
],
"status": "RESOLVED",
"productTypes": ["INTERNET_EXCHANGE",
"METRO_CONNECT"
],
"summary": "line card replacement of dis01.wa1"
}
],
"page": {"limit": 10,
"offset": 30,
"total": 223,
"sorts": ["id",
"-date"
]
},
"_links": {"next": {"href": "/v1/notifications/ibx?limit=10&offset=0"
},
"self": {"href": "/v1/notifications/ibx?limit=10&offset=0"
},
"previous": {"href": "/v1/notifications/ibx?limit=10&offset=0"
}
}
}

Get Network Notification

This API retrieves the details of a user's network notification by its identification ID number.

path Parameters

id

required

string

Network Notification Id of the record need to load.

header Parameters

Authorization

required

string >= 1

Specify the Access token with prefix 'Bearer '.

Responses

Response Schema: application/json

id

required

string

Notification Identification.

type

required

string (network-notification-type)

Enum: "NETWORK_INCIDENT" "NETWORK_MAINTENANCE"

Notification Type.

startTimestamp

required

string <date-time>

Event/Notification start date.

endTimestamp

string <date-time>

Event/Notification start date.

ibxs

required

Array of strings

List of IBX

status

required

string (notification-status)

Enum: "EXTENDED" "RESCHEDULED" "CANCELLED" "COMPLETED" "IN_PROGRESS" "RESOLVED" "UPDATED" "NEW" "OTHER"

Event/Notification Status.

productTypes

Array of strings[ items non-empty ]

List of network product type (example: ETHERNET_EXCHANGE, INTERNET_EXCHANGE, CROSS_CONNECT, METRO_CONNECT, CLOUD_IX). It may return UNKNOWN if no known product type is found.

summary

string

Summary information about the event / notification.

Array of objects (NotificationEmail)

Event/Notification Email Content

Array

subject	string Subject of ibx notification email.
body	string IBX Notification event Email body content.
timestamp	string <date-time> IBX Notification event Email information received time.

Response samples

Content type

application/json

{"id": "5-122662504647",
"type": "NETWORK_MAINTENANCE",
"startTimestamp": "2018-01-28T03:46:36.720Z",
"endTimestamp": "2018-01-29T03:46:36.720Z",
"ibxs": ["SG1",
"SG2"
],
"status": "RESOLVED",
"productTypes": ["INTERNET_EXCHANGE",
"METRO_CONNECT"
],
"summary": "line card replacement of dis01.wa1",
"emails": [{"subject": "FR METRO AREA NEW INCIDENT NOTIFICATION - [5-122720103065]",
"body": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum",
"timestamp": "2018-01-28T03:46:36.720Z"
}
]
}