Skip to main content
API docs by Redocly

Notifications API (2.0.1)

Download OpenAPI specification:Download

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

The notifications API will return email notifications for different categories, such as orders, IBX maintenance announcements, incidents and advisories. Please check the Category, Type, and ProductType schemas for the allowed lists of values to perform a search request.

You can find more information on the Equinix Developer Portal.

Events

Orders and colo notifications

Search notification

Search events by search criteria

Authorizations:
BearerAuth
Request Body schema: application/json
object (Filter the event)
category
Array of strings (Category) non-empty
Items Enum: "GENERAL" "INCIDENT" "MAINTENANCE" "ADVISORY"
type
Array of strings (Type) non-empty
Items Enum: "ORDERS" "SMART_HANDS_SUPPORT_PLAN" "NETWORK_SPECIFICATION" "NETWORK_INCIDENT" "NETWORK_MAINTENANCE" "VIRTUAL_ASSET_UPDATES" "IBX_MAINTENANCE" "IBX_INCIDENT" "IBX_ADVISORY" "IBX_SECURITY_INCIDENT" "MANAGED_SERVICES_INCIDENT" "MANAGED_SERVICES_IBX_MAINTENANCE" "MANAGED_SERVICES_NETWORK_MAINTENANCE"
notificationNumber
Array of strings non-empty
accountNumber
Array of strings non-empty
createdDateTime
Array of strings non-empty
Array of objects (SortCriteria)
Array
direction
string (SortDirection)
Default: "DESC"
Enum: "DESC" "ASC"

Sorting direction

property
string (SortBy)
Default: "createdDateTime"
Value: "createdDateTime"

Possible field names to use on sorting

object (PaginationRequest)

Pagination request information

offset
integer >= 0
Default: 0

Index of the first element.

limit
integer >= 1
Default: 25

Number of elements to be requested per page. Number must be between 1 and 100, and the default is 25.

Responses

Response Schema: application/json
Array of objects (Event)

POST Event Search

Array
notificationNumber
required
string

Notification reference number.

category
string (Category)
Default: "GENERAL"
Enum: "GENERAL" "INCIDENT" "MAINTENANCE" "ADVISORY"

Category of events.

type
required
string (Type)
Enum: "ORDERS" "SMART_HANDS_SUPPORT_PLAN" "NETWORK_SPECIFICATION" "NETWORK_INCIDENT" "NETWORK_MAINTENANCE" "VIRTUAL_ASSET_UPDATES" "IBX_MAINTENANCE" "IBX_INCIDENT" "IBX_ADVISORY" "IBX_SECURITY_INCIDENT" "MANAGED_SERVICES_INCIDENT" "MANAGED_SERVICES_IBX_MAINTENANCE" "MANAGED_SERVICES_NETWORK_MAINTENANCE"

Notification types.

productTypes
Array of strings (ProductType)
Items Enum: "ACCESSORIES" "BI_CLOUD" "BI_VLA" "BOOK_CONFERENCEROOM" "CABINET" "CAGE" "EQUINIX_FABRIC" "CLOUD_IX" "CROSS_CONNECT" "DEINSTALL" "EQUINIX_CONNECT" "EQUINIX_CONNECT_PORT" "ETHERNET_EXCHANGE" "EXPEDITE" "HANDSCAN" "INBOUND_SHIPMENT" "INTERNET_EXCHANGE" "INTERNET_EXCHANGE_PORT" "INTER_METRO_CONNECT" "MANAGEMENT_ACCESS" "METRO_CONNECT" "MOBILITY_EXCHANGE" "NETWORK_TIMING" "OTHER" "OTHER_SERVICES" "OUTBOUND_SHIPMENT" "POWER" "SITE_VISIT" "SMART_HANDS" "SMART_HANDS_MONTHLY_PLAN" "SMART_HANDS_ANNUAL_PLAN" "TOUR_REQUEST" "TROUBLE_TICKET" "VMMR_SDH" "VOIP" "UNKNOWN" "NETWORK_EDGE" "FABRIC" "PRECISION_TIME"

Product types associated with the given order notification.

ibxs
Array of strings

IBX(s) associated with the notification.

createdDateTime
string <date-time>

Time when the notification was sent.

summary
required
string

Notification summary.

status
string (Status)
Enum: "CANCELLED" "COMPLETED" "EXPEDITE" "EXPIRED_CANCELLED" "EXTENDED" "IN_PROGRESS" "MODIFIED" "NEW" "OTHER" "RECEIVED" "REQUIRE_APPROVAL" "RESCHEDULED" "RESOLVED" "SCHEDULED" "SHIPMENT_NOTIFICATION" "UPDATED" "FAILED" "PROVISIONED" "DEPROVISIONED"

Event/Notification Status.If no status found none will be returned

Array of objects (NotificationContact)

Notification recipient list, if any.

Array of objects (AdditionalInfoAttribute)

Additional info, if any. Available fields: SUPPORT_PLAN_PERCENTAGE, ACCOUNT_NAME, ACCOUNT_NUMBER, START_DATETIME, END_DATETIME, PRIORITY, IS_GLOBAL_NOTIFICATION

object (Pagination)

Pagination response information

offset
integer >= 0
Default: 0

Index of the first item returned in the response. The default is 0.

limit
required
integer >= 0
Default: 25

Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 25.

total
required
integer >= 0

Total number of elements returned.

next
string

The offset value relative to the next item in the response.

previous
string

The offset value relative to the previous item in the response.

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "sort": [
    ],
  • "pagination": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}