Skip to main content
API docs by Redocly

Equinix Fabric API v4 (4.21)

Download OpenAPI specification:Download

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

Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1. Cloud Service Providers - Clouds, network and other service providers.
2. Enterprises - Other Equinix customers, vendors and partners.
3. Myself - Another customer instance deployed at Equinix.

Integrations (SDKs, Tools) links:
Fabric Java SDK
Fabric Go SDK
Fabric Python SDK
Equinix Terraform Provider
Fabric Terraform Modules
Equinix Pulumi Provider

Find more information on Equinix Docs Portal

Cloud Events

Cloud Events

Get Cloud Events by Asset Id

This API provides capability to retrieve cloud events of an asset id

Authorizations:
BearerAuth
path Parameters
asset
required
string (CloudEventAssetType)
Enum: "ports" "connections" "routers"

asset

assetId
required
string <uuid> (AssetId)
Example: 757400f8-d360-11e9-bb65-2a2ae2dbcce6

asset UUID

query Parameters
fromDateTime
string <date-time> (StartDateTime)
Example: fromDateTime=2024-07-11T18:06:21Z

Start date and time

toDateTime
string <date-time> (EndDateTime)
Example: toDateTime=2024-07-11T18:06:21Z

End date and time

offset
integer (Offset)
Default: 0
Example: offset=0

offset

limit
integer (Limit)
Default: 20
Example: limit=20

limit

Responses

Response Schema: application/json
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Array of objects (CloudEvent)

Data returned from the API call.

Array
spec
string

Cloud Event Open Telemetry specification

source
string

Cloud Event source

id
string <uuid>

Cloud Event identifier

type
string

Equinix supported event type

subject
string

Cloud Event subject

dataschema
string

Cloud Event dataschema reference

datacontenttype
string

Cloud Event data content type

severitynumber
string

Cloud Event severity number

severitytext
string

Cloud Event severity text

equinixproject
string <uuid>

Equinix project identifier

authtype
string

Cloud Event auth type

authid
string

Cloud Event user identifier

object (CloudEventData)

Response samples

Content type
application/json
{}

Get Cloud Event

This API provides capability to retrieve a cloud event by uuid

Authorizations:
BearerAuth
path Parameters
cloudEventId
required
string <uuid> (CloudEventId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Cloud Event UUID

Responses

Response Schema: application/json
spec
string

Cloud Event Open Telemetry specification

source
string

Cloud Event source

id
string <uuid>

Cloud Event identifier

type
string

Equinix supported event type

subject
string

Cloud Event subject

dataschema
string

Cloud Event dataschema reference

datacontenttype
string

Cloud Event data content type

severitynumber
string

Cloud Event severity number

severitytext
string

Cloud Event severity text

equinixproject
string <uuid>

Equinix project identifier

authtype
string

Cloud Event auth type

authid
string

Cloud Event user identifier

object (CloudEventData)
message
string

Cloud Event message

object (ResourceData)
href
string

Cloud Event asset href

uuid
string

Cloud Event asset uuid

type
string

Cloud Event asset type

name
string

Cloud Event asset name

state
string

Cloud Event asset state

object (AuthContext)
authtype
string
Enum: "system" "user"

Cloud Event auth type

authid
string
Enum: "equinix" "userId"

Cloud Event auth identifier

name
string

Cloud Event username

email
string

Cloud Event email

Response samples

Content type
application/json
{}

Search Cloud Events

This API provides capability to search cloud events from a filtered query

Authorizations:
BearerAuth
Request Body schema: application/json
required
object (CloudEventFilters)
Array of CloudEventSimpleExpression (object) (CloudEventFilter)
Array
Any of
property
string

Possible field names to use on filters:

  • /subject - Cloud Event subject description
  • /type - Cloud Event type
  • /time - Time of Cloud Events
operator
string

Possible operators to use on filters:

  • = - equal
  • > - greater than
  • >= - greater than or equal to
  • < - less than
  • <= - less than or equal to
  • BETWEEN - between
  • IN - in
values
Array of strings
object (PaginationRequest)

Pagination request information

offset
integer >= 0
Default: 0

Index of the first element.

limit
integer >= 1
Default: 20

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

Array of objects (CloudEventFilters)
Array
Array of CloudEventSimpleExpression (object) (CloudEventFilter)
Array
Any of
property
string

Possible field names to use on filters:

  • /subject - Cloud Event subject description
  • /type - Cloud Event type
  • /time - Time of Cloud Events
operator
string

Possible operators to use on filters:

  • = - equal
  • > - greater than
  • >= - greater than or equal to
  • < - less than
  • <= - less than or equal to
  • BETWEEN - between
  • IN - in
values
Array of strings

Responses

Response Schema: application/json
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Array of objects (CloudEvent)

Data returned from the API call.

Array
spec
string

Cloud Event Open Telemetry specification

source
string

Cloud Event source

id
string <uuid>

Cloud Event identifier

type
string

Equinix supported event type

subject
string

Cloud Event subject

dataschema
string

Cloud Event dataschema reference

datacontenttype
string

Cloud Event data content type

severitynumber
string

Cloud Event severity number

severitytext
string

Cloud Event severity text

equinixproject
string <uuid>

Equinix project identifier

authtype
string

Cloud Event auth type

authid
string

Cloud Event user identifier

object (CloudEventData)

Request samples

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

Response samples

Content type
application/json
{}

Cloud Routers

Cloud Routers

Search Advertised Routes

The API provides capability to get list of user's advertised routes using search criteria, including optional filtering, pagination and sorting

Authorizations:
BearerAuth
path Parameters
connectionId
required
string (ConnectionId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Connection Id

Request Body schema: application/json
required
object (ConnectionRouteEntryFilters)
Array of ConnectionRouteEntrySimpleExpression (object) or ConnectionRouteEntryOrFilter (object) (ConnectionRouteEntryFilter) <= 8 items
Array (<= 8 items)
Any of
property
string

Possible field names to use on filters:

  • /type - Route table entry type
  • /state - Route table entry state
  • /prefix - Route table entry prefix
  • /nextHop - Route table entry nextHop
  • /* - all-category search
operator
string

Possible operators to use on filters:

  • = - equal
  • != - not equal
  • > - greater than
  • >= - greater than or equal to
  • < - less than
  • <= - less than or equal to
  • [NOT] BETWEEN - (not) between
  • [NOT] LIKE - (not) like
  • [NOT] IN - (not) in
  • ~* - case-insensitive like
values
Array of strings
object (PaginationRequest)

Pagination request information

offset
integer >= 0
Default: 0

Index of the first element.

limit
integer >= 1
Default: 20

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

Array of objects (ConnectionRouteSortCriteria)
Array
direction
string (ConnectionRouteEntrySortDirection)
Default: "DESC"
Enum: "DESC" "ASC"

Sorting direction

property
string (ConnectionRouteEntrySortBy)
Default: "/changeLog/updatedDateTime"
Enum: "/changeLog/createdDateTime" "/changeLog/updatedDateTime" "/med" "/connection/name" "/type" "/prefix" "/nextHop"

Possible field names to use on sorting

Responses

Response Schema: application/json
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Array of objects (ConnectionRouteTableEntry)

Data returned from the API call.

Array
type
required
string (RouteTableEntryType)
Enum: "IPv4_BGP_ROUTE" "IPv4_STATIC_ROUTE" "IPv4_DIRECT_ROUTE" "IPv6_BGP_ROUTE" "IPv6_STATIC_ROUTE" "IPv6_DIRECT_ROUTE"

Route table entry type

protocolType
string (RouteTableEntryProtocolType)
Enum: "BGP" "STATIC" "DIRECT"

Route table entry protocol type

state
required
string
Enum: "ACTIVE" "INACTIVE"
age
string
prefix
string
nextHop
string
MED
integer
localPreference
integer
asPath
Array of strings
object (ConnectionRouteTableEntry_connection)
required
object (Changelog)

Change log

Request samples

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

Response samples

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

Search Received Routes

The API provides capability to get list of received routes using search criteria, including optional filtering, pagination and sorting

Authorizations:
BearerAuth
path Parameters
connectionId
required
string (ConnectionId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Connection Id

Request Body schema: application/json
required
object (ConnectionRouteEntryFilters)
Array of ConnectionRouteEntrySimpleExpression (object) or ConnectionRouteEntryOrFilter (object) (ConnectionRouteEntryFilter) <= 8 items
Array (<= 8 items)
Any of
property
string

Possible field names to use on filters:

  • /type - Route table entry type
  • /state - Route table entry state
  • /prefix - Route table entry prefix
  • /nextHop - Route table entry nextHop
  • /* - all-category search
operator
string

Possible operators to use on filters:

  • = - equal
  • != - not equal
  • > - greater than
  • >= - greater than or equal to
  • < - less than
  • <= - less than or equal to
  • [NOT] BETWEEN - (not) between
  • [NOT] LIKE - (not) like
  • [NOT] IN - (not) in
  • ~* - case-insensitive like
values
Array of strings
object (PaginationRequest)

Pagination request information

offset
integer >= 0
Default: 0

Index of the first element.

limit
integer >= 1
Default: 20

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

Array of objects (ConnectionRouteSortCriteria)
Array
direction
string (ConnectionRouteEntrySortDirection)
Default: "DESC"
Enum: "DESC" "ASC"

Sorting direction

property
string (ConnectionRouteEntrySortBy)
Default: "/changeLog/updatedDateTime"
Enum: "/changeLog/createdDateTime" "/changeLog/updatedDateTime" "/med" "/connection/name" "/type" "/prefix" "/nextHop"

Possible field names to use on sorting

Responses

Response Schema: application/json
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Array of objects (ConnectionRouteTableEntry)

Data returned from the API call.

Array
type
required
string (RouteTableEntryType)
Enum: "IPv4_BGP_ROUTE" "IPv4_STATIC_ROUTE" "IPv4_DIRECT_ROUTE" "IPv6_BGP_ROUTE" "IPv6_STATIC_ROUTE" "IPv6_DIRECT_ROUTE"

Route table entry type

protocolType
string (RouteTableEntryProtocolType)
Enum: "BGP" "STATIC" "DIRECT"

Route table entry protocol type

state
required
string
Enum: "ACTIVE" "INACTIVE"
age
string
prefix
string
nextHop
string
MED
integer
localPreference
integer
asPath
Array of strings
object (ConnectionRouteTableEntry_connection)
required
object (Changelog)

Change log

Request samples

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

Response samples

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

Create Routers

This API provides capability to create user's Cloud Routers

Authorizations:
BearerAuth
query Parameters
dryRun
boolean
Default: false

option to verify that API calls will succeed

Request Body schema: application/json
required
type
required
string
Value: "XF_ROUTER"
name
required
string

Customer-provided Cloud Router name

required
object (SimplifiedLocationWithoutIBX)
metroHref
string

The Canonical URL at which the resource resides.

region
string
metroName
string
metroCode
required
string
required
object (CloudRouterPostRequestPackage)

Fabric Cloud Router Package Type

href
string <uri>

Fabric Cloud Router URI

type
string
Value: "ROUTER_PACKAGE"

Cloud Router package type

code
required
string
Enum: "LAB" "ADVANCED" "STANDARD" "PREMIUM"

Cloud Router package code

object (Order)
purchaseOrderNumber
string

Purchase order number

customerReferenceNumber
string

Customer reference number

billingTier
string

Billing tier for connection bandwidth

orderId
string

Order Identification

orderNumber
string

Order Reference Number

termLength
integer [ 1 .. 36 ]
Default: 1

Term length in months, valid values are 1, 12, 24, 36 where 1 is the default value (for on-demand case).

object (Project)
projectId
required
string

Subscriber-assigned project ID

object (SimplifiedAccount)
accountNumber
integer <int64>

Account number

accountName
string

Account name

orgId
integer <int64>

Customer organization identifier

organizationName
string

Customer organization name

globalOrgId
string

Global organization identifier

globalOrganizationName
string

Global organization name

ucmId
string

Account ucmId

globalCustId
string

Account name

resellerAccountNumber
integer <int64>

Reseller account number

resellerAccountName
string

Reseller account name

resellerUcmId
string

Reseller account ucmId

resellerOrgId
integer <int64>

Reseller customer organization identifier

Array of objects (SimplifiedNotification)

Preferences for notifications on connection configuration or status changes

Array
type
required
string
Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS"

Notification Type

sendInterval
string
emails
required
Array of strings <email> [ items <email > ]

Array of contact emails

registeredUsers
Array of strings

Array of registered users

object (marketplaceSubscription)

Equinix Fabric Entity for Marketplace Subscription

type
string
Enum: "AWS_MARKETPLACE_SUBSCRIPTION" "GCP_MARKETPLACE_SUBSCRIPTION" "AZURE_MARKETPLACE_SUBSCRIPTION"

Marketplace Subscription type

uuid
string

Equinix-assigned Marketplace Subscription identifier

Responses

Response Schema: application/json
href
string <uri>

Cloud Routers URI

uuid
string <uuid>

Equinix-assigned access point identifier

name
required
string <string>

Customer-provided Cloud Router name

state
string (CloudRouterAccessPointState)
Enum: "PROVISIONED" "PROVISIONING" "DEPROVISIONING" "DEPROVISIONED" "REPROVISIONING" "NOT_PROVISIONED" "NOT_DEPROVISIONED"

Access point lifecycle state

equinixAsn
integer <int64>

Equinix ASN

connectionsCount
integer >= 0

Number of connections associated with this Access point

object

Equinix Fabric Entity for Marketplace Subscription

href
string <uri>

Marketplace Subscription URI

type
string
Enum: "AWS_MARKETPLACE_SUBSCRIPTION" "GCP_MARKETPLACE_SUBSCRIPTION" "AZURE_MARKETPLACE_SUBSCRIPTION"

Marketplace Subscription type

uuid
string

Equinix-assigned Marketplace Subscription identifier

object (Changelog)

Change log

createdBy
string

Created by User Key

createdByFullName
string

Created by User Full Name

createdByEmail
string

Created by User Email Address

createdDateTime
string <date-time>

Created by Date and Time

updatedBy
string

Updated by User Key

updatedByFullName
string

Updated by User Full Name

updatedByEmail
string

Updated by User Email Address

updatedDateTime
string <date-time>

Updated by Date and Time

deletedBy
string

Deleted by User Key

deletedByFullName
string

Deleted by User Full Name

deletedByEmail
string

Deleted by User Email Address

deletedDateTime
string <date-time>

Deleted by Date and Time

object (CloudRouterChange)

Current state of latest CloudRouter change

uuid
string

Uniquely identifies a change

type
required
string
Enum: "ROUTER_UPDATE" "ROUTER_PACKAGE_UPDATE"

Type of change

status
string
Enum: "COMPLETED" "FAILED" "REQUESTED"

Current outcome of the change flow

createdDateTime
string <date-time>

Set when change flow starts

updatedDateTime
required
string <date-time>

Set when change object is updated

information
string

Additional information

object (CloudRouterChangeOperation)

Fabric Cloud Router change operation data

op
required
string
Enum: "replace" "add" "remove"

Handy shortcut for operation name

path
required
string

path inside document leading to updated parameter

value
required
object

new value for updated parameter

type
required
string
Value: "XF_ROUTER"
required
object (SimplifiedLocationWithoutIBX)
metroHref
string

The Canonical URL at which the resource resides.

region
string
metroName
string
metroCode
required
string
required
object (CloudRouterPostRequestPackage)

Fabric Cloud Router Package Type

href
string <uri>

Fabric Cloud Router URI

type
string
Value: "ROUTER_PACKAGE"

Cloud Router package type

code
required
string
Enum: "LAB" "ADVANCED" "STANDARD" "PREMIUM"

Cloud Router package code

object (Order)
purchaseOrderNumber
string

Purchase order number

customerReferenceNumber
string

Customer reference number

billingTier
string

Billing tier for connection bandwidth

orderId
string

Order Identification

orderNumber
string

Order Reference Number

termLength
integer [ 1 .. 36 ]
Default: 1

Term length in months, valid values are 1, 12, 24, 36 where 1 is the default value (for on-demand case).

object (Project)
projectId
required
string

Subscriber-assigned project ID

object (SimplifiedAccount)
accountNumber
integer <int64>

Account number

accountName
string

Account name

orgId
integer <int64>

Customer organization identifier

organizationName
string

Customer organization name

globalOrgId
string

Global organization identifier

globalOrganizationName
string

Global organization name

ucmId
string

Account ucmId

globalCustId
string

Account name

resellerAccountNumber
integer <int64>

Reseller account number

resellerAccountName
string

Reseller account name

resellerUcmId
string

Reseller account ucmId

resellerOrgId
integer <int64>

Reseller customer organization identifier

Array of objects (SimplifiedNotification)

Preferences for notifications on connection configuration or status changes

Array
type
required
string
Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS"

Notification Type

sendInterval
string
emails
required
Array of strings <email> [ items <email > ]

Array of contact emails

registeredUsers
Array of strings

Array of registered users

Request samples

Content type
application/json
Example
{
  • "type": "XF_ROUTER",
  • "name": "My-Cloud-Router",
  • "location": {
    },
  • "package": {
    },
  • "notifications": [
    ],
  • "account": {
    },
  • "project": {
    }
}

Response samples

Content type
application/json
Example
{}

Get Routers

This API provides capability to retrieve user's Cloud Routers

Authorizations:
BearerAuth
path Parameters
routerId
required
string <uuid> (RouterId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Cloud Router UUID

Responses

Response Schema: application/json
href
string <uri>

Cloud Routers URI

uuid
string <uuid>

Equinix-assigned access point identifier

name
required
string <string>

Customer-provided Cloud Router name

state
string (CloudRouterAccessPointState)
Enum: "PROVISIONED" "PROVISIONING" "DEPROVISIONING" "DEPROVISIONED" "REPROVISIONING" "NOT_PROVISIONED" "NOT_DEPROVISIONED"

Access point lifecycle state

equinixAsn
integer <int64>

Equinix ASN

connectionsCount
integer >= 0

Number of connections associated with this Access point

object

Equinix Fabric Entity for Marketplace Subscription

href
string <uri>

Marketplace Subscription URI

type
string
Enum: "AWS_MARKETPLACE_SUBSCRIPTION" "GCP_MARKETPLACE_SUBSCRIPTION" "AZURE_MARKETPLACE_SUBSCRIPTION"

Marketplace Subscription type

uuid
string

Equinix-assigned Marketplace Subscription identifier

object (Changelog)

Change log

createdBy
string

Created by User Key

createdByFullName
string

Created by User Full Name

createdByEmail
string

Created by User Email Address

createdDateTime
string <date-time>

Created by Date and Time

updatedBy
string

Updated by User Key

updatedByFullName
string

Updated by User Full Name

updatedByEmail
string

Updated by User Email Address

updatedDateTime
string <date-time>

Updated by Date and Time

deletedBy
string

Deleted by User Key

deletedByFullName
string

Deleted by User Full Name

deletedByEmail
string

Deleted by User Email Address

deletedDateTime
string <date-time>

Deleted by Date and Time

object (CloudRouterChange)

Current state of latest CloudRouter change

uuid
string

Uniquely identifies a change

type
required
string
Enum: "ROUTER_UPDATE" "ROUTER_PACKAGE_UPDATE"

Type of change

status
string
Enum: "COMPLETED" "FAILED" "REQUESTED"

Current outcome of the change flow

createdDateTime
string <date-time>

Set when change flow starts

updatedDateTime
required
string <date-time>

Set when change object is updated

information
string

Additional information

object (CloudRouterChangeOperation)

Fabric Cloud Router change operation data

op
required
string
Enum: "replace" "add" "remove"

Handy shortcut for operation name

path
required
string

path inside document leading to updated parameter

value
required
object

new value for updated parameter

type
required
string
Value: "XF_ROUTER"
required
object (SimplifiedLocationWithoutIBX)
metroHref
string

The Canonical URL at which the resource resides.

region
string
metroName
string
metroCode
required
string
required
object (CloudRouterPostRequestPackage)

Fabric Cloud Router Package Type

href
string <uri>

Fabric Cloud Router URI

type
string
Value: "ROUTER_PACKAGE"

Cloud Router package type

code
required
string
Enum: "LAB" "ADVANCED" "STANDARD" "PREMIUM"

Cloud Router package code

object (Order)
purchaseOrderNumber
string

Purchase order number

customerReferenceNumber
string

Customer reference number

billingTier
string

Billing tier for connection bandwidth

orderId
string

Order Identification

orderNumber
string

Order Reference Number

termLength
integer [ 1 .. 36 ]
Default: 1

Term length in months, valid values are 1, 12, 24, 36 where 1 is the default value (for on-demand case).

object (Project)
projectId
required
string

Subscriber-assigned project ID

object (SimplifiedAccount)
accountNumber
integer <int64>

Account number

accountName
string

Account name

orgId
integer <int64>

Customer organization identifier

organizationName
string

Customer organization name

globalOrgId
string

Global organization identifier

globalOrganizationName
string

Global organization name

ucmId
string

Account ucmId

globalCustId
string

Account name

resellerAccountNumber
integer <int64>

Reseller account number

resellerAccountName
string

Reseller account name

resellerUcmId
string

Reseller account ucmId

resellerOrgId
integer <int64>

Reseller customer organization identifier

Array of objects (SimplifiedNotification)

Preferences for notifications on connection configuration or status changes

Array
type
required
string
Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS"

Notification Type

sendInterval
string
emails
required
Array of strings <email> [ items <email > ]

Array of contact emails

registeredUsers
Array of strings

Array of registered users

Response samples

Content type
application/json
Example
{
  • "href": "https://api.equinix.com/fabric/v4/routers/201b7346-a9eb-42fe-ae7a-08148c71928d",
  • "uuid": "201b7346-a9eb-42fe-ae7a-08148c71928d",
  • "state": "PROVISIONED",
  • "type": "XF_ROUTER",
  • "name": "My-Cloud-Router",
  • "location": {},
  • "equinixAsn": 30000,
  • "package": {},
  • "order": {
    },
  • "project": {
    },
  • "notifications": [
    ],
  • "account": {
    },
  • "connectionsCount": 0,
  • "changeLog": {
    }
}

Delete Routers

This API provides capability to delete user's Cloud Routers

Authorizations:
BearerAuth
path Parameters
routerId
required
string <uuid> (RouterId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Cloud Router UUID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update Routers

This API provides capability to update user's Cloud Routers

Authorizations:
BearerAuth
path Parameters
routerId
required
string <uuid> (RouterId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Cloud Router UUID

Request Body schema: application/json-patch+json
required
Array (non-empty)
op
required
string
Enum: "replace" "add" "remove"

Handy shortcut for operation name

path
required
string

path inside document leading to updated parameter

value
required
object

new value for updated parameter

Responses

Response Schema: application/json
href
string <uri>

Cloud Routers URI

uuid
string <uuid>

Equinix-assigned access point identifier

name
required
string <string>

Customer-provided Cloud Router name

state
string (CloudRouterAccessPointState)
Enum: "PROVISIONED" "PROVISIONING" "DEPROVISIONING" "DEPROVISIONED" "REPROVISIONING" "NOT_PROVISIONED" "NOT_DEPROVISIONED"

Access point lifecycle state

equinixAsn
integer <int64>

Equinix ASN

connectionsCount
integer >= 0

Number of connections associated with this Access point

object

Equinix Fabric Entity for Marketplace Subscription

href
string <uri>

Marketplace Subscription URI

type
string
Enum: "AWS_MARKETPLACE_SUBSCRIPTION" "GCP_MARKETPLACE_SUBSCRIPTION" "AZURE_MARKETPLACE_SUBSCRIPTION"

Marketplace Subscription type

uuid
string

Equinix-assigned Marketplace Subscription identifier

object (Changelog)

Change log

createdBy
string

Created by User Key

createdByFullName
string

Created by User Full Name

createdByEmail
string

Created by User Email Address

createdDateTime
string <date-time>

Created by Date and Time

updatedBy
string

Updated by User Key

updatedByFullName
string

Updated by User Full Name

updatedByEmail
string

Updated by User Email Address

updatedDateTime
string <date-time>

Updated by Date and Time

deletedBy
string

Deleted by User Key

deletedByFullName
string

Deleted by User Full Name

deletedByEmail
string

Deleted by User Email Address

deletedDateTime
string <date-time>

Deleted by Date and Time

object (CloudRouterChange)

Current state of latest CloudRouter change

uuid
string

Uniquely identifies a change

type
required
string
Enum: "ROUTER_UPDATE" "ROUTER_PACKAGE_UPDATE"

Type of change

status
string
Enum: "COMPLETED" "FAILED" "REQUESTED"

Current outcome of the change flow

createdDateTime
string <date-time>

Set when change flow starts

updatedDateTime
required
string <date-time>

Set when change object is updated

information
string

Additional information

object (CloudRouterChangeOperation)

Fabric Cloud Router change operation data

op
required
string
Enum: "replace" "add" "remove"

Handy shortcut for operation name

path
required
string

path inside document leading to updated parameter

value
required
object

new value for updated parameter

type
required
string
Value: "XF_ROUTER"
required
object (SimplifiedLocationWithoutIBX)
metroHref
string

The Canonical URL at which the resource resides.

region
string
metroName
string
metroCode
required
string
required
object (CloudRouterPostRequestPackage)

Fabric Cloud Router Package Type

href
string <uri>

Fabric Cloud Router URI

type
string
Value: "ROUTER_PACKAGE"

Cloud Router package type

code
required
string
Enum: "LAB" "ADVANCED" "STANDARD" "PREMIUM"

Cloud Router package code

object (Order)
purchaseOrderNumber
string

Purchase order number

customerReferenceNumber
string

Customer reference number

billingTier
string

Billing tier for connection bandwidth

orderId
string

Order Identification

orderNumber
string

Order Reference Number

termLength
integer [ 1 .. 36 ]
Default: 1

Term length in months, valid values are 1, 12, 24, 36 where 1 is the default value (for on-demand case).

object (Project)
projectId
required
string

Subscriber-assigned project ID

object (SimplifiedAccount)
accountNumber
integer <int64>

Account number

accountName
string

Account name

orgId
integer <int64>

Customer organization identifier

organizationName
string

Customer organization name

globalOrgId
string

Global organization identifier

globalOrganizationName
string

Global organization name

ucmId
string

Account ucmId

globalCustId
string

Account name

resellerAccountNumber
integer <int64>

Reseller account number

resellerAccountName
string

Reseller account name

resellerUcmId
string

Reseller account ucmId

resellerOrgId
integer <int64>

Reseller customer organization identifier

Array of objects (SimplifiedNotification)

Preferences for notifications on connection configuration or status changes

Array
type
required
string
Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS"

Notification Type

sendInterval
string
emails
required
Array of strings <email> [ items <email > ]

Array of contact emails

registeredUsers
Array of strings

Array of registered users

Request samples

Content type
application/json-patch+json
Example
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/routers/201b7346-a9eb-42fe-ae7a-08148c71928d",
  • "uuid": "201b7346-a9eb-42fe-ae7a-08148c71928d",
  • "state": "PROVISIONED",
  • "type": "XF_ROUTER",
  • "name": "My-Cloud-Router",
  • "location": {},
  • "equinixAsn": 30000,
  • "package": {},
  • "order": {
    },
  • "project": {
    },
  • "notifications": [
    ],
  • "account": {
    },
  • "connectionsCount": 0,
  • "change": {
    },
  • "changeLog": {
    }
}

Get Route Table Actions

This API provides capability to fetch action status

Authorizations:
BearerAuth
path Parameters
routerId
required
string <uuid> (RouterId_1)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Router UUID

query Parameters
state
string (ActionState)
Enum: "SUCCEEDED" "FAILED" "PENDING"

Action state

Responses

Response Schema: application/json
type
required
string (CloudRouterActionType)
Enum: "BGP_SESSION_STATUS_UPDATE" "ROUTE_TABLE_ENTRY_UPDATE" "RECEIVED_ROUTE_ENTRY_UPDATE" "ADVERTISED_ROUTE_ENTRY_UPDATE"

Cloud router action type

uuid
required
string <uuid>
description
string
state
required
string (CloudRouterActionState)
Enum: "SUCCEEDED" "FAILED" "PENDING"

Cloud router action state

required
object (Changelog)

Change log

createdBy
string

Created by User Key

createdByFullName
string

Created by User Full Name

createdByEmail
string

Created by User Email Address

createdDateTime
string <date-time>

Created by Date and Time

updatedBy
string

Updated by User Key

updatedByFullName
string

Updated by User Full Name

updatedByEmail
string

Updated by User Email Address

updatedDateTime
string <date-time>

Updated by Date and Time

deletedBy
string

Deleted by User Key

deletedByFullName
string

Deleted by User Full Name

deletedByEmail
string

Deleted by User Email Address

deletedDateTime
string <date-time>

Deleted by Date and Time

href
string
object (RouterActionsConnection)

Connection object for router actions

uuid
string

Connection UUID

object (Operation)

Operation object for router actions

bgpIpv4RoutesCount
integer

IPV4 route count

bgpIpv6RoutesCount
integer

IPV6 route count

Response samples

Content type
application/json
{
  • "type": "ROUTE_TABLE_ENTRY_UPDATE",
  • "uuid": "37c10edc-ba2e-4240-a850-8a48f9c47d00",
  • "state": "PENDING",
  • "changeLog": {
    }
}

Create Route Table Action

This API provides capability to refresh route table and bgp session summary information

Authorizations:
BearerAuth
path Parameters
routerId
required
string <uuid> (RouterId_1)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Router UUID

Request Body schema: application/json
required
type
required
string (CloudRouterActionType)
Enum: "BGP_SESSION_STATUS_UPDATE" "ROUTE_TABLE_ENTRY_UPDATE" "RECEIVED_ROUTE_ENTRY_UPDATE" "ADVERTISED_ROUTE_ENTRY_UPDATE"

Cloud router action type

object (RouterActionsConnection)

Connection object for router actions

uuid
string

Connection UUID

Responses

Request samples

Content type
application/json
Example
{
  • "type": "ROUTE_TABLE_ENTRY_UPDATE"
}

Response samples

Content type
application/json
Example
{
  • "type": "ROUTE_TABLE_ENTRY_UPDATE",
  • "uuid": "37c10edc-ba2e-4240-a850-8a48f9c47d00",
  • "state": "PENDING",
  • "changeLog": {
    }
}

Search Route Table Actions

This API provides capability to refresh route table and bgp session summary information

Authorizations:
BearerAuth
path Parameters
routerId
required
string <uuid> (RouterId_1)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Router UUID

Request Body schema: application/json
required
object (CloudRouterActionsSearchFilters)
Array of CloudRouterActionsSearchExpression (object) or CloudRouterActionsSearchOrFilter (object) (CloudRouterActionsSearchFilter) <= 8 items
Array (<= 8 items)
Any of
property
string

Possible field names to use on filters:

  • /type - type of update
  • /state - action state
  • /connection/uuid - connection uuid associated
  • /* - all-category search
operator
string

Possible operators to use on filters:

  • = - equal
  • != - not equal
  • > - greater than
  • >= - greater than or equal to
  • < - less than
  • <= - less than or equal to
  • [NOT] BETWEEN - (not) between
  • [NOT] LIKE - (not) like
  • [NOT] IN - (not) in
  • ~* - case-insensitive like
values
Array of strings
object (PaginationRequest)

Pagination request information

offset
integer >= 0
Default: 0

Index of the first element.

limit
integer >= 1
Default: 20

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

Array of objects (CloudRouterActionsSearchSortCriteria)
Array
direction
string (CloudRouterActionsSearchSortDirection)
Default: "DESC"
Enum: "DESC" "ASC"

Sorting direction

property
string (CloudRouterActionsSearchSortBy)
Default: "/changeLog/updatedDateTime"
Enum: "/changeLog/createdDateTime" "/changeLog/updatedDateTime" "/connection/name" "/type"

Possible field names to use on sorting

Responses

Response Schema: application/json
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Array of objects (CloudRouterActionResponse)

Data returned from the API call.

Array
type
required
string (CloudRouterActionType)
Enum: "BGP_SESSION_STATUS_UPDATE" "ROUTE_TABLE_ENTRY_UPDATE" "RECEIVED_ROUTE_ENTRY_UPDATE" "ADVERTISED_ROUTE_ENTRY_UPDATE"

Cloud router action type

uuid
required
string <uuid>
description
string
state
required
string (CloudRouterActionState)
Enum: "SUCCEEDED" "FAILED" "PENDING"

Cloud router action state

required
object (Changelog)

Change log

href
string
object (RouterActionsConnection)

Connection object for router actions

object (Operation)

Operation object for router actions

Request samples

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

Response samples

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

Get Route Table Action by ID

This API provides capability to fetch action status

Authorizations:
BearerAuth
path Parameters
routerId
required
string <uuid> (RouterId_1)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Router UUID

actionId
required
string <uuid> (ActionId_1)
Example: 457400f8-d360-11e9-bb65-2a2ae2dbcced

Action UUID

query Parameters
state
string (ActionState)
Enum: "SUCCEEDED" "FAILED" "PENDING"

Action state

Responses

Response Schema: application/json
type
required
string (CloudRouterActionType)
Enum: "BGP_SESSION_STATUS_UPDATE" "ROUTE_TABLE_ENTRY_UPDATE" "RECEIVED_ROUTE_ENTRY_UPDATE" "ADVERTISED_ROUTE_ENTRY_UPDATE"

Cloud router action type

uuid
required
string <uuid>
description
string
state
required
string (CloudRouterActionState)
Enum: "SUCCEEDED" "FAILED" "PENDING"

Cloud router action state

required
object (Changelog)

Change log

createdBy
string

Created by User Key

createdByFullName
string

Created by User Full Name

createdByEmail
string

Created by User Email Address

createdDateTime
string <date-time>

Created by Date and Time

updatedBy
string

Updated by User Key

updatedByFullName
string

Updated by User Full Name

updatedByEmail
string

Updated by User Email Address

updatedDateTime
string <date-time>

Updated by Date and Time

deletedBy
string

Deleted by User Key

deletedByFullName
string

Deleted by User Full Name

deletedByEmail
string

Deleted by User Email Address

deletedDateTime
string <date-time>

Deleted by Date and Time

href
string
object (RouterActionsConnection)

Connection object for router actions

uuid
string

Connection UUID

object (Operation)

Operation object for router actions

bgpIpv4RoutesCount
integer

IPV4 route count

bgpIpv6RoutesCount
integer

IPV6 route count

Response samples

Content type
application/json
{
  • "type": "ROUTE_TABLE_ENTRY_UPDATE",
  • "uuid": "37c10edc-ba2e-4240-a850-8a48f9c47d00",
  • "state": "PENDING",
  • "changeLog": {
    }
}

Get Commands

This API provides capability to fetch all commands

Authorizations:
BearerAuth
path Parameters
routerId
required
string <uuid> (RouterId_1)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Router UUID

Responses

Response Schema: application/json
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Array of objects (CloudRouterCommand)
Array
href
string
type
string (CloudRouterCommandType)
Value: "PING_COMMAND"

Fabric Cloud Router Command Type

uuid
string <uuid>
name
string <string>

Customer-provided Cloud Router name

description
string
state
string (CloudRouterCommandState)
Enum: "PENDING" "SUCCEEDED" "FAILED" "DELETED"

Fabric Cloud Router Command State

object (Project)
object (CloudRouterCommandRequest)

Fabric Cloud Router Command Request

object (CloudRouterCommandResponse)
object (Changelog)

Change log

Response samples

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

Initiate Command

This API provides capability to initiate Command

Authorizations:
BearerAuth
path Parameters
routerId
required
string <uuid> (RouterId_1)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Router UUID

Request Body schema: application/json
required
type
required
string (CloudRouterCommandType)
Value: "PING_COMMAND"

Fabric Cloud Router Command Type

name
string

Customer-provided Cloud Router Command name

description
string

Customer-provided Cloud Router Command description

required
object (Project)
projectId
required
string

Subscriber-assigned project ID

required
object (CloudRouterCommandRequest)

Fabric Cloud Router Command Request

destination
required
string

Fabric Cloud Router Ping Command Destination

object (CloudRouterCommandRequestConnection)

Connection object for Cloud Router Command

uuid
string

Connection UUID

timeout
integer

Fabric Cloud Router Ping Command Timeout

dataBytes
integer [ 16 .. 9000 ]
Default: 64

Fabric Cloud Router Ping Command DataBytes

Responses

Request samples

Content type
application/json
{
  • "type": "PING_COMMAND",
  • "name": "ping-test-1",
  • "description": "Testing FCR-SV-1",
  • "project": {
    },
  • "request": {
    }
}

Response samples

Content type
application/json
{}

Search Commands

This API provides capability to search commands

Authorizations:
BearerAuth
path Parameters
routerId
required
string <uuid> (RouterId_1)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Router UUID

Request Body schema: application/json
required
object (CloudRouterCommandSearchFilters)
Array of CloudRouterCommandSearchExpression (object) or CloudRouterCommandSearchOrFilter (object) (CloudRouterCommandSearchFilter) <= 8 items
Array (<= 8 items)
Any of
property
string

Possible field names to use on filters:

  • /type - type of command
  • /name - name of command
  • /state - state of command
  • /request/destination - destination of command request
  • /request/sourceConnection/uuid - source connection uuid
  • /* - all-category search
operator
string

Possible operators to use on filters:

  • = - equal
  • != - not equal
  • > - greater than
  • >= - greater than or equal to
  • < - less than
  • <= - less than or equal to
  • [NOT] BETWEEN - (not) between
  • [NOT] LIKE - (not) like
  • [NOT] IN - (not) in
  • ~* - case-insensitive like
values
Array of strings
object (PaginationRequest)

Pagination request information

offset
integer >= 0
Default: 0

Index of the first element.

limit
integer >= 1
Default: 20

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

Array of objects (CloudRouterCommandSearchSortCriteria)
Array
direction
string (CloudRouterCommandSearchSortDirection)
Default: "DESC"
Enum: "DESC" "ASC"

Sorting direction

property
string (CloudRouterCommandSearchSortBy)
Default: "/changeLog/updatedDateTime"
Enum: "/changeLog/createdDateTime" "/changeLog/updatedDateTime" "/name" "/type"

Possible field names to use on sorting

Responses

Response Schema: application/json
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Array of objects (CloudRouterCommand)

Data returned from the API call.

Array
href
string
type
string (CloudRouterCommandType)
Value: "PING_COMMAND"

Fabric Cloud Router Command Type

uuid
string <uuid>
name
string <string>

Customer-provided Cloud Router name

description
string
state
string (CloudRouterCommandState)
Enum: "PENDING" "SUCCEEDED" "FAILED" "DELETED"

Fabric Cloud Router Command State

object (Project)
object (CloudRouterCommandRequest)

Fabric Cloud Router Command Request

object (CloudRouterCommandResponse)
object (Changelog)

Change log

Request samples

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

Response samples

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

Get Command

This API provides capability to fetch command using command Id

Authorizations:
BearerAuth
path Parameters
routerId
required
string <uuid> (RouterId_1)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Router UUID

commandId
required
string <uuid> (CommandId)
Example: 37c10edc-ba2e-4240-a850-8a48f9c47d00

Command UUID

Responses

Response Schema: application/json
href
string
type
string (CloudRouterCommandType)
Value: "PING_COMMAND"

Fabric Cloud Router Command Type

uuid
string <uuid>
name
string <string>

Customer-provided Cloud Router name

description
string
state
string (CloudRouterCommandState)
Enum: "PENDING" "SUCCEEDED" "FAILED" "DELETED"

Fabric Cloud Router Command State

object (Project)
projectId
required
string

Subscriber-assigned project ID

object (CloudRouterCommandRequest)

Fabric Cloud Router Command Request

destination
required
string

Fabric Cloud Router Ping Command Destination

object (CloudRouterCommandRequestConnection)

Connection object for Cloud Router Command

uuid
string

Connection UUID

timeout
integer

Fabric Cloud Router Ping Command Timeout

dataBytes
integer [ 16 .. 9000 ]
Default: 64

Fabric Cloud Router Ping Command DataBytes

interval
integer
Default: 1000

Time in milliseconds between sending each packet

count
integer
Default: 5

Total number of ping requests

object (CloudRouterCommandResponse)
output
string
object (OutputStructuredPing)
destinationIp
string
destinationName
string
dataBytes
integer
packetsTransmitted
integer
packetsReceived
integer
packetsLossPercent
number <float>
rttMin
number <float>
rttAvg
number <float>
rttMax
number <float>
rttStdDev
number <float>
Array of objects (OutputStructuredPingResponseItem)
object (Changelog)

Change log

createdBy
string

Created by User Key

createdByFullName
string

Created by User Full Name

createdByEmail
string

Created by User Email Address

createdDateTime
string <date-time>

Created by Date and Time

updatedBy
string

Updated by User Key

updatedByFullName
string

Updated by User Full Name

updatedByEmail
string

Updated by User Email Address

updatedDateTime
string <date-time>

Updated by Date and Time

deletedBy
string

Deleted by User Key

deletedByFullName
string

Deleted by User Full Name

deletedByEmail
string

Deleted by User Email Address

deletedDateTime
string <date-time>

Deleted by Date and Time

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/routers/9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81/commands/37c10edc-ba2e-4240-a850-8a48f9c47d00",
  • "type": "PING_COMMAND",
  • "uuid": "37c10edc-ba2e-4240-a850-8a48f9c47d00",
  • "name": "ping-test-1",
  • "description": "Testing FCR-SV-1",
  • "state": "SUCCEEDED",
  • "project": {
    },
  • "request": {
    },
  • "response": {
    },
  • "changeLog": {
    }
}

Delete Command

This API provides capability to delete command based on command Id

Authorizations:
BearerAuth
path Parameters
routerId
required
string <uuid> (RouterId_1)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Router UUID

commandId
required
string <uuid> (CommandId)
Example: 37c10edc-ba2e-4240-a850-8a48f9c47d00

Command UUID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Search Route Table

The API provides capability to get list of user's Fabric Cloud Router route table entries using search criteria, including optional filtering, pagination and sorting

Authorizations:
BearerAuth
path Parameters
routerId
required
string <uuid> (RouterId_1)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Router UUID

Request Body schema: application/json
required
object (RouteTableEntryFilters)
Array of RouteTableEntrySimpleExpression (object) or RouteTableEntryOrFilter (object) (RouteTableEntryFilter) <= 8 items
Array (<= 8 items)
Any of
property
string

Possible field names to use on filters:

  • /type - Route table entry type
  • /prefix - Route table entry prefix
  • /nextHop - Route table entry nextHop
  • /state - Route table entry state
  • /* - all-category search
operator
string

Possible operators to use on filters:

  • = - equal
  • != - not equal
  • > - greater than
  • >= - greater than or equal to
  • < - less than
  • <= - less than or equal to
  • [NOT] BETWEEN - (not) between
  • [NOT] LIKE - (not) like
  • [NOT] IN - (not) in
  • ~* - case-insensitive like
values
Array of strings
object (PaginationRequest)

Pagination request information

offset
integer >= 0
Default: 0

Index of the first element.

limit
integer >= 1
Default: 20

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

Array of objects (RouteTableEntrySortCriteria)
Array
direction
string (RouteTableEntrySortDirection)
Default: "DESC"
Enum: "DESC" "ASC"

Sorting direction

property
string (RouteTableEntrySortBy)
Default: "/changeLog/updatedDateTime"
Enum: "/changeLog/createdDateTime" "/changeLog/updatedDateTime" "/prefix" "/nextHop" "/connection/name" "/type"

Possible field names to use on sorting

Responses

Response Schema: application/json
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Array of objects (RouteTableEntry)

Data returned from the API call.

Array
type
required
string (RouteTableEntryType)
Enum: "IPv4_BGP_ROUTE" "IPv4_STATIC_ROUTE" "IPv4_DIRECT_ROUTE" "IPv6_BGP_ROUTE" "IPv6_STATIC_ROUTE" "IPv6_DIRECT_ROUTE"

Route table entry type

protocolType
string (RouteTableEntryProtocolType)
Enum: "BGP" "STATIC" "DIRECT"

Route table entry protocol type

state
required
string (RouteTableEntryState)
Value: "ACTIVE"

Route table entry state

age
string
prefix
string
nextHop
string
MED
integer
localPreference
integer
asPath
Array of strings
object (ConnectionRouteTableEntry_connection)
required
object (Changelog)

Change log

Request samples

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

Response samples

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

Search Routers

The API provides capability to get list of user's Cloud Routers using search criteria, including optional filtering, pagination and sorting

Authorizations:
BearerAuth
Request Body schema: application/json
required
object (CloudRouterFilters)
Array of CloudRouterSimpleExpression (object) or CloudRouterOrFilter (object) (CloudRouterFilter) <= 8 items
Array (<= 8 items)
Any of
property
string

Possible field names to use on filters:

  • /project/projectId - project id (mandatory)
  • /name - Fabric Cloud Router name
  • /uuid - Fabric Cloud Router uuid
  • /state - Fabric Cloud Router status
  • /location/metroCode - Fabric Cloud Router metro code
  • /location/metroName - Fabric Cloud Router metro name
  • /package/code - Fabric Cloud Router package
  • /* - all-category search
operator
string

Possible operators to use on filters:

  • = - equal
  • != - not equal
  • > - greater than
  • >= - greater than or equal to
  • < - less than
  • <= - less than or equal to
  • [NOT] BETWEEN - (not) between
  • [NOT] LIKE - (not) like
  • [NOT] IN - (not) in
  • ILIKE - case-insensitive like
values
Array of strings
object (PaginationRequest)

Pagination request information

offset
integer >= 0
Default: 0

Index of the first element.

limit
integer >= 1
Default: 20

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

Array of objects (CloudRouterSortCriteria)
Array
direction
string (CloudRouterSortDirection)
Default: "DESC"
Enum: "DESC" "ASC"

Sorting direction

property
string (CloudRouterSortBy)
Default: "/changeLog/updatedDateTime"
Enum: "/name" "/uuid" "/state" "/location/metroCode" "/location/metroName" "/package/code" "/changeLog/createdDateTime" "/changeLog/updatedDateTime"

Possible field names to use on sorting

Responses

Response Schema: application/json
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Array of objects (CloudRouter)

Data returned from the API call.

Array
href
string <uri>

Cloud Routers URI

uuid
string <uuid>

Equinix-assigned access point identifier

name
required
string <string>

Customer-provided Cloud Router name

state
string (CloudRouterAccessPointState)
Enum: "PROVISIONED" "PROVISIONING" "DEPROVISIONING" "DEPROVISIONED" "REPROVISIONING" "NOT_PROVISIONED" "NOT_DEPROVISIONED"

Access point lifecycle state

equinixAsn
integer <int64>

Equinix ASN

connectionsCount
integer >= 0

Number of connections associated with this Access point

object

Equinix Fabric Entity for Marketplace Subscription

object (Changelog)

Change log

object (CloudRouterChange)

Current state of latest CloudRouter change

type
required
string
Value: "XF_ROUTER"
required
object (SimplifiedLocationWithoutIBX)
required
object (CloudRouterPostRequestPackage)

Fabric Cloud Router Package Type

object (Order)
object (Project)
object (SimplifiedAccount)
Array of objects (SimplifiedNotification)

Preferences for notifications on connection configuration or status changes

Request samples

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

Response samples

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

List Packages

This API provides capability to retrieve user's Cloud Routers Packages

Authorizations:
BearerAuth
query Parameters
offset
integer
Example: offset=1

offset

limit
integer
Example: limit=10

number of records to fetch

Responses

Response Schema: application/json
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Array of objects (CloudRouterPackage)

Data returned from the API call.

Array
href
string <uri>

Cloud Router package URI

type
string
Value: "ROUTER_PACKAGE"

Type of Router package

code
string (code)
Enum: "LAB" "ADVANCED" "STANDARD" "PREMIUM"

Cloud Router package code

description
string

Fabric Cloud Router Package description

totalIPv4RoutesMax
integer >= 0

Cloud Router package BGP IPv4 routes limit

totalIPv6RoutesMax
integer >= 0

Cloud Router package BGP IPv6 routes limit

routeFilterSupported
boolean

CloudRouter package route filter support

vcCountMax
integer >= 0

CloudRouter package Max Connection limit

crCountMax
integer >= 0

CloudRouter package Max CloudRouter limit

vcBandwidthMax
integer >= 0

CloudRouter package Max Bandwidth limit

object (PackageChangeLog)

Cloud Router package change log

Response samples

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

Get Package Details

This API provides capability to retrieve user's Cloud Routers Package Details

Authorizations:
BearerAuth
path Parameters
routerPackageCode
required
string (RouterPackageCode)
Enum: "LAB" "ADVANCED" "STANDARD" "PREMIUM"

Equinix-assigned Cloud Router package identifier

Responses

Response Schema: application/json
href
string <uri>

Cloud Router package URI

type
string
Value: "ROUTER_PACKAGE"

Type of Router package

code
string (code)
Enum: "LAB" "ADVANCED" "STANDARD" "PREMIUM"

Cloud Router package code

description
string

Fabric Cloud Router Package description

totalIPv4RoutesMax
integer >= 0

Cloud Router package BGP IPv4 routes limit

totalIPv6RoutesMax
integer >= 0

Cloud Router package BGP IPv6 routes limit

routeFilterSupported
boolean

CloudRouter package route filter support

vcCountMax
integer >= 0

CloudRouter package Max Connection limit

crCountMax
integer >= 0

CloudRouter package Max CloudRouter limit

vcBandwidthMax
integer >= 0

CloudRouter package Max Bandwidth limit

object (PackageChangeLog)

Cloud Router package change log

createdDateTime
string <date-time>
updatedDateTime
string <date-time>

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/routerPackages/LAB",
  • "type": "ROUTER_PACKAGE",
  • "code": "LAB",
  • "description": "string",
  • "totalIPv4RoutesMax": 50,
  • "totalIPv6RoutesMax": 50,
  • "routeFilterSupported": true,
  • "vcCountMax": 10,
  • "crCountMax": 3,
  • "vcBandwidthMax": 50,
  • "changeLog": {
    }
}

Connections

Connections

Create Connection

This API provides capability to create user's virtual connection

Authorizations:
BearerAuth
query Parameters
dryRun
boolean
Default: false

option to verify that API calls will succeed

Request Body schema: application/json
required
type
required
string (ConnectionType)
Enum: "EVPL_VC" "EPL_VC" "EC_VC" "IP_VC" "ACCESS_EPL_VC" "EIA_VC" "EVPLAN_VC" "EPLAN_VC" "IPWAN_VC" "IA_VC"

Connection type

name
required
string

Customer-provided connection name

object (Order)
purchaseOrderNumber
string

Purchase order number

customerReferenceNumber
string

Customer reference number

billingTier
string

Billing tier for connection bandwidth

orderId
string

Order Identification

orderNumber
string

Order Reference Number

termLength
integer [ 1 .. 36 ]
Default: 1

Term length in months, valid values are 1, 12, 24, 36 where 1 is the default value (for on-demand case).

required
Array of objects (SimplifiedNotification)

Preferences for notifications on connection configuration or status changes

Array
type
required
string
Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS"

Notification Type

sendInterval
string
emails
required
Array of strings <email> [ items <email > ]

Array of contact emails

registeredUsers
Array of strings

Array of registered users

bandwidth
required
integer [ 0 .. 50000 ]

Connection bandwidth in Mbps

geoScope
string (GeoScopeType)
Enum: "CANADA" "CONUS" "JAPAN"

Geographic boundary types

object (ConnectionRedundancy)

Connection redundancy configuration

group
string

Redundancy group identifier (UUID of primary connection)

priority
string (ConnectionPriority)
Enum: "PRIMARY" "SECONDARY"

Connection priority in redundancy group

required
object (ConnectionSide)

Connection configuration object for each side of multi-segment connection

object (ServiceToken)

Create Service Tokens (v4) generates Equinix Fabric service tokens. These tokens authorize users to access protected resources and services. The tokens remove sensitive content from the environment, rather than just masking it, making the protected data impossible to unencrypt or decrypt. Resource owners can distribute the tokens to trusted partners and vendors, allowing selected third parties to work directly with Equinix network assets.

type
string (ServiceTokenType)
Enum: "VC_TOKEN" "EPL_TOKEN"

Type of Service Token

expiry
integer
Deprecated
uuid
string <uuid>

Equinix-assigned service token identifier

issuerSide
string
Deprecated

information about token side

name
string

Customer-provided service token name

description
string

Customer-provided service token description

expirationDateTime
string <date-time>

Expiration date and time of the service token.

object (ServiceTokenConnection)

Service Token Connection Type Information

state
string (ServiceTokenState)
Enum: "ACTIVE" "INACTIVE" "EXPIRED" "DELETED"

Service token state

Array of objects (SimplifiedNotification)

Service token related notifications

object (SimplifiedAccount)
object (Changelog)

Change log

object (Project)
object (AccessPoint)

Access point object

type
string (AccessPointType)
Enum: "VD" "VG" "SP" "IGW" "COLO" "SUBNET" "CLOUD_ROUTER" "NETWORK" "METAL_NETWORK" "VPIC_INTERFACE"

Access point type

object (SimplifiedAccount)
object (SimplifiedLocation)
object (SimplifiedPort)

Port specification

object (SimplifiedServiceProfile)

Service Profile is a software definition for a named provider service and it's network connectivity requirements. This includes the basic marketing information and one or more sets of access points (a set per each access point type) fulfilling the provider service.

object (CloudRouter)

Fabric Cloud Router object

object (SimplifiedLinkProtocol)

Connection link protocol Configuration

object (VirtualDevice)

Virtual Device AccessPoint Information

object (Interface)

Interface Information

object (SimplifiedNetwork)

Network specification

sellerRegion
string

Access point seller region

peeringType
string (PeeringType)
Enum: "PRIVATE" "MICROSOFT" "PUBLIC" "MANUAL"

Access point peering type

authenticationKey
string

Access point authentication key

providerConnectionId
string

Provider assigned Connection Id

object (VirtualNetwork)

Virtual Network Information

object (MetalInterconnection)

Metal Interconnection

object (VpicInterface)

MCN VPIC Interface Information

object (InternetAccess)

Internet Access Details

uuid
string <uuid>

Internet Access Service Identifier

object (ConnectionCompanyProfile)

Connection Company Profile Details

id
number

company profile identifier

name
string

company profile name

globalOrgId
string

global customer organization value

object (ConnectionInvitation)

Connection Invitation Details

email
string

invitee email

message
string

invitation message

ctrDraftOrderId
string

draft order id for invitation

Array of objects (ConnectionSideAdditionalInfo)

Any additional information, which is not part of connection metadata or configuration

Array
key
string

Key

value
string

Value

required
object (ConnectionSide)

Connection configuration object for each side of multi-segment connection

object (ServiceToken)

Create Service Tokens (v4) generates Equinix Fabric service tokens. These tokens authorize users to access protected resources and services. The tokens remove sensitive content from the environment, rather than just masking it, making the protected data impossible to unencrypt or decrypt. Resource owners can distribute the tokens to trusted partners and vendors, allowing selected third parties to work directly with Equinix network assets.

type
string (ServiceTokenType)
Enum: "VC_TOKEN" "EPL_TOKEN"

Type of Service Token

expiry
integer
Deprecated
uuid
string <uuid>

Equinix-assigned service token identifier

issuerSide
string
Deprecated

information about token side

name
string

Customer-provided service token name

description
string

Customer-provided service token description

expirationDateTime
string <date-time>

Expiration date and time of the service token.

object (ServiceTokenConnection)

Service Token Connection Type Information

state
string (ServiceTokenState)
Enum: "ACTIVE" "INACTIVE" "EXPIRED" "DELETED"

Service token state

Array of objects (SimplifiedNotification)

Service token related notifications

object (SimplifiedAccount)
object (Changelog)

Change log

object (Project)
object (AccessPoint)

Access point object

type
string (AccessPointType)
Enum: "VD" "VG" "SP" "IGW" "COLO" "SUBNET" "CLOUD_ROUTER" "NETWORK" "METAL_NETWORK" "VPIC_INTERFACE"

Access point type

object (SimplifiedAccount)
object (SimplifiedLocation)
object (SimplifiedPort)

Port specification

object (SimplifiedServiceProfile)

Service Profile is a software definition for a named provider service and it's network connectivity requirements. This includes the basic marketing information and one or more sets of access points (a set per each access point type) fulfilling the provider service.

object (CloudRouter)

Fabric Cloud Router object

object (SimplifiedLinkProtocol)

Connection link protocol Configuration

object (VirtualDevice)

Virtual Device AccessPoint Information

object (Interface)

Interface Information

object (SimplifiedNetwork)

Network specification

sellerRegion
string

Access point seller region

peeringType
string (PeeringType)
Enum: "PRIVATE" "MICROSOFT" "PUBLIC" "MANUAL"

Access point peering type

authenticationKey
string

Access point authentication key

providerConnectionId
string

Provider assigned Connection Id

object (VirtualNetwork)

Virtual Network Information

object (MetalInterconnection)

Metal Interconnection

object (VpicInterface)

MCN VPIC Interface Information

object (InternetAccess)

Internet Access Details

uuid
string <uuid>

Internet Access Service Identifier

object (ConnectionCompanyProfile)

Connection Company Profile Details

id
number

company profile identifier

name
string

company profile name

globalOrgId
string

global customer organization value

object (ConnectionInvitation)

Connection Invitation Details

email
string

invitee email

message
string

invitation message

ctrDraftOrderId
string

draft order id for invitation

Array of objects (ConnectionSideAdditionalInfo)

Any additional information, which is not part of connection metadata or configuration

Array
key
string

Key

value
string

Value

object (Project)
projectId
required
string

Subscriber-assigned project ID

Array of objects (ConnectionSideAdditionalInfo)

Connection additional information

Array
key
string

Key

value
string

Value

object (marketplaceSubscription)

Equinix Fabric Entity for Marketplace Subscription

type
string
Enum: "AWS_MARKETPLACE_SUBSCRIPTION" "GCP_MARKETPLACE_SUBSCRIPTION" "AZURE_MARKETPLACE_SUBSCRIPTION"

Marketplace Subscription type

uuid
string

Equinix-assigned Marketplace Subscription identifier

object (EndCustomer)
isDisclosed
boolean
Default: false

Indicate if endCustomer info should be disclosed or not

name
string
mdmId
string

Responses

Response Schema: application/json
href
string <uri>

Connection URI

type
required
string (ConnectionType)
Enum: "EVPL_VC" "EPL_VC" "EC_VC" "IP_VC" "ACCESS_EPL_VC" "EIA_VC" "EVPLAN_VC" "EPLAN_VC" "IPWAN_VC" "IA_VC"

Connection type

uuid
string

Equinix-assigned connection identifier

name
required
string

Customer-provided connection name

description
string

Customer-provided connection description

state
string (ConnectionState)
Enum: "ACTIVE" "CANCELLED" "DEPROVISIONED" "DEPROVISIONING" "DRAFT" "FAILED" "PENDING" "PROVISIONED" "PROVISIONING" "REPROVISIONING" ""

Connection status

object (Change)

Current state of latest connection change

uuid
string

Uniquely identifies a change

type
required
string
Enum: "CONNECTION_CREATION" "CONNECTION_UPDATE" "CONNECTION_DELETION" "CONNECTION_PROVIDER_STATUS_REQUEST"

Type of change

status
string
Enum: "APPROVED" "COMPLETED" "FAILED" "REJECTED" "REQUESTED" "SUBMITTED_FOR_APPROVAL"

Current outcome of the change flow

createdDateTime
required
string <date-time>

Set when change flow starts

updatedDateTime
string <date-time>

Set when change object is updated

information
string

Additional information

object (ConnectionChangeOperation)

Connection change operation data

op
required
string

Handy shortcut for operation name

path
required
string

path inside document leading to updated parameter

value
required
object

new value for updated parameter

object (ConnectionOperation)

Connection type-specific operational data

providerStatus
string (ProviderStatus)
Enum: "AVAILABLE" "DEPROVISIONED" "DEPROVISIONING" "FAILED" "NOT_AVAILABLE" "PENDING_APPROVAL" "PENDING_CONFIGURATION" "PROVISIONED" "PROVISIONING" "REJECTED" "PENDING_BGP" "OUT_OF_BANDWIDTH" "DELETED" "ERROR" "ERRORED" "NOTPROVISIONED" "NOT_PROVISIONED" "ORDERING" "DELETING" "PENDING DELETE" "N/A"

Connection provider readiness status

equinixStatus
string (EquinixStatus)
Enum: "REJECTED_ACK" "REJECTED" "PENDING_DELETE" "PROVISIONED" "BEING_REPROVISIONED" "BEING_DEPROVISIONED" "BEING_PROVISIONED" "CREATED" "ERRORED" "PENDING_DEPROVISIONING" "APPROVED" "ORDERING" "PENDING_APPROVAL" "NOT_PROVISIONED" "DEPROVISIONING" "NOT_DEPROVISIONED" "PENDING_AUTO_APPROVAL" "PROVISIONING" "PENDING_BGP_PEERING" "PENDING_PROVIDER_VLAN" "DEPROVISIONED" "DELETED" "PENDING_BANDWIDTH_APPROVAL" "AUTO_APPROVAL_FAILED" "UPDATE_PENDING" "DELETED_API" "MODIFIED" "PENDING_PROVIDER_VLAN_ERROR" "DRAFT" "CANCELLED" "PENDING_INTERFACE_CONFIGURATION"

Connection status

operationalStatus
string
Enum: "UP" "DOWN"

Connection operational status

Array of objects (Error)
Array
errorCode
required
string^EQ-\d{7}$
errorMessage
required
string
correlationId
string
details
string
help
string
Array of objects (PriceError_additionalInfo)
opStatusChangedAt
string <date-time>

When connection transitioned into current operational status

object (Order)
purchaseOrderNumber
string

Purchase order number

customerReferenceNumber
string

Customer reference number

billingTier
string

Billing tier for connection bandwidth

orderId
string

Order Identification

orderNumber
string

Order Reference Number

termLength
integer [ 1 .. 36 ]
Default: 1

Term length in months, valid values are 1, 12, 24, 36 where 1 is the default value (for on-demand case).

Array of objects (SimplifiedNotification)

Preferences for notifications on connection configuration or status changes

Array
type
required
string
Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS"

Notification Type

sendInterval
string
emails
required
Array of strings <email> [ items <email > ]

Array of contact emails

registeredUsers
Array of strings

Array of registered users

object (SimplifiedAccount)
accountNumber
integer <int64>

Account number

accountName
string

Account name

orgId
integer <int64>

Customer organization identifier

organizationName
string

Customer organization name

globalOrgId
string

Global organization identifier

globalOrganizationName
string

Global organization name

ucmId
string

Account ucmId

globalCustId
string

Account name

resellerAccountNumber
integer <int64>

Reseller account number

resellerAccountName
string

Reseller account name

resellerUcmId
string

Reseller account ucmId

resellerOrgId
integer <int64>

Reseller customer organization identifier

object (Changelog)

Change log

createdBy
string

Created by User Key

createdByFullName
string

Created by User Full Name

createdByEmail
string

Created by User Email Address

createdDateTime
string <date-time>

Created by Date and Time

updatedBy
string

Updated by User Key

updatedByFullName
string

Updated by User Full Name

updatedByEmail
string

Updated by User Email Address

updatedDateTime
string <date-time>

Updated by Date and Time

deletedBy
string

Deleted by User Key

deletedByFullName
string

Deleted by User Full Name

deletedByEmail
string

Deleted by User Email Address

deletedDateTime
string <date-time>

Deleted by Date and Time

bandwidth
required
integer [ 0 .. 10000 ]

Connection bandwidth in Mbps

geoScope
string (GeoScopeType)
Enum: "CANADA" "CONUS" "JAPAN"

Geographic boundary types

object (ConnectionRedundancy)

Connection redundancy configuration

group
string

Redundancy group identifier (UUID of primary connection)

priority
string (ConnectionPriority)
Enum: "PRIMARY" "SECONDARY"

Connection priority in redundancy group

isRemote
boolean

Connection property derived from access point locations

direction
string (ConnectionDirection)
Enum: "INTERNAL" "INCOMING" "OUTGOING"

Connection directionality from the requester point of view

required
object (ConnectionSide)

Connection configuration object for each side of multi-segment connection

object (ServiceToken)

Create Service Tokens (v4) generates Equinix Fabric service tokens. These tokens authorize users to access protected resources and services. The tokens remove sensitive content from the environment, rather than just masking it, making the protected data impossible to unencrypt or decrypt. Resource owners can distribute the tokens to trusted partners and vendors, allowing selected third parties to work directly with Equinix network assets.

type
string (ServiceTokenType)
Enum: "VC_TOKEN" "EPL_TOKEN"

Type of Service Token

href
string <uri>

An absolute URL that is the subject of the link's context.

expiry
integer
Deprecated
uuid
string <uuid>

Equinix-assigned service token identifier

issuerSide
string
Deprecated

information about token side

name
string

Customer-provided service token name

description
string

Customer-provided service token description

expirationDateTime
string <date-time>

Expiration date and time of the service token.

object (ServiceTokenConnection)

Service Token Connection Type Information

state
string (ServiceTokenState)
Enum: "ACTIVE" "INACTIVE" "EXPIRED" "DELETED"

Service token state

Array of objects (SimplifiedNotification)

Service token related notifications

object (SimplifiedAccount)
object (Changelog)

Change log

object (Project)
object (AccessPoint)

Access point object

type
string (AccessPointType)
Enum: "VD" "VG" "SP" "IGW" "COLO" "SUBNET" "CLOUD_ROUTER" "NETWORK" "METAL_NETWORK" "VPIC_INTERFACE"

Access point type

object (SimplifiedAccount)
object (SimplifiedLocation)
object (SimplifiedPort)

Port specification

object (SimplifiedServiceProfile)

Service Profile is a software definition for a named provider service and it's network connectivity requirements. This includes the basic marketing information and one or more sets of access points (a set per each access point type) fulfilling the provider service.

object (CloudRouter)

Fabric Cloud Router object

object (SimplifiedLinkProtocol)

Connection link protocol Configuration

object (VirtualDevice)

Virtual Device AccessPoint Information

object (Interface)

Interface Information

object (SimplifiedNetwork)

Network specification

sellerRegion
string

Access point seller region

peeringType
string (PeeringType)
Enum: "PRIVATE" "MICROSOFT" "PUBLIC" "MANUAL"

Access point peering type

authenticationKey
string

Access point authentication key

providerConnectionId
string

Provider assigned Connection Id

object (VirtualNetwork)

Virtual Network Information

object (MetalInterconnection)

Metal Interconnection

object (VpicInterface)

MCN VPIC Interface Information

object (InternetAccess)

Internet Access Details

uuid
string <uuid>

Internet Access Service Identifier

object (ConnectionCompanyProfile)

Connection Company Profile Details

id
number

company profile identifier

name
string

company profile name

globalOrgId
string

global customer organization value

object (ConnectionInvitation)

Connection Invitation Details

email
string

invitee email

message
string

invitation message

ctrDraftOrderId
string

draft order id for invitation

Array of objects (ConnectionSideAdditionalInfo)

Any additional information, which is not part of connection metadata or configuration

Array
key
string

Key

value
string

Value

required
object (ConnectionSide)

Connection configuration object for each side of multi-segment connection

object (ServiceToken)

Create Service Tokens (v4) generates Equinix Fabric service tokens. These tokens authorize users to access protected resources and services. The tokens remove sensitive content from the environment, rather than just masking it, making the protected data impossible to unencrypt or decrypt. Resource owners can distribute the tokens to trusted partners and vendors, allowing selected third parties to work directly with Equinix network assets.

type
string (ServiceTokenType)
Enum: "VC_TOKEN" "EPL_TOKEN"

Type of Service Token

href
string <uri>

An absolute URL that is the subject of the link's context.

expiry
integer
Deprecated
uuid
string <uuid>

Equinix-assigned service token identifier

issuerSide
string
Deprecated

information about token side

name
string

Customer-provided service token name

description
string

Customer-provided service token description

expirationDateTime
string <date-time>

Expiration date and time of the service token.

object (ServiceTokenConnection)

Service Token Connection Type Information

state
string (ServiceTokenState)
Enum: "ACTIVE" "INACTIVE" "EXPIRED" "DELETED"

Service token state

Array of objects (SimplifiedNotification)

Service token related notifications

object (SimplifiedAccount)
object (Changelog)

Change log

object (Project)
object (AccessPoint)

Access point object

type
string (AccessPointType)
Enum: "VD" "VG" "SP" "IGW" "COLO" "SUBNET" "CLOUD_ROUTER" "NETWORK" "METAL_NETWORK" "VPIC_INTERFACE"

Access point type

object (SimplifiedAccount)
object (SimplifiedLocation)
object (SimplifiedPort)

Port specification

object (SimplifiedServiceProfile)

Service Profile is a software definition for a named provider service and it's network connectivity requirements. This includes the basic marketing information and one or more sets of access points (a set per each access point type) fulfilling the provider service.

object (CloudRouter)

Fabric Cloud Router object

object (SimplifiedLinkProtocol)

Connection link protocol Configuration

object (VirtualDevice)

Virtual Device AccessPoint Information

object (Interface)

Interface Information

object (SimplifiedNetwork)

Network specification

sellerRegion
string

Access point seller region

peeringType
string (PeeringType)
Enum: "PRIVATE" "MICROSOFT" "PUBLIC" "MANUAL"

Access point peering type

authenticationKey
string

Access point authentication key

providerConnectionId
string

Provider assigned Connection Id

object (VirtualNetwork)

Virtual Network Information

object (MetalInterconnection)

Metal Interconnection

object (VpicInterface)

MCN VPIC Interface Information

object (InternetAccess)

Internet Access Details

uuid
string <uuid>

Internet Access Service Identifier

object (ConnectionCompanyProfile)

Connection Company Profile Details

id
number

company profile identifier

name
string

company profile name

globalOrgId
string

global customer organization value

object (ConnectionInvitation)

Connection Invitation Details

email
string

invitee email

message
string

invitation message

ctrDraftOrderId
string

draft order id for invitation

Array of objects (ConnectionSideAdditionalInfo)

Any additional information, which is not part of connection metadata or configuration

Array
key
string

Key

value
string

Value

object (marketplaceSubscription)

Equinix Fabric Entity for Marketplace Subscription

href
string <uri>

Marketplace Subscription URI

type
string
Enum: "AWS_MARKETPLACE_SUBSCRIPTION" "GCP_MARKETPLACE_SUBSCRIPTION" "AZURE_MARKETPLACE_SUBSCRIPTION"

Marketplace Subscription type

uuid
string

Equinix-assigned Marketplace Subscription identifier

Array of objects (ConnectionSideAdditionalInfo)

Connection additional information

Array
key
string

Key

value
string

Value

object (Project)
projectId
required
string

Subscriber-assigned project ID

Response Schema: application/json
href
string <uri>

Connection URI

type
required
string (ConnectionType)
Enum: "EVPL_VC" "EPL_VC" "EC_VC" "IP_VC" "ACCESS_EPL_VC" "EIA_VC" "EVPLAN_VC" "EPLAN_VC" "IPWAN_VC" "IA_VC"

Connection type

uuid
string

Equinix-assigned connection identifier

name
required
string

Customer-provided connection name

description
string

Customer-provided connection description

state
string (ConnectionState)
Enum: "ACTIVE" "CANCELLED" "DEPROVISIONED" "DEPROVISIONING" "DRAFT" "FAILED" "PENDING" "PROVISIONED" "PROVISIONING" "REPROVISIONING" ""

Connection status

object (Change)

Current state of latest connection change

uuid
string

Uniquely identifies a change

type
required
string
Enum: "CONNECTION_CREATION" "CONNECTION_UPDATE" "CONNECTION_DELETION" "CONNECTION_PROVIDER_STATUS_REQUEST"

Type of change

status
string
Enum: "APPROVED" "COMPLETED" "FAILED" "REJECTED" "REQUESTED" "SUBMITTED_FOR_APPROVAL"

Current outcome of the change flow

createdDateTime
required
string <date-time>

Set when change flow starts

updatedDateTime
string <date-time>

Set when change object is updated

information
string

Additional information

object (ConnectionChangeOperation)

Connection change operation data

op
required
string

Handy shortcut for operation name

path
required
string

path inside document leading to updated parameter

value
required
object

new value for updated parameter

object (ConnectionOperation)

Connection type-specific operational data

providerStatus
string (ProviderStatus)
Enum: "AVAILABLE" "DEPROVISIONED" "DEPROVISIONING" "FAILED" "NOT_AVAILABLE" "PENDING_APPROVAL" "PENDING_CONFIGURATION" "PROVISIONED" "PROVISIONING" "REJECTED" "PENDING_BGP" "OUT_OF_BANDWIDTH" "DELETED" "ERROR" "ERRORED" "NOTPROVISIONED" "NOT_PROVISIONED" "ORDERING" "DELETING" "PENDING DELETE" "N/A"

Connection provider readiness status

equinixStatus
string (EquinixStatus)
Enum: "REJECTED_ACK" "REJECTED" "PENDING_DELETE" "PROVISIONED" "BEING_REPROVISIONED" "BEING_DEPROVISIONED" "BEING_PROVISIONED" "CREATED" "ERRORED" "PENDING_DEPROVISIONING" "APPROVED" "ORDERING" "PENDING_APPROVAL" "NOT_PROVISIONED" "DEPROVISIONING" "NOT_DEPROVISIONED" "PENDING_AUTO_APPROVAL" "PROVISIONING" "PENDING_BGP_PEERING" "PENDING_PROVIDER_VLAN" "DEPROVISIONED" "DELETED" "PENDING_BANDWIDTH_APPROVAL" "AUTO_APPROVAL_FAILED" "UPDATE_PENDING" "DELETED_API" "MODIFIED" "PENDING_PROVIDER_VLAN_ERROR" "DRAFT" "CANCELLED" "PENDING_INTERFACE_CONFIGURATION"

Connection status

operationalStatus
string
Enum: "UP" "DOWN"

Connection operational status

Array of objects (Error)
Array
errorCode
required
string^EQ-\d{7}$
errorMessage
required
string
correlationId
string
details
string
help
string
Array of objects (PriceError_additionalInfo)
opStatusChangedAt
string <date-time>

When connection transitioned into current operational status

object (Order)
purchaseOrderNumber
string

Purchase order number

customerReferenceNumber
string

Customer reference number

billingTier
string

Billing tier for connection bandwidth

orderId
string

Order Identification

orderNumber
string

Order Reference Number

termLength
integer [ 1 .. 36 ]
Default: 1

Term length in months, valid values are 1, 12, 24, 36 where 1 is the default value (for on-demand case).

Array of objects (SimplifiedNotification)

Preferences for notifications on connection configuration or status changes

Array
type
required
string
Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS"

Notification Type

sendInterval
string
emails
required
Array of strings <email> [ items <email > ]

Array of contact emails

registeredUsers
Array of strings

Array of registered users

object (SimplifiedAccount)
accountNumber
integer <int64>

Account number

accountName
string

Account name

orgId
integer <int64>

Customer organization identifier

organizationName
string

Customer organization name

globalOrgId
string

Global organization identifier

globalOrganizationName
string

Global organization name

ucmId
string

Account ucmId

globalCustId
string

Account name

resellerAccountNumber
integer <int64>

Reseller account number

resellerAccountName
string

Reseller account name

resellerUcmId
string

Reseller account ucmId

resellerOrgId
integer <int64>

Reseller customer organization identifier

object (Changelog)

Change log

createdBy
string

Created by User Key

createdByFullName
string

Created by User Full Name

createdByEmail
string

Created by User Email Address

createdDateTime
string <date-time>

Created by Date and Time

updatedBy
string

Updated by User Key

updatedByFullName
string

Updated by User Full Name

updatedByEmail
string

Updated by User Email Address

updatedDateTime
string <date-time>

Updated by Date and Time

deletedBy
string

Deleted by User Key

deletedByFullName
string

Deleted by User Full Name

deletedByEmail
string

Deleted by User Email Address

deletedDateTime
string <date-time>

Deleted by Date and Time

bandwidth
required
integer [ 0 .. 10000 ]

Connection bandwidth in Mbps

geoScope
string (GeoScopeType)
Enum: "CANADA" "CONUS" "JAPAN"

Geographic boundary types

object (ConnectionRedundancy)

Connection redundancy configuration

group
string

Redundancy group identifier (UUID of primary connection)

priority
string (ConnectionPriority)
Enum: "PRIMARY" "SECONDARY"

Connection priority in redundancy group

isRemote
boolean

Connection property derived from access point locations

direction
string (ConnectionDirection)
Enum: "INTERNAL" "INCOMING" "OUTGOING"

Connection directionality from the requester point of view

required
object (ConnectionSide)

Connection configuration object for each side of multi-segment connection

object (ServiceToken)

Create Service Tokens (v4) generates Equinix Fabric service tokens. These tokens authorize users to access protected resources and services. The tokens remove sensitive content from the environment, rather than just masking it, making the protected data impossible to unencrypt or decrypt. Resource owners can distribute the tokens to trusted partners and vendors, allowing selected third parties to work directly with Equinix network assets.

type
string (ServiceTokenType)
Enum: "VC_TOKEN" "EPL_TOKEN"

Type of Service Token

href
string <uri>

An absolute URL that is the subject of the link's context.

expiry
integer
Deprecated
uuid
string <uuid>

Equinix-assigned service token identifier

issuerSide
string
Deprecated

information about token side

name
string

Customer-provided service token name

description
string

Customer-provided service token description

expirationDateTime
string <date-time>

Expiration date and time of the service token.

object (ServiceTokenConnection)

Service Token Connection Type Information

state
string (ServiceTokenState)
Enum: "ACTIVE" "INACTIVE" "EXPIRED" "DELETED"

Service token state

Array of objects (SimplifiedNotification)

Service token related notifications

object (SimplifiedAccount)
object (Changelog)

Change log

object (Project)
object (AccessPoint)

Access point object

type
string (AccessPointType)
Enum: "VD" "VG" "SP" "IGW" "COLO" "SUBNET" "CLOUD_ROUTER" "NETWORK" "METAL_NETWORK" "VPIC_INTERFACE"

Access point type

object (SimplifiedAccount)
object (SimplifiedLocation)
object (SimplifiedPort)

Port specification

object (SimplifiedServiceProfile)

Service Profile is a software definition for a named provider service and it's network connectivity requirements. This includes the basic marketing information and one or more sets of access points (a set per each access point type) fulfilling the provider service.

object (CloudRouter)

Fabric Cloud Router object

object (SimplifiedLinkProtocol)

Connection link protocol Configuration

object (VirtualDevice)

Virtual Device AccessPoint Information

object (Interface)

Interface Information

object (SimplifiedNetwork)

Network specification

sellerRegion
string

Access point seller region

peeringType
string (PeeringType)
Enum: "PRIVATE" "MICROSOFT" "PUBLIC" "MANUAL"

Access point peering type

authenticationKey
string

Access point authentication key

providerConnectionId
string

Provider assigned Connection Id

object (VirtualNetwork)

Virtual Network Information

object (MetalInterconnection)

Metal Interconnection

object (VpicInterface)

MCN VPIC Interface Information

object (InternetAccess)

Internet Access Details

uuid
string <uuid>

Internet Access Service Identifier

object (ConnectionCompanyProfile)

Connection Company Profile Details

id
number

company profile identifier

name
string

company profile name

globalOrgId
string

global customer organization value

object (ConnectionInvitation)

Connection Invitation Details

email
string

invitee email

message
string

invitation message

ctrDraftOrderId
string

draft order id for invitation

Array of objects (ConnectionSideAdditionalInfo)

Any additional information, which is not part of connection metadata or configuration

Array
key
string

Key

value
string

Value

required
object (ConnectionSide)

Connection configuration object for each side of multi-segment connection

object (ServiceToken)

Create Service Tokens (v4) generates Equinix Fabric service tokens. These tokens authorize users to access protected resources and services. The tokens remove sensitive content from the environment, rather than just masking it, making the protected data impossible to unencrypt or decrypt. Resource owners can distribute the tokens to trusted partners and vendors, allowing selected third parties to work directly with Equinix network assets.

type
string (ServiceTokenType)
Enum: "VC_TOKEN" "EPL_TOKEN"

Type of Service Token

href
string <uri>

An absolute URL that is the subject of the link's context.

expiry
integer
Deprecated
uuid
string <uuid>

Equinix-assigned service token identifier

issuerSide
string
Deprecated

information about token side

name
string

Customer-provided service token name

description
string

Customer-provided service token description

expirationDateTime
string <date-time>

Expiration date and time of the service token.

object (ServiceTokenConnection)

Service Token Connection Type Information

state
string (ServiceTokenState)
Enum: "ACTIVE" "INACTIVE" "EXPIRED" "DELETED"

Service token state

Array of objects (SimplifiedNotification)

Service token related notifications

object (SimplifiedAccount)
object (Changelog)

Change log

object (Project)
object (AccessPoint)

Access point object

type
string (AccessPointType)
Enum: "VD" "VG" "SP" "IGW" "COLO" "SUBNET" "CLOUD_ROUTER" "NETWORK" "METAL_NETWORK" "VPIC_INTERFACE"

Access point type

object (SimplifiedAccount)
object (SimplifiedLocation)
object (SimplifiedPort)

Port specification

object (SimplifiedServiceProfile)

Service Profile is a software definition for a named provider service and it's network connectivity requirements. This includes the basic marketing information and one or more sets of access points (a set per each access point type) fulfilling the provider service.

object (CloudRouter)

Fabric Cloud Router object

object (SimplifiedLinkProtocol)

Connection link protocol Configuration

object (VirtualDevice)

Virtual Device AccessPoint Information

object (Interface)

Interface Information

object (SimplifiedNetwork)

Network specification

sellerRegion
string

Access point seller region

peeringType
string (PeeringType)
Enum: "PRIVATE" "MICROSOFT" "PUBLIC" "MANUAL"

Access point peering type

authenticationKey
string

Access point authentication key

providerConnectionId
string

Provider assigned Connection Id

object (VirtualNetwork)

Virtual Network Information

object (MetalInterconnection)

Metal Interconnection

object (VpicInterface)

MCN VPIC Interface Information

object (InternetAccess)

Internet Access Details

uuid
string <uuid>

Internet Access Service Identifier

object (ConnectionCompanyProfile)

Connection Company Profile Details

id
number

company profile identifier

name
string

company profile name

globalOrgId
string

global customer organization value

object (ConnectionInvitation)

Connection Invitation Details

email
string

invitee email

message
string

invitation message

ctrDraftOrderId
string

draft order id for invitation

Array of objects (ConnectionSideAdditionalInfo)

Any additional information, which is not part of connection metadata or configuration

Array
key
string

Key

value
string

Value

object (marketplaceSubscription)

Equinix Fabric Entity for Marketplace Subscription

href
string <uri>

Marketplace Subscription URI

type
string
Enum: "AWS_MARKETPLACE_SUBSCRIPTION" "GCP_MARKETPLACE_SUBSCRIPTION" "AZURE_MARKETPLACE_SUBSCRIPTION"

Marketplace Subscription type

uuid
string

Equinix-assigned Marketplace Subscription identifier

Array of objects (ConnectionSideAdditionalInfo)

Connection additional information

Array
key
string

Key

value
string

Value

object (Project)
projectId
required
string

Subscriber-assigned project ID

Request samples

Content type
application/json
Example
{
  • "type": "EVPL_VC",
  • "name": "My-Layer2-Connection-3",
  • "bandwidth": 1000,
  • "redundancy": {
    },
  • "aSide": {
    },
  • "order": {
    },
  • "zSide": {
    },
  • "notifications": [
    ]
}

Response samples

Content type
application/json
Example
{}

Get Connection by ID

The API provides capability to get user's virtual connection details (Service Tokens, Access Points, Link Protocols, etc) by it's connection ID (UUID)

Authorizations:
BearerAuth
path Parameters
connectionId
required
string (ConnectionId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Connection Id

query Parameters
direction
string (ConnectionDirection)
Enum: "INTERNAL" "INCOMING" "OUTGOING"

Connection Direction

Responses

Response Schema: application/json
href
string <uri>

Connection URI

type
required
string (ConnectionType)
Enum: "EVPL_VC" "EPL_VC" "EC_VC" "IP_VC" "ACCESS_EPL_VC" "EIA_VC" "EVPLAN_VC" "EPLAN_VC" "IPWAN_VC" "IA_VC"

Connection type

uuid
string

Equinix-assigned connection identifier

name
required
string

Customer-provided connection name

description
string

Customer-provided connection description

state
string (ConnectionState)
Enum: "ACTIVE" "CANCELLED" "DEPROVISIONED" "DEPROVISIONING" "DRAFT" "FAILED" "PENDING" "PROVISIONED" "PROVISIONING" "REPROVISIONING" ""

Connection status

object (Change)

Current state of latest connection change

uuid
string

Uniquely identifies a change

type
required
string
Enum: "CONNECTION_CREATION" "CONNECTION_UPDATE" "CONNECTION_DELETION" "CONNECTION_PROVIDER_STATUS_REQUEST"

Type of change

status
string
Enum: "APPROVED" "COMPLETED" "FAILED" "REJECTED" "REQUESTED" "SUBMITTED_FOR_APPROVAL"

Current outcome of the change flow

createdDateTime
required
string <date-time>

Set when change flow starts

updatedDateTime
string <date-time>

Set when change object is updated

information
string

Additional information

object (ConnectionChangeOperation)

Connection change operation data

op
required
string

Handy shortcut for operation name

path
required
string

path inside document leading to updated parameter

value
required
object

new value for updated parameter

object (ConnectionOperation)

Connection type-specific operational data

providerStatus
string (ProviderStatus)
Enum: "AVAILABLE" "DEPROVISIONED" "DEPROVISIONING" "FAILED" "NOT_AVAILABLE" "PENDING_APPROVAL" "PENDING_CONFIGURATION" "PROVISIONED" "PROVISIONING" "REJECTED" "PENDING_BGP" "OUT_OF_BANDWIDTH" "DELETED" "ERROR" "ERRORED" "NOTPROVISIONED" "NOT_PROVISIONED" "ORDERING" "DELETING" "PENDING DELETE" "N/A"

Connection provider readiness status

equinixStatus
string (EquinixStatus)
Enum: "REJECTED_ACK" "REJECTED" "PENDING_DELETE" "PROVISIONED" "BEING_REPROVISIONED" "BEING_DEPROVISIONED" "BEING_PROVISIONED" "CREATED" "ERRORED" "PENDING_DEPROVISIONING" "APPROVED" "ORDERING" "PENDING_APPROVAL" "NOT_PROVISIONED" "DEPROVISIONING" "NOT_DEPROVISIONED" "PENDING_AUTO_APPROVAL" "PROVISIONING" "PENDING_BGP_PEERING" "PENDING_PROVIDER_VLAN" "DEPROVISIONED" "DELETED" "PENDING_BANDWIDTH_APPROVAL" "AUTO_APPROVAL_FAILED" "UPDATE_PENDING" "DELETED_API" "MODIFIED" "PENDING_PROVIDER_VLAN_ERROR" "DRAFT" "CANCELLED" "PENDING_INTERFACE_CONFIGURATION"

Connection status

operationalStatus
string
Enum: "UP" "DOWN"

Connection operational status

Array of objects (Error)
Array
errorCode
required
string^EQ-\d{7}$
errorMessage
required
string
correlationId
string
details
string
help
string
Array of objects (PriceError_additionalInfo)
opStatusChangedAt
string <date-time>

When connection transitioned into current operational status

object (Order)
purchaseOrderNumber
string

Purchase order number

customerReferenceNumber
string

Customer reference number

billingTier
string

Billing tier for connection bandwidth

orderId
string

Order Identification

orderNumber
string

Order Reference Number

termLength
integer [ 1 .. 36 ]
Default: 1

Term length in months, valid values are 1, 12, 24, 36 where 1 is the default value (for on-demand case).

Array of objects (SimplifiedNotification)

Preferences for notifications on connection configuration or status changes

Array
type
required
string
Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS"

Notification Type

sendInterval
string
emails
required
Array of strings <email> [ items <email > ]

Array of contact emails

registeredUsers
Array of strings

Array of registered users

object (SimplifiedAccount)
accountNumber
integer <int64>

Account number

accountName
string

Account name

orgId
integer <int64>

Customer organization identifier

organizationName
string

Customer organization name

globalOrgId
string

Global organization identifier

globalOrganizationName
string

Global organization name

ucmId
string

Account ucmId

globalCustId
string

Account name

resellerAccountNumber
integer <int64>

Reseller account number

resellerAccountName
string

Reseller account name

resellerUcmId
string

Reseller account ucmId

resellerOrgId
integer <int64>

Reseller customer organization identifier

object (Changelog)

Change log

createdBy
string

Created by User Key

createdByFullName
string

Created by User Full Name

createdByEmail
string

Created by User Email Address

createdDateTime
string <date-time>

Created by Date and Time

updatedBy
string

Updated by User Key

updatedByFullName
string

Updated by User Full Name

updatedByEmail
string

Updated by User Email Address

updatedDateTime
string <date-time>

Updated by Date and Time

deletedBy
string

Deleted by User Key

deletedByFullName
string

Deleted by User Full Name

deletedByEmail
string

Deleted by User Email Address

deletedDateTime
string <date-time>

Deleted by Date and Time

bandwidth
required
integer [ 0 .. 10000 ]

Connection bandwidth in Mbps

geoScope
string (GeoScopeType)
Enum: "CANADA" "CONUS" "JAPAN"

Geographic boundary types

object (ConnectionRedundancy)

Connection redundancy configuration

group
string

Redundancy group identifier (UUID of primary connection)

priority
string (ConnectionPriority)
Enum: "PRIMARY" "SECONDARY"

Connection priority in redundancy group

isRemote
boolean

Connection property derived from access point locations

direction
string (ConnectionDirection)
Enum: "INTERNAL" "INCOMING" "OUTGOING"

Connection directionality from the requester point of view

required
object (ConnectionSide)

Connection configuration object for each side of multi-segment connection

object (ServiceToken)

Create Service Tokens (v4) generates Equinix Fabric service tokens. These tokens authorize users to access protected resources and services. The tokens remove sensitive content from the environment, rather than just masking it, making the protected data impossible to unencrypt or decrypt. Resource owners can distribute the tokens to trusted partners and vendors, allowing selected third parties to work directly with Equinix network assets.

type
string (ServiceTokenType)
Enum: "VC_TOKEN" "EPL_TOKEN"

Type of Service Token

href
string <uri>

An absolute URL that is the subject of the link's context.

expiry
integer
Deprecated
uuid
string <uuid>

Equinix-assigned service token identifier

issuerSide
string
Deprecated

information about token side

name
string

Customer-provided service token name

description
string

Customer-provided service token description

expirationDateTime
string <date-time>

Expiration date and time of the service token.

object (ServiceTokenConnection)

Service Token Connection Type Information

state
string (ServiceTokenState)
Enum: "ACTIVE" "INACTIVE" "EXPIRED" "DELETED"

Service token state

Array of objects (SimplifiedNotification)

Service token related notifications

object (SimplifiedAccount)
object (Changelog)

Change log

object (Project)
object (AccessPoint)

Access point object

type
string (AccessPointType)
Enum: "VD" "VG" "SP" "IGW" "COLO" "SUBNET" "CLOUD_ROUTER" "NETWORK" "METAL_NETWORK" "VPIC_INTERFACE"

Access point type

object (SimplifiedAccount)
object (SimplifiedLocation)
object (SimplifiedPort)

Port specification

object (SimplifiedServiceProfile)

Service Profile is a software definition for a named provider service and it's network connectivity requirements. This includes the basic marketing information and one or more sets of access points (a set per each access point type) fulfilling the provider service.

object (CloudRouter)

Fabric Cloud Router object

object (SimplifiedLinkProtocol)

Connection link protocol Configuration

object (VirtualDevice)

Virtual Device AccessPoint Information

object (Interface)

Interface Information

object (SimplifiedNetwork)

Network specification

sellerRegion
string

Access point seller region

peeringType
string (PeeringType)
Enum: "PRIVATE" "MICROSOFT" "PUBLIC" "MANUAL"

Access point peering type

authenticationKey
string

Access point authentication key

providerConnectionId
string

Provider assigned Connection Id

object (VirtualNetwork)

Virtual Network Information

object (MetalInterconnection)

Metal Interconnection

object (VpicInterface)

MCN VPIC Interface Information

object (InternetAccess)

Internet Access Details

uuid
string <uuid>

Internet Access Service Identifier

object (ConnectionCompanyProfile)

Connection Company Profile Details

id
number

company profile identifier

name
string

company profile name

globalOrgId
string

global customer organization value

object (ConnectionInvitation)

Connection Invitation Details

email
string

invitee email

message
string

invitation message

ctrDraftOrderId
string

draft order id for invitation

Array of objects (ConnectionSideAdditionalInfo)

Any additional information, which is not part of connection metadata or configuration

Array
key
string

Key

value
string

Value

required
object (ConnectionSide)

Connection configuration object for each side of multi-segment connection

object (ServiceToken)

Create Service Tokens (v4) generates Equinix Fabric service tokens. These tokens authorize users to access protected resources and services. The tokens remove sensitive content from the environment, rather than just masking it, making the protected data impossible to unencrypt or decrypt. Resource owners can distribute the tokens to trusted partners and vendors, allowing selected third parties to work directly with Equinix network assets.

type
string (ServiceTokenType)
Enum: "VC_TOKEN" "EPL_TOKEN"

Type of Service Token

href
string <uri>

An absolute URL that is the subject of the link's context.

expiry
integer
Deprecated
uuid
string <uuid>

Equinix-assigned service token identifier

issuerSide
string
Deprecated

information about token side

name
string

Customer-provided service token name

description
string

Customer-provided service token description

expirationDateTime
string <date-time>

Expiration date and time of the service token.

object (ServiceTokenConnection)

Service Token Connection Type Information

state
string (ServiceTokenState)
Enum: "ACTIVE" "INACTIVE" "EXPIRED" "DELETED"

Service token state

Array of objects (SimplifiedNotification)

Service token related notifications

object (SimplifiedAccount)
object (Changelog)

Change log

object (Project)
object (AccessPoint)

Access point object

type
string (AccessPointType)
Enum: "VD" "VG" "SP" "IGW" "COLO" "SUBNET" "CLOUD_ROUTER" "NETWORK" "METAL_NETWORK" "VPIC_INTERFACE"

Access point type

object (SimplifiedAccount)
object (SimplifiedLocation)
object (SimplifiedPort)

Port specification

object (SimplifiedServiceProfile)

Service Profile is a software definition for a named provider service and it's network connectivity requirements. This includes the basic marketing information and one or more sets of access points (a set per each access point type) fulfilling the provider service.

object (CloudRouter)

Fabric Cloud Router object

object (SimplifiedLinkProtocol)

Connection link protocol Configuration

object (VirtualDevice)

Virtual Device AccessPoint Information

object (Interface)

Interface Information

object (SimplifiedNetwork)

Network specification

sellerRegion
string

Access point seller region

peeringType
string (PeeringType)
Enum: "PRIVATE" "MICROSOFT" "PUBLIC" "MANUAL"

Access point peering type

authenticationKey
string

Access point authentication key

providerConnectionId
string

Provider assigned Connection Id

object (VirtualNetwork)

Virtual Network Information

object (MetalInterconnection)

Metal Interconnection

object (VpicInterface)

MCN VPIC Interface Information

object (InternetAccess)

Internet Access Details

uuid
string <uuid>

Internet Access Service Identifier

object (ConnectionCompanyProfile)

Connection Company Profile Details

id
number

company profile identifier

name
string

company profile name

globalOrgId
string

global customer organization value

object (ConnectionInvitation)

Connection Invitation Details

email
string

invitee email

message
string

invitation message

ctrDraftOrderId
string

draft order id for invitation

Array of objects (ConnectionSideAdditionalInfo)

Any additional information, which is not part of connection metadata or configuration

Array
key
string

Key

value
string

Value

object (marketplaceSubscription)

Equinix Fabric Entity for Marketplace Subscription

href
string <uri>

Marketplace Subscription URI

type
string
Enum: "AWS_MARKETPLACE_SUBSCRIPTION" "GCP_MARKETPLACE_SUBSCRIPTION" "AZURE_MARKETPLACE_SUBSCRIPTION"

Marketplace Subscription type

uuid
string

Equinix-assigned Marketplace Subscription identifier

Array of objects (ConnectionSideAdditionalInfo)

Connection additional information

Array
key
string

Key

value
string

Value

object (Project)
projectId
required
string

Subscriber-assigned project ID

Response samples

Content type
application/json
Example
{}

Delete by ID

Delete Connection by ID

Authorizations:
BearerAuth
path Parameters
connectionId
required
string (VirtualCircuitId)

Connection UUID

Responses

Response Schema: application/json
href
string <uri>

Connection URI

type
required
string (ConnectionType)
Enum: "EVPL_VC" "EPL_VC" "EC_VC" "IP_VC" "ACCESS_EPL_VC" "EIA_VC" "EVPLAN_VC" "EPLAN_VC" "IPWAN_VC" "IA_VC"

Connection type

uuid
string

Equinix-assigned connection identifier

name
required
string

Customer-provided connection name

description
string

Customer-provided connection description

state
string (ConnectionState)
Enum: "ACTIVE" "CANCELLED" "DEPROVISIONED" "DEPROVISIONING" "DRAFT" "FAILED" "PENDING" "PROVISIONED" "PROVISIONING" "REPROVISIONING" ""

Connection status

object (Change)

Current state of latest connection change

uuid
string

Uniquely identifies a change

type
required
string
Enum: "CONNECTION_CREATION" "CONNECTION_UPDATE" "CONNECTION_DELETION" "CONNECTION_PROVIDER_STATUS_REQUEST"

Type of change

status
string
Enum: "APPROVED" "COMPLETED" "FAILED" "REJECTED" "REQUESTED" "SUBMITTED_FOR_APPROVAL"

Current outcome of the change flow

createdDateTime
required
string <date-time>

Set when change flow starts

updatedDateTime
string <date-time>

Set when change object is updated

information
string

Additional information

object (ConnectionChangeOperation)

Connection change operation data

op
required
string

Handy shortcut for operation name

path
required
string

path inside document leading to updated parameter

value
required
object

new value for updated parameter

object (ConnectionOperation)

Connection type-specific operational data

providerStatus
string (ProviderStatus)
Enum: "AVAILABLE" "DEPROVISIONED" "DEPROVISIONING" "FAILED" "NOT_AVAILABLE" "PENDING_APPROVAL" "PENDING_CONFIGURATION" "PROVISIONED" "PROVISIONING" "REJECTED" "PENDING_BGP" "OUT_OF_BANDWIDTH" "DELETED" "ERROR" "ERRORED" "NOTPROVISIONED" "NOT_PROVISIONED" "ORDERING" "DELETING" "PENDING DELETE" "N/A"

Connection provider readiness status

equinixStatus
string (EquinixStatus)
Enum: "REJECTED_ACK" "REJECTED" "PENDING_DELETE" "PROVISIONED" "BEING_REPROVISIONED" "BEING_DEPROVISIONED" "BEING_PROVISIONED" "CREATED" "ERRORED" "PENDING_DEPROVISIONING" "APPROVED" "ORDERING" "PENDING_APPROVAL" "NOT_PROVISIONED" "DEPROVISIONING" "NOT_DEPROVISIONED" "PENDING_AUTO_APPROVAL" "PROVISIONING" "PENDING_BGP_PEERING" "PENDING_PROVIDER_VLAN" "DEPROVISIONED" "DELETED" "PENDING_BANDWIDTH_APPROVAL" "AUTO_APPROVAL_FAILED" "UPDATE_PENDING" "DELETED_API" "MODIFIED" "PENDING_PROVIDER_VLAN_ERROR" "DRAFT" "CANCELLED" "PENDING_INTERFACE_CONFIGURATION"

Connection status

operationalStatus
string
Enum: "UP" "DOWN"

Connection operational status

Array of objects (Error)
Array
errorCode
required
string^EQ-\d{7}$
errorMessage
required
string
correlationId
string
details
string
help
string
Array of objects (PriceError_additionalInfo)
opStatusChangedAt
string <date-time>

When connection transitioned into current operational status

object (Order)
purchaseOrderNumber
string

Purchase order number

customerReferenceNumber
string

Customer reference number

billingTier
string

Billing tier for connection bandwidth

orderId
string

Order Identification

orderNumber
string

Order Reference Number

termLength
integer [ 1 .. 36 ]
Default: 1

Term length in months, valid values are 1, 12, 24, 36 where 1 is the default value (for on-demand case).

Array of objects (SimplifiedNotification)

Preferences for notifications on connection configuration or status changes

Array
type
required
string
Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS"

Notification Type

sendInterval
string
emails
required
Array of strings <email> [ items <email > ]

Array of contact emails

registeredUsers
Array of strings

Array of registered users

object (SimplifiedAccount)
accountNumber
integer <int64>

Account number

accountName
string

Account name

orgId
integer <int64>

Customer organization identifier

organizationName
string

Customer organization name

globalOrgId
string

Global organization identifier

globalOrganizationName
string

Global organization name

ucmId
string

Account ucmId

globalCustId
string

Account name

resellerAccountNumber
integer <int64>

Reseller account number

resellerAccountName
string

Reseller account name

resellerUcmId
string

Reseller account ucmId

resellerOrgId
integer <int64>

Reseller customer organization identifier

object (Changelog)

Change log

createdBy
string

Created by User Key

createdByFullName
string

Created by User Full Name

createdByEmail
string

Created by User Email Address

createdDateTime
string <date-time>

Created by Date and Time

updatedBy
string

Updated by User Key

updatedByFullName
string

Updated by User Full Name

updatedByEmail
string

Updated by User Email Address

updatedDateTime
string <date-time>

Updated by Date and Time

deletedBy
string

Deleted by User Key

deletedByFullName
string

Deleted by User Full Name

deletedByEmail
string

Deleted by User Email Address

deletedDateTime
string <date-time>

Deleted by Date and Time

bandwidth
required
integer [ 0 .. 10000 ]

Connection bandwidth in Mbps

geoScope
string (GeoScopeType)
Enum: "CANADA" "CONUS" "JAPAN"

Geographic boundary types

object (ConnectionRedundancy)

Connection redundancy configuration

group
string

Redundancy group identifier (UUID of primary connection)

priority
string (ConnectionPriority)
Enum: "PRIMARY" "SECONDARY"

Connection priority in redundancy group

isRemote
boolean

Connection property derived from access point locations

direction
string (ConnectionDirection)
Enum: "INTERNAL" "INCOMING" "OUTGOING"

Connection directionality from the requester point of view

required
object (ConnectionSide)

Connection configuration object for each side of multi-segment connection

object (ServiceToken)

Create Service Tokens (v4) generates Equinix Fabric service tokens. These tokens authorize users to access protected resources and services. The tokens remove sensitive content from the environment, rather than just masking it, making the protected data impossible to unencrypt or decrypt. Resource owners can distribute the tokens to trusted partners and vendors, allowing selected third parties to work directly with Equinix network assets.

type
string (ServiceTokenType)
Enum: "VC_TOKEN" "EPL_TOKEN"

Type of Service Token

href
string <uri>

An absolute URL that is the subject of the link's context.

expiry
integer
Deprecated
uuid
string <uuid>

Equinix-assigned service token identifier

issuerSide
string
Deprecated

information about token side

name
string

Customer-provided service token name

description
string

Customer-provided service token description

expirationDateTime
string <date-time>

Expiration date and time of the service token.

object (ServiceTokenConnection)

Service Token Connection Type Information

state
string (ServiceTokenState)
Enum: "ACTIVE" "INACTIVE" "EXPIRED" "DELETED"

Service token state

Array of objects (SimplifiedNotification)

Service token related notifications

object (SimplifiedAccount)
object (Changelog)

Change log

object (Project)
object (AccessPoint)

Access point object

type
string (AccessPointType)
Enum: "VD" "VG" "SP" "IGW" "COLO" "SUBNET" "CLOUD_ROUTER" "NETWORK" "METAL_NETWORK" "VPIC_INTERFACE"

Access point type

object (SimplifiedAccount)
object (SimplifiedLocation)
object (SimplifiedPort)

Port specification

object (SimplifiedServiceProfile)

Service Profile is a software definition for a named provider service and it's network connectivity requirements. This includes the basic marketing information and one or more sets of access points (a set per each access point type) fulfilling the provider service.

object (CloudRouter)

Fabric Cloud Router object

object (SimplifiedLinkProtocol)

Connection link protocol Configuration

object (VirtualDevice)

Virtual Device AccessPoint Information

object (Interface)

Interface Information

object (SimplifiedNetwork)

Network specification

sellerRegion
string

Access point seller region

peeringType
string (PeeringType)
Enum: "PRIVATE" "MICROSOFT" "PUBLIC" "MANUAL"

Access point peering type

authenticationKey
string

Access point authentication key

providerConnectionId
string

Provider assigned Connection Id

object (VirtualNetwork)

Virtual Network Information

object (MetalInterconnection)

Metal Interconnection

object (VpicInterface)

MCN VPIC Interface Information

object (InternetAccess)

Internet Access Details

uuid
string <uuid>

Internet Access Service Identifier

object (ConnectionCompanyProfile)

Connection Company Profile Details

id
number

company profile identifier

name
string

company profile name

globalOrgId
string

global customer organization value

object (ConnectionInvitation)

Connection Invitation Details

email
string

invitee email

message
string

invitation message

ctrDraftOrderId
string

draft order id for invitation

Array of objects (ConnectionSideAdditionalInfo)

Any additional information, which is not part of connection metadata or configuration

Array
key
string

Key

value
string

Value

required
object (ConnectionSide)

Connection configuration object for each side of multi-segment connection

object (ServiceToken)

Create Service Tokens (v4) generates Equinix Fabric service tokens. These tokens authorize users to access protected resources and services. The tokens remove sensitive content from the environment, rather than just masking it, making the protected data impossible to unencrypt or decrypt. Resource owners can distribute the tokens to trusted partners and vendors, allowing selected third parties to work directly with Equinix network assets.

type
string (ServiceTokenType)
Enum: "VC_TOKEN" "EPL_TOKEN"

Type of Service Token

href
string <uri>

An absolute URL that is the subject of the link's context.

expiry
integer
Deprecated
uuid
string <uuid>

Equinix-assigned service token identifier

issuerSide
string
Deprecated

information about token side

name
string

Customer-provided service token name

description
string

Customer-provided service token description

expirationDateTime
string <date-time>

Expiration date and time of the service token.

object (ServiceTokenConnection)

Service Token Connection Type Information

state
string (ServiceTokenState)
Enum: "ACTIVE" "INACTIVE" "EXPIRED" "DELETED"

Service token state

Array of objects (SimplifiedNotification)

Service token related notifications

object (SimplifiedAccount)
object (Changelog)

Change log

object (Project)
object (AccessPoint)

Access point object

type
string (AccessPointType)
Enum: "VD" "VG" "SP" "IGW" "COLO" "SUBNET" "CLOUD_ROUTER" "NETWORK" "METAL_NETWORK" "VPIC_INTERFACE"

Access point type

object (SimplifiedAccount)
object (SimplifiedLocation)
object (SimplifiedPort)

Port specification

object (SimplifiedServiceProfile)

Service Profile is a software definition for a named provider service and it's network connectivity requirements. This includes the basic marketing information and one or more sets of access points (a set per each access point type) fulfilling the provider service.

object (CloudRouter)

Fabric Cloud Router object

object (SimplifiedLinkProtocol)

Connection link protocol Configuration

object (VirtualDevice)

Virtual Device AccessPoint Information

object (Interface)

Interface Information

object (SimplifiedNetwork)

Network specification

sellerRegion
string

Access point seller region

peeringType
string (PeeringType)
Enum: "PRIVATE" "MICROSOFT" "PUBLIC" "MANUAL"

Access point peering type

authenticationKey
string

Access point authentication key

providerConnectionId
string

Provider assigned Connection Id

object (VirtualNetwork)

Virtual Network Information

object (MetalInterconnection)

Metal Interconnection

object (VpicInterface)

MCN VPIC Interface Information

object (InternetAccess)

Internet Access Details

uuid
string <uuid>

Internet Access Service Identifier

object (ConnectionCompanyProfile)

Connection Company Profile Details

id
number

company profile identifier

name
string

company profile name

globalOrgId
string

global customer organization value

object (ConnectionInvitation)

Connection Invitation Details

email
string

invitee email

message
string

invitation message

ctrDraftOrderId
string

draft order id for invitation

Array of objects (ConnectionSideAdditionalInfo)

Any additional information, which is not part of connection metadata or configuration

Array
key
string

Key

value
string

Value

object (marketplaceSubscription)

Equinix Fabric Entity for Marketplace Subscription

href
string <uri>

Marketplace Subscription URI

type
string
Enum: "AWS_MARKETPLACE_SUBSCRIPTION" "GCP_MARKETPLACE_SUBSCRIPTION" "AZURE_MARKETPLACE_SUBSCRIPTION"

Marketplace Subscription type

uuid
string

Equinix-assigned Marketplace Subscription identifier

Array of objects (ConnectionSideAdditionalInfo)

Connection additional information

Array
key
string

Key

value
string

Value

object (Project)
projectId
required
string

Subscriber-assigned project ID

Response samples

Content type
application/json
{}

Update by ID

Update Connection by ID

Authorizations:
BearerAuth
path Parameters
connectionId
required
string (ConnectionId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Connection Id

query Parameters
dryRun
boolean
Default: false

option to verify that API calls will succeed

Request Body schema: application/json-patch+json
required
Array (non-empty)
op
required
string

Handy shortcut for operation name

path
required
string

path inside document leading to updated parameter

value
required
object

new value for updated parameter

Responses

Response Schema: application/json
href
string <uri>

Connection URI

type
required
string (ConnectionType)
Enum: "EVPL_VC" "EPL_VC" "EC_VC" "IP_VC" "ACCESS_EPL_VC" "EIA_VC" "EVPLAN_VC" "EPLAN_VC" "IPWAN_VC" "IA_VC"

Connection type

uuid
string

Equinix-assigned connection identifier

name
required
string

Customer-provided connection name

description
string

Customer-provided connection description

state
string (ConnectionState)
Enum: "ACTIVE" "CANCELLED" "DEPROVISIONED" "DEPROVISIONING" "DRAFT" "FAILED" "PENDING" "PROVISIONED" "PROVISIONING" "REPROVISIONING" ""

Connection status

object (Change)

Current state of latest connection change

uuid
string

Uniquely identifies a change

type
required
string
Enum: "CONNECTION_CREATION" "CONNECTION_UPDATE" "CONNECTION_DELETION" "CONNECTION_PROVIDER_STATUS_REQUEST"

Type of change

status
string
Enum: "APPROVED" "COMPLETED" "FAILED" "REJECTED" "REQUESTED" "SUBMITTED_FOR_APPROVAL"

Current outcome of the change flow

createdDateTime
required
string <date-time>

Set when change flow starts

updatedDateTime
string <date-time>

Set when change object is updated

information
string

Additional information

object (ConnectionChangeOperation)

Connection change operation data

op
required
string

Handy shortcut for operation name

path
required
string

path inside document leading to updated parameter

value
required
object

new value for updated parameter

object (ConnectionOperation)

Connection type-specific operational data

providerStatus
string (ProviderStatus)
Enum: "AVAILABLE" "DEPROVISIONED" "DEPROVISIONING" "FAILED" "NOT_AVAILABLE" "PENDING_APPROVAL" "PENDING_CONFIGURATION" "PROVISIONED" "PROVISIONING" "REJECTED" "PENDING_BGP" "OUT_OF_BANDWIDTH" "DELETED" "ERROR" "ERRORED" "NOTPROVISIONED" "NOT_PROVISIONED" "ORDERING" "DELETING" "PENDING DELETE" "N/A"

Connection provider readiness status

equinixStatus
string (EquinixStatus)
Enum: "REJECTED_ACK" "REJECTED" "PENDING_DELETE" "PROVISIONED" "BEING_REPROVISIONED" "BEING_DEPROVISIONED" "BEING_PROVISIONED" "CREATED" "ERRORED" "PENDING_DEPROVISIONING" "APPROVED" "ORDERING" "PENDING_APPROVAL" "NOT_PROVISIONED" "DEPROVISIONING" "NOT_DEPROVISIONED" "PENDING_AUTO_APPROVAL" "PROVISIONING" "PENDING_BGP_PEERING" "PENDING_PROVIDER_VLAN" "DEPROVISIONED" "DELETED" "PENDING_BANDWIDTH_APPROVAL" "AUTO_APPROVAL_FAILED" "UPDATE_PENDING" "DELETED_API" "MODIFIED" "PENDING_PROVIDER_VLAN_ERROR" "DRAFT" "CANCELLED" "PENDING_INTERFACE_CONFIGURATION"

Connection status

operationalStatus
string
Enum: "UP" "DOWN"

Connection operational status

Array of objects (Error)
Array
errorCode
required
string^EQ-\d{7}$
errorMessage
required
string
correlationId
string
details
string
help
string
Array of objects (PriceError_additionalInfo)
opStatusChangedAt
string <date-time>

When connection transitioned into current operational status

object (Order)
purchaseOrderNumber
string

Purchase order number

customerReferenceNumber
string

Customer reference number

billingTier
string

Billing tier for connection bandwidth

orderId
string

Order Identification

orderNumber
string

Order Reference Number

termLength
integer [ 1 .. 36 ]
Default: 1

Term length in months, valid values are 1, 12, 24, 36 where 1 is the default value (for on-demand case).

Array of objects (SimplifiedNotification)

Preferences for notifications on connection configuration or status changes

Array
type
required
string
Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS"

Notification Type

sendInterval
string
emails
required
Array of strings <email> [ items <email > ]

Array of contact emails

registeredUsers
Array of strings

Array of registered users

object (SimplifiedAccount)
accountNumber
integer <int64>

Account number

accountName
string

Account name

orgId
integer <int64>

Customer organization identifier

organizationName
string

Customer organization name

globalOrgId
string

Global organization identifier

globalOrganizationName
string

Global organization name

ucmId
string

Account ucmId

globalCustId
string

Account name

resellerAccountNumber
integer <int64>

Reseller account number

resellerAccountName
string

Reseller account name

resellerUcmId
string

Reseller account ucmId

resellerOrgId
integer <int64>

Reseller customer organization identifier

object (Changelog)

Change log

createdBy
string

Created by User Key

createdByFullName
string

Created by User Full Name

createdByEmail
string

Created by User Email Address

createdDateTime
string <date-time>

Created by Date and Time

updatedBy
string

Updated by User Key

updatedByFullName
string

Updated by User Full Name

updatedByEmail
string

Updated by User Email Address

updatedDateTime
string <date-time>

Updated by Date and Time

deletedBy
string

Deleted by User Key

deletedByFullName
string

Deleted by User Full Name

deletedByEmail
string

Deleted by User Email Address

deletedDateTime
string <date-time>

Deleted by Date and Time

bandwidth
required
integer [ 0 .. 10000 ]

Connection bandwidth in Mbps

geoScope
string (GeoScopeType)
Enum: "CANADA" "CONUS" "JAPAN"

Geographic boundary types

object (ConnectionRedundancy)

Connection redundancy configuration

group
string

Redundancy group identifier (UUID of primary connection)

priority
string (ConnectionPriority)
Enum: "PRIMARY" "SECONDARY"

Connection priority in redundancy group

isRemote
boolean

Connection property derived from access point locations

direction
string (ConnectionDirection)
Enum: "INTERNAL" "INCOMING" "OUTGOING"

Connection directionality from the requester point of view

required
object (ConnectionSide)

Connection configuration object for each side of multi-segment connection

object (ServiceToken)

Create Service Tokens (v4) generates Equinix Fabric service tokens. These tokens authorize users to access protected resources and services. The tokens remove sensitive content from the environment, rather than just masking it, making the protected data impossible to unencrypt or decrypt. Resource owners can distribute the tokens to trusted partners and vendors, allowing selected third parties to work directly with Equinix network assets.

type
string (ServiceTokenType)
Enum: "VC_TOKEN" "EPL_TOKEN"

Type of Service Token

href
string <uri>

An absolute URL that is the subject of the link's context.

expiry
integer
Deprecated
uuid
string <uuid>

Equinix-assigned service token identifier

issuerSide
string
Deprecated

information about token side

name
string

Customer-provided service token name

description
string

Customer-provided service token description

expirationDateTime
string <date-time>

Expiration date and time of the service token.

object (ServiceTokenConnection)

Service Token Connection Type Information

state
string (ServiceTokenState)
Enum: "ACTIVE" "INACTIVE" "EXPIRED" "DELETED"

Service token state

Array of objects (SimplifiedNotification)

Service token related notifications

object (SimplifiedAccount)
object (Changelog)

Change log

object (Project)
object (AccessPoint)

Access point object

type
string (AccessPointType)
Enum: "VD" "VG" "SP" "IGW" "COLO" "SUBNET" "CLOUD_ROUTER" "NETWORK" "METAL_NETWORK" "VPIC_INTERFACE"

Access point type

object (SimplifiedAccount)
object (SimplifiedLocation)
object (SimplifiedPort)

Port specification

object (SimplifiedServiceProfile)

Service Profile is a software definition for a named provider service and it's network connectivity requirements. This includes the basic marketing information and one or more sets of access points (a set per each access point type) fulfilling the provider service.

object (CloudRouter)

Fabric Cloud Router object

object (SimplifiedLinkProtocol)

Connection link protocol Configuration

object (VirtualDevice)

Virtual Device AccessPoint Information

object (Interface)

Interface Information

object (SimplifiedNetwork)

Network specification

sellerRegion
string

Access point seller region

peeringType
string (PeeringType)
Enum: "PRIVATE" "MICROSOFT" "PUBLIC" "MANUAL"

Access point peering type

authenticationKey
string

Access point authentication key

providerConnectionId
string

Provider assigned Connection Id

object (VirtualNetwork)

Virtual Network Information

object (MetalInterconnection)

Metal Interconnection

object (VpicInterface)

MCN VPIC Interface Information

object (InternetAccess)

Internet Access Details

uuid
string <uuid>

Internet Access Service Identifier

object (ConnectionCompanyProfile)

Connection Company Profile Details

id
number

company profile identifier

name
string

company profile name

globalOrgId
string

global customer organization value

object (ConnectionInvitation)

Connection Invitation Details

email
string

invitee email

message
string

invitation message

ctrDraftOrderId
string

draft order id for invitation

Array of objects (ConnectionSideAdditionalInfo)

Any additional information, which is not part of connection metadata or configuration

Array
key
string

Key

value
string

Value

required
object (ConnectionSide)

Connection configuration object for each side of multi-segment connection

object (ServiceToken)

Create Service Tokens (v4) generates Equinix Fabric service tokens. These tokens authorize users to access protected resources and services. The tokens remove sensitive content from the environment, rather than just masking it, making the protected data impossible to unencrypt or decrypt. Resource owners can distribute the tokens to trusted partners and vendors, allowing selected third parties to work directly with Equinix network assets.

type
string (ServiceTokenType)
Enum: "VC_TOKEN" "EPL_TOKEN"

Type of Service Token

href
string <uri>

An absolute URL that is the subject of the link's context.

expiry
integer
Deprecated
uuid
string <uuid>

Equinix-assigned service token identifier

issuerSide
string
Deprecated

information about token side

name
string

Customer-provided service token name

description
string

Customer-provided service token description

expirationDateTime
string <date-time>

Expiration date and time of the service token.

object (ServiceTokenConnection)

Service Token Connection Type Information

state
string (ServiceTokenState)
Enum: "ACTIVE" "INACTIVE" "EXPIRED" "DELETED"

Service token state

Array of objects (SimplifiedNotification)

Service token related notifications

object (SimplifiedAccount)
object (Changelog)

Change log

object (Project)
object (AccessPoint)

Access point object

type
string (AccessPointType)
Enum: "VD" "VG" "SP" "IGW" "COLO" "SUBNET" "CLOUD_ROUTER" "NETWORK" "METAL_NETWORK" "VPIC_INTERFACE"

Access point type

object (SimplifiedAccount)
object (SimplifiedLocation)
object (SimplifiedPort)

Port specification

object (SimplifiedServiceProfile)

Service Profile is a software definition for a named provider service and it's network connectivity requirements. This includes the basic marketing information and one or more sets of access points (a set per each access point type) fulfilling the provider service.

object (CloudRouter)

Fabric Cloud Router object

object (SimplifiedLinkProtocol)

Connection link protocol Configuration

object (VirtualDevice)

Virtual Device AccessPoint Information

object (Interface)

Interface Information

object (SimplifiedNetwork)

Network specification

sellerRegion
string

Access point seller region

peeringType
string (PeeringType)
Enum: "PRIVATE" "MICROSOFT" "PUBLIC" "MANUAL"

Access point peering type

authenticationKey
string

Access point authentication key

providerConnectionId
string

Provider assigned Connection Id

object (VirtualNetwork)

Virtual Network Information

object (MetalInterconnection)

Metal Interconnection

object (VpicInterface)

MCN VPIC Interface Information

object (InternetAccess)

Internet Access Details

uuid
string <uuid>

Internet Access Service Identifier

object (ConnectionCompanyProfile)

Connection Company Profile Details

id
number

company profile identifier

name
string

company profile name

globalOrgId
string

global customer organization value

object (ConnectionInvitation)

Connection Invitation Details

email
string

invitee email

message
string

invitation message

ctrDraftOrderId
string

draft order id for invitation

Array of objects (ConnectionSideAdditionalInfo)

Any additional information, which is not part of connection metadata or configuration

Array
key
string

Key

value
string

Value

object (marketplaceSubscription)

Equinix Fabric Entity for Marketplace Subscription

href
string <uri>

Marketplace Subscription URI

type
string
Enum: "AWS_MARKETPLACE_SUBSCRIPTION" "GCP_MARKETPLACE_SUBSCRIPTION" "AZURE_MARKETPLACE_SUBSCRIPTION"

Marketplace Subscription type

uuid
string

Equinix-assigned Marketplace Subscription identifier

Array of objects (ConnectionSideAdditionalInfo)

Connection additional information

Array
key
string

Key

value
string

Value

object (Project)
projectId
required
string

Subscriber-assigned project ID

Request samples

Content type
application/json-patch+json
Example
[
  • {
    }
]

Response samples

Content type
application/json
{}

Connection Actions

This API provides capability to accept/reject user's virtual connection

Authorizations:
BearerAuth
path Parameters
connectionId
required
string (ConnectionId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Connection Id

Request Body schema: application/json
required
type
required
string (Actions)
Enum: "CONNECTION_CREATION_ACCEPTANCE" "CONNECTION_CREATION_REJECTION" "CONNECTION_UPDATE_ACCEPTANCE" "CONNECTION_UPDATE_REJECTION" "CONNECTION_DELETION_ACCEPTANCE" "CONNECTION_REJECTION_ACCEPTANCE" "CONNECTION_UPDATE_REQUEST" "MIGRATION_EVPL_VC" "CONNECTION_PROVIDER_STATUS_REQUEST" "CONNECTION_PROVIDER_BANDWIDTH_REQUEST" "ACCEPT_HOSTED_CONNECTION" "CANCEL_EVPL_VC_DRAFT_ORDERS"

Connection action type

description
string

Connection rejection reason detail

object (ConnectionAcceptanceData)

Connection acceptance data

object (ConnectionSide)

Connection configuration object for each side of multi-segment connection

object (ServiceToken)

Create Service Tokens (v4) generates Equinix Fabric service tokens. These tokens authorize users to access protected resources and services. The tokens remove sensitive content from the environment, rather than just masking it, making the protected data impossible to unencrypt or decrypt. Resource owners can distribute the tokens to trusted partners and vendors, allowing selected third parties to work directly with Equinix network assets.

object (AccessPoint)

Access point object

object (InternetAccess)

Internet Access Details

object (ConnectionCompanyProfile)

Connection Company Profile Details

object (ConnectionInvitation)

Connection Invitation Details

Array of objects (ConnectionSideAdditionalInfo)

Any additional information, which is not part of connection metadata or configuration

Responses

Request samples

Content type
application/json
Example
{
  • "type": "CONNECTION_CREATION_ACCEPTANCE",
  • "data": {
    }
}

Response samples

Content type
application/json
Example
{}

Search connections

The API provides capability to get list of user's virtual connections using search criteria, including optional filtering, pagination and sorting

Authorizations:
BearerAuth
Request Body schema: application/json
required
object (Expression)
and
Array of objects (Expressions)
or
Array of objects (Expressions)
property
string (SearchFieldName)
Enum: "/isRemote" "/name" "/uuid" "/type" "/geoScope" "/account/orgId" "/aSide/accessPoint/account/accountName" "/aSide/accessPoint/account/accountNumber" "/aSide/accessPoint/router/uuid" "/aSide/accessPoint/linkProtocol/vlanCTag" "/aSide/accessPoint/linkProtocol/vlanSTag" "/aSide/accessPoint/linkProtocol/vlanTagMin" "/aSide/accessPoint/linkProtocol/vlanTagMax" "/aSide/accessPoint/location/metroCode" "/aSide/accessPoint/location/metroName" "/aSide/accessPoint/name" "/aSide/accessPoint/port/uuid" "/aSide/accessPoint/port/name" "/aSide/accessPoint/type" "/aSide/accessPoint/virtualDevice/name" "/aSide/accessPoint/virtualDevice/uuid" "/aSide/serviceToken/uuid" "/change/status" "/operation/equinixStatus" "/operation/providerStatus" "/project/projectId" "/redundancy/group" "/redundancy/priority" "/zSide/accessPoint/account/accountName" "/zSide/accessPoint/authenticationKey" "/zSide/accessPoint/linkProtocol/vlanCTag" "/zSide/accessPoint/linkProtocol/vlanSTag" "/zSide/accessPoint/linkProtocol/vlanTagMin" "/zSide/accessPoint/linkProtocol/vlanTagMax" "/zSide/accessPoint/location/metroCode" "/zSide/accessPoint/location/metroName" "/zSide/accessPoint/name" "/zSide/accessPoint/port/uuid" "/zSide/accessPoint/network/uuid" "/zSide/accessPoint/port/name" "/zSide/accessPoint/profile/uuid" "/zSide/accessPoint/type" "/zSide/accessPoint/virtualDevice/name" "/zSide/accessPoint/virtualDevice/uuid" "/zSide/serviceToken/uuid" "/zSide/internetAccess/uuid" "*"

Possible field names to use on filters

operator
string
Enum: "=" "!=" ">" ">=" "<" "<=" "BETWEEN" "NOT BETWEEN" "LIKE" "NOT LIKE" "IN" "NOT IN" "IS NOT NULL" "IS NULL"
values
Array of strings
object (PaginationRequest)

Pagination request information

offset
integer >= 0
Default: 0

Index of the first element.

limit
integer >= 1
Default: 20

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

Array of objects (SortCriteria)
Array
direction
string (SortDirection)
Default: "DESC"
Enum: "DESC" "ASC"

Sorting direction

property
string (SortBy)
Default: "/changeLog/updatedDateTime"
Enum: "/name" "/direction" "/aSide/accessPoint/name" "/aSide/accessPoint/type" "/aSide/accessPoint/account/accountName" "/aSide/accessPoint/location/metroName" "/aSide/accessPoint/location/metroCode" "/aSide/accessPoint/linkProtocol/vlanCTag" "/aSide/accessPoint/linkProtocol/vlanSTag" "/zSide/accessPoint/name" "/zSide/accessPoint/type" "/zSide/accessPoint/account/accountName" "/zSide/accessPoint/location/metroName" "/zSide/accessPoint/location/metroCode" "/zSide/accessPoint/linkProtocol/vlanCTag" "/zSide/accessPoint/linkProtocol/vlanSTag" "/zSide/accessPoint/authenticationKey" "/bandwidth" "/geoScope" "/uuid" "/changeLog/createdDateTime" "/changeLog/updatedDateTime" "/operation/equinixStatus" "/operation/providerStatus" "/redundancy/priority"

Possible field names to use on sorting

Responses

Response Schema: application/json
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Array of objects (SortCriteriaResponse)
Array
direction
string (SortDirection)
Default: "DESC"
Enum: "DESC" "ASC"

Sorting direction

property
string (SortBy)
Default: "/changeLog/updatedDateTime"
Enum: "/name" "/direction" "/aSide/accessPoint/name" "/aSide/accessPoint/type" "/aSide/accessPoint/account/accountName" "/aSide/accessPoint/location/metroName" "/aSide/accessPoint/location/metroCode" "/aSide/accessPoint/linkProtocol/vlanCTag" "/aSide/accessPoint/linkProtocol/vlanSTag" "/zSide/accessPoint/name" "/zSide/accessPoint/type" "/zSide/accessPoint/account/accountName" "/zSide/accessPoint/location/metroName" "/zSide/accessPoint/location/metroCode" "/zSide/accessPoint/linkProtocol/vlanCTag" "/zSide/accessPoint/linkProtocol/vlanSTag" "/zSide/accessPoint/authenticationKey" "/bandwidth" "/geoScope" "/uuid" "/changeLog/createdDateTime" "/changeLog/updatedDateTime" "/operation/equinixStatus" "/operation/providerStatus" "/redundancy/priority"

Possible field names to use on sorting

Array of objects (Connection)
Array
href
string <uri>

Connection URI

type
required
string (ConnectionType)
Enum: "EVPL_VC" "EPL_VC" "EC_VC" "IP_VC" "ACCESS_EPL_VC" "EIA_VC" "EVPLAN_VC" "EPLAN_VC" "IPWAN_VC" "IA_VC"

Connection type

uuid
string

Equinix-assigned connection identifier

name
required
string

Customer-provided connection name

description
string

Customer-provided connection description

state
string (ConnectionState)
Enum: "ACTIVE" "CANCELLED" "DEPROVISIONED" "DEPROVISIONING" "DRAFT" "FAILED" "PENDING" "PROVISIONED" "PROVISIONING" "REPROVISIONING" ""

Connection status

object (Change)

Current state of latest connection change

object (ConnectionOperation)

Connection type-specific operational data

object (Order)
Array of objects (SimplifiedNotification)

Preferences for notifications on connection configuration or status changes

object (SimplifiedAccount)
object (Changelog)

Change log

bandwidth
required
integer [ 0 .. 10000 ]

Connection bandwidth in Mbps

geoScope
string (GeoScopeType)
Enum: "CANADA" "CONUS" "JAPAN"

Geographic boundary types

object (ConnectionRedundancy)

Connection redundancy configuration

isRemote
boolean

Connection property derived from access point locations

direction
string (ConnectionDirection)
Enum: "INTERNAL" "INCOMING" "OUTGOING"

Connection directionality from the requester point of view

required
object (ConnectionSide)

Connection configuration object for each side of multi-segment connection

required
object (ConnectionSide)

Connection configuration object for each side of multi-segment connection

object (marketplaceSubscription)

Equinix Fabric Entity for Marketplace Subscription

Array of objects (ConnectionSideAdditionalInfo)

Connection additional information

object (Project)

Request samples

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

Response samples

Content type
application/json
[
  • {
    }
]

Validate Connection

This API provides capability to validate by auth key

Authorizations:
BearerAuth
Request Body schema: application/json
required
object (ValidateRequest_filter)

Filters

Array of objects (ValidateRequest_filter_and)
Array
property
string

Path to property

operator
string

Type of operation

values
Array of strings

Values for the given property

Responses

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

Additional information

Array
key
string

Key

value
string

Value

Array of objects (ValidateConnectionResponse)

Connection response data

Array
uuid
string

Equinix-assigned connection identifier

bandwidth
integer [ 0 .. 50000 ]

Connection bandwidth in Mbps

object (ConnectionRedundancy)

Connection redundancy configuration

object (ConnectionSide)

Connection configuration object for each side of multi-segment connection

object (ConnectionSide)

Connection configuration object for each side of multi-segment connection

Request samples

Content type
application/json
Example
{
  • "filter": {
    }
}

Response samples

Content type
application/json
Example
{
  • "additionalInfo": [
    ]
}

Metros

Metros

Get all Metros

GET All Subscriber Metros with an option query parameter to return all Equinix Fabric metros in which the customer has a presence, as well as latency data for each location.

Authorizations:
BearerAuth
query Parameters
presence
string (Presence)
Value: "MY_PORTS"

User On Boarded Metros based on Fabric resource availability

offset
integer
Example: offset=1

offset

limit
integer
Example: limit=10

number of records to fetch

Responses

Response Schema: application/json
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Array of objects (Metro)

List of Fabric Metros.

Array
href
string

The Canonical URL at which the resource resides.

type
string

Indicator of a Fabric Metro

code
string

Code Assigned to an Equinix IBX data center in a specified metropolitan area.

region
string

Board geographic area in which the data center is located

name
string

Name of the region in which the data center is located.

equinixAsn
integer <int64>

Autonomous system number (ASN) for a specified Fabric metro. The ASN is a unique identifier that carries the network routing protocol and exchanges that data with other internal systems via border gateway protocol.

localVCBandwidthMax
integer <int64>

This field holds Max Connection speed with in the metro

object (GeoCoordinates)

Geographic location data of Fabric Metro

Array of objects (ConnectedMetro)
geoScopes
Array of strings (GeoScopeType)
Items Enum: "CANADA" "CONUS" "JAPAN"

List of supported geographic boundaries of a Fabric Metro.

Response samples

Content type
application/json
{}

Get Metro by Code

GET Metros retrieves all Equinix Fabric metros, as well as latency data between each metro location.

Authorizations:
BearerAuth
path Parameters
metroCode
required
string (MetroCode)

Metro Code

Responses

Response Schema: application/json
href
string

The Canonical URL at which the resource resides.

type
string

Indicator of a Fabric Metro

code
string

Code Assigned to an Equinix IBX data center in a specified metropolitan area.

region
string

Board geographic area in which the data center is located

name
string

Name of the region in which the data center is located.

equinixAsn
integer <int64>

Autonomous system number (ASN) for a specified Fabric metro. The ASN is a unique identifier that carries the network routing protocol and exchanges that data with other internal systems via border gateway protocol.

localVCBandwidthMax
integer <int64>

This field holds Max Connection speed with in the metro

object (GeoCoordinates)

Geographic location data of Fabric Metro

latitude
number <double>

Latitude of a Fabric Metro

longitude
number <double>

Longitude of a Fabric Metro

Array of objects (ConnectedMetro)
Array
href
string

The Canonical URL at which the resource resides.

code
string

Code assigned to an Equinix International Business Exchange (IBX) data center in a specified metropolitan area.

avgLatency
number

Average latency (in milliseconds[ms]) between two specified metros.

remoteVCBandwidthMax
integer <int64>

This field holds the Max Connection speed with connected metros

geoScopes
Array of strings (GeoScopeType)
Items Enum: "CANADA" "CONUS" "JAPAN"

List of supported geographic boundaries of a Fabric Metro.

Response samples

Content type
application/json
{}

Ports

Ports

Get All Ports

Get All Ports returns details of all assigned and available ports for the specified user credentials. The metro attribute in the response shows the origin of the proposed connection.

Authorizations:
BearerAuth
query Parameters
name
string

port name to be provided if specific port(s) to be retrieved

Responses

Response Schema: application/json
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Array of objects (Port)

GET All User Port Across Fabric Metros

Array
href
string <uri>

Equinix assigned response attribute for an absolute URL that is the subject of the link's context.

type
string (PortType)
Enum: "XF_PORT" "IX_PORT" "IA_PORT"

Type of Port

id
integer

Equinix assigned response attribute for Port Id

uuid
string <uuid>

Equinix assigned response attribute for port identifier

name
string

Equinix assigned response attribute for Port name

description
string

Equinix assigned response attribute for Port description

physicalPortsSpeed
integer >= 0

Physical Ports Speed in Mbps

connectionsCount
integer >= 0

Equinix assigned response attribute for Connection count

physicalPortsType
string
Enum: "1000BASE_LX" "10GBASE_LR" "100GBASE_LR4" "10GBASE_ER" "1000BASE_SX"

Physical Ports Type

physicalPortsCount
integer
connectivitySourceType
string
Enum: "COLO" "BMMR" "REMOTE"

Port connectivity type

bmmrType
string
Enum: "SELF" "EQUINIX"
object (Project)
state
string (PortState)
Enum: "PENDING" "PROVISIONING" "REPROVISIONING" "PROVISIONED" "ACTIVE" "DEPROVISIONING" "DEPROVISIONED" "INACTIVE" "FAILED" "ADDED" "DELETED" "TO_BE_ADDED" "TO_BE_DELETED"

Port lifecycle state

object (PortOrder)
object

Operational specifications for ports.

object (SimplifiedAccount)
object (PortChange)

Current state of latest port change

object (Changelog)

Change log

serviceType
string
Deprecated
Enum: "EPL" "MSP"

Port service Type

bandwidth
integer >= 0
Deprecated

Equinix assigned response attribute for Port bandwidth in Mbps

availableBandwidth
integer >= 0

Equinix assigned response attribute for Port available bandwidth in Mbps

usedBandwidth
integer >= 0

Equinix assigned response attribute for Port used bandwidth in Mbps

object (SimplifiedLocation)
object (PortDevice)

Port device

object (PortInterface)

Port interface

demarcationPointIbx
string

A-side/Equinix ibx

tetherIbx
string

z-side/Equinix ibx

object (PortDemarcationPoint)

Customer physical Port

object (PortRedundancy)

Port redundancy configuration

object (PortEncapsulation)

Port encapsulation configuration

lagEnabled
boolean

If LAG enabled

object

Port Lag

asn
integer

Port ASN

object (Package)

Package settings for port

object (PortSettings)

Port configuration settings

physicalPortQuantity
integer

Number of physical ports

Array of objects (PortNotification)

Notification preferences

Array of objects (PortAdditionalInfo)

Port additional information

object (EndCustomer)
Array of objects (PhysicalPort)

Physical ports that implement this port

Array of objects (PortLoa)

Port Loas

Response samples

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

Create Port

Creates Equinix Fabric? Port.

Authorizations:
BearerAuth
Request Body schema: application/json
required
type
required
string (PortType)
Enum: "XF_PORT" "IX_PORT" "IA_PORT"

Type of Port

id
integer

Equinix assigned response attribute for Port Id

uuid
string <uuid>

Equinix assigned response attribute for port identifier

name
string

Equinix assigned response attribute for Port name

description
string

Equinix assigned response attribute for Port description

physicalPortsSpeed
required
integer >= 0

Physical Ports Speed in Mbps

connectionsCount
integer >= 0

Equinix assigned response attribute for Connection count

physicalPortsType
required
string
Enum: "1000BASE_LX" "10GBASE_LR" "100GBASE_LR4" "10GBASE_ER" "1000BASE_SX"

Physical Ports Type

physicalPortsCount
integer
connectivitySourceType
required
string
Enum: "COLO" "BMMR" "REMOTE"

Port connectivity type

bmmrType
string
Enum: "SELF" "EQUINIX"
object (Project)
projectId
required
string

Subscriber-assigned project ID

state
string (PortState)
Enum: "PENDING" "PROVISIONING" "REPROVISIONING" "PROVISIONED" "ACTIVE" "DEPROVISIONING" "DEPROVISIONED" "INACTIVE" "FAILED" "ADDED" "DELETED" "TO_BE_ADDED" "TO_BE_DELETED"

Port lifecycle state

object (PortOrder)
object (PortOrder_purchaseOrder)

purchase order

number
string

purchase order number

amount
string

purchase order amount

startDate
string <datetime>
endDate
string <datetime>
attachmentId
string <uuid>
selectionType
string
Deprecated
Enum: "EXEMPTION" "EXISTING" "NEW" "BLANKET"
type
string
Enum: "EXEMPTION" "EXISTING" "NEW" "BLANKET"
orderId
string

Order Identification

customerReferenceId
string

Customer order reference Id

orderNumber
string

Order Reference Number

uuid
string <uuid>

Equinix-assigned order identifier, this is a derived response atrribute

object (PortOrder_signature)

Port signature Type

signatory
string
Enum: "DELEGATE" "SELF" "ACCOUNT_SUPPORT"

Port signature Type

object (PortOrder_signature_delegate)

delegate oder details

object

Operational specifications for ports.

operationalStatus
string
Enum: "UP" "DOWN" "PARTIAL"

Availability of a given physical port.

connectionCount
integer <int64>

Total number of connections.

evplVCCount
integer <int64>

Total number of connections.

fgVCCount
integer <int64>

Total number of connections.

accessVCCount
integer <int64>

Total number of connections.

opStatusChangedAt
string <date-time>

Date and time at which port availability changed.

required
object (SimplifiedAccount)
accountNumber
integer <int64>

Account number

accountName
string

Account name

orgId
integer <int64>

Customer organization identifier

organizationName
string

Customer organization name

globalOrgId
string

Global organization identifier

globalOrganizationName
string

Global organization name

ucmId
string

Account ucmId

globalCustId
string

Account name

resellerAccountNumber
integer <int64>

Reseller account number

resellerAccountName
string

Reseller account name

resellerUcmId
string

Reseller account ucmId

resellerOrgId
integer <int64>

Reseller customer organization identifier

object (PortChange)

Current state of latest port change

uuid
string

Uniquely identifies a change

type
string
Enum: "PORT_CREATION" "PORT_UPDATE" "PORT_DELETION"

Type of change

status
string
Enum: "COMPLETED" "FAILED" "REQUESTED"

Current outcome of the change flow

information
string

Additional information

object (PortChangeOperation)

Port change operation data

op
required
string

Handy shortcut for operation name

path
required
string

path inside document leading to updated parameter

value
required
object

new value for updated parameter

createdDateTime
string <date-time>

Set when change flow starts

updatedDateTime
string <date-time>

Set when change object is updated

object (Changelog)

Change log

createdBy
string

Created by User Key

createdByFullName
string

Created by User Full Name

createdByEmail
string

Created by User Email Address

createdDateTime
string <date-time>

Created by Date and Time

updatedBy
string

Updated by User Key

updatedByFullName
string

Updated by User Full Name

updatedByEmail
string

Updated by User Email Address

updatedDateTime
string <date-time>

Updated by Date and Time

deletedBy
string

Deleted by User Key

deletedByFullName
string

Deleted by User Full Name

deletedByEmail
string

Deleted by User Email Address

deletedDateTime
string <date-time>

Deleted by Date and Time

serviceType
string
Deprecated
Enum: "EPL" "MSP"

Port service Type

bandwidth
integer >= 0
Deprecated

Equinix assigned response attribute for Port bandwidth in Mbps

availableBandwidth
integer >= 0

Equinix assigned response attribute for Port available bandwidth in Mbps

usedBandwidth
integer >= 0

Equinix assigned response attribute for Port used bandwidth in Mbps

required
object (SimplifiedLocation)
metroHref
string
region
string
metroName
string
metroCode
string
ibx
string
Deprecated
object (PortDevice)

Port device

name
string

Device name

object (PortDeviceRedundancy)

Device redundancy

group
string

Device redundancy group

priority
string
Enum: "PRIMARY" "SECONDARY"

Device redundancy priority

object (PortInterface)

Port interface

type
string

Port interface type

demarcationPointIbx
string

A-side/Equinix ibx

tetherIbx
string

z-side/Equinix ibx

object (PortDemarcationPoint)

Customer physical Port

cabinetUniqueSpaceId
string

Port cabinet unique space id

cageUniqueSpaceId
string

Port cage unique space id

patchPanel
string

Port patch panel

patchPanelName
string
Deprecated

Port patch panel

patchPanelPortA
string

Port patch panel port A

patchPanelPortB
string

Port patch panel port B

connectorType
string

Port connector type

ibx
string

Port ibx identifier

object (PortRedundancy)

Port redundancy configuration

enabled
boolean

Access point redundancy

group
string
Deprecated

Port UUID of respective primary port

priority
string (PortPriority)
Enum: "PRIMARY" "SECONDARY"

Port priority in redundancy group

required
object (PortEncapsulation)

Port encapsulation configuration

type
string
Enum: "NULL" "DOT1Q" "QINQ" "UNTAGGED"

Port encapsulation protocol type

tagProtocolId
string

Port encapsulation tag protocol identifier

lagEnabled
boolean

If LAG enabled

object

Port Lag

id
string

id

enabled
boolean
Deprecated

enabled

name
string

name

memberStatus
string

member status

asn
integer

Port ASN

object (Package)

Package settings for port

code
string
Enum: "STANDARD" "UNLIMITED" "UNLIMITED_PLUS"

Type of Port Package

type
string
Enum: "EPL" "MSP"

Port service Type

required
object (PortSettings)

Port configuration settings

buyout
boolean
Deprecated
viewPortPermission
boolean
Deprecated
placeVcOrderPermission
boolean
Deprecated
layer3Enabled
boolean
Deprecated
sharedPortType
boolean
sharedPortProduct
string
Enum: "NETWORK_EDGE" "VIRTUAL_GATEWAY" "SMARTKEY" "EDGE_METAL"
packageType
string
Deprecated
Enum: "STANDARD" "UNLIMITED" "UNLIMITED_PLUS"

Type of Port Package

physicalPortQuantity
integer

Number of physical ports

Array of objects (PortNotification)

Notification preferences

Array
type
required
string
Enum: "NOTIFICATION" "TECHNICAL" "PEERING" "ESCALATION"

Notification Type

registeredUsers
required
Array of strings

Array of registered users

Array of objects (PortAdditionalInfo)

Port additional information

Array
key
string

Key

value
string

Value

object (EndCustomer)
isDisclosed
boolean
Default: false

Indicate if endCustomer info should be disclosed or not

name
string
mdmId
string
Array of objects (PhysicalPort)

Physical ports that implement this port

Array
type
string (PhysicalPortType)
Value: "XF_PHYSICAL_PORT"

Type of Port

id
integer
Deprecated

Equinix assigned response attribute for Physical Port Id

state
string (PortState)
Enum: "PENDING" "PROVISIONING" "REPROVISIONING" "PROVISIONED" "ACTIVE" "DEPROVISIONING" "DEPROVISIONED" "INACTIVE" "FAILED" "ADDED" "DELETED" "TO_BE_ADDED" "TO_BE_DELETED"

Port lifecycle state

object (SimplifiedAccount)
interfaceSpeed
integer >= 0

Physical Port Speed in Mbps

interfaceType
string

Physical Port Interface Type

uuid
string <uuid>

Equinix assigned response attribute for physical port identifier

object (PortTether)

Port physical connection

object (PortDemarcationPoint)

Customer physical Port

object (PhysicalPortSettings)

Physical Port configuration settings

object (PortInterface)

Port interface

Array of objects (PortNotification)

Notification preferences

Array of objects (PortAdditionalInfo)

Physical Port additional information

object (PortOrder)
object (PortOperation)

Operational specifications for ports.

Array of objects (PortLoa)

Port Loas

Array of objects (PortLoa)

Port Loas

Array
uuid
string

uuid

type
string
Value: "CTR_LOA"

Loa type

Responses

Response Schema: application/json
href
string <uri>

Equinix assigned response attribute for an absolute URL that is the subject of the link's context.

type
string (PortType)
Enum: "XF_PORT" "IX_PORT" "IA_PORT"

Type of Port

id
integer

Equinix assigned response attribute for Port Id

uuid
string <uuid>

Equinix assigned response attribute for port identifier

name
string

Equinix assigned response attribute for Port name

description
string

Equinix assigned response attribute for Port description

physicalPortsSpeed
integer >= 0

Physical Ports Speed in Mbps

connectionsCount
integer >= 0

Equinix assigned response attribute for Connection count

physicalPortsType
string
Enum: "1000BASE_LX" "10GBASE_LR" "100GBASE_LR4" "10GBASE_ER" "1000BASE_SX"

Physical Ports Type

physicalPortsCount
integer
connectivitySourceType
string
Enum: "COLO" "BMMR" "REMOTE"

Port connectivity type

bmmrType
string
Enum: "SELF" "EQUINIX"
object (Project)
projectId
required
string

Subscriber-assigned project ID

state
string (PortState)
Enum: "PENDING" "PROVISIONING" "REPROVISIONING" "PROVISIONED" "ACTIVE" "DEPROVISIONING" "DEPROVISIONED" "INACTIVE" "FAILED" "ADDED" "DELETED" "TO_BE_ADDED" "TO_BE_DELETED"

Port lifecycle state

object (PortOrder)
object (PortOrder_purchaseOrder)

purchase order

number
string

purchase order number

amount
string

purchase order amount

startDate
string <datetime>
endDate
string <datetime>
attachmentId
string <uuid>
selectionType
string
Deprecated
Enum: "EXEMPTION" "EXISTING" "NEW" "BLANKET"
type
string
Enum: "EXEMPTION" "EXISTING" "NEW" "BLANKET"
orderId
string

Order Identification

customerReferenceId
string

Customer order reference Id

orderNumber
string

Order Reference Number

uuid
string <uuid>

Equinix-assigned order identifier, this is a derived response atrribute

object (PortOrder_signature)

Port signature Type

signatory
string
Enum: "DELEGATE" "SELF" "ACCOUNT_SUPPORT"

Port signature Type

object (PortOrder_signature_delegate)

delegate oder details

object

Operational specifications for ports.

operationalStatus
string
Enum: "UP" "DOWN" "PARTIAL"

Availability of a given physical port.

connectionCount
integer <int64>

Total number of connections.

evplVCCount
integer <int64>

Total number of connections.

fgVCCount
integer <int64>

Total number of connections.

accessVCCount
integer <int64>

Total number of connections.

opStatusChangedAt
string <date-time>

Date and time at which port availability changed.

object (SimplifiedAccount)
accountNumber
integer <int64>

Account number

accountName
string

Account name

orgId
integer <int64>

Customer organization identifier

organizationName
string

Customer organization name

globalOrgId
string

Global organization identifier

globalOrganizationName
string

Global organization name

ucmId
string

Account ucmId

globalCustId
string

Account name

resellerAccountNumber
integer <int64>

Reseller account number

resellerAccountName
string

Reseller account name

resellerUcmId
string

Reseller account ucmId

resellerOrgId
integer <int64>

Reseller customer organization identifier

object (PortChange)

Current state of latest port change

uuid
string

Uniquely identifies a change

type
string
Enum: "PORT_CREATION" "PORT_UPDATE" "PORT_DELETION"

Type of change

status
string
Enum: "COMPLETED" "FAILED" "REQUESTED"

Current outcome of the change flow

information
string

Additional information

object (PortChangeOperation)

Port change operation data

op
required
string

Handy shortcut for operation name

path
required
string

path inside document leading to updated parameter

value
required
object

new value for updated parameter

createdDateTime
string <date-time>

Set when change flow starts

updatedDateTime
string <date-time>

Set when change object is updated

object (Changelog)

Change log

createdBy
string

Created by User Key

createdByFullName
string

Created by User Full Name

createdByEmail
string

Created by User Email Address

createdDateTime
string <date-time>

Created by Date and Time

updatedBy
string

Updated by User Key

updatedByFullName
string

Updated by User Full Name

updatedByEmail
string

Updated by User Email Address

updatedDateTime
string <date-time>

Updated by Date and Time

deletedBy
string

Deleted by User Key

deletedByFullName
string

Deleted by User Full Name

deletedByEmail
string

Deleted by User Email Address

deletedDateTime
string <date-time>

Deleted by Date and Time

serviceType
string
Deprecated
Enum: "EPL" "MSP"

Port service Type

bandwidth
integer >= 0
Deprecated

Equinix assigned response attribute for Port bandwidth in Mbps

availableBandwidth
integer >= 0

Equinix assigned response attribute for Port available bandwidth in Mbps

usedBandwidth
integer >= 0

Equinix assigned response attribute for Port used bandwidth in Mbps

object (SimplifiedLocation)
metroHref
string
region
string
metroName
string
metroCode
string
ibx
string
Deprecated
object (PortDevice)

Port device

name
string

Device name

object (PortDeviceRedundancy)

Device redundancy

group
string

Device redundancy group

priority
string
Enum: "PRIMARY" "SECONDARY"

Device redundancy priority

object (PortInterface)

Port interface

type
string

Port interface type

demarcationPointIbx
string

A-side/Equinix ibx

tetherIbx
string

z-side/Equinix ibx

object (PortDemarcationPoint)

Customer physical Port

cabinetUniqueSpaceId
string

Port cabinet unique space id

cageUniqueSpaceId
string

Port cage unique space id

patchPanel
string

Port patch panel

patchPanelName
string
Deprecated

Port patch panel

patchPanelPortA
string

Port patch panel port A

patchPanelPortB
string

Port patch panel port B

connectorType
string

Port connector type

ibx
string

Port ibx identifier

object (PortRedundancy)

Port redundancy configuration

enabled
boolean

Access point redundancy

group
string
Deprecated

Port UUID of respective primary port

priority
string (PortPriority)
Enum: "PRIMARY" "SECONDARY"

Port priority in redundancy group

object (PortEncapsulation)

Port encapsulation configuration

type
string
Enum: "NULL" "DOT1Q" "QINQ" "UNTAGGED"

Port encapsulation protocol type

tagProtocolId
string

Port encapsulation tag protocol identifier

lagEnabled
boolean

If LAG enabled

object

Port Lag

id
string

id

enabled
boolean
Deprecated

enabled

name
string

name

memberStatus
string

member status

asn
integer

Port ASN

object (Package)

Package settings for port

code
string
Enum: "STANDARD" "UNLIMITED" "UNLIMITED_PLUS"

Type of Port Package

type
string
Enum: "EPL" "MSP"

Port service Type

object (PortSettings)

Port configuration settings

buyout
boolean
Deprecated
viewPortPermission
boolean
Deprecated
placeVcOrderPermission
boolean
Deprecated
layer3Enabled
boolean
Deprecated
sharedPortType
boolean
sharedPortProduct
string
Enum: "NETWORK_EDGE" "VIRTUAL_GATEWAY" "SMARTKEY" "EDGE_METAL"
packageType
string
Deprecated
Enum: "STANDARD" "UNLIMITED" "UNLIMITED_PLUS"

Type of Port Package

physicalPortQuantity
integer

Number of physical ports

Array of objects (PortNotification)

Notification preferences

Array
type
required
string
Enum: "NOTIFICATION" "TECHNICAL" "PEERING" "ESCALATION"

Notification Type

registeredUsers
required
Array of strings

Array of registered users

Array of objects (PortAdditionalInfo)

Port additional information

Array
key
string

Key

value
string

Value

object (EndCustomer)
isDisclosed
boolean
Default: false

Indicate if endCustomer info should be disclosed or not

name
string
mdmId
string
Array of objects (PhysicalPort)

Physical ports that implement this port

Array
href
string <uri>

Equinix assigned response attribute for an absolute URL that is the subject of the link's context.

type
string (PhysicalPortType)
Value: "XF_PHYSICAL_PORT"

Type of Port

id
integer
Deprecated

Equinix assigned response attribute for Physical Port Id

state
string (PortState)
Enum: "PENDING" "PROVISIONING" "REPROVISIONING" "PROVISIONED" "ACTIVE" "DEPROVISIONING" "DEPROVISIONED" "INACTIVE" "FAILED" "ADDED" "DELETED" "TO_BE_ADDED" "TO_BE_DELETED"

Port lifecycle state

object (SimplifiedAccount)
interfaceSpeed
integer >= 0

Physical Port Speed in Mbps

interfaceType
string

Physical Port Interface Type

uuid
string <uuid>

Equinix assigned response attribute for physical port identifier

object (PortTether)

Port physical connection

object (PortDemarcationPoint)

Customer physical Port

object (PhysicalPortSettings)

Physical Port configuration settings

object (PortInterface)

Port interface

Array of objects (PortNotification)

Notification preferences

Array of objects (PortAdditionalInfo)

Physical Port additional information

object (PortOrder)
object (PortOperation)

Operational specifications for ports.

Array of objects (PortLoa)

Port Loas

Array of objects (PortLoa)

Port Loas

Array
uuid
string

uuid

href
string <uri>

Loa uri.

type
string
Value: "CTR_LOA"

Loa type

Request samples

Content type
application/json
Example
{
  • "type": "XF_PORT",
  • "physicalPortsSpeed": 1000,
  • "physicalPortsType": "1000BASE_LX",
  • "connectivitySourceType": "COLO",
  • "location": {
    },
  • "demarcationPointIbx": "GV1",
  • "package": {
    },
  • "lagEnabled": false,
  • "encapsulation": {
    },
  • "project": {
    },
  • "account": {
    },
  • "notifications": [
    ],
  • "order": {
    },
  • "physicalPorts": [
    ]
}

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/ports/0f6bdb36-e130-4924-b038-ee1785fad166",
  • "type": "XF_PORT",
  • "uuid": "0f6bdb36-e130-4924-b038-ee1785fad166",
  • "state": "PENDING",
  • "physicalPortsType": "10GBASE_L",
  • "physicalPortsSpeed": 10000,
  • "physicalPortsCount": 1,
  • "location": {
    },
  • "demarcationPointIbx": "AM1",
  • "redundancy": {
    },
  • "lagEnabled": false,
  • "encapsulation": {
    },
  • "package": {
    },
  • "settings": {
    },
  • "project": {
    },
  • "account": {
    },
  • "order": {
    },
  • "notifications": [
    ]
}

Create Port

Create Port creates Equinix Fabric? Port. Preview

Authorizations:
BearerAuth
Request Body schema: application/json
required
Array of objects (PortRequest)
Array
type
required
string (PortType)
Enum: "XF_PORT" "IX_PORT" "IA_PORT"

Type of Port

id
integer

Equinix assigned response attribute for Port Id

uuid
string <uuid>

Equinix assigned response attribute for port identifier

name
string

Equinix assigned response attribute for Port name

description
string

Equinix assigned response attribute for Port description

physicalPortsSpeed
required
integer >= 0

Physical Ports Speed in Mbps

connectionsCount
integer >= 0

Equinix assigned response attribute for Connection count

physicalPortsType
required
string
Enum: "1000BASE_LX" "10GBASE_LR" "100GBASE_LR4" "10GBASE_ER" "1000BASE_SX"

Physical Ports Type

physicalPortsCount
integer
connectivitySourceType
required
string
Enum: "COLO" "BMMR" "REMOTE"

Port connectivity type

bmmrType
string
Enum: "SELF" "EQUINIX"
object (Project)
state
string (PortState)
Enum: "PENDING" "PROVISIONING" "REPROVISIONING" "PROVISIONED" "ACTIVE" "DEPROVISIONING" "DEPROVISIONED" "INACTIVE" "FAILED" "ADDED" "DELETED" "TO_BE_ADDED" "TO_BE_DELETED"

Port lifecycle state

object (PortOrder)
object

Operational specifications for ports.

required
object (SimplifiedAccount)
object (PortChange)

Current state of latest port change

object (Changelog)

Change log

serviceType
string
Deprecated
Enum: "EPL" "MSP"

Port service Type

bandwidth
integer >= 0
Deprecated

Equinix assigned response attribute for Port bandwidth in Mbps

availableBandwidth
integer >= 0

Equinix assigned response attribute for Port available bandwidth in Mbps

usedBandwidth
integer >= 0

Equinix assigned response attribute for Port used bandwidth in Mbps

required
object (SimplifiedLocation)
object (PortDevice)

Port device

object (PortInterface)

Port interface

demarcationPointIbx
string

A-side/Equinix ibx

tetherIbx
string

z-side/Equinix ibx

object (PortDemarcationPoint)

Customer physical Port

object (PortRedundancy)

Port redundancy configuration

required
object (PortEncapsulation)

Port encapsulation configuration

lagEnabled
boolean

If LAG enabled

object

Port Lag

asn
integer

Port ASN

object (Package)

Package settings for port

required
object (PortSettings)

Port configuration settings

physicalPortQuantity
integer

Number of physical ports

Array of objects (PortNotification)

Notification preferences

Array of objects (PortAdditionalInfo)

Port additional information

object (EndCustomer)
Array of objects (PhysicalPort)

Physical ports that implement this port

Array of objects (PortLoa)

Port Loas

Responses

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

Ports that are part of BulkPort

Array
href
string <uri>

Equinix assigned response attribute for an absolute URL that is the subject of the link's context.

type
string (PortType)
Enum: "XF_PORT" "IX_PORT" "IA_PORT"

Type of Port

id
integer

Equinix assigned response attribute for Port Id

uuid
string <uuid>

Equinix assigned response attribute for port identifier

name
string

Equinix assigned response attribute for Port name

description
string

Equinix assigned response attribute for Port description

physicalPortsSpeed
integer >= 0

Physical Ports Speed in Mbps

connectionsCount
integer >= 0

Equinix assigned response attribute for Connection count

physicalPortsType
string
Enum: "1000BASE_LX" "10GBASE_LR" "100GBASE_LR4" "10GBASE_ER" "1000BASE_SX"

Physical Ports Type

physicalPortsCount
integer
connectivitySourceType
string
Enum: "COLO" "BMMR" "REMOTE"

Port connectivity type

bmmrType
string
Enum: "SELF" "EQUINIX"
object (Project)
state
string (PortState)
Enum: "PENDING" "PROVISIONING" "REPROVISIONING" "PROVISIONED" "ACTIVE" "DEPROVISIONING" "DEPROVISIONED" "INACTIVE" "FAILED" "ADDED" "DELETED" "TO_BE_ADDED" "TO_BE_DELETED"

Port lifecycle state

object (PortOrder)
object

Operational specifications for ports.

object (SimplifiedAccount)
object (PortChange)

Current state of latest port change

object (Changelog)

Change log

serviceType
string
Deprecated
Enum: "EPL" "MSP"

Port service Type

bandwidth
integer >= 0
Deprecated

Equinix assigned response attribute for Port bandwidth in Mbps

availableBandwidth
integer >= 0

Equinix assigned response attribute for Port available bandwidth in Mbps

usedBandwidth
integer >= 0

Equinix assigned response attribute for Port used bandwidth in Mbps

object (SimplifiedLocation)
object (PortDevice)

Port device

object (PortInterface)

Port interface

demarcationPointIbx
string

A-side/Equinix ibx

tetherIbx
string

z-side/Equinix ibx

object (PortDemarcationPoint)

Customer physical Port

object (PortRedundancy)

Port redundancy configuration

object (PortEncapsulation)

Port encapsulation configuration

lagEnabled
boolean

If LAG enabled

object

Port Lag

asn
integer

Port ASN

object (Package)

Package settings for port

object (PortSettings)

Port configuration settings

physicalPortQuantity
integer

Number of physical ports

Array of objects (PortNotification)

Notification preferences

Array of objects (PortAdditionalInfo)

Port additional information

object (EndCustomer)
Array of objects (PhysicalPort)

Physical ports that implement this port

Array of objects (PortLoa)

Port Loas

Request samples

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

Response samples

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

Add to Lag

Add Physical Ports to Virtual Port. Preview

Authorizations:
BearerAuth
path Parameters
portId
required
string <uuid> (PortUUID)

Port UUID

Request Body schema: application/json
required
Array of objects (PhysicalPort)

add physical ports to virtual port

Array
type
string (PhysicalPortType)
Value: "XF_PHYSICAL_PORT"

Type of Port

id
integer
Deprecated

Equinix assigned response attribute for Physical Port Id

state
string (PortState)
Enum: "PENDING" "PROVISIONING" "REPROVISIONING" "PROVISIONED" "ACTIVE" "DEPROVISIONING" "DEPROVISIONED" "INACTIVE" "FAILED" "ADDED" "DELETED" "TO_BE_ADDED" "TO_BE_DELETED"

Port lifecycle state

object (SimplifiedAccount)
interfaceSpeed
integer >= 0

Physical Port Speed in Mbps

interfaceType
string

Physical Port Interface Type

uuid
string <uuid>

Equinix assigned response attribute for physical port identifier

object (PortTether)

Port physical connection

object (PortDemarcationPoint)

Customer physical Port

object (PhysicalPortSettings)

Physical Port configuration settings

object (PortInterface)

Port interface

Array of objects (PortNotification)

Notification preferences

Array of objects (PortAdditionalInfo)

Physical Port additional information

object (PortOrder)
object (PortOperation)

Operational specifications for ports.

Array of objects (PortLoa)

Port Loas

Responses

Response Schema: application/json
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Array of objects (PhysicalPort)

GET All Physical Ports

Array
href
string <uri>

Equinix assigned response attribute for an absolute URL that is the subject of the link's context.

type
string (PhysicalPortType)
Value: "XF_PHYSICAL_PORT"

Type of Port

id
integer
Deprecated

Equinix assigned response attribute for Physical Port Id

state
string (PortState)
Enum: "PENDING" "PROVISIONING" "REPROVISIONING" "PROVISIONED" "ACTIVE" "DEPROVISIONING" "DEPROVISIONED" "INACTIVE" "FAILED" "ADDED" "DELETED" "TO_BE_ADDED" "TO_BE_DELETED"

Port lifecycle state

object (SimplifiedAccount)
interfaceSpeed
integer >= 0

Physical Port Speed in Mbps

interfaceType
string

Physical Port Interface Type

uuid
string <uuid>

Equinix assigned response attribute for physical port identifier

object (PortTether)

Port physical connection

object (PortDemarcationPoint)

Customer physical Port

object (PhysicalPortSettings)

Physical Port configuration settings

object (PortInterface)

Port interface

Array of objects (PortNotification)

Notification preferences

Array of objects (PortAdditionalInfo)

Physical Port additional information

object (PortOrder)
object (PortOperation)

Operational specifications for ports.

Array of objects (PortLoa)

Port Loas

Request samples

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

Response samples

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

Get Port by uuid

Get Port By uuid returns details of assigned and available Equinix Fabric port for the specified user credentials. The metro code attribute in the response shows the origin of the proposed connection.

Authorizations:
BearerAuth
path Parameters
portId
required
string <uuid> (PortUUID)

Port UUID

Responses

Response Schema: application/json
href
string <uri>

Equinix assigned response attribute for an absolute URL that is the subject of the link's context.

type
string (PortType)
Enum: "XF_PORT" "IX_PORT" "IA_PORT"

Type of Port

id
integer

Equinix assigned response attribute for Port Id

uuid
string <uuid>

Equinix assigned response attribute for port identifier

name
string

Equinix assigned response attribute for Port name

description
string

Equinix assigned response attribute for Port description

physicalPortsSpeed
integer >= 0

Physical Ports Speed in Mbps

connectionsCount
integer >= 0

Equinix assigned response attribute for Connection count

physicalPortsType
string
Enum: "1000BASE_LX" "10GBASE_LR" "100GBASE_LR4" "10GBASE_ER" "1000BASE_SX"

Physical Ports Type

physicalPortsCount
integer
connectivitySourceType
string
Enum: "COLO" "BMMR" "REMOTE"

Port connectivity type

bmmrType
string
Enum: "SELF" "EQUINIX"
object (Project)
projectId
required
string

Subscriber-assigned project ID

state
string (PortState)
Enum: "PENDING" "PROVISIONING" "REPROVISIONING" "PROVISIONED" "ACTIVE" "DEPROVISIONING" "DEPROVISIONED" "INACTIVE" "FAILED" "ADDED" "DELETED" "TO_BE_ADDED" "TO_BE_DELETED"

Port lifecycle state

object (PortOrder)
object (PortOrder_purchaseOrder)

purchase order

number
string

purchase order number

amount
string

purchase order amount

startDate
string <datetime>
endDate
string <datetime>
attachmentId
string <uuid>
selectionType
string
Deprecated
Enum: "EXEMPTION" "EXISTING" "NEW" "BLANKET"
type
string
Enum: "EXEMPTION" "EXISTING" "NEW" "BLANKET"
orderId
string

Order Identification

customerReferenceId
string

Customer order reference Id

orderNumber
string

Order Reference Number

uuid
string <uuid>

Equinix-assigned order identifier, this is a derived response atrribute

object (PortOrder_signature)

Port signature Type

signatory
string
Enum: "DELEGATE" "SELF" "ACCOUNT_SUPPORT"

Port signature Type

object (PortOrder_signature_delegate)

delegate oder details

object

Operational specifications for ports.

operationalStatus
string
Enum: "UP" "DOWN" "PARTIAL"

Availability of a given physical port.

connectionCount
integer <int64>

Total number of connections.

evplVCCount
integer <int64>

Total number of connections.

fgVCCount
integer <int64>

Total number of connections.

accessVCCount
integer <int64>

Total number of connections.

opStatusChangedAt
string <date-time>

Date and time at which port availability changed.

object (SimplifiedAccount)
accountNumber
integer <int64>

Account number

accountName
string

Account name

orgId
integer <int64>

Customer organization identifier

organizationName
string

Customer organization name

globalOrgId
string

Global organization identifier

globalOrganizationName
string

Global organization name

ucmId
string

Account ucmId

globalCustId
string

Account name

resellerAccountNumber
integer <int64>

Reseller account number

resellerAccountName
string

Reseller account name

resellerUcmId
string

Reseller account ucmId

resellerOrgId
integer <int64>

Reseller customer organization identifier

object (PortChange)

Current state of latest port change

uuid
string

Uniquely identifies a change

type
string
Enum: "PORT_CREATION" "PORT_UPDATE" "PORT_DELETION"

Type of change

status
string
Enum: "COMPLETED" "FAILED" "REQUESTED"

Current outcome of the change flow

information
string

Additional information

object (PortChangeOperation)

Port change operation data

op
required
string

Handy shortcut for operation name

path
required
string

path inside document leading to updated parameter

value
required
object

new value for updated parameter

createdDateTime
string <date-time>

Set when change flow starts

updatedDateTime
string <date-time>

Set when change object is updated

object (Changelog)

Change log

createdBy
string

Created by User Key

createdByFullName
string

Created by User Full Name

createdByEmail
string

Created by User Email Address

createdDateTime
string <date-time>

Created by Date and Time

updatedBy
string

Updated by User Key

updatedByFullName
string

Updated by User Full Name

updatedByEmail
string

Updated by User Email Address

updatedDateTime
string <date-time>

Updated by Date and Time

deletedBy
string

Deleted by User Key

deletedByFullName
string

Deleted by User Full Name

deletedByEmail
string

Deleted by User Email Address

deletedDateTime
string <date-time>

Deleted by Date and Time

serviceType
string
Deprecated
Enum: "EPL" "MSP"

Port service Type

bandwidth
integer >= 0
Deprecated

Equinix assigned response attribute for Port bandwidth in Mbps

availableBandwidth
integer >= 0

Equinix assigned response attribute for Port available bandwidth in Mbps

usedBandwidth
integer >= 0

Equinix assigned response attribute for Port used bandwidth in Mbps

object (SimplifiedLocation)
metroHref
string
region
string
metroName
string
metroCode
string
ibx
string
Deprecated
object (PortDevice)

Port device

name
string

Device name

object (PortDeviceRedundancy)

Device redundancy

group
string

Device redundancy group

priority
string
Enum: "PRIMARY" "SECONDARY"

Device redundancy priority

object (PortInterface)

Port interface

type
string

Port interface type

demarcationPointIbx
string

A-side/Equinix ibx

tetherIbx
string

z-side/Equinix ibx

object (PortDemarcationPoint)

Customer physical Port

cabinetUniqueSpaceId
string

Port cabinet unique space id

cageUniqueSpaceId
string

Port cage unique space id

patchPanel
string

Port patch panel

patchPanelName
string
Deprecated

Port patch panel

patchPanelPortA
string

Port patch panel port A

patchPanelPortB
string

Port patch panel port B

connectorType
string

Port connector type

ibx
string

Port ibx identifier

object (PortRedundancy)

Port redundancy configuration

enabled
boolean

Access point redundancy

group
string
Deprecated

Port UUID of respective primary port

priority
string (PortPriority)
Enum: "PRIMARY" "SECONDARY"

Port priority in redundancy group

object (PortEncapsulation)

Port encapsulation configuration

type
string
Enum: "NULL" "DOT1Q" "QINQ" "UNTAGGED"

Port encapsulation protocol type

tagProtocolId
string

Port encapsulation tag protocol identifier

lagEnabled
boolean

If LAG enabled

object

Port Lag

id
string

id

enabled
boolean
Deprecated

enabled

name
string

name

memberStatus
string

member status

asn
integer

Port ASN

object (Package)

Package settings for port

code
string
Enum: "STANDARD" "UNLIMITED" "UNLIMITED_PLUS"

Type of Port Package

type
string
Enum: "EPL" "MSP"

Port service Type

object (PortSettings)

Port configuration settings

buyout
boolean
Deprecated
viewPortPermission
boolean
Deprecated
placeVcOrderPermission
boolean
Deprecated
layer3Enabled
boolean
Deprecated
sharedPortType
boolean
sharedPortProduct
string
Enum: "NETWORK_EDGE" "VIRTUAL_GATEWAY" "SMARTKEY" "EDGE_METAL"
packageType
string
Deprecated
Enum: "STANDARD" "UNLIMITED" "UNLIMITED_PLUS"

Type of Port Package

physicalPortQuantity
integer

Number of physical ports

Array of objects (PortNotification)

Notification preferences

Array
type
required
string
Enum: "NOTIFICATION" "TECHNICAL" "PEERING" "ESCALATION"

Notification Type

registeredUsers
required
Array of strings

Array of registered users

Array of objects (PortAdditionalInfo)

Port additional information

Array
key
string

Key

value
string

Value

object (EndCustomer)
isDisclosed
boolean
Default: false

Indicate if endCustomer info should be disclosed or not

name
string
mdmId
string
Array of objects (PhysicalPort)

Physical ports that implement this port

Array
href
string <uri>

Equinix assigned response attribute for an absolute URL that is the subject of the link's context.

type
string (PhysicalPortType)
Value: "XF_PHYSICAL_PORT"

Type of Port

id
integer
Deprecated

Equinix assigned response attribute for Physical Port Id

state
string (PortState)
Enum: "PENDING" "PROVISIONING" "REPROVISIONING" "PROVISIONED" "ACTIVE" "DEPROVISIONING" "DEPROVISIONED" "INACTIVE" "FAILED" "ADDED" "DELETED" "TO_BE_ADDED" "TO_BE_DELETED"

Port lifecycle state

object (SimplifiedAccount)
interfaceSpeed
integer >= 0

Physical Port Speed in Mbps

interfaceType
string

Physical Port Interface Type

uuid
string <uuid>

Equinix assigned response attribute for physical port identifier

object (PortTether)

Port physical connection

object (PortDemarcationPoint)

Customer physical Port

object (PhysicalPortSettings)

Physical Port configuration settings

object (PortInterface)

Port interface

Array of objects (PortNotification)

Notification preferences

Array of objects (PortAdditionalInfo)

Physical Port additional information

object (PortOrder)
object (PortOperation)

Operational specifications for ports.

Array of objects (PortLoa)

Port Loas

Array of objects (PortLoa)

Port Loas

Array
uuid
string

uuid

href
string <uri>

Loa uri.

type
string
Value: "CTR_LOA"

Loa type

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/ports/e91484bb-4f65-4ab3-8f77-500dec2f855d",
  • "type": "XF_PORT",
  • "uuid": "e91484bb-4f65-4ab3-8f77-500dec2f855d",
  • "name": "test-AT1-Dot1q-L-Secondary-108608",
  • "state": "ACTIVE",
  • "bandwidth": 10000,
  • "usedBandwidth": 0,
  • "availableBandwidth": 20000,
  • "physicalPortsSpeed": 10000,
  • "physicalPortsType": "1000BASE_LX",
  • "connectivitySourceType": "COLO",
  • "redundancy": {
    },
  • "location": {},
  • "device": {
    },
  • "encapsulation": {
    },
  • "lagEnabled": true,
  • "package": {
    },
  • "settings": {
    },
  • "physicalPorts": [
    ],
  • "operation": {
    },
  • "account": {
    },
  • "changeLog": {
    },
  • "project": {
    }
}

Delete a single port

The API provides capability to delete a single port

Authorizations:
BearerAuth
path Parameters
portId
required
string <uuid> (PortUUID)

Port UUID

Responses

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/ports/e91484bb-4f65-4ab3-8f77-500dec2f855d",
  • "type": "XF_PORT",
  • "uuid": "e91484bb-4f65-4ab3-8f77-500dec2f855d",
  • "name": "test-AT1-Dot1q-L-Secondary-108608",
  • "state": "DEPROVISIONING",
  • "bandwidth": 10000,
  • "usedBandwidth": 0,
  • "availableBandwidth": 20000,
  • "redundancy": {
    },
  • "location": {},
  • "device": {
    },
  • "encapsulation": {
    },
  • "lagEnabled": true,
  • "settings": {
    },
  • "physicalPorts": [
    ],
  • "account": {
    },
  • "changeLog": {
    }
}

Update by UUID

Update Port by UUID

Authorizations:
BearerAuth
path Parameters
portId
required
string <uuid> (PortUUID)

Port UUID

Request Body schema: application/json-patch+json
required
Array (non-empty)
op
required
string

Handy shortcut for operation name

path
required
string

path inside document leading to updated parameter

value
required
object

new value for updated parameter

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

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

Get Vlans

The API provides capability to retrieve Vlans for a Port.

Authorizations:
BearerAuth
path Parameters
portUuid
required
string <uuid> (PortUUID)

Port UUID

Responses

Response Schema: application/json
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Array of objects (LinkProtocolResponse)
Array
href
string <uri>

LinkProtocol URI

uuid
string <uuid>

Equinix-assigned network identifier

state
string (LinkProtocolState)
Enum: "RESERVED" "RELEASED"

Network status

type
string (LinkProtocolRequestType)
Enum: "UNTAGGED" "DOT1Q" "QINQ" "VXLAN"

Type of Link Protocol

vlanTag
integer
vni
integer
vlanTagMin
integer
vlanTagMax
integer
vlanSTag
integer
vlanCTag
integer
vlanCTagMin
integer
vlanCTagMax
integer
object (SubInterface)

Sub Interface information

object (LinkProtocolConnection)

Connection details of Link Protocol

object (LinkProtocolServiceToken)

Service Token details of Link Protocol

object (Changelog)

Change log

Response samples

Content type
application/json
Example
{}

Search ports

The API provides capability to get list of user's virtual ports using search criteria, including optional filtering, pagination and sorting

Authorizations:
BearerAuth
Request Body schema: application/json
required
object (PortExpression)
and
Array of objects (PortExpressions)
or
Array of objects (PortExpressions)
property
string (PortSearchFieldName)
Enum: "/project/projectId" "/settings/productCode" "/state"

Possible field names to use on filters

operator
string
Value: "="
values
Array of strings
object (PaginationRequest)

Pagination request information

offset
integer >= 0
Default: 0

Index of the first element.

limit
integer >= 1
Default: 20

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

Array of objects (PortSortCriteria)
Array
direction
string (PortSortDirection)
Default: "DESC"
Enum: "DESC" "ASC"

Sorting direction

property
string (PortSortBy)
Default: "/device/name"
Value: "/device/name"

Possible field names to use on sorting

Responses

Response Schema: application/json
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Array of objects (Port)

GET All User Port Across Fabric Metros

Array
href
string <uri>

Equinix assigned response attribute for an absolute URL that is the subject of the link's context.

type
string (PortType)
Enum: "XF_PORT" "IX_PORT" "IA_PORT"

Type of Port

id
integer

Equinix assigned response attribute for Port Id

uuid
string <uuid>

Equinix assigned response attribute for port identifier

name
string

Equinix assigned response attribute for Port name

description
string

Equinix assigned response attribute for Port description

physicalPortsSpeed
integer >= 0

Physical Ports Speed in Mbps

connectionsCount
integer >= 0

Equinix assigned response attribute for Connection count

physicalPortsType
string
Enum: "1000BASE_LX" "10GBASE_LR" "100GBASE_LR4" "10GBASE_ER" "1000BASE_SX"

Physical Ports Type

physicalPortsCount
integer
connectivitySourceType
string
Enum: "COLO" "BMMR" "REMOTE"

Port connectivity type

bmmrType
string
Enum: "SELF" "EQUINIX"
object (Project)
state
string (PortState)
Enum: "PENDING" "PROVISIONING" "REPROVISIONING" "PROVISIONED" "ACTIVE" "DEPROVISIONING" "DEPROVISIONED" "INACTIVE" "FAILED" "ADDED" "DELETED" "TO_BE_ADDED" "TO_BE_DELETED"

Port lifecycle state

object (PortOrder)
object

Operational specifications for ports.

object (SimplifiedAccount)
object (PortChange)

Current state of latest port change

object (Changelog)

Change log

serviceType
string
Deprecated
Enum: "EPL" "MSP"

Port service Type

bandwidth
integer >= 0
Deprecated

Equinix assigned response attribute for Port bandwidth in Mbps

availableBandwidth
integer >= 0

Equinix assigned response attribute for Port available bandwidth in Mbps

usedBandwidth
integer >= 0

Equinix assigned response attribute for Port used bandwidth in Mbps

object (SimplifiedLocation)
object (PortDevice)

Port device

object (PortInterface)

Port interface

demarcationPointIbx
string

A-side/Equinix ibx

tetherIbx
string

z-side/Equinix ibx

object (PortDemarcationPoint)

Customer physical Port

object (PortRedundancy)

Port redundancy configuration

object (PortEncapsulation)

Port encapsulation configuration

lagEnabled
boolean

If LAG enabled

object

Port Lag

asn
integer

Port ASN

object (Package)

Package settings for port

object (PortSettings)

Port configuration settings

physicalPortQuantity
integer

Number of physical ports

Array of objects (PortNotification)

Notification preferences

Array of objects (PortAdditionalInfo)

Port additional information

object (EndCustomer)
Array of objects (PhysicalPort)

Physical ports that implement this port

Array of objects (PortLoa)

Port Loas

Request samples

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

Response samples

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

Precision Time

Precision Time Beta

Create Time Service

The API provides capability to create Precision Time service

Authorizations:
BearerAuth
Request Body schema: application/json
required
type
required
string
Enum: "NTP" "PTP"

Precision Time Service Type refers to the corresponding Protocol.

name
required
string

Precision Time Service name.

required
object (precisionTimePackageRequest)

Precision Time Service Level Request

code
required
string
Enum: "NTP_STANDARD" "NTP_ENTERPRISE" "PTP_STANDARD" "PTP_ENTERPRISE"

Precision Time Service Level

required
Array of objects (fabricConnectionUuid)
Array
type
string

Connection Type

uuid
required
string <uuid>

Connection UUID.

required
object (ipv4)

EPT service network information

primary
required
string <ipv4>

Primary Timing Server IP Address

secondary
required
string <ipv4>

Secondary Timing Server IP Address

networkMask
required
string <ipv4>

Network Mask

defaultGateway
string <ipv4>

Gateway Interface IP address

Array of objects (ntpAdvanceConfiguration)

NTP Advanced configuration - MD5 Authentication.

Array
type
string
Enum: "ASCII" "HEX"
keyNumber
integer [ 1 .. 65535 ]

The authentication Key ID.

key
string [ 10 .. 40 ] characters

The plaintext authentication key. For ASCII type, the key must contain printable ASCII characters, range 10-20 characters. For HEX type, range should be 10-40 characters.

object (ptpAdvanceConfiguration)

PTP Advanced Configuration.

timeScale
string
Enum: "ARB" "PTP"

Time Scale value, ARB denotes Arbitrary and PTP denotes Precision Time Protocol.

domain
integer [ 0 .. 127 ]

The PTP domain value.

priority1
integer [ 0 .. 248 ]

The priority1 value determines the best primary clock, Lower value indicates higher priority.

priority2
integer [ 0 .. 248 ]

The priority2 value differentiates and prioritizes the primary clock to avoid confusion when priority1-value is the same for different primary clocks in a network.

logAnnounceInterval
integer
Enum: -3 -2 -1 0 1

Logarithmic value that controls the rate of PTP Announce packets from the PTP time server. Default is 1 (1 packet every 2 seconds), Unit packets/second.

logSyncInterval
integer
Enum: -5 -4 -3 -2 -1 0 1

Logarithmic value that controls the rate of PTP Sync packets. Default is -4 (16 packets per second), Unit packets/second..

logDelayReqInterval
integer
Enum: -5 -4 -3 -2 -1 0 1

Logarithmic value that controls the rate of PTP DelayReq packets. Default is -4 (16 packets per second), Unit packets/second..

transportMode
string
Enum: "MULTICAST" "UNICAST" "HYBRID"
grantTime
integer [ 30 .. 7200 ]

Unicast Grant Time in seconds. For Multicast and Hybrid transport modes, grant time defaults to 300 seconds. For Unicast mode, grant time can be between 30 to 7200.

object (Project)
projectId
required
string

Subscriber-assigned project ID

object (precisionTimeOrder)

Precision Time Order

purchaseOrderNumber
string

Purchase order number

customerReferenceNumber
string

Customer reference number

orderNumber
string

Order Reference Number

Responses

Request samples

Content type
application/json
Example
{
  • "type": "NTP",
  • "name": "EPT-NTP-Service",
  • "connections": [
    ],
  • "package": {
    },
  • "ipv4": {
    }
}

Response samples

Content type
application/json
Example
{}

Get Service By ID.

The API provides capability to get Precision Time Service details

Authorizations:
BearerAuth
path Parameters
serviceId
required
string <uuid> (ServiceId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Service UUID

Responses

Response Schema: application/json
href
required
string <uri>

Precision Time Service URI.

type
required
string
Enum: "NTP" "PTP"

Precision Time Service type refers to the corresponding protocol.

name
string

Precision Time Service Name.

uuid
required
string <uuid>

Precision Time Service UUID.

state
required
string
Enum: "CANCELLED" "CANCELLING" "CONFIGURING" "CONFIGURING_FAILED" "DRAFT" "DEPROVISIONING" "DEPROVISIONING_FAILED" "DEPROVISIONED" "PROVISIONED" "PROVISIONING" "PROVISIONING_FAILED" "REPROVISIONING" "REPROVISIONING_FAILED"

Precision Time Service Status.

required
object (precisionTimePackagePostResponse)
href
string <uri>
code
required
string
Enum: "NTP_STANDARD" "NTP_ENTERPRISE" "PTP_STANDARD" "PTP_ENTERPRISE"
Array of objects (fabricConnectionResponse) [ 1 .. 2 ] items unique

Fabric Connections associated with Precision Time Service.

Array ([ 1 .. 2 ] items)
href
string <uri>

Connection URI

type
string

Connection Type.

uuid
string <uuid>

Connection UUID.

object (fabricConnectionAccessPoint)

Fabric Connection access point object.

object (fabricConnectionAccessPoint)

Fabric Connection access point object.

object (ipv4)

EPT service network information

primary
required
string <ipv4>

Primary Timing Server IP Address

secondary
required
string <ipv4>

Secondary Timing Server IP Address

networkMask
required
string <ipv4>

Network Mask

defaultGateway
string <ipv4>

Gateway Interface IP address

Array of objects (ntpAdvanceConfiguration)

NTP Advanced configuration - MD5 Authentication.

Array
type
string
Enum: "ASCII" "HEX"
keyNumber
integer [ 1 .. 65535 ]

The authentication Key ID.

key
string [ 10 .. 40 ] characters

The plaintext authentication key. For ASCII type, the key must contain printable ASCII characters, range 10-20 characters. For HEX type, range should be 10-40 characters.

object (ptpAdvanceConfiguration)

PTP Advanced Configuration.

timeScale
string
Enum: "ARB" "PTP"

Time Scale value, ARB denotes Arbitrary and PTP denotes Precision Time Protocol.

domain
integer [ 0 .. 127 ]

The PTP domain value.

priority1
integer [ 0 .. 248 ]

The priority1 value determines the best primary clock, Lower value indicates higher priority.

priority2
integer [ 0 .. 248 ]

The priority2 value differentiates and prioritizes the primary clock to avoid confusion when priority1-value is the same for different primary clocks in a network.

logAnnounceInterval
integer
Enum: -3 -2 -1 0 1

Logarithmic value that controls the rate of PTP Announce packets from the PTP time server. Default is 1 (1 packet every 2 seconds), Unit packets/second.

logSyncInterval
integer
Enum: -5 -4 -3 -2 -1 0 1

Logarithmic value that controls the rate of PTP Sync packets. Default is -4 (16 packets per second), Unit packets/second..

logDelayReqInterval
integer
Enum: -5 -4 -3 -2 -1 0 1

Logarithmic value that controls the rate of PTP DelayReq packets. Default is -4 (16 packets per second), Unit packets/second..

transportMode
string
Enum: "MULTICAST" "UNICAST" "HYBRID"
grantTime
integer [ 30 .. 7200 ]

Unicast Grant Time in seconds. For Multicast and Hybrid transport modes, grant time defaults to 300 seconds. For Unicast mode, grant time can be between 30 to 7200.

object (Project)
projectId
required
string

Subscriber-assigned project ID

object (SimplifiedAccount)
accountNumber
integer <int64>

Account number

accountName
string

Account name

orgId
integer <int64>

Customer organization identifier

organizationName
string

Customer organization name

globalOrgId
string

Global organization identifier

globalOrganizationName
string

Global organization name

ucmId
string

Account ucmId

globalCustId
string

Account name

resellerAccountNumber
integer <int64>

Reseller account number

resellerAccountName
string

Reseller account name

resellerUcmId
string

Reseller account ucmId

resellerOrgId
integer <int64>

Reseller customer organization identifier

object (precisionTimeOrder)

Precision Time Order

purchaseOrderNumber
string

Purchase order number

customerReferenceNumber
string

Customer reference number

orderNumber
string

Order Reference Number

object (precisionTimePrice)

Precision Time Price

currency
string

offering price currency

Array of objects (PriceCharge)
Array
type
string
Enum: "MONTHLY_RECURRING" "NON_RECURRING"

Price charge type

price
number <double> >= 0

Offering price

object (Changelog)

Change log

createdBy
string

Created by User Key

createdByFullName
string

Created by User Full Name

createdByEmail
string

Created by User Email Address

createdDateTime
string <date-time>

Created by Date and Time

updatedBy
string

Updated by User Key

updatedByFullName
string

Updated by User Full Name

updatedByEmail
string

Updated by User Email Address

updatedDateTime
string <date-time>

Updated by Date and Time

deletedBy
string

Deleted by User Key

deletedByFullName
string

Deleted by User Full Name

deletedByEmail
string

Deleted by User Email Address

deletedDateTime
string <date-time>

Deleted by Date and Time

Response samples

Content type
application/json
Example
{}

Configure Service.

The API provides capability to Configure/Fulfill the Precision Time Service.

Authorizations:
BearerAuth
path Parameters
serviceId
required
string <uuid> (ServiceId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Service UUID

Request Body schema: application/json
required
type
required
string
Enum: "NTP" "PTP"

Precision Time Service Type refers to the corresponding Protocol.

name
required
string

Precision Time Service name.

required
object (precisionTimePackageRequest)

Precision Time Service Level Request

code
required
string
Enum: "NTP_STANDARD" "NTP_ENTERPRISE" "PTP_STANDARD" "PTP_ENTERPRISE"

Precision Time Service Level

required
Array of objects (fabricConnectionUuid)
Array
type
string

Connection Type

uuid
required
string <uuid>

Connection UUID.

required
object (ipv4)

EPT service network information

primary
required
string <ipv4>

Primary Timing Server IP Address

secondary
required
string <ipv4>

Secondary Timing Server IP Address

networkMask
required
string <ipv4>

Network Mask

defaultGateway
string <ipv4>

Gateway Interface IP address

Array of objects (ntpAdvanceConfiguration)

NTP Advanced configuration - MD5 Authentication.

Array
type
string
Enum: "ASCII" "HEX"
keyNumber
integer [ 1 .. 65535 ]

The authentication Key ID.

key
string [ 10 .. 40 ] characters

The plaintext authentication key. For ASCII type, the key must contain printable ASCII characters, range 10-20 characters. For HEX type, range should be 10-40 characters.

object (ptpAdvanceConfiguration)

PTP Advanced Configuration.

timeScale
string
Enum: "ARB" "PTP"

Time Scale value, ARB denotes Arbitrary and PTP denotes Precision Time Protocol.

domain
integer [ 0 .. 127 ]

The PTP domain value.

priority1
integer [ 0 .. 248 ]

The priority1 value determines the best primary clock, Lower value indicates higher priority.

priority2
integer [ 0 .. 248 ]

The priority2 value differentiates and prioritizes the primary clock to avoid confusion when priority1-value is the same for different primary clocks in a network.

logAnnounceInterval
integer
Enum: -3 -2 -1 0 1

Logarithmic value that controls the rate of PTP Announce packets from the PTP time server. Default is 1 (1 packet every 2 seconds), Unit packets/second.

logSyncInterval
integer
Enum: -5 -4 -3 -2 -1 0 1

Logarithmic value that controls the rate of PTP Sync packets. Default is -4 (16 packets per second), Unit packets/second..

logDelayReqInterval
integer
Enum: -5 -4 -3 -2 -1 0 1

Logarithmic value that controls the rate of PTP DelayReq packets. Default is -4 (16 packets per second), Unit packets/second..

transportMode
string
Enum: "MULTICAST" "UNICAST" "HYBRID"
grantTime
integer [ 30 .. 7200 ]

Unicast Grant Time in seconds. For Multicast and Hybrid transport modes, grant time defaults to 300 seconds. For Unicast mode, grant time can be between 30 to 7200.

object (Project)
projectId
required
string

Subscriber-assigned project ID

object (precisionTimeOrder)

Precision Time Order

purchaseOrderNumber
string

Purchase order number

customerReferenceNumber
string

Customer reference number

orderNumber
string

Order Reference Number

Responses

Request samples

Content type
application/json
Example
{
  • "type": "NTP",
  • "name": "EPT-Standard-Service",
  • "connections": [
    ],
  • "package": {
    },
  • "ipv4": {
    }
}

Response samples

Content type
application/json
{}

Delete by ID.

The API provides capability to delete Precision Time Service by service id.

Authorizations:
BearerAuth
path Parameters
serviceId
required
string <uuid> (ServiceId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Service UUID

Responses

Response samples

Content type
application/json
{}

Update By ID.

The API provides capability to update Precision Time Service by service id.

Authorizations:
BearerAuth
path Parameters
serviceId
required
string <uuid> (ServiceId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Service UUID

Request Body schema: application/json-patch+json
required
Array (= 1 items)
op
required
string
Enum: "replace" "add" "remove"

Handy shortcut for operation name

path
required
string
Enum: "/name" "/package/code" "/ipv4" "/ntpAdvancedConfiguration" "/ptpAdvancedConfiguration"

path inside document leading to updated parameter

value
required
object

new value for updated parameter

Responses

Request samples

Content type
application/json-patch+json
Example
[
  • {
    }
]

Response samples

Content type
application/json
{}

Search Time Services

The API provides capability to get list of user's Time Services using search criteria, including optional filtering, pagination and sorting

Authorizations:
BearerAuth
Request Body schema: application/json
required
object (TimeServiceFilters)
Array of TimeServiceSimpleExpression (object) or TimeServiceOrFilter (object) (TimeServiceFilter) <= 8 items
Array (<= 8 items)
Any of
property
string

Possible field names to use on filters:

  • /project/projectId - project id (mandatory)
  • /name - Precision Time Service name
  • /uuid - Precision Time Service uuid
  • /type - Precision Time Service protocol
  • /state - Precision Time Service status
  • /account/accountNumber - Precision Time Service account number
  • /package/code - Precision Time Service package
  • /* - all-category search
operator
string

Possible operators to use on filters:

  • = - equal
  • != - not equal
  • [NOT] BETWEEN - (not) between
  • [NOT] LIKE - (not) like
  • [NOT] IN - (not) in
  • ILIKE - case-insensitive like
values
Array of strings
object (PaginationRequest)

Pagination request information

offset
integer >= 0
Default: 0

Index of the first element.

limit
integer >= 1
Default: 20

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

Array of objects (TimeServiceSortCriteria)
Array
direction
string (TimeServiceSortDirection)
Default: "DESC"
Enum: "DESC" "ASC"

Sorting direction

property
string (TimeServiceSortBy)
Default: "/changeLog/updatedDateTime"
Enum: "/name" "/uuid" "/state" "/type" "/package/code" "/changeLog/createdDateTime" "/changeLog/updatedDateTime"

Possible field names to use on sorting

Responses

Response Schema: application/json
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Array of objects (precisionTimeServiceResponse)

Data returned from the API call.

Array
href
required
string <uri>

Precision Time Service URI.

type
required
string
Enum: "NTP" "PTP"

Precision Time Service type refers to the corresponding protocol.

name
string

Precision Time Service Name.

uuid
required
string <uuid>

Precision Time Service UUID.

state
required
string
Enum: "CANCELLED" "CANCELLING" "CONFIGURING" "CONFIGURING_FAILED" "DRAFT" "DEPROVISIONING" "DEPROVISIONING_FAILED" "DEPROVISIONED" "PROVISIONED" "PROVISIONING" "PROVISIONING_FAILED" "REPROVISIONING" "REPROVISIONING_FAILED"

Precision Time Service Status.

required
object (precisionTimePackagePostResponse)
Array of objects (fabricConnectionResponse) [ 1 .. 2 ] items unique

Fabric Connections associated with Precision Time Service.

object (ipv4)

EPT service network information

Array of objects (ntpAdvanceConfiguration)

NTP Advanced configuration - MD5 Authentication.

object (ptpAdvanceConfiguration)

PTP Advanced Configuration.

object (Project)
object (SimplifiedAccount)
object (precisionTimeOrder)

Precision Time Order

object (precisionTimePrice)

Precision Time Price

object (Changelog)

Change log

Request samples

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

Response samples

Content type
application/json
{}

Get Connection Links

The API provides capability to get prevision timing service's details

Authorizations:
BearerAuth
path Parameters
serviceId
required
string <uuid> (ServiceId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Service UUID

Responses

Response Schema: application/json
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Array of objects (connectionLink)

Data returned from the API call

Array
href
string <uri>
type
string
Value: "EVPL_VC"
uuid
string <uuid>

Response samples

Content type
application/json
{}

Get Packages

The API provides capability to get timing service's packages

Authorizations:
BearerAuth

Responses

Response Schema: application/json
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Array of objects (precisionTimePackageRespose)

Data returned from the API call

Array
href
string <uri>
type
required
string
Value: "TIME_SERVICE_PACKAGE"
code
required
string
Enum: "NTP_STANDARD" "NTP_ENTERPRISE" "PTP_STANDARD" "PTP_ENTERPRISE"
bandwidth
required
integer

Connection bandwidth in Mbps.

clientsPerSecondMax
integer >= 0

Max. number of clients that can be synchronized per second at a packet rate of 1 per second.

redundancySupported
boolean

Is Redundant virtual connection supported for the package code.

multiSubnetSupported
boolean

Is Multiple subnet supported for the package code.

accuracySlaUnit
string

Accuracy SLA unit.

accuracySla
integer

Accuracy SLA for the package code, -1 value denotes the accuracySla is not published.

accuracySlaMin
integer >= 1

Typical minimum Accuracy for the package code.

accuracySlaMax
integer >= 1

Typical maximum Accuracy for the package code.

object (Changelog)

Change log

Response samples

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

Get Package By Code

The API provides capability to get timing service's package by code

Authorizations:
BearerAuth
path Parameters
packageCode
required
string
Enum: "NTP_STANDARD" "NTP_ENTERPRISE" "PTP_STANDARD" "PTP_ENTERPRISE"

Package Code

Responses

Response Schema: application/json
href
string <uri>
type
required
string
Value: "TIME_SERVICE_PACKAGE"
code
required
string
Enum: "NTP_STANDARD" "NTP_ENTERPRISE" "PTP_STANDARD" "PTP_ENTERPRISE"
bandwidth
required
integer

Connection bandwidth in Mbps.

clientsPerSecondMax
integer >= 0

Max. number of clients that can be synchronized per second at a packet rate of 1 per second.

redundancySupported
boolean

Is Redundant virtual connection supported for the package code.

multiSubnetSupported
boolean

Is Multiple subnet supported for the package code.

accuracySlaUnit
string

Accuracy SLA unit.

accuracySla
integer

Accuracy SLA for the package code, -1 value denotes the accuracySla is not published.

accuracySlaMin
integer >= 1

Typical minimum Accuracy for the package code.

accuracySlaMax
integer >= 1

Typical maximum Accuracy for the package code.

object (Changelog)

Change log

createdBy
string

Created by User Key

createdByFullName
string

Created by User Full Name

createdByEmail
string

Created by User Email Address

createdDateTime
string <date-time>

Created by Date and Time

updatedBy
string

Updated by User Key

updatedByFullName
string

Updated by User Full Name

updatedByEmail
string

Updated by User Email Address

updatedDateTime
string <date-time>

Updated by Date and Time

deletedBy
string

Deleted by User Key

deletedByFullName
string

Deleted by User Full Name

deletedByEmail
string

Deleted by User Email Address

deletedDateTime
string <date-time>

Deleted by Date and Time

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/timeServicePackages/NTP_STANDARD",
  • "type": "TIME_SERVICE_PACKAGE",
  • "code": "NTP_STANDARD",
  • "bandwidth": 10,
  • "clientsPerSecondMax": 100,
  • "accuracySlaUnit": "microseconds",
  • "accuracySla": 50,
  • "accuracySlaMin": 1,
  • "accuracySlaMax": 10,
  • "redundancySupported": true,
  • "multiSubnetSupported": true,
  • "changeLog": {
    }
}

Prices

Prices

Get Prices

Search prices by search criteria

Authorizations:
BearerAuth
Request Body schema: application/json
required
object (SearchExpression)
and
Array of objects (SearchExpressions)
or
Array of objects (SearchExpressions)
property
string
operator
string
Enum: "=" "!=" ">" ">=" "<" "<=" "BETWEEN" "NOT BETWEEN" "LIKE" "NOT LIKE" "IN" "NOT IN" "IS NOT NULL" "IS NULL"
values
Array of strings

Responses

Response Schema: application/json
Array of objects (Price)
Array
href
string <url>

An absolute URL that returns specified pricing data

type
string (ProductType)
Enum: "VIRTUAL_CONNECTION_PRODUCT" "IP_BLOCK_PRODUCT" "VIRTUAL_PORT_PRODUCT" "CLOUD_ROUTER_PRODUCT" "PRECISION_TIME_PRODUCT"

Product type

code
string

Equinix-assigned product code

name
string

Full product name

description
string

Product description

object (SimplifiedAccount)
Array of objects (PriceCharge)
currency
string

Product offering price currency

termLength
integer
Enum: 1 12 24 36

In months. No value or value of 1 means on-demand

catgory
string (PriceCategory)
Enum: "COUNTRY" "CUSTOMER"

Price category

object (VirtualConnectionPrice)

Virtual Connection Product configuration

object (IpBlockPrice)

IP Block Product configuration

object (FabricCloudRouterPrice)

Cloud Router Product configuration

object (VirtualPortPrice)

Preferences and settings for a virtual port connected to an internet service provider (ISP) or other Equinix platform entity.

object (TimeServicePrice)

Time Service Product configuration

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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Request samples

Content type
application/json
Example
{
  • "filter": {
    }
}

Response samples

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

Route Aggregation Rules

Route Aggregation Rules

GetRARules

This API provides capability to get all Route Aggregations Rules for Fabric

Authorizations:
BearerAuth
path Parameters
routeAggregationId
required
string (RouteAggregationId)
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Aggregations Id

query Parameters
offset
integer
Example: offset=1

offset

limit
integer
Example: limit=10

number of records to fetch

Responses

Response Schema: application/json
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Array of objects (RouteAggregationRulesData)

List of Route Aggregation Rules

Array
href
string <uri>

Route Aggregation Rules URI

type
string
Value: "BGP_IPv4_PREFIX_AGGREGATION_RULE"

Route Aggregation type

uuid
string <uuid>

Route Aggregation Rule identifier

name
string
description
string

Customer-provided Route Aggregation Rule description

state
string (RouteAggregationRuleState)
Enum: "PROVISIONING" "REPROVISIONING" "DEPROVISIONING" "PROVISIONED" "DEPROVISIONED" "NOT_PROVISIONED" "NOT_DEPROVISIONED"

Route Aggregation Rule status

object (RouteAggregationRulesChange)

Current state of latest Route Aggregation Rule change

prefix
string
object (Changelog)

Change log

Response samples

Content type
application/json
{}

Create RARule

This API provides capability to create a Route Aggregation Rule

Authorizations:
BearerAuth
path Parameters
routeAggregationId
required
string (RouteAggregationId)
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Aggregations Id

Request Body schema: application/json
required
name
string
description
string

Customer-provided Route Aggregation Rule description

prefix
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "Private-subnet-aggregation",
  • "description": "Test rule",
  • "prefix": "192.168.0.0/24"
}

Response samples

Content type
application/json
{}

GetRARule By UUID

This API provides capability to view a Route Aggregation Rule by UUID

Authorizations:
BearerAuth
path Parameters
routeAggregationId
required
string (RouteAggregationId)
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Aggregations Id

routeAggregationRuleId
required
string (RouteAggregationRuleId)
Example: 65b025ef-022b-4180-85cf-82cfc1ab655b

Route Aggregation Rules Id

Responses

Response samples

Content type
application/json
{}

ReplaceRARule

This API provides capability to replace a Route Aggregation Rule completely

Authorizations:
BearerAuth
path Parameters
routeAggregationId
required
string (RouteAggregationId)
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Aggregations Id

routeAggregationRuleId
required
string (RouteAggregationRuleId)
Example: 65b025ef-022b-4180-85cf-82cfc1ab655b

Route Aggregation Rules Id

Request Body schema: application/json
required
name
string
description
string

Customer-provided Route Aggregation Rule description

prefix
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "Private-subnet-aggregation-update",
  • "description": "Test rule",
  • "prefix": "192.168.0.0/24"
}

Response samples

Content type
application/json
{}

DeleteRARule

This API provides capability to delete a Route aggregation Rule

Authorizations:
BearerAuth
path Parameters
routeAggregationId
required
string (RouteAggregationId)
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Aggregations Id

routeAggregationRuleId
required
string (RouteAggregationRuleId)
Example: 65b025ef-022b-4180-85cf-82cfc1ab655b

Route Aggregation Rules Id

Responses

Response samples

Content type
application/json
{}

PatchRARule

This API provides capability to partially update a Route Aggregation Rule

Authorizations:
BearerAuth
path Parameters
routeAggregationId
required
string (RouteAggregationId)
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Aggregations Id

routeAggregationRuleId
required
string (RouteAggregationRuleId)
Example: 65b025ef-022b-4180-85cf-82cfc1ab655b

Route Aggregation Rules Id

Request Body schema: application/json
required
Array (non-empty)
op
required
string

Handy shortcut for operation name

path
required
string

path to change

value
required
object

new value for updated parameter

Responses

Request samples

Content type
application/json
Example
[
  • {
    }
]

Response samples

Content type
application/json
{}

Get All Changes

This API provides capability to retrieve all of a Route Aggregation Rule's Changes

Authorizations:
BearerAuth
path Parameters
routeAggregationId
required
string (RouteAggregationId)
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Aggregations Id

routeAggregationRuleId
required
string (RouteAggregationRuleId)
Example: 65b025ef-022b-4180-85cf-82cfc1ab655b

Route Aggregation Rules Id

query Parameters
offset
integer
Example: offset=1

offset

limit
integer
Example: limit=10

number of records to fetch

Responses

Response Schema: application/json
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Array of objects (RouteAggregationRulesChangeData)
Array
status
string
Enum: "COMPLETED" "FAILED" "REQUESTED"

Current outcome of the change flow

createdBy
string

Created by User Key

createdDateTime
string <date-time>

Set when change flow starts

updatedBy
string

Updated by User Key

updatedDateTime
string <date-time>

Set when change object is updated

object (RouteAggregationRulesChangeOperation)

Route Aggregation Rule change operation data

uuid
required
string

Uniquely identifies a change

type
required
string
Enum: "BGP_IPv4_PREFIX_AGGREGATION_RULE_UPDATE" "BGP_IPv4_PREFIX_AGGREGATION_RULE_CREATION" "BGP_IPv4_PREFIX_AGGREGATION_RULE_DELETION"

Type of change

href
string <uri>

Route Aggregation Change URI

Response samples

Content type
application/json
{}

Get Change By ID

This API provides capability to retrieve a specific Route Aggregation Rule's Changes

Authorizations:
BearerAuth
path Parameters
routeAggregationId
required
string (RouteAggregationId)
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Aggregations Id

routeAggregationRuleId
required
string (RouteAggregationRuleId)
Example: 65b025ef-022b-4180-85cf-82cfc1ab655b

Route Aggregation Rules Id

changeId
required
string <uuid> (ChangeId_4)
Example: 6d500177-9404-41f2-99e8-2bf1a84d8db5

Route Aggregation Rule Change UUID

Responses

Response Schema: application/json
status
string
Enum: "COMPLETED" "FAILED" "REQUESTED"

Current outcome of the change flow

createdBy
string

Created by User Key

createdDateTime
string <date-time>

Set when change flow starts

updatedBy
string

Updated by User Key

updatedDateTime
string <date-time>

Set when change object is updated

object (RouteAggregationRulesChangeOperation)

Route Aggregation Rule change operation data

op
required
string
Enum: "add" "replace" "remove"

Handy shortcut for operation name

path
required
string

path inside document leading to updated parameter

required
object (RouteAggregationRulesBase)
name
string
description
string

Customer-provided Route Aggregation Rule description

prefix
required
string
uuid
required
string

Uniquely identifies a change

type
required
string
Enum: "BGP_IPv4_PREFIX_AGGREGATION_RULE_UPDATE" "BGP_IPv4_PREFIX_AGGREGATION_RULE_CREATION" "BGP_IPv4_PREFIX_AGGREGATION_RULE_DELETION"

Type of change

href
string <uri>

Route Aggregation Change URI

Response samples

Content type
application/json
{}

Bulk RARules

This API provides capability to create bulk route aggregation rules

Authorizations:
BearerAuth
path Parameters
routeAggregationId
required
string (RouteAggregationId)
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Aggregations Id

Request Body schema: application/json
required
Array of objects (RouteAggregationRulesBase)

Route Aggregation Rule configuration

Array
name
string
description
string

Customer-provided Route Aggregation Rule description

prefix
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{}

Route Aggregations

Route Aggregations

Get All Aggregations

This API provides capability to view all Route Aggregations attached to a Connection

Authorizations:
BearerAuth
path Parameters
connectionId
required
string (ConnectionId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Connection Id

Responses

Response Schema: application/json
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Array of objects (ConnectionRouteAggregationData)

List of Route Aggregations attached to a Connection

Array
href
string <uri>

Route Aggregation URI

type
string
Value: "BGP_IPv4_PREFIX_AGGREGATION"

Route Aggregation type

uuid
string <uuid>

Route Aggregation identifier

attachmentStatus
string
Enum: "ATTACHING" "ATTACHED" "DETACHED" "DETACHING" "FAILED" "PENDING_BGP_CONFIGURATION"

Response samples

Content type
application/json
{}

Get Aggregation

This API provides capability to view a specific Route Aggregation attached to a Connection

Authorizations:
BearerAuth
path Parameters
routeAggregationId
required
string (RouteAggregationId)
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Aggregations Id

connectionId
required
string (ConnectionId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Connection Id

Responses

Response Schema: application/json
href
string <uri>

Route Aggregation URI

type
string
Value: "BGP_IPv4_PREFIX_AGGREGATION"

Route Aggregation type

uuid
string <uuid>

Route Aggregation identifier

attachmentStatus
string
Enum: "ATTACHING" "ATTACHED" "DETACHED" "DETACHING" "FAILED" "PENDING_BGP_CONFIGURATION"

Response samples

Content type
application/json
{}

Attach Aggregation

This API provides capability to attach a Route Aggregation to a Connection

Authorizations:
BearerAuth
path Parameters
routeAggregationId
required
string (RouteAggregationId)
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Aggregations Id

connectionId
required
string (ConnectionId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Connection Id

Responses

Response samples

Content type
application/json
{}

Detach Aggregation

This API provides capability to detach a Route Aggregation from a Connection

Authorizations:
BearerAuth
path Parameters
routeAggregationId
required
string (RouteAggregationId)
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Aggregations Id

connectionId
required
string (ConnectionId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Connection Id

Responses

Response samples

Content type
application/json
{}

Create Aggregations

This API provides capability to create a Route Aggregation

Authorizations:
BearerAuth
Request Body schema: application/json
required
type
required
string
Enum: "BGP_IPv4_PREFIX_AGGREGATION" "BGP_IPv6_PREFIX_AGGREGATION"

Route Aggregation type

name
required
string
description
string

Customer-provided connection description

required
object (Project)
projectId
required
string

Subscriber-assigned project ID

Responses

Request samples

Content type
application/json
{
  • "type": "BGP_IPv4_PREFIX_AGGREGATION",
  • "name": "My-route-aggregation-v4",
  • "description": "Test aggregation",
  • "project": {
    }
}

Response samples

Content type
application/json
{}

Get Aggregation

This API provides capability to view a Route Aggregation by UUID

Authorizations:
BearerAuth
path Parameters
routeAggregationId
required
string (RouteAggregationId)
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Aggregations Id

Responses

Response Schema: application/json
href
string <uri>

Route Aggregation URI

type
string
Enum: "BGP_IPv4_PREFIX_AGGREGATION" "BGP_IPv6_PREFIX_AGGREGATION"

Route Aggregation type

uuid
string <uuid>

Route Aggregation identifier

name
string
description
string

Customer-provided connection description

state
string (RouteAggregationState)
Enum: "PROVISIONING" "REPROVISIONING" "DEPROVISIONING" "PROVISIONED" "DEPROVISIONED" "NOT_PROVISIONED" "NOT_DEPROVISIONED"

Route Aggregation status

object (RouteAggregationsChange)

Current state of latest Route Aggregation change

uuid
required
string

Uniquely identifies a change

type
required
string
Enum: "BGP_IPv4_PREFIX_AGGREGATION_UPDATE" "BGP_IPv4_PREFIX_AGGREGATION_CREATION" "BGP_IPv4_PREFIX_AGGREGATION_DELETION" "BGP_IPv6_PREFIX_AGGREGATION_UPDATE" "BGP_IPv6_PREFIX_AGGREGATION_CREATION" "BGP_IPv6_PREFIX_AGGREGATION_DELETION"

Type of change

href
string <uri>

Route AGGREGATION Change URI

connectionsCount
integer
rulesCount
integer
object (RouteAggregationsData_project)
projectId
required
string

Subscriber-assigned project ID

href
string <uri>

Project URI

object (Changelog)

Change log

createdBy
string

Created by User Key

createdByFullName
string

Created by User Full Name

createdByEmail
string

Created by User Email Address

createdDateTime
string <date-time>

Created by Date and Time

updatedBy
string

Updated by User Key

updatedByFullName
string

Updated by User Full Name

updatedByEmail
string

Updated by User Email Address

updatedDateTime
string <date-time>

Updated by Date and Time

deletedBy
string

Deleted by User Key

deletedByFullName
string

Deleted by User Full Name

deletedByEmail
string

Deleted by User Email Address

deletedDateTime
string <date-time>

Deleted by Date and Time

Response samples

Content type
application/json
{}

Delete Aggregation

This API provides capability to delete a Route Aggregation

Authorizations:
BearerAuth
path Parameters
routeAggregationId
required
string (RouteAggregationId)
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Aggregations Id

Responses

Response samples

Content type
application/json
{}

Patch Aggregation

This API provides capability to partially update a Route Aggregation

Authorizations:
BearerAuth
path Parameters
routeAggregationId
required
string (RouteAggregationId)
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Aggregations Id

Request Body schema: application/json
required
Array (non-empty)
op
required
string

Handy shortcut for operation name

path
required
string

path to change

value
required
object

new value for updated parameter

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{}

Get All Changes

This API provides capability to retrieve all of a Route Aggregation's Changes

Authorizations:
BearerAuth
path Parameters
routeAggregationId
required
string (RouteAggregationId)
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Aggregations Id

query Parameters
offset
integer
Example: offset=1

offset

limit
integer
Example: limit=10

number of records to fetch

Responses

Response Schema: application/json
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Array of objects (RouteAggregationChangeData)
Array
status
string
Enum: "COMPLETED" "FAILED" "REQUESTED"

Current outcome of the change flow

createdBy
string

Created by User Key

createdDateTime
string <date-time>

Set when change flow starts

updatedBy
string

Updated by User Key

updatedDateTime
string <date-time>

Set when change object is updated

information
string

Additional information

object (RouteAggregationsChangeOperation)

Route Aggregation change operation data

uuid
required
string

Uniquely identifies a change

type
required
string
Enum: "BGP_IPv4_PREFIX_AGGREGATION_UPDATE" "BGP_IPv4_PREFIX_AGGREGATION_CREATION" "BGP_IPv4_PREFIX_AGGREGATION_DELETION" "BGP_IPv6_PREFIX_AGGREGATION_UPDATE" "BGP_IPv6_PREFIX_AGGREGATION_CREATION" "BGP_IPv6_PREFIX_AGGREGATION_DELETION"

Type of change

href
string <uri>

Route AGGREGATION Change URI

Response samples

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

Get Change By ID

This API provides capability to retrieve a specific Route Aggregation's Changes

Authorizations:
BearerAuth
path Parameters
routeAggregationId
required
string (RouteAggregationId)
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Aggregations Id

changeId
required
string <uuid> (ChangeId_3)
Example: 6d500177-9404-41f2-99e8-2bf1a84d8db5

Routing Protocol Change UUID

Responses

Response Schema: application/json
status
string
Enum: "COMPLETED" "FAILED" "REQUESTED"

Current outcome of the change flow

createdBy
string

Created by User Key

createdDateTime
string <date-time>

Set when change flow starts

updatedBy
string

Updated by User Key

updatedDateTime
string <date-time>

Set when change object is updated

information
string

Additional information

object (RouteAggregationsChangeOperation)

Route Aggregation change operation data

op
required
string
Enum: "add" "replace" "remove"

Handy shortcut for operation name

path
required
string

path inside document leading to updated parameter

required
object (RouteAggregationsBase)
type
required
string
Enum: "BGP_IPv4_PREFIX_AGGREGATION" "BGP_IPv6_PREFIX_AGGREGATION"

Route Aggregation type

name
required
string
description
string

Customer-provided connection description

required
object (Project)
uuid
required
string

Uniquely identifies a change

type
required
string
Enum: "BGP_IPv4_PREFIX_AGGREGATION_UPDATE" "BGP_IPv4_PREFIX_AGGREGATION_CREATION" "BGP_IPv4_PREFIX_AGGREGATION_DELETION" "BGP_IPv6_PREFIX_AGGREGATION_UPDATE" "BGP_IPv6_PREFIX_AGGREGATION_CREATION" "BGP_IPv6_PREFIX_AGGREGATION_DELETION"

Type of change

href
string <uri>

Route AGGREGATION Change URI

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/changes/04af0d37-9160-43d8-97ef-9da9786996a3",
  • "type": "BGP_IPv4_PREFIX_AGGREGATION_CREATION",
  • "uuid": "04af0d37-9160-43d8-97ef-9da9786996a3",
  • "status": "COMPLETED",
  • "createdBy": "testuser",
  • "createdByEmail": "testuser@equinix.com",
  • "createdByFullName": "testuser testuser",
  • "createdDateTime": "2020-05-21T10:30:00Z",
  • "updatedBy": "_system",
  • "updatedByEmail": null,
  • "updatedByFullName": null,
  • "updatedDateTime": "2020-05-21T10:30:00Z",
  • "data": {
    }
}

Get All Connections on Route Aggregation

This API provides capability to view all Connections using the Route Aggregation

Authorizations:
BearerAuth
path Parameters
routeAggregationId
required
string (RouteAggregationId)
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Aggregations Id

Responses

Response Schema: application/json
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Array of objects (RouteAggregationConnectionsData)

List of Connections using a Route Aggregation

Array
href
string <uri>

Connection URI

type
string (ConnectionType)
Enum: "EVPL_VC" "EPL_VC" "EC_VC" "IP_VC" "ACCESS_EPL_VC" "EIA_VC" "EVPLAN_VC" "EPLAN_VC" "IPWAN_VC" "IA_VC"

Connection type

uuid
string <uuid>

Route Aggregation identifier

name
string

Response samples

Content type
application/json
{}

Search Aggregations

This API provides capability to search Route Aggregations

Authorizations:
BearerAuth
Request Body schema: application/json
required
object (RouteAggregationsSearchBase_filter)
Array of objects (RouteAggregationsSearchFilterItem)
Array
property
string
Enum: "/type" "/name" "/project/projectId" "/uuid" "/state"
operator
string
values
Array of strings
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Array of objects (RouteAggregationSortItem)
Array
property
string
Default: "/changeLog/updatedDateTime"
Enum: "/type" "/uuid" "/name" "/project/projectId" "/state" "/connectionsCount" "/changeLog/createdDateTime" "/changeLog/updatedDateTime"

Possible field names to use on sorting

direction
string
Default: "DESC"
Enum: "DESC" "ASC"

Sorting direction

Responses

Response Schema: application/json
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Array of objects (RouteAggregationsData)

List of Route Aggregations

Array
href
string <uri>

Route Aggregation URI

type
string
Enum: "BGP_IPv4_PREFIX_AGGREGATION" "BGP_IPv6_PREFIX_AGGREGATION"

Route Aggregation type

uuid
string <uuid>

Route Aggregation identifier

name
string
description
string

Customer-provided connection description

state
string (RouteAggregationState)
Enum: "PROVISIONING" "REPROVISIONING" "DEPROVISIONING" "PROVISIONED" "DEPROVISIONED" "NOT_PROVISIONED" "NOT_DEPROVISIONED"

Route Aggregation status

object (RouteAggregationsChange)

Current state of latest Route Aggregation change

connectionsCount
integer
rulesCount
integer
object (RouteAggregationsData_project)
object (Changelog)

Change log

Request samples

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

Response samples

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

Route Filter Rules

Route Filter Rules

Get Route Filter Rules

This API provides capability to get all Route Filters Rules for Fabric

Authorizations:
BearerAuth
path Parameters
routeFilterId
required
string (RouteFilterId)
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Filters Id

query Parameters
offset
integer
Example: offset=1

offset

limit
integer
Example: limit=10

number of records to fetch

Responses

Response Schema: application/json
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Array of objects (RouteFilterRulesData)

List of Route Filter Rules

Array
href
string <uri>

Route Filter Rules URI

type
string
Enum: "BGP_IPv4_PREFIX_FILTER_RULE" "BGP_IPv6_PREFIX_FILTER_RULE"

Route filter type

uuid
string <uuid>

Route Filter Rule identifier

name
string
description
string

Customer-provided Route Filter Rule description

state
string (RouteFilterRuleState)
Enum: "PROVISIONING" "REPROVISIONING" "DEPROVISIONING" "PROVISIONED" "DEPROVISIONED" "NOT_PROVISIONED" "NOT_DEPROVISIONED"

Route filter rule status

prefixMatch
string
Default: "orlonger"

prefix matching operator

object (RouteFilterRulesChange)

Current state of latest route filter rule change

action
string
Enum: "PERMIT" "DENY"
prefix
string
object (Changelog)

Change log

Response samples

Content type
application/json
{}

Create Route Filter Rule

This API provides capability to create a Route Filter Rule

Authorizations:
BearerAuth
path Parameters
routeFilterId
required
string (RouteFilterId)
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Filters Id

Request Body schema: application/json
required
name
string
description
string

Customer-provided Route Filter Rule description

prefix
required
string
prefixMatch
string
Default: "orlonger"

Responses

Request samples

Content type
application/json
Example
{
  • "name": "Private-subnet-filter",
  • "description": "Test rule",
  • "prefix": "192.168.0.0/24",
  • "prefixMatch": "exact"
}

Response samples

Content type
application/json
Example
{}

Get Route Filter Rule By UUID

This API provides capability to view a Route Filter Rule by UUID

Authorizations:
BearerAuth
path Parameters
routeFilterId
required
string (RouteFilterId)
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Filters Id

routeFilterRuleId
required
string (RouteFilterRuleId)
Example: 65b025ef-022b-4180-85cf-82cfc1ab655b

Route Filter Rules Id

Responses

Response samples

Content type
application/json
Example
{}

Replace Route Filter Rule

This API provides capability to replace a Route Filter Rule completely

Authorizations:
BearerAuth
path Parameters
routeFilterId
required
string (RouteFilterId)
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Filters Id

routeFilterRuleId
required
string (RouteFilterRuleId)
Example: 65b025ef-022b-4180-85cf-82cfc1ab655b

Route Filter Rules Id

Request Body schema: application/json
required
name
string
description
string

Customer-provided Route Filter Rule description

prefix
required
string
prefixMatch
string
Default: "orlonger"

Responses

Request samples

Content type
application/json
Example
{
  • "name": "Private-subnet-filter-update",
  • "description": "Test rule",
  • "prefix": "192.168.0.0/24",
  • "prefixMatch": "exact"
}

Response samples

Content type
application/json
Example
{}

Delete Route Filter Rule

This API provides capability to delete a Route Filter Rule

Authorizations:
BearerAuth
path Parameters
routeFilterId
required
string (RouteFilterId)
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Filters Id

routeFilterRuleId
required
string (RouteFilterRuleId)
Example: 65b025ef-022b-4180-85cf-82cfc1ab655b

Route Filter Rules Id

Responses

Response samples

Content type
application/json
Example
{}

Patch Route Filter Rule

This API provides capability to partially update a Route Filter Rule

Authorizations:
BearerAuth
path Parameters
routeFilterId
required
string (RouteFilterId)
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Filters Id

routeFilterRuleId
required
string (RouteFilterRuleId)
Example: 65b025ef-022b-4180-85cf-82cfc1ab655b

Route Filter Rules Id

Request Body schema: application/json
required
Array (non-empty)
op
required
string

Handy shortcut for operation name

path
required
string

path to change

value
required
object

new value for updated parameter

Responses

Request samples

Content type
application/json
Example
[
  • {
    }
]

Response samples

Content type
application/json
Example
{}

Get All Changes

This API provides capability to retrieve all of a Route Filter Rule's Changes

Authorizations:
BearerAuth
path Parameters
routeFilterId
required
string (RouteFilterId)
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Filters Id

routeFilterRuleId
required
string (RouteFilterRuleId)
Example: 65b025ef-022b-4180-85cf-82cfc1ab655b

Route Filter Rules Id

query Parameters
offset
integer
Example: offset=1

offset

limit
integer
Example: limit=10

number of records to fetch

Responses

Response Schema: application/json
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Array of objects (RouteFilterRulesChangeData)
Array
status
string
Enum: "COMPLETED" "FAILED" "REQUESTED"

Current outcome of the change flow

createdBy
string

Created by User Key

createdDateTime
string <date-time>

Set when change flow starts

updatedBy
string

Updated by User Key

updatedDateTime
string <date-time>

Set when change object is updated

object (RouteFilterRulesChangeOperation)

Route filter rule change operation data

uuid
required
string

Uniquely identifies a change

type
required
string
Enum: "BGP_IPv4_PREFIX_FILTER_RULE_UPDATE" "BGP_IPv4_PREFIX_FILTER_RULE_CREATION" "BGP_IPv4_PREFIX_FILTER_RULE_DELETION" "BGP_IPv6_PREFIX_FILTER_RULE_UPDATE" "BGP_IPv6_PREFIX_FILTER_RULE_CREATION" "BGP_IPv6_PREFIX_FILTER_RULE_DELETION"

Type of change

href
string <uri>

Route Filter Change URI

Response samples

Content type
application/json
{}

Get Change By ID

This API provides capability to retrieve a specific Route Filter Rule's Changes

Authorizations:
BearerAuth
path Parameters
routeFilterId
required
string (RouteFilterId)
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Filters Id

routeFilterRuleId
required
string (RouteFilterRuleId)
Example: 65b025ef-022b-4180-85cf-82cfc1ab655b

Route Filter Rules Id

changeId
required
string <uuid> (ChangeId_2)
Example: 6d500177-9404-41f2-99e8-2bf1a84d8db5

Route Filter Rule Change UUID

Responses

Response Schema: application/json
status
string
Enum: "COMPLETED" "FAILED" "REQUESTED"

Current outcome of the change flow

createdBy
string

Created by User Key

createdDateTime
string <date-time>

Set when change flow starts

updatedBy
string

Updated by User Key

updatedDateTime
string <date-time>

Set when change object is updated

object (RouteFilterRulesChangeOperation)

Route filter rule change operation data

op
required
string
Enum: "add" "replace" "remove"

Handy shortcut for operation name

path
required
string

path inside document leading to updated parameter

required
object (RouteFilterRulesBase)
name
string
description
string

Customer-provided Route Filter Rule description

prefix
required
string
prefixMatch
string
Default: "orlonger"
uuid
required
string

Uniquely identifies a change

type
required
string
Enum: "BGP_IPv4_PREFIX_FILTER_RULE_UPDATE" "BGP_IPv4_PREFIX_FILTER_RULE_CREATION" "BGP_IPv4_PREFIX_FILTER_RULE_DELETION" "BGP_IPv6_PREFIX_FILTER_RULE_UPDATE" "BGP_IPv6_PREFIX_FILTER_RULE_CREATION" "BGP_IPv6_PREFIX_FILTER_RULE_DELETION"

Type of change

href
string <uri>

Route Filter Change URI

Response samples

Content type
application/json
{}

Bulk Create Route Filter Rules

This API provides capability to create bulk route filter rules

Authorizations:
BearerAuth
path Parameters
routeFilterId
required
string (RouteFilterId)
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Filters Id

Request Body schema: application/json
required
Array of objects (RouteFilterRulesBase)

Route Filter Rule configuration

Array
name
string
description
string

Customer-provided Route Filter Rule description

prefix
required
string
prefixMatch
string
Default: "orlonger"

Responses

Request samples

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

Response samples

Content type
application/json
{}

Route Filters

Route Filters

Get All Route Filters

This API provides capability to view all Route Filters attached to a Connection

Authorizations:
BearerAuth
path Parameters
connectionId
required
string (ConnectionId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Connection Id

Responses

Response Schema: application/json
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Array of objects (ConnectionRouteFilterData)

List of Route Filters attached to a Connection

Array
href
string <uri>

Route filter URI

type
string
Enum: "BGP_IPv4_PREFIX_FILTER" "BGP_IPv6_PREFIX_FILTER"

Route filter type

uuid
string <uuid>

Route Filter identifier

attachmentStatus
string
Enum: "ATTACHING" "ATTACHED" "DETACHED" "DETACHING" "FAILED" "PENDING_BGP_CONFIGURATION"
direction
string
Enum: "INBOUND" "OUTBOUND"

Response samples

Content type
application/json
{}

Get Route Filter

This API provides capability to view a specific Route Filter attached to a Connection

Authorizations:
BearerAuth
path Parameters
routeFilterId
required
string (RouteFilterId)
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Filters Id

connectionId
required
string (ConnectionId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Connection Id

Responses

Response Schema: application/json
href
string <uri>

Route filter URI

type
string
Enum: "BGP_IPv4_PREFIX_FILTER" "BGP_IPv6_PREFIX_FILTER"

Route filter type

uuid
string <uuid>

Route Filter identifier

attachmentStatus
string
Enum: "ATTACHING" "ATTACHED" "DETACHED" "DETACHING" "FAILED" "PENDING_BGP_CONFIGURATION"
direction
string
Enum: "INBOUND" "OUTBOUND"

Response samples

Content type
application/json
{}

Attach Route Filter

This API provides capability to attach a Route Filter to a Connection

Authorizations:
BearerAuth
path Parameters
routeFilterId
required
string (RouteFilterId)
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Filters Id

connectionId
required
string (ConnectionId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Connection Id

Request Body schema: application/json
required
direction
required
string
Enum: "INBOUND" "OUTBOUND"

Route Filter direction to attach to a connection

Responses

Request samples

Content type
application/json
Example
{
  • "direction": "INBOUND"
}

Response samples

Content type
application/json
{}

Detach Route Filter

This API provides capability to detach a Route Filter from a Connection

Authorizations:
BearerAuth
path Parameters
routeFilterId
required
string (RouteFilterId)
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Filters Id

connectionId
required
string (ConnectionId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Connection Id

Responses

Response samples

Content type
application/json
Example
{}

Create Route Filters

This API provides capability to create a Route Filter

Authorizations:
BearerAuth
Request Body schema: application/json
required
type
required
string
Enum: "BGP_IPv4_PREFIX_FILTER" "BGP_IPv6_PREFIX_FILTER"

Route Filter type

name
required
string
description
string

Customer-provided connection description

required
object (Project)
projectId
required
string

Subscriber-assigned project ID

Responses

Request samples

Content type
application/json
Example
{
  • "type": "BGP_IPv4_PREFIX_FILTER",
  • "name": "My-route-filter-v4",
  • "description": "Test filter",
  • "project": {
    },
  • "notifications": {
    }
}

Response samples

Content type
application/json
{}

Get Route Filter By UUID

This API provides capability to view a Route Filter by UUID

Authorizations:
BearerAuth
path Parameters
routeFilterId
required
string (RouteFilterId)
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Filters Id

Responses

Response Schema: application/json
href
string <uri>

Route filter URI

type
string
Enum: "BGP_IPv4_PREFIX_FILTER" "BGP_IPv6_PREFIX_FILTER"

Route Filter type

uuid
string <uuid>

Route filter identifier

name
string
description
string

Customer-provided connection description

state
string (RouteFilterState)
Enum: "PROVISIONING" "REPROVISIONING" "DEPROVISIONING" "PROVISIONED" "DEPROVISIONED" "NOT_PROVISIONED" "NOT_DEPROVISIONED"

Route Filter status

object (RouteFiltersChange)

Current state of latest route filter change

uuid
required
string

Uniquely identifies a change

type
required
string
Enum: "BGP_IPv4_PREFIX_FILTER_UPDATE" "BGP_IPv4_PREFIX_FILTER_CREATION" "BGP_IPv4_PREFIX_FILTER_DELETION" "BGP_IPv6_PREFIX_FILTER_UPDATE" "BGP_IPv6_PREFIX_FILTER_CREATION" "BGP_IPv6_PREFIX_FILTER_DELETION"

Type of change

href
string <uri>

Route filter change URI

notMatchedRuleAction
string
Enum: "ALLOW" "DENY"
connectionsCount
integer
rulesCount
integer
object (RouteFiltersData_project)
projectId
required
string

Subscriber-assigned project ID

href
string <uri>

Project URI

object (Changelog)

Change log

createdBy
string

Created by User Key

createdByFullName
string

Created by User Full Name

createdByEmail
string

Created by User Email Address

createdDateTime
string <date-time>

Created by Date and Time

updatedBy
string

Updated by User Key

updatedByFullName
string

Updated by User Full Name

updatedByEmail
string

Updated by User Email Address

updatedDateTime
string <date-time>

Updated by Date and Time

deletedBy
string

Deleted by User Key

deletedByFullName
string

Deleted by User Full Name

deletedByEmail
string

Deleted by User Email Address

deletedDateTime
string <date-time>

Deleted by Date and Time

Response samples

Content type
application/json
{}

Delete Route Filter

This API provides capability to delete a Route Filter

Authorizations:
BearerAuth
path Parameters
routeFilterId
required
string (RouteFilterId)
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Filters Id

Responses

Response samples

Content type
application/json
{}

Patch Route Filter

This API provides capability to partially update a Route Filter

Authorizations:
BearerAuth
path Parameters
routeFilterId
required
string (RouteFilterId)
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Filters Id

Request Body schema: application/json
required
Array (non-empty)
op
required
string

Handy shortcut for operation name

path
required
string

path to change

value
required
object

new value for updated parameter

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{}

Get All Changes

This API provides capability to retrieve all of a Route Filter's Changes

Authorizations:
BearerAuth
path Parameters
routeFilterId
required
string (RouteFilterId)
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Filters Id

query Parameters
offset
integer
Example: offset=1

offset

limit
integer
Example: limit=10

number of records to fetch

Responses

Response Schema: application/json
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Array of objects (RouteFilterChangeData)
Array
status
string
Enum: "COMPLETED" "FAILED" "REQUESTED"

Current outcome of the change flow

createdBy
string

Created by user key

createdDateTime
string <date-time>

Set when change flow starts

updatedBy
string

Updated by user key

updatedDateTime
string <date-time>

Set when change object is updated

information
string

Additional information

object (RouteFiltersChangeOperation)

Route filter change operation data

uuid
required
string

Uniquely identifies a change

type
required
string
Enum: "BGP_IPv4_PREFIX_FILTER_UPDATE" "BGP_IPv4_PREFIX_FILTER_CREATION" "BGP_IPv4_PREFIX_FILTER_DELETION" "BGP_IPv6_PREFIX_FILTER_UPDATE" "BGP_IPv6_PREFIX_FILTER_CREATION" "BGP_IPv6_PREFIX_FILTER_DELETION"

Type of change

href
string <uri>

Route filter change URI

Response samples

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

Get Change By ID

This API provides capability to retrieve a specific Route Filter's Changes

Authorizations:
BearerAuth
path Parameters
routeFilterId
required
string (RouteFilterId)
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Filters Id

changeId
required
string <uuid> (ChangeId_1)
Example: 6d500177-9404-41f2-99e8-2bf1a84d8db5

Routing Protocol Change UUID

Responses

Response Schema: application/json
status
string
Enum: "COMPLETED" "FAILED" "REQUESTED"

Current outcome of the change flow

createdBy
string

Created by user key

createdDateTime
string <date-time>

Set when change flow starts

updatedBy
string

Updated by user key

updatedDateTime
string <date-time>

Set when change object is updated

information
string

Additional information

object (RouteFiltersChangeOperation)

Route filter change operation data

op
required
string
Enum: "add" "replace" "remove"

Handy shortcut for operation name

path
required
string

path inside document leading to updated parameter

required
object (RouteFiltersBase)
type
required
string
Enum: "BGP_IPv4_PREFIX_FILTER" "BGP_IPv6_PREFIX_FILTER"

Route Filter type

name
required
string
description
string

Customer-provided connection description

required
object (Project)
uuid
required
string

Uniquely identifies a change

type
required
string
Enum: "BGP_IPv4_PREFIX_FILTER_UPDATE" "BGP_IPv4_PREFIX_FILTER_CREATION" "BGP_IPv4_PREFIX_FILTER_DELETION" "BGP_IPv6_PREFIX_FILTER_UPDATE" "BGP_IPv6_PREFIX_FILTER_CREATION" "BGP_IPv6_PREFIX_FILTER_DELETION"

Type of change

href
string <uri>

Route filter change URI

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/changes/04af0d37-9160-43d8-97ef-9da9786996a3",
  • "type": "BGP_IPv4_PREFIX_FILTER_CREATION",
  • "uuid": "04af0d37-9160-43d8-97ef-9da9786996a3",
  • "status": "COMPLETED",
  • "createdBy": "testuser",
  • "createdByEmail": "testuser@equinix.com",
  • "createdByFullName": "testuser testuser",
  • "createdDateTime": "2020-05-21T10:30:00Z",
  • "updatedBy": "_system",
  • "updatedByEmail": null,
  • "updatedByFullName": null,
  • "updatedDateTime": "2020-05-21T10:30:00Z",
  • "data": {
    }
}

Get All Connections on Route Filter

This API provides capability to view all Connections using the Route Filter

Authorizations:
BearerAuth
path Parameters
routeFilterId
required
string (RouteFilterId)
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Filters Id

Responses

Response Schema: application/json
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Array of objects (RouteFilterConnectionsData)

List of Connections using a Route Filter

Array
href
string <uri>

Connection URI

type
string (ConnectionType)
Enum: "EVPL_VC" "EPL_VC" "EC_VC" "IP_VC" "ACCESS_EPL_VC" "EIA_VC" "EVPLAN_VC" "EPLAN_VC" "IPWAN_VC" "IA_VC"

Connection type

uuid
string <uuid>

Route filter identifier

name
string

Response samples

Content type
application/json
{}

Search Route Filters

This API provides capability to search Route Filters

Authorizations:
BearerAuth
Request Body schema: application/json
required
object (RouteFiltersSearchBase_filter)
Array of objects (RouteFiltersSearchFilterItem)
Array
property
string
Enum: "/type" "/name" "/project/projectId" "/uuid" "/state"
operator
string
values
Array of strings
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Array of objects (SortItem)
Array
property
string
Default: "/changeLog/updatedDateTime"
Enum: "/type" "/uuid" "/name" "/project/projectId" "/state" "/notMatchedRuleAction" "/connectionsCount" "/changeLog/createdDateTime" "/changeLog/updatedDateTime"

Possible field names to use on sorting

direction
string
Default: "DESC"
Enum: "DESC" "ASC"

Sorting direction

Responses

Response Schema: application/json
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Array of objects (RouteFiltersData)

List of route filters

Array
href
string <uri>

Route filter URI

type
string
Enum: "BGP_IPv4_PREFIX_FILTER" "BGP_IPv6_PREFIX_FILTER"

Route Filter type

uuid
string <uuid>

Route filter identifier

name
string
description
string

Customer-provided connection description

state
string (RouteFilterState)
Enum: "PROVISIONING" "REPROVISIONING" "DEPROVISIONING" "PROVISIONED" "DEPROVISIONED" "NOT_PROVISIONED" "NOT_DEPROVISIONED"

Route Filter status

object (RouteFiltersChange)

Current state of latest route filter change

notMatchedRuleAction
string
Enum: "ALLOW" "DENY"
connectionsCount
integer
rulesCount
integer
object (RouteFiltersData_project)
object (Changelog)

Change log

Request samples

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

Response samples

Content type
application/json
{}

Routing Protocols

Routing Protocols

GetRoutingProtocols

This API provides capability to get Routing Protocols for connections

Authorizations:
BearerAuth
path Parameters
connectionId
required
string (ConnectionId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Connection Id

query Parameters
offset
integer
Example: offset=1

offset

limit
integer
Example: limit=10

number of records to fetch

Responses

Response Schema: application/json
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Array of RoutingProtocolBGPData (object) or RoutingProtocolDirectData (object) (RoutingProtocolData)

List of Routing Protocols

Array
One of
type
string
Enum: "BGP" "DIRECT"

Routing protocol type

name
string
object (BGPConnectionIpv4)
object (BGPConnectionIpv6)
customerAsn
integer <int64>

Customer asn

equinixAsn
integer <int64>

Equinix asn

bgpAuthKey
string

BGP authorization key

asOverrideEnabled
boolean

Enable AS number override

object (RoutingProtocolBFD)
href
string <uri>

Routing Protocol URI

uuid
string <uuid>

Routing protocol identifier

state
string
Enum: "PROVISIONED" "DEPROVISIONED" "PROVISIONING" "DEPROVISIONING" "REPROVISIONING" "FAILED"
object (RoutingProtocolOperation)
object (RoutingProtocolChange)

Current state of latest Routing Protocol change

object (Changelog)

Change log

Response samples

Content type
application/json
{}

Create Protocol

This API provides capability to create Routing Protocol for connections

Authorizations:
BearerAuth
path Parameters
connectionId
required
string (ConnectionId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Connection Id

Request Body schema: application/json
required
One of
type
required
string
Enum: "BGP" "DIRECT"

Routing protocol type

name
string
object (BGPConnectionIpv4)
customerPeerIp
required
string

Customer side peering ip

equinixPeerIp
string

Equinix side peering ip

enabled
required
boolean

Admin status for the BGP session

outboundASPrependCount
integer <int64>

AS path prepend count

inboundMED
integer <int64>

Inbound Multi Exit Discriminator attribute

outboundMED
integer <int64>

Outbound Multi Exit Discriminator attribute

routesMax
integer <int64>

Maximum learnt prefixes limit

object (BGPConnectionOperation)

BGP IPv4 or IPv6 Connection State operational data

operationalStatus
string
Enum: "UP" "DOWN" "UNKNOWN"

BGP IPv4 or IPv6 Connection State operational status

opStatusChangedAt
string <date-time>

Last BGP State Update by Date and Time

object (BGPConnectionIpv6)
customerPeerIp
required
string

Customer side peering ip

equinixPeerIp
string

Equinix side peering ip

enabled
required
boolean

Admin status for the BGP session

outboundASPrependCount
integer <int64>

AS path prepend count

inboundMED
integer <int64>

Inbound Multi Exit Discriminator attribute

outboundMED
integer <int64>

Outbound Multi Exit Discriminator attribute

routesMax
integer <int64>

Maximum learnt prefixes limit

object (BGPConnectionOperation)

BGP IPv4 or IPv6 Connection State operational data

operationalStatus
string
Enum: "UP" "DOWN" "UNKNOWN"

BGP IPv4 or IPv6 Connection State operational status

opStatusChangedAt
string <date-time>

Last BGP State Update by Date and Time

customerAsn
integer <int64>

Customer asn

equinixAsn
integer <int64>

Equinix asn

bgpAuthKey
string

BGP authorization key

asOverrideEnabled
boolean

Enable AS number override

object (RoutingProtocolBFD)
enabled
required
boolean
interval
string

Responses

Request samples

Content type
application/json
Example
{
  • "type": "DIRECT",
  • "directIpv4": {
    },
  • "directIpv6": {
    }
}

Response samples

Content type
application/json
Example
{}

Bulk Create Protocol

This API provides capability to create Routing Protocol for connections

Authorizations:
BearerAuth
path Parameters
connectionId
required
string (ConnectionId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Connection Id

Request Body schema: application/json
required
Array of RoutingProtocolBGPType (object) or RoutingProtocolDirectType (object) (RoutingProtocolBase)

Connection routing protocol configuration

Array
One of
type
required
string
Enum: "BGP" "DIRECT"

Routing protocol type

name
string
object (BGPConnectionIpv4)
object (BGPConnectionIpv6)
customerAsn
integer <int64>

Customer asn

equinixAsn
integer <int64>

Equinix asn

bgpAuthKey
string

BGP authorization key

asOverrideEnabled
boolean

Enable AS number override

object (RoutingProtocolBFD)

Responses

Request samples

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

Response samples

Content type
application/json
{}

Get Protocol

This API provides capability to accept/reject user's virtual connection

Authorizations:
BearerAuth
path Parameters
routingProtocolId
required
string <uuid> (RoutingProtocolId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Routing Protocol Id

connectionId
required
string (ConnectionId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Connection Id

Responses

Response Schema: application/json
One of
type
string
Enum: "BGP" "DIRECT"

Routing protocol type

name
string
object (BGPConnectionIpv4)
customerPeerIp
required
string

Customer side peering ip

equinixPeerIp
string

Equinix side peering ip

enabled
required
boolean

Admin status for the BGP session

outboundASPrependCount
integer <int64>

AS path prepend count

inboundMED
integer <int64>

Inbound Multi Exit Discriminator attribute

outboundMED
integer <int64>

Outbound Multi Exit Discriminator attribute

routesMax
integer <int64>

Maximum learnt prefixes limit

object (BGPConnectionOperation)

BGP IPv4 or IPv6 Connection State operational data

operationalStatus
string
Enum: "UP" "DOWN" "UNKNOWN"

BGP IPv4 or IPv6 Connection State operational status

opStatusChangedAt
string <date-time>

Last BGP State Update by Date and Time

object (BGPConnectionIpv6)
customerPeerIp
required
string

Customer side peering ip

equinixPeerIp
string

Equinix side peering ip

enabled
required
boolean

Admin status for the BGP session

outboundASPrependCount
integer <int64>

AS path prepend count

inboundMED
integer <int64>

Inbound Multi Exit Discriminator attribute

outboundMED
integer <int64>

Outbound Multi Exit Discriminator attribute

routesMax
integer <int64>

Maximum learnt prefixes limit

object (BGPConnectionOperation)

BGP IPv4 or IPv6 Connection State operational data

operationalStatus
string
Enum: "UP" "DOWN" "UNKNOWN"

BGP IPv4 or IPv6 Connection State operational status

opStatusChangedAt
string <date-time>

Last BGP State Update by Date and Time

customerAsn
integer <int64>

Customer asn

equinixAsn
integer <int64>

Equinix asn

bgpAuthKey
string

BGP authorization key

asOverrideEnabled
boolean

Enable AS number override

object (RoutingProtocolBFD)
enabled
required
boolean
interval
string
href
string <uri>

Routing Protocol URI

uuid
string <uuid>

Routing protocol identifier

state
string
Enum: "PROVISIONED" "DEPROVISIONED" "PROVISIONING" "DEPROVISIONING" "REPROVISIONING" "FAILED"
object (RoutingProtocolOperation)
Array of objects (Error)
Array
errorCode
required
string^EQ-\d{7}$
errorMessage
required
string
correlationId
string
details
string
help
string
Array of objects (PriceError_additionalInfo)
object (RoutingProtocolChange)

Current state of latest Routing Protocol change

uuid
required
string

Uniquely identifies a change

type
required
string
Enum: "ROUTING_PROTOCOL_UPDATE" "ROUTING_PROTOCOL_CREATION" "ROUTING_PROTOCOL_DELETION"

Type of change

href
string <uri>

Routing Protocol Change URI

object (Changelog)

Change log

createdBy
string

Created by User Key

createdByFullName
string

Created by User Full Name

createdByEmail
string

Created by User Email Address

createdDateTime
string <date-time>

Created by Date and Time

updatedBy
string

Updated by User Key

updatedByFullName
string

Updated by User Full Name

updatedByEmail
string

Updated by User Email Address

updatedDateTime
string <date-time>

Updated by Date and Time

deletedBy
string

Deleted by User Key

deletedByFullName
string

Deleted by User Full Name

deletedByEmail
string

Deleted by User Email Address

deletedDateTime
string <date-time>

Deleted by Date and Time

Response samples

Content type
application/json
Example
{}

Replace Protocol

This API provides capability to replace complete Routing Protocols on a virtual connection

Authorizations:
BearerAuth
path Parameters
routingProtocolId
required
string <uuid> (RoutingProtocolId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Routing Protocol Id

connectionId
required
string (ConnectionId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Connection Id

Request Body schema: application/json
required
One of
type
required
string
Enum: "BGP" "DIRECT"

Routing protocol type

name
string
object (BGPConnectionIpv4)
customerPeerIp
required
string

Customer side peering ip

equinixPeerIp
string

Equinix side peering ip

enabled
required
boolean

Admin status for the BGP session

outboundASPrependCount
integer <int64>

AS path prepend count

inboundMED
integer <int64>

Inbound Multi Exit Discriminator attribute

outboundMED
integer <int64>

Outbound Multi Exit Discriminator attribute

routesMax
integer <int64>

Maximum learnt prefixes limit

object (BGPConnectionOperation)

BGP IPv4 or IPv6 Connection State operational data

operationalStatus
string
Enum: "UP" "DOWN" "UNKNOWN"

BGP IPv4 or IPv6 Connection State operational status

opStatusChangedAt
string <date-time>

Last BGP State Update by Date and Time

object (BGPConnectionIpv6)
customerPeerIp
required
string

Customer side peering ip

equinixPeerIp
string

Equinix side peering ip

enabled
required
boolean

Admin status for the BGP session

outboundASPrependCount
integer <int64>

AS path prepend count

inboundMED
integer <int64>

Inbound Multi Exit Discriminator attribute

outboundMED
integer <int64>

Outbound Multi Exit Discriminator attribute

routesMax
integer <int64>

Maximum learnt prefixes limit

object (BGPConnectionOperation)

BGP IPv4 or IPv6 Connection State operational data

operationalStatus
string
Enum: "UP" "DOWN" "UNKNOWN"

BGP IPv4 or IPv6 Connection State operational status

opStatusChangedAt
string <date-time>

Last BGP State Update by Date and Time

customerAsn
integer <int64>

Customer asn

equinixAsn
integer <int64>

Equinix asn

bgpAuthKey
string

BGP authorization key

asOverrideEnabled
boolean

Enable AS number override

object (RoutingProtocolBFD)
enabled
required
boolean
interval
string

Responses

Request samples

Content type
application/json
Example
{
  • "type": "DIRECT",
  • "directIpv4": {
    },
  • "directIpv6": {
    }
}

Response samples

Content type
application/json
Example
{}

Delete Protocol

This API provides capability to delete Routing Protocols on virtual connection

Authorizations:
BearerAuth
path Parameters
routingProtocolId
required
string <uuid> (RoutingProtocolId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Routing Protocol Id

connectionId
required
string (ConnectionId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Connection Id

Responses

Response samples

Content type
application/json
Example
{}

Patch Protocol

This API provides capability to partially update Routing Protocols on a virtual connection

Authorizations:
BearerAuth
path Parameters
routingProtocolId
required
string <uuid> (RoutingProtocolId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Routing Protocol Id

connectionId
required
string (ConnectionId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Connection Id

Request Body schema: application/json
required
Array (non-empty)
op
required
string

Handy shortcut for operation name

path
required
string

path inside document leading to updated parameter

value
required
object

new value for updated parameter

Responses

Request samples

Content type
application/json
Example
[
  • {
    }
]

Response samples

Content type
application/json
Example
{}

Get BGP Actions

This API provides capability to get all BGP actions status

Authorizations:
BearerAuth
path Parameters
routingProtocolId
required
string <uuid> (RoutingProtocolId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Routing Protocol Id

connectionId
required
string (ConnectionId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Connection Id

query Parameters
offset
integer
Example: offset=1

offset

limit
integer
Example: limit=10

number of records to fetch

Responses

Response Schema: application/json
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Array of objects (BGPActionData)
Array
href
string <uri>

Routing Protocol URI

uuid
string <uuid>

Routing protocol identifier

type
string (BGPActions)
Enum: "CLEAR_BGPIPV4" "CLEAR_BGPIPV6" "CLEAR_BGPIPV4_INBOUND" "CLEAR_BGPIPV6_INBOUND" "RESET_BGPIPV4" "RESET_BGPIPV6"

BGP action type

description
string

BGP action description

state
string (BGPActionStates)
Enum: "PENDING" "FAILED" "SUCCEEDED"

BGP action state

object (Changelog)

Change log

Response samples

Content type
application/json
{}

Clear/Reset BGP

This API provides capability to clear/reset Routing Protocols BGP session

Authorizations:
BearerAuth
path Parameters
routingProtocolId
required
string <uuid> (RoutingProtocolId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Routing Protocol Id

connectionId
required
string (ConnectionId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Connection Id

Request Body schema: application/json
required
type
required
string (BGPActions)
Enum: "CLEAR_BGPIPV4" "CLEAR_BGPIPV6" "CLEAR_BGPIPV4_INBOUND" "CLEAR_BGPIPV6_INBOUND" "RESET_BGPIPV4" "RESET_BGPIPV6"

BGP action type

Responses

Request samples

Content type
application/json
Example
{
  • "type": "CLEAR_BGPIPV4"
}

Response samples

Content type
application/json
Example
{}

Get BGP Action

This API provides capability to retrieve specific BGP action

Authorizations:
BearerAuth
path Parameters
connectionId
required
string (ConnectionId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Connection Id

routingProtocolId
required
string <uuid> (RoutingProtocolId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Routing Protocol Id

actionId
required
string <uuid> (ActionId)
Example: 86534014-34b4-53f6-45d6-4b94a92d8623

BGP Action UUID

Responses

Response Schema: application/json
href
string <uri>

Routing Protocol URI

uuid
string <uuid>

Routing protocol identifier

type
string (BGPActions)
Enum: "CLEAR_BGPIPV4" "CLEAR_BGPIPV6" "CLEAR_BGPIPV4_INBOUND" "CLEAR_BGPIPV6_INBOUND" "RESET_BGPIPV4" "RESET_BGPIPV6"

BGP action type

description
string

BGP action description

state
string (BGPActionStates)
Enum: "PENDING" "FAILED" "SUCCEEDED"

BGP action state

object (Changelog)

Change log

createdBy
string

Created by User Key

createdByFullName
string

Created by User Full Name

createdByEmail
string

Created by User Email Address

createdDateTime
string <date-time>

Created by Date and Time

updatedBy
string

Updated by User Key

updatedByFullName
string

Updated by User Full Name

updatedByEmail
string

Updated by User Email Address

updatedDateTime
string <date-time>

Updated by Date and Time

deletedBy
string

Deleted by User Key

deletedByFullName
string

Deleted by User Full Name

deletedByEmail
string

Deleted by User Email Address

deletedDateTime
string <date-time>

Deleted by Date and Time

Response samples

Content type
application/json
{}

Get Change By ID

This API provides capability to retrieve specific Routing Protocol Change

Authorizations:
BearerAuth
path Parameters
connectionId
required
string (ConnectionId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Connection Id

routingProtocolId
required
string <uuid> (RoutingProtocolId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Routing Protocol Id

changeId
required
string <uuid> (ChangeId)
Example: 6d500177-9404-41f2-99e8-2bf1a84d8db5

Routing Protocol Change UUID

Responses

Response Schema: application/json
status
string
Enum: "COMPLETED" "FAILED" "REQUESTED"

Current outcome of the change flow

createdBy
string

Created by User Key

createdDateTime
string <date-time>

Set when change flow starts

updatedBy
string

Updated by User Key

updatedDateTime
string <date-time>

Set when change object is updated

information
string

Additional information

object (RoutingProtocolChangeOperation)

Routing Protocol change operation data

op
required
string
Enum: "add" "replace" "remove"

Handy shortcut for operation name

path
required
string

path inside document leading to updated parameter

required
RoutingProtocolBGPType (object) or RoutingProtocolDirectType (object) (RoutingProtocolBase)
One of
type
required
string
Enum: "BGP" "DIRECT"

Routing protocol type

name
string
object (BGPConnectionIpv4)
object (BGPConnectionIpv6)
customerAsn
integer <int64>

Customer asn

equinixAsn
integer <int64>

Equinix asn

bgpAuthKey
string

BGP authorization key

asOverrideEnabled
boolean

Enable AS number override

object (RoutingProtocolBFD)
uuid
required
string

Uniquely identifies a change

type
required
string
Enum: "ROUTING_PROTOCOL_UPDATE" "ROUTING_PROTOCOL_CREATION" "ROUTING_PROTOCOL_DELETION"

Type of change

href
string <uri>

Routing Protocol Change URI

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/connections/2a4fb415-5a7f-436f-bae6-02f5e403deec/routingProtocols/2a4fb415-5a7f-436f-bae6-02f5e403deec/changes/4b17da68-3d6b-436d-9c8f-2105f3b950d9",
  • "type": "ROUTING_PROTOCOL_UPDATE",
  • "uuid": "4b17da68-3d6b-436d-9c8f-2105f3b950d9",
  • "status": "COMPLETED",
  • "createdDateTime": "2020-05-21T10:30:00Z",
  • "updatedDateTime": "2020-05-21T10:30:50Z",
  • "data": {
    }
}

Get Changes

This API provides capability to retrieve user's Routing Protocol Changes

Authorizations:
BearerAuth
path Parameters
connectionId
required
string (ConnectionId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Connection Id

routingProtocolId
required
string <uuid> (RoutingProtocolId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Routing Protocol Id

query Parameters
offset
integer
Example: offset=1

offset

limit
integer
Example: limit=10

number of records to fetch

Responses

Response Schema: application/json
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Array of objects (RoutingProtocolChangeData)
Array
status
string
Enum: "COMPLETED" "FAILED" "REQUESTED"

Current outcome of the change flow

createdBy
string

Created by User Key

createdDateTime
string <date-time>

Set when change flow starts

updatedBy
string

Updated by User Key

updatedDateTime
string <date-time>

Set when change object is updated

information
string

Additional information

object (RoutingProtocolChangeOperation)

Routing Protocol change operation data

uuid
required
string

Uniquely identifies a change

type
required
string
Enum: "ROUTING_PROTOCOL_UPDATE" "ROUTING_PROTOCOL_CREATION" "ROUTING_PROTOCOL_DELETION"

Type of change

href
string <uri>

Routing Protocol Change URI

Response samples

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

Validate Subnet

This API provides capability to validate all subnets associated with any connection in the given FCR

Authorizations:
BearerAuth
path Parameters
routerId
required
string <uuid> (RouterId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Cloud Router UUID

Request Body schema: application/json
required
object (ValidateRequest_filter)

Filters

Array of objects (ValidateRequest_filter_and)
Array
property
string

Path to property

operator
string

Type of operation

values
Array of strings

Values for the given property

Responses

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

Additional information

Array
key
string

Key

value
string

Value

Request samples

Content type
application/json
Example
{
  • "filter": {
    }
}

Response samples

Content type
application/json
{
  • "additionalInfo": [
    ]
}

Service Profiles

Service Profiles

Get all Profiles

The API request returns all Equinix Fabric Service Profiles in accordance with the view point requested.

Authorizations:
BearerAuth
query Parameters
offset
integer
Example: offset=1

offset

limit
integer
Example: limit=10

number of records to fetch

viewPoint
string
Default: "aSide"
Enum: "aSide" "zSide"

flips view between buyer and seller representation

Responses

Response Schema: application/json; charset=UTF-8
Array of objects (ServiceProfile)
Array
state
string (ServiceProfileStateEnum)
Enum: "ACTIVE" "PENDING_APPROVAL" "DELETED" "REJECTED"

Equinix assigned state.

object

Seller Account for Service Profile.

object (Project)
object

Seller Account for Service Profile.

href
string <uri>

Service Profile URI response attribute

type
string (ServiceProfileTypeEnum)
Enum: "L2_PROFILE" "L3_PROFILE" "IA_PROFILE"

Service profile type

name
string <= 50 characters

Customer-assigned service profile name

uuid
string <uuid>

Equinix-assigned service profile identifier

description
string

User-provided service description should be of maximum length 375

Array of objects (SimplifiedNotification)

Recipients of notifications on service profile change

tags
Array of strings (Tags)
visibility
string (ServiceProfileVisibilityEnum)
Enum: "PRIVATE" "PUBLIC"
allowedEmails
Array of strings <email> [ items <email > ]
Array of ServiceProfileAccessPointTypeCOLO (object) or ServiceProfileAccessPointTypeVD (object) (ServiceProfileAccessPointType) non-empty
Array of objects (CustomField)
object (MarketingInfo)
Array of objects (ServiceProfileAccessPointCOLO)
Array of objects (ServiceProfileAccessPointVD)
Array of objects (ServiceMetro)

Derived response attribute.

selfProfile
boolean

response attribute indicates whether the profile belongs to the same organization as the api-invoker.

projectId
string
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Response samples

Content type
application/json; charset=UTF-8
Example
{
  • "data": [
    ],
  • "pagination": {
    }
}

Create Profile

Create Service Profile creates Equinix Fabric? Service Profile.

Authorizations:
BearerAuth
Request Body schema: application/json
required
object (Project)
projectId
required
string

Subscriber-assigned project ID

type
required
string (ServiceProfileTypeEnum)
Enum: "L2_PROFILE" "L3_PROFILE" "IA_PROFILE"

Service profile type

name
required
string <= 50 characters

Customer-assigned service profile name

uuid
string <uuid>

Equinix-assigned service profile identifier

description
required
string

User-provided service description should be of maximum length 375

Array of objects (SimplifiedNotification)

Recipients of notifications on service profile change

Array
type
required
string
Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS"

Notification Type

sendInterval
string
emails
required
Array of strings <email> [ items <email > ]

Array of contact emails

registeredUsers
Array of strings

Array of registered users

tags
Array of strings (Tags)
visibility
string (ServiceProfileVisibilityEnum)
Enum: "PRIVATE" "PUBLIC"
allowedEmails
Array of strings <email> [ items <email > ]
Array of ServiceProfileAccessPointTypeCOLO (object) or ServiceProfileAccessPointTypeVD (object) (ServiceProfileAccessPointType) non-empty
Array (non-empty)
One of
uuid
string
type
required
string (ServiceProfileAccessPointTypeEnum)
Enum: "VD" "COLO"

Access point type

supportedBandwidths
Array of integers (Bandwidths)
allowRemoteConnections
boolean
Default: false

Setting to allow or prohibit remote connections to the service profile.

allowCustomBandwidth
boolean
Default: false

Setting to enable or disable the ability of the buyer to customize the bandwidth.

bandwidthAlertThreshold
number

percentage of port bandwidth at which an allocation alert is generated - missing on wiki.

allowBandwidthAutoApproval
boolean
Default: false

Setting to enable or disable the ability of the buyer to change connection bandwidth without approval of the seller.

allowBandwidthUpgrade
boolean

Availability of a bandwidth upgrade. The default is false.

object (ServiceProfileLinkProtocolConfig)

Configuration for dot1q to qinq translation support

enableAutoGenerateServiceKey
boolean

for verizon only.

connectionRedundancyRequired
boolean
Default: false

Mandate redundant connections

object (ApiConfig)

Configuration for API based Integration for Service Profile

connectionLabel
string

custom name for "Connection"

object (AuthenticationKey)

Authentication Key Support and Customization

object (ServiceProfileMetadata)

Metadata. Response attribute. Ignored on request payload.

Array of objects (CustomField)
Array
label
required
string
description
string
required
boolean
dataType
required
string
Enum: "STRING" "LIST" "NUMBER"
options
Array of strings
captureInEmail
boolean

capture this field as a part of email notification

object (MarketingInfo)
logo
string

Logo file name

promotion
boolean

Profile promotion on marketplace

Array of objects (ProcessStep) <= 3 items
Array (<= 3 items)
title
string

Service profile custom step title

subTitle
string

Service profile custom step sub title

description
string

Service profile custom step description

Array of objects (ServiceProfileAccessPointCOLO)
Array
type
required
string
Value: "XF_PORT"
uuid
required
string <uuid>
object (SimplifiedLocation)
sellerRegion
string
sellerRegionDescription
string
crossConnectId
string
Array of objects (ServiceProfileAccessPointVD)
Array
type
required
string
Value: "VD"
uuid
required
string <uuid>
object (SimplifiedLocation)
interfaceUuid
string <uuid>
Array of objects (ServiceMetro)

Derived response attribute.

Array
code
string

metro code

name
string

metro name

vcBandwidthMax
integer

max VC speed supported in Mbps

ibxs
Array of strings
inTrail
boolean
displayName
string

service metro display name

object
selfProfile
boolean

response attribute indicates whether the profile belongs to the same organization as the api-invoker.

projectId
string

Responses

Response Headers
ETag
string

response header - identifier for a specific version of a resource.

Response Schema: application/json; charset=UTF-8
state
string (ServiceProfileStateEnum)
Enum: "ACTIVE" "PENDING_APPROVAL" "DELETED" "REJECTED"

Equinix assigned state.

object

Seller Account for Service Profile.

accountNumber
integer <int64>

Account number

accountName
string

Account name

orgId
integer <int64>

Customer organization identifier

organizationName
string

Customer organization name

globalOrgId
string

Global organization identifier

globalOrganizationName
string

Global organization name

ucmId
string

Account ucmId

globalCustId
string

Account name

resellerAccountNumber
integer <int64>

Reseller account number

resellerAccountName
string

Reseller account name

resellerUcmId
string

Reseller account ucmId

resellerOrgId
integer <int64>

Reseller customer organization identifier

object (Project)
projectId
required
string

Subscriber-assigned project ID

object

Seller Account for Service Profile.

createdBy
string

Created by User Key

createdByFullName
string

Created by User Full Name

createdByEmail
string

Created by User Email Address

createdDateTime
string <date-time>

Created by Date and Time

updatedBy
string

Updated by User Key

updatedByFullName
string

Updated by User Full Name

updatedByEmail
string

Updated by User Email Address

updatedDateTime
string <date-time>

Updated by Date and Time

deletedBy
string

Deleted by User Key

deletedByFullName
string

Deleted by User Full Name

deletedByEmail
string

Deleted by User Email Address

deletedDateTime
string <date-time>

Deleted by Date and Time

href
string <uri>

Service Profile URI response attribute

type
string (ServiceProfileTypeEnum)
Enum: "L2_PROFILE" "L3_PROFILE" "IA_PROFILE"

Service profile type

name
string <= 50 characters

Customer-assigned service profile name

uuid
string <uuid>

Equinix-assigned service profile identifier

description
string

User-provided service description should be of maximum length 375

Array of objects (SimplifiedNotification)

Recipients of notifications on service profile change

Array
type
required
string
Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS"

Notification Type

sendInterval
string
emails
required
Array of strings <email> [ items <email > ]

Array of contact emails

registeredUsers
Array of strings

Array of registered users

tags
Array of strings (Tags)
visibility
string (ServiceProfileVisibilityEnum)
Enum: "PRIVATE" "PUBLIC"
allowedEmails
Array of strings <email> [ items <email > ]
Array of ServiceProfileAccessPointTypeCOLO (object) or ServiceProfileAccessPointTypeVD (object) (ServiceProfileAccessPointType) non-empty
Array (non-empty)
One of
uuid
string
type
required
string (ServiceProfileAccessPointTypeEnum)
Enum: "VD" "COLO"

Access point type

supportedBandwidths
Array of integers (Bandwidths)
allowRemoteConnections
boolean
Default: false

Setting to allow or prohibit remote connections to the service profile.

allowCustomBandwidth
boolean
Default: false

Setting to enable or disable the ability of the buyer to customize the bandwidth.

bandwidthAlertThreshold
number

percentage of port bandwidth at which an allocation alert is generated - missing on wiki.

allowBandwidthAutoApproval
boolean
Default: false

Setting to enable or disable the ability of the buyer to change connection bandwidth without approval of the seller.

allowBandwidthUpgrade
boolean

Availability of a bandwidth upgrade. The default is false.

object (ServiceProfileLinkProtocolConfig)

Configuration for dot1q to qinq translation support

enableAutoGenerateServiceKey
boolean

for verizon only.

connectionRedundancyRequired
boolean
Default: false

Mandate redundant connections

object (ApiConfig)

Configuration for API based Integration for Service Profile

connectionLabel
string

custom name for "Connection"

object (AuthenticationKey)

Authentication Key Support and Customization

object (ServiceProfileMetadata)

Metadata. Response attribute. Ignored on request payload.

Array of objects (CustomField)
Array
label
required
string
description
string
required
boolean
dataType
required
string
Enum: "STRING" "LIST" "NUMBER"
options
Array of strings
captureInEmail
boolean

capture this field as a part of email notification

object (MarketingInfo)
logo
string

Logo file name

promotion
boolean

Profile promotion on marketplace

Array of objects (ProcessStep) <= 3 items
Array (<= 3 items)
title
string

Service profile custom step title

subTitle
string

Service profile custom step sub title

description
string

Service profile custom step description

Array of objects (ServiceProfileAccessPointCOLO)
Array
type
required
string
Value: "XF_PORT"
uuid
required
string <uuid>
object (SimplifiedLocation)
sellerRegion
string
sellerRegionDescription
string
crossConnectId
string
Array of objects (ServiceProfileAccessPointVD)
Array
type
required
string
Value: "VD"
uuid
required
string <uuid>
object (SimplifiedLocation)
interfaceUuid
string <uuid>
Array of objects (ServiceMetro)

Derived response attribute.

Array
code
string

metro code

name
string

metro name

vcBandwidthMax
integer

max VC speed supported in Mbps

ibxs
Array of strings
inTrail
boolean
displayName
string

service metro display name

object
selfProfile
boolean

response attribute indicates whether the profile belongs to the same organization as the api-invoker.

projectId
string

Request samples

Content type
application/json
Example
{
  • "name": "Service Profile 1",
  • "description": "Sample_description",
  • "type": "L2_PROFILE",
  • "notifications": [
    ],
  • "visibility": "PUBLIC",
  • "allowedEmails": [
    ],
  • "ports": [
    ],
  • "marketingInfo": {
    },
  • "accessPointTypeConfigs": [
    ]
}

Response samples

Content type
application/json; charset=UTF-8
{
  • "state": "PENDING_APPROVAL",
  • "account": {
    },
  • "changeLog": {
    },
  • "href": "https://api.equinix.com/fabric/v4/serviceProfiles/ea4b5141-e4d2-49f1-9768-4ea6e215b37f",
  • "type": "L2_PROFILE",
  • "name": "Service Profile 1",
  • "uuid": "ea4b5141-e4d2-49f1-9768-4ea6e215b37f",
  • "description": "Sample_description",
  • "notifications": [
    ],
  • "visibility": "PUBLIC",
  • "allowedEmails": [
    ],
  • "accessPointTypeConfigs": [
    ],
  • "marketingInfo": {
    },
  • "ports": [
    ],
  • "metros": [
    ]
}

Profile Search

Search service profiles by search criteria

Authorizations:
BearerAuth
query Parameters
viewPoint
string
Default: "aSide"
Enum: "aSide" "zSide"

flips view between buyer and seller representation

Request Body schema: application/json
required
ServiceProfileSimpleExpression (object) or ServiceProfileAndFilter (object) (ServiceProfileFilter)
Any of
property
string

Possible field names to use on filters:

  • /name - Service Profile name
  • /uuid - Service Profile uuid
  • /state - Service Profile status
  • /metros/code - Service Profile metro code
  • /visibility - Service Profile package
  • /type - Service Profile package
  • /project/projectId - Service Profile project id
operator
string

Possible operators to use on filters:

  • = - equal
values
Array of strings
object (PaginationRequest)

Pagination request information

offset
integer >= 0
Default: 0

Index of the first element.

limit
integer >= 1
Default: 20

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

Array of objects (ServiceProfileSortCriteria)
Array
direction
string (ServiceProfileSortDirection)
Default: "DESC"
Enum: "DESC" "ASC"

Sorting direction

property
string (ServiceProfileSortBy)
Default: "/changeLog/updatedDateTime"
Enum: "/name" "/state" "/changeLog/createdDateTime" "/changeLog/updatedDateTime"

Possible field names to use on sorting

Responses

Response Schema: application/json; charset=UTF-8
Array of objects (ServiceProfile)
Array
state
string (ServiceProfileStateEnum)
Enum: "ACTIVE" "PENDING_APPROVAL" "DELETED" "REJECTED"

Equinix assigned state.

object

Seller Account for Service Profile.

object (Project)
object

Seller Account for Service Profile.

href
string <uri>

Service Profile URI response attribute

type
string (ServiceProfileTypeEnum)
Enum: "L2_PROFILE" "L3_PROFILE" "IA_PROFILE"

Service profile type

name
string <= 50 characters

Customer-assigned service profile name

uuid
string <uuid>

Equinix-assigned service profile identifier

description
string

User-provided service description should be of maximum length 375

Array of objects (SimplifiedNotification)

Recipients of notifications on service profile change

tags
Array of strings (Tags)
visibility
string (ServiceProfileVisibilityEnum)
Enum: "PRIVATE" "PUBLIC"
allowedEmails
Array of strings <email> [ items <email > ]
Array of ServiceProfileAccessPointTypeCOLO (object) or ServiceProfileAccessPointTypeVD (object) (ServiceProfileAccessPointType) non-empty
Array of objects (CustomField)
object (MarketingInfo)
Array of objects (ServiceProfileAccessPointCOLO)
Array of objects (ServiceProfileAccessPointVD)
Array of objects (ServiceMetro)

Derived response attribute.

selfProfile
boolean

response attribute indicates whether the profile belongs to the same organization as the api-invoker.

projectId
string
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Request samples

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

Response samples

Content type
application/json; charset=UTF-8
{
  • "data": [
    ],
  • "pagination": {
    }
}

Get Profile

Get service profile by UUID. View Point parameter if set to zSide will give seller's view of the profile otherwise buyer's view.

Authorizations:
BearerAuth
path Parameters
serviceProfileId
required
string <uuid> (ServiceProfileId)

Service Profile UUID

query Parameters
viewPoint
string
Default: "aSide"
Enum: "aSide" "zSide"

flips view between buyer and seller representation

Responses

Response Headers
ETag
string

response header - identifier for a specific version of a resource.

Response Schema: application/json; charset=UTF-8
state
string (ServiceProfileStateEnum)
Enum: "ACTIVE" "PENDING_APPROVAL" "DELETED" "REJECTED"

Equinix assigned state.

object

Seller Account for Service Profile.

accountNumber
integer <int64>

Account number

accountName
string

Account name

orgId
integer <int64>

Customer organization identifier

organizationName
string

Customer organization name

globalOrgId
string

Global organization identifier

globalOrganizationName
string

Global organization name

ucmId
string

Account ucmId

globalCustId
string

Account name

resellerAccountNumber
integer <int64>

Reseller account number

resellerAccountName
string

Reseller account name

resellerUcmId
string

Reseller account ucmId

resellerOrgId
integer <int64>

Reseller customer organization identifier

object (Project)
projectId
required
string

Subscriber-assigned project ID

object

Seller Account for Service Profile.

createdBy
string

Created by User Key

createdByFullName
string

Created by User Full Name

createdByEmail
string

Created by User Email Address

createdDateTime
string <date-time>

Created by Date and Time

updatedBy
string

Updated by User Key

updatedByFullName
string

Updated by User Full Name

updatedByEmail
string

Updated by User Email Address

updatedDateTime
string <date-time>

Updated by Date and Time

deletedBy
string

Deleted by User Key

deletedByFullName
string

Deleted by User Full Name

deletedByEmail
string

Deleted by User Email Address

deletedDateTime
string <date-time>

Deleted by Date and Time

href
string <uri>

Service Profile URI response attribute

type
string (ServiceProfileTypeEnum)
Enum: "L2_PROFILE" "L3_PROFILE" "IA_PROFILE"

Service profile type

name
string <= 50 characters

Customer-assigned service profile name

uuid
string <uuid>

Equinix-assigned service profile identifier

description
string

User-provided service description should be of maximum length 375

Array of objects (SimplifiedNotification)

Recipients of notifications on service profile change

Array
type
required
string
Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS"

Notification Type

sendInterval
string
emails
required
Array of strings <email> [ items <email > ]

Array of contact emails

registeredUsers
Array of strings

Array of registered users

tags
Array of strings (Tags)
visibility
string (ServiceProfileVisibilityEnum)
Enum: "PRIVATE" "PUBLIC"
allowedEmails
Array of strings <email> [ items <email > ]
Array of ServiceProfileAccessPointTypeCOLO (object) or ServiceProfileAccessPointTypeVD (object) (ServiceProfileAccessPointType) non-empty
Array (non-empty)
One of
uuid
string
type
required
string (ServiceProfileAccessPointTypeEnum)
Enum: "VD" "COLO"

Access point type

supportedBandwidths
Array of integers (Bandwidths)
allowRemoteConnections
boolean
Default: false

Setting to allow or prohibit remote connections to the service profile.

allowCustomBandwidth
boolean
Default: false

Setting to enable or disable the ability of the buyer to customize the bandwidth.

bandwidthAlertThreshold
number

percentage of port bandwidth at which an allocation alert is generated - missing on wiki.

allowBandwidthAutoApproval
boolean
Default: false

Setting to enable or disable the ability of the buyer to change connection bandwidth without approval of the seller.

allowBandwidthUpgrade
boolean

Availability of a bandwidth upgrade. The default is false.

object (ServiceProfileLinkProtocolConfig)

Configuration for dot1q to qinq translation support

enableAutoGenerateServiceKey
boolean

for verizon only.

connectionRedundancyRequired
boolean
Default: false

Mandate redundant connections

object (ApiConfig)

Configuration for API based Integration for Service Profile

connectionLabel
string

custom name for "Connection"

object (AuthenticationKey)

Authentication Key Support and Customization

object (ServiceProfileMetadata)

Metadata. Response attribute. Ignored on request payload.

Array of objects (CustomField)
Array
label
required
string
description
string
required
boolean
dataType
required
string
Enum: "STRING" "LIST" "NUMBER"
options
Array of strings
captureInEmail
boolean

capture this field as a part of email notification

object (MarketingInfo)
logo
string

Logo file name

promotion
boolean

Profile promotion on marketplace

Array of objects (ProcessStep) <= 3 items
Array (<= 3 items)
title
string

Service profile custom step title

subTitle
string

Service profile custom step sub title

description
string

Service profile custom step description

Array of objects (ServiceProfileAccessPointCOLO)
Array
type
required
string
Value: "XF_PORT"
uuid
required
string <uuid>
object (SimplifiedLocation)
sellerRegion
string
sellerRegionDescription
string
crossConnectId
string
Array of objects (ServiceProfileAccessPointVD)
Array
type
required
string
Value: "VD"
uuid
required
string <uuid>
object (SimplifiedLocation)
interfaceUuid
string <uuid>
Array of objects (ServiceMetro)

Derived response attribute.

Array
code
string

metro code

name
string

metro name

vcBandwidthMax
integer

max VC speed supported in Mbps

ibxs
Array of strings
inTrail
boolean
displayName
string

service metro display name

object
selfProfile
boolean

response attribute indicates whether the profile belongs to the same organization as the api-invoker.

projectId
string

Response samples

Content type
application/json; charset=UTF-8
Example
{
  • "state": "ACTIVE",
  • "account": {
    },
  • "changeLog": {
    },
  • "href": "https://api.equinix.com/fabric/v4/serviceProfiles/ea4b5141-e4d2-49f1-9768-4ea6e215b37f?viewPoint=aSide",
  • "type": "L2_PROFILE",
  • "name": "Service Profile 2",
  • "uuid": "ea4b5141-e4d2-49f1-9768-4ea6e215b37f",
  • "description": "Sample_description",
  • "visibility": "PUBLIC",
  • "allowedEmails": [
    ],
  • "accessPointTypeConfigs": [
    ],
  • "marketingInfo": {
    },
  • "metros": [
    ],
  • "selfProfile": true
}

Replace Profile

This API request replaces a service profile definition

Authorizations:
BearerAuth
path Parameters
serviceProfileId
required
string <uuid> (ServiceProfileId)

Service Profile UUID

header Parameters
If-Match
required
string

conditional request

Request Body schema: application/json
required
object (Project)
projectId
required
string

Subscriber-assigned project ID

type
required
string (ServiceProfileTypeEnum)
Enum: "L2_PROFILE" "L3_PROFILE" "IA_PROFILE"

Service profile type

name
required
string <= 50 characters

Customer-assigned service profile name

uuid
string <uuid>

Equinix-assigned service profile identifier

description
required
string

User-provided service description should be of maximum length 375

Array of objects (SimplifiedNotification)

Recipients of notifications on service profile change

Array
type
required
string
Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS"

Notification Type

sendInterval
string
emails
required
Array of strings <email> [ items <email > ]

Array of contact emails

registeredUsers
Array of strings

Array of registered users

tags
Array of strings (Tags)
visibility
string (ServiceProfileVisibilityEnum)
Enum: "PRIVATE" "PUBLIC"
allowedEmails
Array of strings <email> [ items <email > ]
Array of ServiceProfileAccessPointTypeCOLO (object) or ServiceProfileAccessPointTypeVD (object) (ServiceProfileAccessPointType) non-empty
Array (non-empty)
One of
uuid
string
type
required
string (ServiceProfileAccessPointTypeEnum)
Enum: "VD" "COLO"

Access point type

supportedBandwidths
Array of integers (Bandwidths)
allowRemoteConnections
boolean
Default: false

Setting to allow or prohibit remote connections to the service profile.

allowCustomBandwidth
boolean
Default: false

Setting to enable or disable the ability of the buyer to customize the bandwidth.

bandwidthAlertThreshold
number

percentage of port bandwidth at which an allocation alert is generated - missing on wiki.

allowBandwidthAutoApproval
boolean
Default: false

Setting to enable or disable the ability of the buyer to change connection bandwidth without approval of the seller.

allowBandwidthUpgrade
boolean

Availability of a bandwidth upgrade. The default is false.

object (ServiceProfileLinkProtocolConfig)

Configuration for dot1q to qinq translation support

enableAutoGenerateServiceKey
boolean

for verizon only.

connectionRedundancyRequired
boolean
Default: false

Mandate redundant connections

object (ApiConfig)

Configuration for API based Integration for Service Profile

connectionLabel
string

custom name for "Connection"

object (AuthenticationKey)

Authentication Key Support and Customization

object (ServiceProfileMetadata)

Metadata. Response attribute. Ignored on request payload.

Array of objects (CustomField)
Array
label
required
string
description
string
required
boolean
dataType
required
string
Enum: "STRING" "LIST" "NUMBER"
options
Array of strings
captureInEmail
boolean

capture this field as a part of email notification

object (MarketingInfo)
logo
string

Logo file name

promotion
boolean

Profile promotion on marketplace

Array of objects (ProcessStep) <= 3 items
Array (<= 3 items)
title
string

Service profile custom step title

subTitle
string

Service profile custom step sub title

description
string

Service profile custom step description

Array of objects (ServiceProfileAccessPointCOLO)
Array
type
required
string
Value: "XF_PORT"
uuid
required
string <uuid>
object (SimplifiedLocation)
sellerRegion
string
sellerRegionDescription
string
crossConnectId
string
Array of objects (ServiceProfileAccessPointVD)
Array
type
required
string
Value: "VD"
uuid
required
string <uuid>
object (SimplifiedLocation)
interfaceUuid
string <uuid>
Array of objects (ServiceMetro)

Derived response attribute.

Array
code
string

metro code

name
string

metro name

vcBandwidthMax
integer

max VC speed supported in Mbps

ibxs
Array of strings
inTrail
boolean
displayName
string

service metro display name

object
selfProfile
boolean

response attribute indicates whether the profile belongs to the same organization as the api-invoker.

projectId
string

Responses

Request samples

Content type
application/json
{
  • "name": "Service Profile 2",
  • "description": "Sample_description",
  • "type": "L2_PROFILE",
  • "notifications": [
    ],
  • "visibility": "PUBLIC",
  • "allowedEmails": [
    ],
  • "ports": [
    ],
  • "marketingInfo": {
    },
  • "accessPointTypeConfigs": [
    ]
}

Response samples

Content type
application/json; charset=UTF-8
{
  • "state": "ACTIVE",
  • "account": {
    },
  • "changeLog": {
    },
  • "href": "https://api.equinix.com/fabric/v4/serviceProfiles/ea4b5141-e4d2-49f1-9768-4ea6e215b37f",
  • "type": "L2_PROFILE",
  • "name": "Service Profile 2",
  • "uuid": "ea4b5141-e4d2-49f1-9768-4ea6e215b37f",
  • "description": "Sample_description",
  • "notifications": [
    ],
  • "visibility": "PUBLIC",
  • "allowedEmails": [
    ],
  • "accessPointTypeConfigs": [
    ],
  • "marketingInfo": {
    },
  • "ports": [
    ],
  • "metros": [
    ]
}

Delete Profile

delete Service Profile by UUID

Authorizations:
BearerAuth
path Parameters
serviceProfileId
required
string <uuid> (ServiceProfileId)

Service Profile UUID

Responses

Response Headers
ETag
string

response header - identifier for a specific version of a resource.

Response Schema: application/json; charset=UTF-8
state
string (ServiceProfileStateEnum)
Enum: "ACTIVE" "PENDING_APPROVAL" "DELETED" "REJECTED"

Equinix assigned state.

object

Seller Account for Service Profile.

accountNumber
integer <int64>

Account number

accountName
string

Account name

orgId
integer <int64>

Customer organization identifier

organizationName
string

Customer organization name

globalOrgId
string

Global organization identifier

globalOrganizationName
string

Global organization name

ucmId
string

Account ucmId

globalCustId
string

Account name

resellerAccountNumber
integer <int64>

Reseller account number

resellerAccountName
string

Reseller account name

resellerUcmId
string

Reseller account ucmId

resellerOrgId
integer <int64>

Reseller customer organization identifier

object (Project)
projectId
required
string

Subscriber-assigned project ID

object

Seller Account for Service Profile.

createdBy
string

Created by User Key

createdByFullName
string

Created by User Full Name

createdByEmail
string

Created by User Email Address

createdDateTime
string <date-time>

Created by Date and Time

updatedBy
string

Updated by User Key

updatedByFullName
string

Updated by User Full Name

updatedByEmail
string

Updated by User Email Address

updatedDateTime
string <date-time>

Updated by Date and Time

deletedBy
string

Deleted by User Key

deletedByFullName
string

Deleted by User Full Name

deletedByEmail
string

Deleted by User Email Address

deletedDateTime
string <date-time>

Deleted by Date and Time

href
string <uri>

Service Profile URI response attribute

type
string (ServiceProfileTypeEnum)
Enum: "L2_PROFILE" "L3_PROFILE" "IA_PROFILE"

Service profile type

name
string <= 50 characters

Customer-assigned service profile name

uuid
string <uuid>

Equinix-assigned service profile identifier

description
string

User-provided service description should be of maximum length 375

Array of objects (SimplifiedNotification)

Recipients of notifications on service profile change

Array
type
required
string
Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS"

Notification Type

sendInterval
string
emails
required
Array of strings <email> [ items <email > ]

Array of contact emails

registeredUsers
Array of strings

Array of registered users

tags
Array of strings (Tags)
visibility
string (ServiceProfileVisibilityEnum)
Enum: "PRIVATE" "PUBLIC"
allowedEmails
Array of strings <email> [ items <email > ]
Array of ServiceProfileAccessPointTypeCOLO (object) or ServiceProfileAccessPointTypeVD (object) (ServiceProfileAccessPointType) non-empty
Array (non-empty)
One of
uuid
string
type
required
string (ServiceProfileAccessPointTypeEnum)
Enum: "VD" "COLO"

Access point type

supportedBandwidths
Array of integers (Bandwidths)
allowRemoteConnections
boolean
Default: false

Setting to allow or prohibit remote connections to the service profile.

allowCustomBandwidth
boolean
Default: false

Setting to enable or disable the ability of the buyer to customize the bandwidth.

bandwidthAlertThreshold
number

percentage of port bandwidth at which an allocation alert is generated - missing on wiki.

allowBandwidthAutoApproval
boolean
Default: false

Setting to enable or disable the ability of the buyer to change connection bandwidth without approval of the seller.

allowBandwidthUpgrade
boolean

Availability of a bandwidth upgrade. The default is false.

object (ServiceProfileLinkProtocolConfig)

Configuration for dot1q to qinq translation support

enableAutoGenerateServiceKey
boolean

for verizon only.

connectionRedundancyRequired
boolean
Default: false

Mandate redundant connections

object (ApiConfig)

Configuration for API based Integration for Service Profile

connectionLabel
string

custom name for "Connection"

object (AuthenticationKey)

Authentication Key Support and Customization

object (ServiceProfileMetadata)

Metadata. Response attribute. Ignored on request payload.

Array of objects (CustomField)
Array
label
required
string
description
string
required
boolean
dataType
required
string
Enum: "STRING" "LIST" "NUMBER"
options
Array of strings
captureInEmail
boolean

capture this field as a part of email notification

object (MarketingInfo)
logo
string

Logo file name

promotion
boolean

Profile promotion on marketplace

Array of objects (ProcessStep) <= 3 items
Array (<= 3 items)
title
string

Service profile custom step title

subTitle
string

Service profile custom step sub title

description
string

Service profile custom step description

Array of objects (ServiceProfileAccessPointCOLO)
Array
type
required
string
Value: "XF_PORT"
uuid
required
string <uuid>
object (SimplifiedLocation)
sellerRegion
string
sellerRegionDescription
string
crossConnectId
string
Array of objects (ServiceProfileAccessPointVD)
Array
type
required
string
Value: "VD"
uuid
required
string <uuid>
object (SimplifiedLocation)
interfaceUuid
string <uuid>
Array of objects (ServiceMetro)

Derived response attribute.

Array
code
string

metro code

name
string

metro name

vcBandwidthMax
integer

max VC speed supported in Mbps

ibxs
Array of strings
inTrail
boolean
displayName
string

service metro display name

object
selfProfile
boolean

response attribute indicates whether the profile belongs to the same organization as the api-invoker.

projectId
string

Response samples

Content type
application/json; charset=UTF-8
{
  • "state": "DELETED",
  • "account": {
    },
  • "changeLog": {
    },
  • "href": "https://api.equinix.com/fabric/v4/serviceProfiles/ea4b5141-e4d2-49f1-9768-4ea6e215b37f",
  • "type": "L2_PROFILE",
  • "name": "Service Profile 2",
  • "uuid": "ea4b5141-e4d2-49f1-9768-4ea6e215b37f",
  • "description": "Sample_description",
  • "notifications": [
    ],
  • "tags": [
    ],
  • "visibility": "PUBLIC",
  • "allowedEmails": [
    ],
  • "accessPointTypeConfigs": [
    ],
  • "marketingInfo": {
    },
  • "ports": [
    ],
  • "metros": [
    ]
}

Update Profile

Update Service Profile by UUID

Authorizations:
BearerAuth
path Parameters
serviceProfileId
required
string <uuid> (ServiceProfileId)

Service Profile UUID

header Parameters
If-Match
required
string

conditional request

Request Body schema: application/json-patch+json
required
Array
One of
op
required
string (OpEnum)
Enum: "add" "remove" "replace"

the operation to be performed

path
required
string (Path)

A JSON Pointer path.

value
required
object

value to add

Responses

Response Headers
ETag
string

response header - identifier for a specific version of a resource.

Response Schema: application/json; charset=UTF-8
state
string (ServiceProfileStateEnum)
Enum: "ACTIVE" "PENDING_APPROVAL" "DELETED" "REJECTED"

Equinix assigned state.

object

Seller Account for Service Profile.

accountNumber
integer <int64>

Account number

accountName
string

Account name

orgId
integer <int64>

Customer organization identifier

organizationName
string

Customer organization name

globalOrgId
string

Global organization identifier

globalOrganizationName
string

Global organization name

ucmId
string

Account ucmId

globalCustId
string

Account name

resellerAccountNumber
integer <int64>

Reseller account number

resellerAccountName
string

Reseller account name

resellerUcmId
string

Reseller account ucmId

resellerOrgId
integer <int64>

Reseller customer organization identifier

object (Project)
projectId
required
string

Subscriber-assigned project ID

object

Seller Account for Service Profile.

createdBy
string

Created by User Key

createdByFullName
string

Created by User Full Name

createdByEmail
string

Created by User Email Address

createdDateTime
string <date-time>

Created by Date and Time

updatedBy
string

Updated by User Key

updatedByFullName
string

Updated by User Full Name

updatedByEmail
string

Updated by User Email Address

updatedDateTime
string <date-time>

Updated by Date and Time

deletedBy
string

Deleted by User Key

deletedByFullName
string

Deleted by User Full Name

deletedByEmail
string

Deleted by User Email Address

deletedDateTime
string <date-time>

Deleted by Date and Time

href
string <uri>

Service Profile URI response attribute

type
string (ServiceProfileTypeEnum)
Enum: "L2_PROFILE" "L3_PROFILE" "IA_PROFILE"

Service profile type

name
string <= 50 characters

Customer-assigned service profile name

uuid
string <uuid>

Equinix-assigned service profile identifier

description
string

User-provided service description should be of maximum length 375

Array of objects (SimplifiedNotification)

Recipients of notifications on service profile change

Array
type
required
string
Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS"

Notification Type

sendInterval
string
emails
required
Array of strings <email> [ items <email > ]

Array of contact emails

registeredUsers
Array of strings

Array of registered users

tags
Array of strings (Tags)
visibility
string (ServiceProfileVisibilityEnum)
Enum: "PRIVATE" "PUBLIC"
allowedEmails
Array of strings <email> [ items <email > ]
Array of ServiceProfileAccessPointTypeCOLO (object) or ServiceProfileAccessPointTypeVD (object) (ServiceProfileAccessPointType) non-empty
Array (non-empty)
One of
uuid
string
type
required
string (ServiceProfileAccessPointTypeEnum)
Enum: "VD" "COLO"

Access point type

supportedBandwidths
Array of integers (Bandwidths)
allowRemoteConnections
boolean
Default: false

Setting to allow or prohibit remote connections to the service profile.

allowCustomBandwidth
boolean
Default: false

Setting to enable or disable the ability of the buyer to customize the bandwidth.

bandwidthAlertThreshold
number

percentage of port bandwidth at which an allocation alert is generated - missing on wiki.

allowBandwidthAutoApproval
boolean
Default: false

Setting to enable or disable the ability of the buyer to change connection bandwidth without approval of the seller.

allowBandwidthUpgrade
boolean

Availability of a bandwidth upgrade. The default is false.

object (ServiceProfileLinkProtocolConfig)

Configuration for dot1q to qinq translation support

enableAutoGenerateServiceKey
boolean

for verizon only.

connectionRedundancyRequired
boolean
Default: false

Mandate redundant connections

object (ApiConfig)

Configuration for API based Integration for Service Profile

connectionLabel
string

custom name for "Connection"

object (AuthenticationKey)

Authentication Key Support and Customization

object (ServiceProfileMetadata)

Metadata. Response attribute. Ignored on request payload.

Array of objects (CustomField)
Array
label
required
string
description
string
required
boolean
dataType
required
string
Enum: "STRING" "LIST" "NUMBER"
options
Array of strings
captureInEmail
boolean

capture this field as a part of email notification

object (MarketingInfo)
logo
string

Logo file name

promotion
boolean

Profile promotion on marketplace

Array of objects (ProcessStep) <= 3 items
Array (<= 3 items)
title
string

Service profile custom step title

subTitle
string

Service profile custom step sub title

description
string

Service profile custom step description

Array of objects (ServiceProfileAccessPointCOLO)
Array
type
required
string
Value: "XF_PORT"
uuid
required
string <uuid>
object (SimplifiedLocation)
sellerRegion
string
sellerRegionDescription
string
crossConnectId
string
Array of objects (ServiceProfileAccessPointVD)
Array
type
required
string
Value: "VD"
uuid
required
string <uuid>
object (SimplifiedLocation)
interfaceUuid
string <uuid>
Array of objects (ServiceMetro)

Derived response attribute.

Array
code
string

metro code

name
string

metro name

vcBandwidthMax
integer

max VC speed supported in Mbps

ibxs
Array of strings
inTrail
boolean
displayName
string

service metro display name

object
selfProfile
boolean

response attribute indicates whether the profile belongs to the same organization as the api-invoker.

projectId
string

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
application/json; charset=UTF-8
{
  • "state": "ACTIVE",
  • "account": {
    },
  • "changeLog": {
    },
  • "href": "https://api.equinix.com/fabric/v4/serviceProfiles/ea4b5141-e4d2-49f1-9768-4ea6e215b37f",
  • "type": "L2_PROFILE",
  • "name": "Service Profile 2",
  • "uuid": "ea4b5141-e4d2-49f1-9768-4ea6e215b37f",
  • "description": "Sample_description",
  • "notifications": [
    ],
  • "visibility": "PUBLIC",
  • "tags": [
    ],
  • "allowedEmails": [
    ],
  • "accessPointTypeConfigs": [
    ],
  • "marketingInfo": {
    },
  • "ports": [
    ],
  • "metros": [
    ]
}

Get Profile Metros

Get service profile metros by UUID.

Authorizations:
BearerAuth
path Parameters
serviceProfileId
required
string <uuid> (ServiceProfileId)

Service Profile UUID

query Parameters
offset
integer
Example: offset=1

offset

limit
integer
Example: limit=10

number of records to fetch

Responses

Response Schema: application/json; charset=UTF-8
Array of objects (ServiceMetro)
Array
code
string

metro code

name
string

metro name

vcBandwidthMax
integer

max VC speed supported in Mbps

ibxs
Array of strings
inTrail
boolean
displayName
string

service metro display name

object
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Response samples

Content type
application/json; charset=UTF-8
{
  • "data": [
    ],
  • "pagination": {
    }
}

Service Tokens

Service Tokens

Get Token by uuid

Get Specified Service Tokens uses the uuid of an Equinix Fabric service token to return details about the token's type, state, location, bandwidth, and other key properties.

Authorizations:
BearerAuth
path Parameters
serviceTokenId
required
string <uuid> (ServiceTokenUUID)

Service Token UUID

Responses

Response Schema: application/json
type
string (ServiceTokenType)
Enum: "VC_TOKEN" "EPL_TOKEN"

Type of Service Token

href
string <uri>

An absolute URL that is the subject of the link's context.

expiry
integer
Deprecated
uuid
string <uuid>

Equinix-assigned service token identifier

issuerSide
string
Deprecated

information about token side

name
string

Customer-provided service token name

description
string

Customer-provided service token description

expirationDateTime
string <date-time>

Expiration date and time of the service token.

object (ServiceTokenConnection)

Service Token Connection Type Information

type
string
Enum: "EVPL_VC" "EPL_VC" "EVPLAN_VC" "EPLAN_VC" "IPWAN_VC" "IP_VC"

Type of Connection

href
string <uri>

An absolute URL that is the subject of the link's context.

uuid
string <uuid>

Equinix-assigned connection identifier

allowRemoteConnection
boolean
Default: false

Authorization to connect remotely

allowCustomBandwidth
boolean
Default: false

Allow custom bandwidth value

bandwidthLimit
integer [ 0 .. 100000 ]

Connection bandwidth limit in Mbps

supportedBandwidths
Array of integers

List of permitted bandwidths.

object (ServiceTokenSide)

Connection link protocol,virtual device or network configuration

Array of objects (AccessPointSelector)

List of AccessPointSelectors

Array
type
string
Enum: "COLO" "VD" "NETWORK"

Type of Access point

hideAssetInfo
boolean
Deprecated
object (SimplifiedMetadataEntity)

Configuration details for port used at the access point.

object (SimplifiedLinkProtocol)

Connection link protocol Configuration

object (SimplifiedVirtualDevice)
object (VirtualDeviceInterface)

Virtual Device Interface Information

object (SimplifiedTokenNetwork)
object (ServiceTokenSide)

Connection link protocol,virtual device or network configuration

Array of objects (AccessPointSelector)

List of AccessPointSelectors

Array
type
string
Enum: "COLO" "VD" "NETWORK"

Type of Access point

hideAssetInfo
boolean
Deprecated
object (SimplifiedMetadataEntity)

Configuration details for port used at the access point.

object (SimplifiedLinkProtocol)

Connection link protocol Configuration

object (SimplifiedVirtualDevice)
object (VirtualDeviceInterface)

Virtual Device Interface Information

object (SimplifiedTokenNetwork)
state
string (ServiceTokenState)
Enum: "ACTIVE" "INACTIVE" "EXPIRED" "DELETED"

Service token state

Array of objects (SimplifiedNotification)

Service token related notifications

Array
type
required
string
Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS"

Notification Type

sendInterval
string
emails
required
Array of strings <email> [ items <email > ]

Array of contact emails

registeredUsers
Array of strings

Array of registered users

object (SimplifiedAccount)
accountNumber
integer <int64>

Account number

accountName
string

Account name

orgId
integer <int64>

Customer organization identifier

organizationName
string

Customer organization name

globalOrgId
string

Global organization identifier

globalOrganizationName
string

Global organization name

ucmId
string

Account ucmId

globalCustId
string

Account name

resellerAccountNumber
integer <int64>

Reseller account number

resellerAccountName
string

Reseller account name

resellerUcmId
string

Reseller account ucmId

resellerOrgId
integer <int64>

Reseller customer organization identifier

object (Changelog)

Change log

createdBy
string

Created by User Key

createdByFullName
string

Created by User Full Name

createdByEmail
string

Created by User Email Address

createdDateTime
string <date-time>

Created by Date and Time

updatedBy
string

Updated by User Key

updatedByFullName
string

Updated by User Full Name

updatedByEmail
string

Updated by User Email Address

updatedDateTime
string <date-time>

Updated by Date and Time

deletedBy
string

Deleted by User Key

deletedByFullName
string

Deleted by User Full Name

deletedByEmail
string

Deleted by User Email Address

deletedDateTime
string <date-time>

Deleted by Date and Time

object (Project)
projectId
required
string

Subscriber-assigned project ID

Response samples

Content type
application/json
Example
{
  • "href": "https://api.equinix.com/fabric/v4/serviceTokens/13ab7dc7-c18e-4f73-aa35-fc3a83966e79",
  • "type": "VC_TOKEN",
  • "uuid": "13ab7dc7-c18e-4f73-aa35-fc3a83966e79",
  • "name": "Az_Aside_Dot1Q_Pri_SV",
  • "description": "Az_Aside_Dot1Q_Pri_SV_Description",
  • "state": "INACTIVE",
  • "expirationDateTime": "2021-03-18T06:43:49.980Z",
  • "connection": {
    },
  • "notifications": [
    ],
  • "account": {
    },
  • "changeLog": {
    },
  • "project": {
    }
}

Delete Token by uuid

Delete Service Tokens removes an Equinix Fabric service token corresponding to the specified uuid which are in INACTIVE state.

Authorizations:
BearerAuth
path Parameters
serviceTokenId
required
string <uuid> (ServiceTokenUUID)

Service Token UUID

Responses

Response Schema: application/json
type
string (ServiceTokenType)
Enum: "VC_TOKEN" "EPL_TOKEN"

Type of Service Token

href
string <uri>

An absolute URL that is the subject of the link's context.

expiry
integer
Deprecated
uuid
string <uuid>

Equinix-assigned service token identifier

issuerSide
string
Deprecated

information about token side

name
string

Customer-provided service token name

description
string

Customer-provided service token description

expirationDateTime
string <date-time>

Expiration date and time of the service token.

object (ServiceTokenConnection)

Service Token Connection Type Information

type
string
Enum: "EVPL_VC" "EPL_VC" "EVPLAN_VC" "EPLAN_VC" "IPWAN_VC" "IP_VC"

Type of Connection

href
string <uri>

An absolute URL that is the subject of the link's context.

uuid
string <uuid>

Equinix-assigned connection identifier

allowRemoteConnection
boolean
Default: false

Authorization to connect remotely

allowCustomBandwidth
boolean
Default: false

Allow custom bandwidth value

bandwidthLimit
integer [ 0 .. 100000 ]

Connection bandwidth limit in Mbps

supportedBandwidths
Array of integers

List of permitted bandwidths.

object (ServiceTokenSide)

Connection link protocol,virtual device or network configuration

Array of objects (AccessPointSelector)

List of AccessPointSelectors

Array
type
string
Enum: "COLO" "VD" "NETWORK"

Type of Access point

hideAssetInfo
boolean
Deprecated
object (SimplifiedMetadataEntity)

Configuration details for port used at the access point.

object (SimplifiedLinkProtocol)

Connection link protocol Configuration

object (SimplifiedVirtualDevice)
object (VirtualDeviceInterface)

Virtual Device Interface Information

object (SimplifiedTokenNetwork)
object (ServiceTokenSide)

Connection link protocol,virtual device or network configuration

Array of objects (AccessPointSelector)

List of AccessPointSelectors

Array
type
string
Enum: "COLO" "VD" "NETWORK"

Type of Access point

hideAssetInfo
boolean
Deprecated
object (SimplifiedMetadataEntity)

Configuration details for port used at the access point.

object (SimplifiedLinkProtocol)

Connection link protocol Configuration

object (SimplifiedVirtualDevice)
object (VirtualDeviceInterface)

Virtual Device Interface Information

object (SimplifiedTokenNetwork)
state
string (ServiceTokenState)
Enum: "ACTIVE" "INACTIVE" "EXPIRED" "DELETED"

Service token state

Array of objects (SimplifiedNotification)

Service token related notifications

Array
type
required
string
Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS"

Notification Type

sendInterval
string
emails
required
Array of strings <email> [ items <email > ]

Array of contact emails

registeredUsers
Array of strings

Array of registered users

object (SimplifiedAccount)
accountNumber
integer <int64>

Account number

accountName
string

Account name

orgId
integer <int64>

Customer organization identifier

organizationName
string

Customer organization name

globalOrgId
string

Global organization identifier

globalOrganizationName
string

Global organization name

ucmId
string

Account ucmId

globalCustId
string

Account name

resellerAccountNumber
integer <int64>

Reseller account number

resellerAccountName
string

Reseller account name

resellerUcmId
string

Reseller account ucmId

resellerOrgId
integer <int64>

Reseller customer organization identifier

object (Changelog)

Change log

createdBy
string

Created by User Key

createdByFullName
string

Created by User Full Name

createdByEmail
string

Created by User Email Address

createdDateTime
string <date-time>

Created by Date and Time

updatedBy
string

Updated by User Key

updatedByFullName
string

Updated by User Full Name

updatedByEmail
string

Updated by User Email Address

updatedDateTime
string <date-time>

Updated by Date and Time

deletedBy
string

Deleted by User Key

deletedByFullName
string

Deleted by User Full Name

deletedByEmail
string

Deleted by User Email Address

deletedDateTime
string <date-time>

Deleted by Date and Time

object (Project)
projectId
required
string

Subscriber-assigned project ID

Response samples

Content type
application/json
Example
{
  • "href": "https://api.equinix.com/fabric/v4/serviceTokens/13ab7dc7-c18e-4f73-aa35-fc3a83966e79",
  • "type": "VC_TOKEN",
  • "uuid": "13ab7dc7-c18e-4f73-aa35-fc3a83966e79",
  • "name": "Az_Aside_Dot1Q_Pri_SV",
  • "description": "Az_Aside_Dot1Q_Pri_SV_Description",
  • "state": "INACTIVE",
  • "expirationDateTime": "2021-03-18T06:43:49.980Z",
  • "connection": {
    },
  • "notifications": [
    ],
  • "account": {
    },
  • "changeLog": {
    },
  • "project": {
    }
}

Update Token By ID

This API provides capability to update user's Service Token

Authorizations:
BearerAuth
path Parameters
serviceTokenId
required
string <uuid> (ServiceTokenUUID)

Service Token UUID

query Parameters
dryRun
boolean
Default: false

option to verify that API calls will succeed

Request Body schema: application/json-patch+json
required
Array (non-empty)
op
required
string
Enum: "replace" "add" "remove"

Handy shortcut for operation name

path
required
string

path inside document leading to updated parameter

value
required
object

new value for updated parameter

Responses

Response Schema: application/json
type
string (ServiceTokenType)
Enum: "VC_TOKEN" "EPL_TOKEN"

Type of Service Token

href
string <uri>

An absolute URL that is the subject of the link's context.

expiry
integer
Deprecated
uuid
string <uuid>

Equinix-assigned service token identifier

issuerSide
string
Deprecated

information about token side

name
string

Customer-provided service token name

description
string

Customer-provided service token description

expirationDateTime
string <date-time>

Expiration date and time of the service token.

object (ServiceTokenConnection)

Service Token Connection Type Information

type
string
Enum: "EVPL_VC" "EPL_VC" "EVPLAN_VC" "EPLAN_VC" "IPWAN_VC" "IP_VC"

Type of Connection

href
string <uri>

An absolute URL that is the subject of the link's context.

uuid
string <uuid>

Equinix-assigned connection identifier

allowRemoteConnection
boolean
Default: false

Authorization to connect remotely

allowCustomBandwidth
boolean
Default: false

Allow custom bandwidth value

bandwidthLimit
integer [ 0 .. 100000 ]

Connection bandwidth limit in Mbps

supportedBandwidths
Array of integers

List of permitted bandwidths.

object (ServiceTokenSide)

Connection link protocol,virtual device or network configuration

Array of objects (AccessPointSelector)

List of AccessPointSelectors

Array
type
string
Enum: "COLO" "VD" "NETWORK"

Type of Access point

hideAssetInfo
boolean
Deprecated
object (SimplifiedMetadataEntity)

Configuration details for port used at the access point.

object (SimplifiedLinkProtocol)

Connection link protocol Configuration

object (SimplifiedVirtualDevice)
object (VirtualDeviceInterface)

Virtual Device Interface Information

object (SimplifiedTokenNetwork)
object (ServiceTokenSide)

Connection link protocol,virtual device or network configuration

Array of objects (AccessPointSelector)

List of AccessPointSelectors

Array
type
string
Enum: "COLO" "VD" "NETWORK"

Type of Access point

hideAssetInfo
boolean
Deprecated
object (SimplifiedMetadataEntity)

Configuration details for port used at the access point.

object (SimplifiedLinkProtocol)

Connection link protocol Configuration

object (SimplifiedVirtualDevice)
object (VirtualDeviceInterface)

Virtual Device Interface Information

object (SimplifiedTokenNetwork)
state
string (ServiceTokenState)
Enum: "ACTIVE" "INACTIVE" "EXPIRED" "DELETED"

Service token state

Array of objects (SimplifiedNotification)

Service token related notifications

Array
type
required
string
Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS"

Notification Type

sendInterval
string
emails
required
Array of strings <email> [ items <email > ]

Array of contact emails

registeredUsers
Array of strings

Array of registered users

object (SimplifiedAccount)
accountNumber
integer <int64>

Account number

accountName
string

Account name

orgId
integer <int64>

Customer organization identifier

organizationName
string

Customer organization name

globalOrgId
string

Global organization identifier

globalOrganizationName
string

Global organization name

ucmId
string

Account ucmId

globalCustId
string

Account name

resellerAccountNumber
integer <int64>

Reseller account number

resellerAccountName
string

Reseller account name

resellerUcmId
string

Reseller account ucmId

resellerOrgId
integer <int64>

Reseller customer organization identifier

object (Changelog)

Change log

createdBy
string

Created by User Key

createdByFullName
string

Created by User Full Name

createdByEmail
string

Created by User Email Address

createdDateTime
string <date-time>

Created by Date and Time

updatedBy
string

Updated by User Key

updatedByFullName
string

Updated by User Full Name

updatedByEmail
string

Updated by User Email Address

updatedDateTime
string <date-time>

Updated by Date and Time

deletedBy
string

Deleted by User Key

deletedByFullName
string

Deleted by User Full Name

deletedByEmail
string

Deleted by User Email Address

deletedDateTime
string <date-time>

Deleted by Date and Time

object (Project)
projectId
required
string

Subscriber-assigned project ID

Request samples

Content type
application/json-patch+json
Example
[
  • {
    }
]

Response samples

Content type
application/json
Example
{
  • "href": "https://api.equinix.com/fabric/v4/serviceTokens/13ab7dc7-c18e-4f73-aa35-fc3a83966e79",
  • "type": "VC_TOKEN",
  • "uuid": "13ab7dc7-c18e-4f73-aa35-fc3a83966e79",
  • "name": "Az_Aside_Dot1Q_Pri_SV",
  • "description": "Az_Aside_Dot1Q_Pri_SV_Description",
  • "state": "INACTIVE",
  • "expirationDateTime": "2021-03-18T06:43:49.980Z",
  • "connection": {
    },
  • "notifications": [
    ],
  • "account": {
    },
  • "changeLog": {
    },
  • "project": {
    }
}

Get All Tokens

Get All ServiceTokens creates a list of all Equinix Fabric service tokens associated with the subscriber's account.

Authorizations:
BearerAuth
query Parameters
offset
number

offset

limit
number

number of records to fetch

Responses

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

List of Service Tokens

Array
type
string (ServiceTokenType)
Enum: "VC_TOKEN" "EPL_TOKEN"

Type of Service Token

href
string <uri>

An absolute URL that is the subject of the link's context.

expiry
integer
Deprecated
uuid
string <uuid>

Equinix-assigned service token identifier

issuerSide
string
Deprecated

information about token side

name
string

Customer-provided service token name

description
string

Customer-provided service token description

expirationDateTime
string <date-time>

Expiration date and time of the service token.

object (ServiceTokenConnection)

Service Token Connection Type Information

state
string (ServiceTokenState)
Enum: "ACTIVE" "INACTIVE" "EXPIRED" "DELETED"

Service token state

Array of objects (SimplifiedNotification)

Service token related notifications

object (SimplifiedAccount)
object (Changelog)

Change log

object (Project)
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Response samples

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

Create Service Token

Create Service Tokens generates Equinix Fabric? service tokens. These tokens authorize users to access protected resources and services.

Authorizations:
BearerAuth
query Parameters
dryRun
boolean
Default: false

option to verify that API calls will succeed

Request Body schema: application/json
required
type
string (ServiceTokenType)
Enum: "VC_TOKEN" "EPL_TOKEN"

Type of Service Token

expiry
integer
Deprecated
uuid
string <uuid>

Equinix-assigned service token identifier

issuerSide
string
Deprecated

information about token side

name
string

Customer-provided service token name

description
string

Customer-provided service token description

expirationDateTime
string <date-time>

Expiration date and time of the service token.

object (ServiceTokenConnection)

Service Token Connection Type Information

type
string
Enum: "EVPL_VC" "EPL_VC" "EVPLAN_VC" "EPLAN_VC" "IPWAN_VC" "IP_VC"

Type of Connection

uuid
string <uuid>

Equinix-assigned connection identifier

allowRemoteConnection
boolean
Default: false

Authorization to connect remotely

allowCustomBandwidth
boolean
Default: false

Allow custom bandwidth value

bandwidthLimit
integer [ 0 .. 100000 ]

Connection bandwidth limit in Mbps

supportedBandwidths
Array of integers

List of permitted bandwidths.

object (ServiceTokenSide)

Connection link protocol,virtual device or network configuration

Array of objects (AccessPointSelector)

List of AccessPointSelectors

Array
type
string
Enum: "COLO" "VD" "NETWORK"

Type of Access point

hideAssetInfo
boolean
Deprecated
object (SimplifiedMetadataEntity)

Configuration details for port used at the access point.

object (SimplifiedLinkProtocol)

Connection link protocol Configuration

object (SimplifiedVirtualDevice)
object (VirtualDeviceInterface)

Virtual Device Interface Information

object (SimplifiedTokenNetwork)
object (ServiceTokenSide)

Connection link protocol,virtual device or network configuration

Array of objects (AccessPointSelector)

List of AccessPointSelectors

Array
type
string
Enum: "COLO" "VD" "NETWORK"

Type of Access point

hideAssetInfo
boolean
Deprecated
object (SimplifiedMetadataEntity)

Configuration details for port used at the access point.

object (SimplifiedLinkProtocol)

Connection link protocol Configuration

object (SimplifiedVirtualDevice)
object (VirtualDeviceInterface)

Virtual Device Interface Information

object (SimplifiedTokenNetwork)
state
string (ServiceTokenState)
Enum: "ACTIVE" "INACTIVE" "EXPIRED" "DELETED"

Service token state

Array of objects (SimplifiedNotification)

Service token related notifications

Array
type
required
string
Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS"

Notification Type

sendInterval
string
emails
required
Array of strings <email> [ items <email > ]

Array of contact emails

registeredUsers
Array of strings

Array of registered users

object (SimplifiedAccount)
accountNumber
integer <int64>

Account number

accountName
string

Account name

orgId
integer <int64>

Customer organization identifier

organizationName
string

Customer organization name

globalOrgId
string

Global organization identifier

globalOrganizationName
string

Global organization name

ucmId
string

Account ucmId

globalCustId
string

Account name

resellerAccountNumber
integer <int64>

Reseller account number

resellerAccountName
string

Reseller account name

resellerUcmId
string

Reseller account ucmId

resellerOrgId
integer <int64>

Reseller customer organization identifier

object (Changelog)

Change log

createdBy
string

Created by User Key

createdByFullName
string

Created by User Full Name

createdByEmail
string

Created by User Email Address

createdDateTime
string <date-time>

Created by Date and Time

updatedBy
string

Updated by User Key

updatedByFullName
string

Updated by User Full Name

updatedByEmail
string

Updated by User Email Address

updatedDateTime
string <date-time>

Updated by Date and Time

deletedBy
string

Deleted by User Key

deletedByFullName
string

Deleted by User Full Name

deletedByEmail
string

Deleted by User Email Address

deletedDateTime
string <date-time>

Deleted by Date and Time

object (Project)
projectId
required
string

Subscriber-assigned project ID

Responses

Response Schema: application/json
type
string (ServiceTokenType)
Enum: "VC_TOKEN" "EPL_TOKEN"

Type of Service Token

href
string <uri>

An absolute URL that is the subject of the link's context.

expiry
integer
Deprecated
uuid
string <uuid>

Equinix-assigned service token identifier

issuerSide
string
Deprecated

information about token side

name
string

Customer-provided service token name

description
string

Customer-provided service token description

expirationDateTime
string <date-time>

Expiration date and time of the service token.

object (ServiceTokenConnection)

Service Token Connection Type Information

type
string
Enum: "EVPL_VC" "EPL_VC" "EVPLAN_VC" "EPLAN_VC" "IPWAN_VC" "IP_VC"

Type of Connection

href
string <uri>

An absolute URL that is the subject of the link's context.

uuid
string <uuid>

Equinix-assigned connection identifier

allowRemoteConnection
boolean
Default: false

Authorization to connect remotely

allowCustomBandwidth
boolean
Default: false

Allow custom bandwidth value

bandwidthLimit
integer [ 0 .. 100000 ]

Connection bandwidth limit in Mbps

supportedBandwidths
Array of integers

List of permitted bandwidths.

object (ServiceTokenSide)

Connection link protocol,virtual device or network configuration

Array of objects (AccessPointSelector)

List of AccessPointSelectors

Array
type
string
Enum: "COLO" "VD" "NETWORK"

Type of Access point

hideAssetInfo
boolean
Deprecated
object (SimplifiedMetadataEntity)

Configuration details for port used at the access point.

object (SimplifiedLinkProtocol)

Connection link protocol Configuration

object (SimplifiedVirtualDevice)
object (VirtualDeviceInterface)

Virtual Device Interface Information

object (SimplifiedTokenNetwork)
object (ServiceTokenSide)

Connection link protocol,virtual device or network configuration

Array of objects (AccessPointSelector)

List of AccessPointSelectors

Array
type
string
Enum: "COLO" "VD" "NETWORK"

Type of Access point

hideAssetInfo
boolean
Deprecated
object (SimplifiedMetadataEntity)

Configuration details for port used at the access point.

object (SimplifiedLinkProtocol)

Connection link protocol Configuration

object (SimplifiedVirtualDevice)
object (VirtualDeviceInterface)

Virtual Device Interface Information

object (SimplifiedTokenNetwork)
state
string (ServiceTokenState)
Enum: "ACTIVE" "INACTIVE" "EXPIRED" "DELETED"

Service token state

Array of objects (SimplifiedNotification)

Service token related notifications

Array
type
required
string
Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS"

Notification Type

sendInterval
string
emails
required
Array of strings <email> [ items <email > ]

Array of contact emails

registeredUsers
Array of strings

Array of registered users

object (SimplifiedAccount)
accountNumber
integer <int64>

Account number

accountName
string

Account name

orgId
integer <int64>

Customer organization identifier

organizationName
string

Customer organization name

globalOrgId
string

Global organization identifier

globalOrganizationName
string

Global organization name

ucmId
string

Account ucmId

globalCustId
string

Account name

resellerAccountNumber
integer <int64>

Reseller account number

resellerAccountName
string

Reseller account name

resellerUcmId
string

Reseller account ucmId

resellerOrgId
integer <int64>

Reseller customer organization identifier

object (Changelog)

Change log

createdBy
string

Created by User Key

createdByFullName
string

Created by User Full Name

createdByEmail
string

Created by User Email Address

createdDateTime
string <date-time>

Created by Date and Time

updatedBy
string

Updated by User Key

updatedByFullName
string

Updated by User Full Name

updatedByEmail
string

Updated by User Email Address

updatedDateTime
string <date-time>

Updated by Date and Time

deletedBy
string

Deleted by User Key

deletedByFullName
string

Deleted by User Full Name

deletedByEmail
string

Deleted by User Email Address

deletedDateTime
string <date-time>

Deleted by Date and Time

object (Project)
projectId
required
string

Subscriber-assigned project ID

Response Schema: application/json
type
string (ServiceTokenType)
Enum: "VC_TOKEN" "EPL_TOKEN"

Type of Service Token

href
string <uri>

An absolute URL that is the subject of the link's context.

expiry
integer
Deprecated
uuid
string <uuid>

Equinix-assigned service token identifier

issuerSide
string
Deprecated

information about token side

name
string

Customer-provided service token name

description
string

Customer-provided service token description

expirationDateTime
string <date-time>

Expiration date and time of the service token.

object (ServiceTokenConnection)

Service Token Connection Type Information

type
string
Enum: "EVPL_VC" "EPL_VC" "EVPLAN_VC" "EPLAN_VC" "IPWAN_VC" "IP_VC"

Type of Connection

href
string <uri>

An absolute URL that is the subject of the link's context.

uuid
string <uuid>

Equinix-assigned connection identifier

allowRemoteConnection
boolean
Default: false

Authorization to connect remotely

allowCustomBandwidth
boolean
Default: false

Allow custom bandwidth value

bandwidthLimit
integer [ 0 .. 100000 ]

Connection bandwidth limit in Mbps

supportedBandwidths
Array of integers

List of permitted bandwidths.

object (ServiceTokenSide)

Connection link protocol,virtual device or network configuration

Array of objects (AccessPointSelector)

List of AccessPointSelectors

Array
type
string
Enum: "COLO" "VD" "NETWORK"

Type of Access point

hideAssetInfo
boolean
Deprecated
object (SimplifiedMetadataEntity)

Configuration details for port used at the access point.

object (SimplifiedLinkProtocol)

Connection link protocol Configuration

object (SimplifiedVirtualDevice)
object (VirtualDeviceInterface)

Virtual Device Interface Information

object (SimplifiedTokenNetwork)
object (ServiceTokenSide)

Connection link protocol,virtual device or network configuration

Array of objects (AccessPointSelector)

List of AccessPointSelectors

Array
type
string
Enum: "COLO" "VD" "NETWORK"

Type of Access point

hideAssetInfo
boolean
Deprecated
object (SimplifiedMetadataEntity)

Configuration details for port used at the access point.

object (SimplifiedLinkProtocol)

Connection link protocol Configuration

object (SimplifiedVirtualDevice)
object (VirtualDeviceInterface)

Virtual Device Interface Information

object (SimplifiedTokenNetwork)
state
string (ServiceTokenState)
Enum: "ACTIVE" "INACTIVE" "EXPIRED" "DELETED"

Service token state

Array of objects (SimplifiedNotification)

Service token related notifications

Array
type
required
string
Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS"

Notification Type

sendInterval
string
emails
required
Array of strings <email> [ items <email > ]

Array of contact emails

registeredUsers
Array of strings

Array of registered users

object (SimplifiedAccount)
accountNumber
integer <int64>

Account number

accountName
string

Account name

orgId
integer <int64>

Customer organization identifier

organizationName
string

Customer organization name

globalOrgId
string

Global organization identifier

globalOrganizationName
string

Global organization name

ucmId
string

Account ucmId

globalCustId
string

Account name

resellerAccountNumber
integer <int64>

Reseller account number

resellerAccountName
string

Reseller account name

resellerUcmId
string

Reseller account ucmId

resellerOrgId
integer <int64>

Reseller customer organization identifier

object (Changelog)

Change log

createdBy
string

Created by User Key

createdByFullName
string

Created by User Full Name

createdByEmail
string

Created by User Email Address

createdDateTime
string <date-time>

Created by Date and Time

updatedBy
string

Updated by User Key

updatedByFullName
string

Updated by User Full Name

updatedByEmail
string

Updated by User Email Address

updatedDateTime
string <date-time>

Updated by Date and Time

deletedBy
string

Deleted by User Key

deletedByFullName
string

Deleted by User Full Name

deletedByEmail
string

Deleted by User Email Address

deletedDateTime
string <date-time>

Deleted by Date and Time

object (Project)
projectId
required
string

Subscriber-assigned project ID

Request samples

Content type
application/json
Example
{
  • "type": "VC_TOKEN",
  • "name": "Az_Aside_Dot1Q_Pri_SV",
  • "description": "Az_Aside_Dot1Q_Pri_SV_Description",
  • "expirationDateTime": "2021-03-18T06:43:49.980Z",
  • "connection": {
    },
  • "notifications": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "VC_TOKEN",
  • "name": "Aside_Dot1Q_Service_Token",
  • "description": "Az_Aside_Dot1Q_DryRun_Description",
  • "expirationDateTime": "2024-12-18T06:43:49.980Z",
  • "connection": {},
  • "notifications": [
    ]
}

ServiceToken Actions

This API provides capability to accept/reject user's servicetokens

Authorizations:
BearerAuth
path Parameters
serviceTokenId
required
string <uuid> (ServiceTokenUUID)

Service Token UUID

Request Body schema: application/json
required
type
required
string (ServiceTokenActions)
Value: "RESEND_EMAIL_NOTIFICATION"

Service Token action type

Responses

Request samples

Content type
application/json
{
  • "type": "RESEND_EMAIL_NOTIFICATION"
}

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/serviceTokens/13ab7dc7-c18e-4f73-aa35-fc3a83966e79",
  • "type": "VC_TOKEN",
  • "uuid": "13ab7dc7-c18e-4f73-aa35-fc3a83966e79",
  • "name": "Az_Aside_Dot1Q_Pri_SV",
  • "description": "Az_Aside_Dot1Q_Pri_SV_Description",
  • "state": "INACTIVE",
  • "expiry": 0,
  • "expirationDateTime": "2021-03-18T06:43:49.980Z",
  • "connection": {
    },
  • "notifications": [
    ],
  • "account": {
    },
  • "changeLog": {
    },
  • "project": {
    }
}

Search servicetokens

The API provides capability to get list of user's servicetokens using search criteria, including optional filtering, pagination and sorting

Authorizations:
BearerAuth
query Parameters
offset
number

offset

limit
number

number of records to fetch

Request Body schema: application/json
required
object (ServiceTokenSearchExpression)
and
Array of objects (ServiceTokenSearchExpressions)
property
string (ServiceTokenSearchFieldName)
Enum: "/uuid" "/state" "/name" "/project/projectId"

Possible field names to use on filters

operator
string
Value: "="
values
Array of strings
object (PaginationRequest)

Pagination request information

offset
integer >= 0
Default: 0

Index of the first element.

limit
integer >= 1
Default: 20

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

Responses

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

List of Service Tokens

Array
type
string (ServiceTokenType)
Enum: "VC_TOKEN" "EPL_TOKEN"

Type of Service Token

href
string <uri>

An absolute URL that is the subject of the link's context.

expiry
integer
Deprecated
uuid
string <uuid>

Equinix-assigned service token identifier

issuerSide
string
Deprecated

information about token side

name
string

Customer-provided service token name

description
string

Customer-provided service token description

expirationDateTime
string <date-time>

Expiration date and time of the service token.

object (ServiceTokenConnection)

Service Token Connection Type Information

state
string (ServiceTokenState)
Enum: "ACTIVE" "INACTIVE" "EXPIRED" "DELETED"

Service token state

Array of objects (SimplifiedNotification)

Service token related notifications

object (SimplifiedAccount)
object (Changelog)

Change log

object (Project)
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Request samples

Content type
application/json
{
  • "filter": {
    }
}

Response samples

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

Statistics

Statistics

Get Stats by uuid

This API provides service-level traffic metrics so that you can view access and gather key information required to manage service subscription sizing and capacity.

Authorizations:
BearerAuth
path Parameters
portId
required
string <uuid> (PortUUID)

Port UUID

query Parameters
startDateTime
required
string <date-time> (StartDateTime)
Example: startDateTime=2020-11-06T07:00:00Z

startDateTime

endDateTime
required
string <date-time> (EndDateTime)
Example: endDateTime=2020-11-10T07:00:00Z

endDateTime

Responses

Response Schema: application/json
startDateTime
string <date-time>

Start and duration of the statistical analysis interval.

endDateTime
string <date-time>

End and duration of the statistical analysis interval.

viewPoint
string
Enum: "aSide" "zSide"

Point of view for connection metrics - aSide or zSide

object (BandwidthUtilization)

Bandwidth utilization statistics (octet counters-based)

unit
string
Value: "Mbps"

Aggregated data transfer capacity. Possible values- Mbps, megabits (1 million bits) per second; Gbps, gigabits (1 billion bits) per second.

metricInterval
string

An interval formatted value, indicating the time-interval the metric objects within the response represent

object (Direction)

Directional statistics

max
number <float>

Max bandwidth within request time range, represented in units specified by response "units" field

mean
number <float>

Mean bandwidth within request time range, represented in units specified by response "units" field

Array of objects (Metrics)

Bandwidth utilization statistics for a specified interval.

object (Direction)

Directional statistics

max
number <float>

Max bandwidth within request time range, represented in units specified by response "units" field

mean
number <float>

Mean bandwidth within request time range, represented in units specified by response "units" field

Array of objects (Metrics)

Bandwidth utilization statistics for a specified interval.

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/ports/xxxxx191-xx70-xxxx-xx04-xxxxxxxa37xx",
  • "type": "XF_PORT",
  • "uuid": "xxxxx191-xx70-xxxx-xx04-xxxxxxxa37xx",
  • "name": "Equinix-EM-CX-xxx-L-Dot1q-BO-100G-PRI-xx",
  • "bandwidthUtilization": 10000,
  • "stats": {
    }
}

Get Stats by uuid

This API provides service-level metrics so that you can view access and gather key information required to manage service subscription sizing and capacity

Authorizations:
BearerAuth
path Parameters
connectionId
required
string (VirtualCircuitId)

Connection UUID

query Parameters
startDateTime
required
string <date-time> (StartDateTime)
Example: startDateTime=2020-11-06T07:00:00Z

startDateTime

endDateTime
required
string <date-time> (EndDateTime)
Example: endDateTime=2020-11-10T07:00:00Z

endDateTime

viewPoint
required
string (viewPoint)
Enum: "aSide" "zSide"
Example: viewPoint=aSide

viewPoint

Responses

Response Schema: application/json
startDateTime
string <date-time>

Start and duration of the statistical analysis interval.

endDateTime
string <date-time>

End and duration of the statistical analysis interval.

viewPoint
string
Enum: "aSide" "zSide"

Point of view for connection metrics - aSide or zSide

object (BandwidthUtilization)

Bandwidth utilization statistics (octet counters-based)

unit
string
Value: "Mbps"

Aggregated data transfer capacity. Possible values- Mbps, megabits (1 million bits) per second; Gbps, gigabits (1 billion bits) per second.

metricInterval
string

An interval formatted value, indicating the time-interval the metric objects within the response represent

object (Direction)

Directional statistics

max
number <float>

Max bandwidth within request time range, represented in units specified by response "units" field

mean
number <float>

Mean bandwidth within request time range, represented in units specified by response "units" field

Array of objects (Metrics)

Bandwidth utilization statistics for a specified interval.

object (Direction)

Directional statistics

max
number <float>

Max bandwidth within request time range, represented in units specified by response "units" field

mean
number <float>

Mean bandwidth within request time range, represented in units specified by response "units" field

Array of objects (Metrics)

Bandwidth utilization statistics for a specified interval.

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/connections/97d1850f-4df0-468c-9281-fa7b0dfa2096",
  • "type": "EVPL_VC",
  • "uuid": "97d1850f-4df0-468c-9281-fa7b0dfa2096",
  • "name": "Admin-STATS-123-Abc",
  • "stats": {
    }
}

Stream Alert Rules

Stream Subscriptions

Get Stream Alert Rules

This API provides capability to retrieve stream alert rules

Authorizations:
BearerAuth
path Parameters
streamId
required
string <uuid> (StreamId)
Example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5

Stream UUID

query Parameters
offset
integer
Example: offset=1

offset

limit
integer
Example: limit=10

number of records to fetch

Responses

Response Schema: application/json
href
string <uri>

Stream Alert Rule URI

uuid
string <uuid>

Equinix-assigned access point identifier

type
string
Value: "METRIC_ALERT"

Stream subscription type

name
string

Customer-provided stream alert rule name

description
string

Customer-provided stream alert rule description

state
string
Enum: "ACTIVE" "INACTIVE"

Steam subscription provision state

enabled
boolean
Default: true

Stream alert rule enabled status

metricName
string
Enum: "equinix.fabric.connection.bandwidth_tx.usage" "equinix.fabric.connection.bandwidth_rx.usage" "equinix.fabric.port.bandwidth_tx.usage" "equinix.fabric.port.bandwidth_rx.usage" "equinix.fabric.port.packets_erred_tx.count" "equinix.fabric.port.packets_erred_rx.count" "equinix.fabric.port.packets_dropped_tx.count" "equinix.fabric.port.packets_dropped_rx.count" "equinix.fabric.metro.<source_metro_code>_<destination_metro_code>.latency"

Stream alert rule metric name

object (ResourceSelector)
include
Array of strings

Supported metric names to use on filters with property /subject:

  • * - all events or metrics
  • */ports/<uuid> - port metrics
  • */connections/<uuid> - connection metrics
  • */metros/<metroCode> - metro latency metrics
windowSize
string

Stream alert rule metric window size

operand
string
Enum: "ABOVE" "BELOW"

Stream alert rule metric operand

warningThreshold
string

Stream alert rule metric warning threshold

criticalThreshold
string

Stream alert rule metric critical threshold

object (Changelog)

Change log

createdBy
string

Created by User Key

createdByFullName
string

Created by User Full Name

createdByEmail
string

Created by User Email Address

createdDateTime
string <date-time>

Created by Date and Time

updatedBy
string

Updated by User Key

updatedByFullName
string

Updated by User Full Name

updatedByEmail
string

Updated by User Email Address

updatedDateTime
string <date-time>

Updated by Date and Time

deletedBy
string

Deleted by User Key

deletedByFullName
string

Deleted by User Full Name

deletedByEmail
string

Deleted by User Email Address

deletedDateTime
string <date-time>

Deleted by Date and Time

Response samples

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

Create Stream Alert Rules

This API provides capability to create user's Stream Alert Rules

Authorizations:
BearerAuth
path Parameters
streamId
required
string <uuid> (StreamId)
Example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5

Stream UUID

Request Body schema: application/json
required
type
string
Value: "METRIC_ALERT"
name
string

Customer-provided stream name

description
string

Customer-provided stream description

enabled
boolean
Default: true

Stream alert rule enabled status

metricName
string
Enum: "equinix.fabric.connection.bandwidth_tx.usage" "equinix.fabric.connection.bandwidth_rx.usage" "equinix.fabric.port.bandwidth_tx.usage" "equinix.fabric.port.bandwidth_rx.usage" "equinix.fabric.port.packets_erred_tx.count" "equinix.fabric.port.packets_erred_rx.count" "equinix.fabric.port.packets_dropped_tx.count" "equinix.fabric.port.packets_dropped_rx.count" "equinix.fabric.metro.<source_metro_code>_<destination_metro_code>.latency"

Stream alert rule metric name

object (ResourceSelector)
include
Array of strings

Supported metric names to use on filters with property /subject:

  • * - all events or metrics
  • */ports/<uuid> - port metrics
  • */connections/<uuid> - connection metrics
  • */metros/<metroCode> - metro latency metrics
windowSize
string

Stream alert rule metric window size

operand
string
Enum: "ABOVE" "BELOW"

Stream alert rule metric operand

warningThreshold
string

Stream alert rule metric warning threshold

criticalThreshold
string

Stream alert rule metric critical threshold

Responses

Request samples

Content type
application/json
{
  • "type": "METRIC_ALERT",
  • "name": "metric-alert-1",
  • "description": "metric-alert-1",
  • "enabled": true,
  • "metricName": "equinix.fabric.connection.bandwidth_tx.usage",
  • "resourceSelector": {
    },
  • "operand": "ABOVE",
  • "windowSize": "PT15M",
  • "warningThreshold": 35000000,
  • "criticalThreshold": 45000000
}

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418/alertRules/0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15",
  • "uuid": "0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15",
  • "type": "METRIC_ALERT",
  • "name": "metric-alert-1",
  • "description": "metric-alert-1",
  • "state": "ACTIVE",
  • "enabled": true,
  • "metricName": "equinix.fabric.connection.bandwidth_tx.usage",
  • "resourceSelector": {
    },
  • "windowSize": "PT15M",
  • "operand": "ABOVE",
  • "warningThreshold": 35000000,
  • "criticalThreshold": 45000000,
  • "changeLog": {
    }
}

Get Stream Alert Rules

This API provides capability to get user's stream alert rules

Authorizations:
BearerAuth
path Parameters
streamId
required
string <uuid> (StreamId)
Example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5

Stream UUID

alertRuleId
required
string <uuid> (AlertRuleId)
Example: 0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15

alert rule UUID

Responses

Response Schema: application/json
href
string <uri>

Stream Alert Rule URI

uuid
string <uuid>

Equinix-assigned access point identifier

type
string
Value: "METRIC_ALERT"

Stream subscription type

name
string

Customer-provided stream alert rule name

description
string

Customer-provided stream alert rule description

state
string
Enum: "ACTIVE" "INACTIVE"

Steam subscription provision state

enabled
boolean
Default: true

Stream alert rule enabled status

metricName
string
Enum: "equinix.fabric.connection.bandwidth_tx.usage" "equinix.fabric.connection.bandwidth_rx.usage" "equinix.fabric.port.bandwidth_tx.usage" "equinix.fabric.port.bandwidth_rx.usage" "equinix.fabric.port.packets_erred_tx.count" "equinix.fabric.port.packets_erred_rx.count" "equinix.fabric.port.packets_dropped_tx.count" "equinix.fabric.port.packets_dropped_rx.count" "equinix.fabric.metro.<source_metro_code>_<destination_metro_code>.latency"

Stream alert rule metric name

object (ResourceSelector)
include
Array of strings

Supported metric names to use on filters with property /subject:

  • * - all events or metrics
  • */ports/<uuid> - port metrics
  • */connections/<uuid> - connection metrics
  • */metros/<metroCode> - metro latency metrics
windowSize
string

Stream alert rule metric window size

operand
string
Enum: "ABOVE" "BELOW"

Stream alert rule metric operand

warningThreshold
string

Stream alert rule metric warning threshold

criticalThreshold
string

Stream alert rule metric critical threshold

object (Changelog)

Change log

createdBy
string

Created by User Key

createdByFullName
string

Created by User Full Name

createdByEmail
string

Created by User Email Address

createdDateTime
string <date-time>

Created by Date and Time

updatedBy
string

Updated by User Key

updatedByFullName
string

Updated by User Full Name

updatedByEmail
string

Updated by User Email Address

updatedDateTime
string <date-time>

Updated by Date and Time

deletedBy
string

Deleted by User Key

deletedByFullName
string

Deleted by User Full Name

deletedByEmail
string

Deleted by User Email Address

deletedDateTime
string <date-time>

Deleted by Date and Time

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418/alertRules/0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15",
  • "uuid": "0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15",
  • "type": "METRIC_ALERT",
  • "name": "metric-alert-1",
  • "description": "metric-alert-1",
  • "state": "ACTIVE",
  • "enabled": true,
  • "metricName": "equinix.fabric.connection.bandwidth_tx.usage",
  • "resourceSelector": {
    },
  • "windowSize": "PT15M",
  • "operand": "ABOVE",
  • "warningThreshold": 35000000,
  • "criticalThreshold": 45000000,
  • "changeLog": {
    }
}

Update Stream Alert Rules

This API provides capability to update a user's stream alert rule

Authorizations:
BearerAuth
path Parameters
streamId
required
string <uuid> (StreamId)
Example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5

Stream UUID

alertRuleId
required
string <uuid> (AlertRuleId)
Example: 0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15

alert rule UUID

Request Body schema: application/json
required
name
string

Customer-provided stream name

description
string

Customer-provided stream description

enabled
boolean
Default: true

Stream alert rule enabled status

metricName
string
Enum: "equinix.fabric.connection.bandwidth_tx.usage" "equinix.fabric.connection.bandwidth_rx.usage" "equinix.fabric.port.bandwidth_tx.usage" "equinix.fabric.port.bandwidth_rx.usage" "equinix.fabric.port.packets_erred_tx.count" "equinix.fabric.port.packets_erred_rx.count" "equinix.fabric.port.packets_dropped_tx.count" "equinix.fabric.port.packets_dropped_rx.count" "equinix.fabric.metro.<source_metro_code>_<destination_metro_code>.latency"

Stream alert rule metric name

object (ResourceSelector)
include
Array of strings

Supported metric names to use on filters with property /subject:

  • * - all events or metrics
  • */ports/<uuid> - port metrics
  • */connections/<uuid> - connection metrics
  • */metros/<metroCode> - metro latency metrics
operand
string
Enum: "ABOVE" "BELOW"

Stream alert rule metric operand

windowSize
string

Stream alert rule metric window size

warningThreshold
string

Stream alert rule metric warning threshold

criticalThreshold
string

Stream alert rule metric critical threshold

Responses

Request samples

Content type
application/json
{
  • "name": "metric-alert-1",
  • "description": "metric-alert-1",
  • "enabled": true,
  • "metricName": "equinix.fabric.connection.bandwidth_tx.usage",
  • "resourceSelector": {
    },
  • "operand": "ABOVE",
  • "windowSize": "PT15M",
  • "warningThreshold": 35000000,
  • "criticalThreshold": 45000000
}

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418/alertRules/0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15",
  • "uuid": "0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15",
  • "type": "METRIC_ALERT",
  • "name": "metric-alert-1",
  • "description": "metric-alert-1",
  • "state": "ACTIVE",
  • "enabled": true,
  • "metricName": "equinix.fabric.connection.bandwidth_tx.usage",
  • "resourceSelector": {
    },
  • "windowSize": "PT15M",
  • "operand": "ABOVE",
  • "warningThreshold": 35000000,
  • "criticalThreshold": 45000000,
  • "changeLog": {
    }
}

Update Stream Alert Rules

This API provides capability to delete a user's stream alert rule

Authorizations:
BearerAuth
path Parameters
streamId
required
string <uuid> (StreamId)
Example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5

Stream UUID

alertRuleId
required
string <uuid> (AlertRuleId)
Example: 0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15

alert rule UUID

Responses

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418/alertRules/0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15",
  • "uuid": "0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15",
  • "type": "METRIC_ALERT",
  • "name": "metric-alert-1",
  • "description": "metric-alert-1",
  • "state": "INACTIVE",
  • "enabled": true,
  • "metricName": "equinix.fabric.connection.bandwidth_tx.usage",
  • "resourceSelector": {
    },
  • "windowSize": "PT15M",
  • "operand": "ABOVE",
  • "warningThreshold": 35000000,
  • "criticalThreshold": 45000000,
  • "changeLog": {
    }
}

Stream Subscriptions

Stream Subscriptions

Get Subscriptions

This API provides capability to retrieve stream subscriptions

Authorizations:
BearerAuth
path Parameters
streamId
required
string <uuid> (StreamId)
Example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5

Stream UUID

query Parameters
offset
integer
Example: offset=1

offset

limit
integer
Example: limit=10

number of records to fetch

Responses

Response Schema: application/json
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Array of objects (StreamSubscription)

Data returned from the API call.

Array
href
string <uri>

Stream Subscription URI

uuid
string <uuid>

Equinix-assigned access point identifier

type
string
Value: "STREAM_SUBSCRIPTION"

type

name
string

Customer-provided subscription name

description
string

Customer-provided subscription description

state
string
Enum: "PROVISIONING" "PROVISIONED" "REPROVISIONING" "DEPROVISIONING" "DEPROVISIONED" "FAILED"

Steam subscription provision state

enabled
boolean

Stream subscription enabled status

object (StreamSubscriptionSelector)
object (StreamSubscriptionSelector)
object (StreamSubscriptionSink)

Create Stream destination

object (Changelog)

Change log

lastErrorMessage
string

HTTP response from sink type if error occurred

Response samples

Content type
application/json
{}

Create Subscription

This API provides capability to create user's Stream Subscriptions

Authorizations:
BearerAuth
path Parameters
streamId
required
string <uuid> (StreamId)
Example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5

Stream UUID

Request Body schema: application/json
required
type
string
Value: "STREAM_SUBSCRIPTION"
name
string

Customer-provided stream subscription name

description
string

Customer-provided stream subscription description

enabled
boolean

Stream subscription enabled status

object (StreamSubscriptionSelector)
include
Array of strings (StreamSubscriptionSelectorExpression) <= 8 items
except
Array of strings (StreamSubscriptionSelectorExpression) <= 8 items
object (StreamSubscriptionSelector)
include
Array of strings (StreamSubscriptionSelectorExpression) <= 8 items
except
Array of strings (StreamSubscriptionSelectorExpression) <= 8 items
object (StreamSubscriptionSink)

Create Stream destination

uri
string

any publicly reachable http endpoint

type
string
Enum: "DATADOG" "PAGERDUTY" "SPLUNK_HEC" "SLACK" "TEAMS" "CUSTOM"

destination type

batchEnabled
boolean

batch mode on/off

batchSizeMax
integer

maximum batch size

batchWaitTimeMax
integer

maximum batch waiting time

object (StreamSubscriptionSinkCredential)

Stream subscription sink credentials

type
string
Enum: "ACCESS_TOKEN" "INTEGRATION_KEY" "API_KEY" "USERNAME_PASSWORD"

credential type

accessToken
string

passed as Authorization header value

integrationKey
string

passed as Authorization header value

apiKey
string

passed as Authorization header value

username
string

passed as Authorization header value

password
string

passed as Authorization header value

object (StreamSubscriptionSinkSetting)

Stream subscription sink settings

eventIndex
string

event index

metricIndex
string

metric index

source
string

source

applicationKey
string

Application key

eventUri
string

event uri

metricUri
string

metric uri

host
string

sink host

Responses

Request samples

Content type
application/json
Example
{
  • "type": "STREAM_SUBSCRIPTION",
  • "name": "splunk1",
  • "description": "subscription-1",
  • "enabled": true,
  • "sink": {
    }
}

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418/subscriptions/d684aa26-8276-48b7-bb42-a6d9def0a418",
  • "uuid": "d684aa26-8276-48b7-bb42-a6d9def0a418",
  • "type": "STREAM_SUBSCRIPTION",
  • "name": "stream 1",
  • "description": "stream dec 1",
  • "state": "PROVISIONED",
  • "enabled": true,
  • "metricSelector": {
    },
  • "eventSelector": {
    },
  • "sink": {
    },
  • "changeLog": {
    }
}

Get Subscription

This API provides capability to delete user's get Stream Subscriptions

Authorizations:
BearerAuth
path Parameters
streamId
required
string <uuid> (StreamId)
Example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5

Stream UUID

subscriptionId
required
string <uuid> (StreamSubscriptionId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Stream Subscription UUID

Responses

Response Schema: application/json
href
string <uri>

Stream Subscription URI

uuid
string <uuid>

Equinix-assigned access point identifier

type
string
Value: "STREAM_SUBSCRIPTION"

type

name
string

Customer-provided subscription name

description
string

Customer-provided subscription description

state
string
Enum: "PROVISIONING" "PROVISIONED" "REPROVISIONING" "DEPROVISIONING" "DEPROVISIONED" "FAILED"

Steam subscription provision state

enabled
boolean

Stream subscription enabled status

object (StreamSubscriptionSelector)
include
Array of strings (StreamSubscriptionSelectorExpression) <= 8 items
except
Array of strings (StreamSubscriptionSelectorExpression) <= 8 items
object (StreamSubscriptionSelector)
include
Array of strings (StreamSubscriptionSelectorExpression) <= 8 items
except
Array of strings (StreamSubscriptionSelectorExpression) <= 8 items
object (StreamSubscriptionSink)

Create Stream destination

uri
string

any publicly reachable http endpoint

type
string
Enum: "DATADOG" "PAGERDUTY" "SPLUNK_HEC" "SLACK" "TEAMS" "CUSTOM"

destination type

batchEnabled
boolean

batch mode on/off

batchSizeMax
integer

maximum batch size

batchWaitTimeMax
integer

maximum batch waiting time

object (StreamSubscriptionSinkCredential)

Stream subscription sink credentials

type
string
Enum: "ACCESS_TOKEN" "INTEGRATION_KEY" "API_KEY" "USERNAME_PASSWORD"

credential type

accessToken
string

passed as Authorization header value

integrationKey
string

passed as Authorization header value

apiKey
string

passed as Authorization header value

username
string

passed as Authorization header value

password
string

passed as Authorization header value

object (StreamSubscriptionSinkSetting)

Stream subscription sink settings

eventIndex
string

event index

metricIndex
string

metric index

source
string

source

applicationKey
string

Application key

eventUri
string

event uri

metricUri
string

metric uri

host
string

sink host

object (Changelog)

Change log

createdBy
string

Created by User Key

createdByFullName
string

Created by User Full Name

createdByEmail
string

Created by User Email Address

createdDateTime
string <date-time>

Created by Date and Time

updatedBy
string

Updated by User Key

updatedByFullName
string

Updated by User Full Name

updatedByEmail
string

Updated by User Email Address

updatedDateTime
string <date-time>

Updated by Date and Time

deletedBy
string

Deleted by User Key

deletedByFullName
string

Deleted by User Full Name

deletedByEmail
string

Deleted by User Email Address

deletedDateTime
string <date-time>

Deleted by Date and Time

lastErrorMessage
string

HTTP response from sink type if error occurred

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418/subscriptions/d684aa26-8276-48b7-bb42-a6d9def0a418",
  • "uuid": "d684aa26-8276-48b7-bb42-a6d9def0a418",
  • "type": "STREAM_SUBSCRIPTION",
  • "name": "stream 1",
  • "description": "stream dec 1",
  • "state": "PROVISIONED",
  • "enabled": true,
  • "metricSelector": {
    },
  • "eventSelector": {
    },
  • "sink": {
    },
  • "changeLog": {
    }
}

Update Subscription

This API provides capability to update user's Stream Subscriptions

Authorizations:
BearerAuth
path Parameters
streamId
required
string <uuid> (StreamId)
Example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5

Stream UUID

subscriptionId
required
string <uuid> (StreamSubscriptionId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Stream Subscription UUID

Request Body schema: application/json
required
name
string

Customer-provided stream subscription name

description
string

Customer-provided stream subscription description

enabled
boolean

Stream subscription enabled status

object (StreamSubscriptionFilter)
Array of StreamFilterSimpleExpression (object) or StreamFilterOrFilter (object) (StreamFilter) <= 8 items
Array (<= 8 items)
Any of
property
string

Possible field names to use on filters:

  • /subject - subject
  • /type - type
operator
string

Possible operators to use on filters:

  • = - equal
  • in - in
  • LIKE - case-sensitive like
  • ILIKE - case-insensitive like
values
Array of strings

Supported event or metric names to use on filters with property /type:

  • * - all events or metrics
  • equinix.fabric.port.* - port events or metrics
  • equinix.fabric.connection.* - connection events or metrics
  • equinix.fabric.router.* - cloud router events
  • equinix.fabric.metro.* - metro metrics
  • equinix.fabric.network.* - network events
  • equinix.fabric.service_token.* - service token events
  • equinix.network_edge.* - network edge events
  • equinix.network_edge.acl.* - network edge acl events
  • equinix.network_edge.device.* - network edge device events
  • equinix.access_manager.* - identity access manager events
  • equinix.access_manager.user.role.* - identity access manager user role events

Supported event or metric names to use on filters with property /subject:

  • * - all events or metrics
  • /fabric/v4/ports/<uuid> - port events or metrics
  • /fabric/v4/connections/<uuid> - connection events or metrics
  • /fabric/v4/routers/<uuid> - cloud router events
  • /fabric/v4/metros/<metroCode> - metro metrics
  • /fabric/v4/networks/<uuid> - network events
  • /fabric/v4/tokens/<uuid> - service token events
  • /ne/v1/acl/<uuid> - network edge acl events
  • /ne/v1/devices/<uuid> - network edge device events
  • /am/v2/users/<uuid>/roleAssignments/<uuid> - identity access manager events
object (StreamSubscriptionSelector)
include
Array of strings (StreamSubscriptionSelectorExpression) <= 8 items
except
Array of strings (StreamSubscriptionSelectorExpression) <= 8 items
object (StreamSubscriptionSelector)
include
Array of strings (StreamSubscriptionSelectorExpression) <= 8 items
except
Array of strings (StreamSubscriptionSelectorExpression) <= 8 items
object (StreamSubscriptionSink)

Create Stream destination

uri
string

any publicly reachable http endpoint

type
string
Enum: "DATADOG" "PAGERDUTY" "SPLUNK_HEC" "SLACK" "TEAMS" "CUSTOM"

destination type

batchEnabled
boolean

batch mode on/off

batchSizeMax
integer

maximum batch size

batchWaitTimeMax
integer

maximum batch waiting time

object (StreamSubscriptionSinkCredential)

Stream subscription sink credentials

type
string
Enum: "ACCESS_TOKEN" "INTEGRATION_KEY" "API_KEY" "USERNAME_PASSWORD"

credential type

accessToken
string

passed as Authorization header value

integrationKey
string

passed as Authorization header value

apiKey
string

passed as Authorization header value

username
string

passed as Authorization header value

password
string

passed as Authorization header value

object (StreamSubscriptionSinkSetting)

Stream subscription sink settings

eventIndex
string

event index

metricIndex
string

metric index

source
string

source

applicationKey
string

Application key

eventUri
string

event uri

metricUri
string

metric uri

host
string

sink host

Responses

Request samples

Content type
application/json
{
  • "name": "splunk1",
  • "description": "subscription 1",
  • "enabled": true,
  • "metricSelector": {
    },
  • "eventSelector": {
    },
  • "sink": {
    }
}

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418/subscriptions/d684aa26-8276-48b7-bb42-a6d9def0a418",
  • "uuid": "d684aa26-8276-48b7-bb42-a6d9def0a418",
  • "type": "STREAM_SUBSCRIPTION",
  • "name": "stream 1",
  • "description": "stream dec 1",
  • "state": "PROVISIONED",
  • "enabled": true,
  • "metricSelector": {
    },
  • "eventSelector": {
    },
  • "sink": {
    },
  • "changeLog": {
    }
}

Delete Subscription

This API provides capability to delete user's Stream Subscriptions

Authorizations:
BearerAuth
path Parameters
streamId
required
string <uuid> (StreamId)
Example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5

Stream UUID

subscriptionId
required
string <uuid> (StreamSubscriptionId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Stream Subscription UUID

Responses

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418/subscriptions/d684aa26-8276-48b7-bb42-a6d9def0a418",
  • "uuid": "d684aa26-8276-48b7-bb42-a6d9def0a418",
  • "type": "STREAM_SUBSCRIPTION",
  • "name": "stream 1",
  • "description": "stream dec 1",
  • "state": "DEPROVISIONING",
  • "enabled": true,
  • "metricSelector": {
    },
  • "eventSelector": {
    },
  • "sink": {
    },
  • "changeLog": {
    }
}

Streams

Streams

Get Streams

This API provides capability to retrieve streams

Authorizations:
BearerAuth
query Parameters
offset
integer
Example: offset=1

offset

limit
integer
Example: limit=10

number of records to fetch

Responses

Response Schema: application/json
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Array of objects (Stream)

Data returned from the API call.

Array
href
string <uri>

Stream URI

uuid
string <uuid>

Equinix-assigned access point identifier

state
string
Enum: "PROVISIONING" "PROVISIONED" "REPROVISIONING" "DEPROVISIONING" "DEPROVISIONED" "FAILED"

Stream provision state

assetsCount
integer

Stream assets count

streamSubscriptionsCount
integer

Stream subscriptions count

object (Changelog)

Change log

type
string
Value: "TELEMETRY_STREAM"
name
string

Customer-provided stream name

description
string

Customer-provided stream description

object (Project)

Response samples

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

Create Stream

This API provides capability to create user's stream

Authorizations:
BearerAuth
Request Body schema: application/json
required
type
string
Value: "TELEMETRY_STREAM"
name
string

Customer-provided stream name

description
string

Customer-provided stream description

object (Project)
projectId
required
string

Subscriber-assigned project ID

Responses

Request samples

Content type
application/json
{
  • "type": "TELEMETRY_STREAM",
  • "name": "splunk1",
  • "description": "subscription-1",
  • "project": {
    }
}

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418",
  • "uuid": "d684aa26-8276-48b7-bb42-a6d9def0a418",
  • "type": "TELEMETRY_STREAM",
  • "name": "stream1",
  • "description": "stream 1",
  • "project": {
    },
  • "state": "PROVISIONED",
  • "assetsCount": 1,
  • "streamSubscriptionsCount": 2,
  • "changeLog": {
    }
}

Get Stream

This API provides capability to get user's stream

Authorizations:
BearerAuth
path Parameters
streamId
required
string <uuid> (StreamId)
Example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5

Stream UUID

Responses

Response Schema: application/json
href
string <uri>

Stream URI

uuid
string <uuid>

Equinix-assigned access point identifier

state
string
Enum: "PROVISIONING" "PROVISIONED" "REPROVISIONING" "DEPROVISIONING" "DEPROVISIONED" "FAILED"

Stream provision state

assetsCount
integer

Stream assets count

streamSubscriptionsCount
integer

Stream subscriptions count

object (Changelog)

Change log

createdBy
string

Created by User Key

createdByFullName
string

Created by User Full Name

createdByEmail
string

Created by User Email Address

createdDateTime
string <date-time>

Created by Date and Time

updatedBy
string

Updated by User Key

updatedByFullName
string

Updated by User Full Name

updatedByEmail
string

Updated by User Email Address

updatedDateTime
string <date-time>

Updated by Date and Time

deletedBy
string

Deleted by User Key

deletedByFullName
string

Deleted by User Full Name

deletedByEmail
string

Deleted by User Email Address

deletedDateTime
string <date-time>

Deleted by Date and Time

type
string
Value: "TELEMETRY_STREAM"
name
string

Customer-provided stream name

description
string

Customer-provided stream description

object (Project)
projectId
required
string

Subscriber-assigned project ID

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418",
  • "uuid": "d684aa26-8276-48b7-bb42-a6d9def0a418",
  • "type": "TELEMETRY_STREAM",
  • "name": "stream1",
  • "description": "stream 1",
  • "project": {
    },
  • "state": "PROVISIONED",
  • "assetsCount": 1,
  • "streamSubscriptionsCount": 2,
  • "changeLog": {
    }
}

Update Stream

This API provides capability to update user's stream

Authorizations:
BearerAuth
path Parameters
streamId
required
string <uuid> (StreamId)
Example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5

Stream UUID

Request Body schema: application/json
required
name
string

Customer-provided stream name

description
string

Customer-provided stream description

Responses

Request samples

Content type
application/json
{
  • "name": "splunk1",
  • "description": "subscription 1"
}

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418",
  • "uuid": "d684aa26-8276-48b7-bb42-a6d9def0a418",
  • "type": "TELEMETRY_STREAM",
  • "name": "stream1",
  • "description": "stream 1",
  • "project": {
    },
  • "state": "PROVISIONED",
  • "assetsCount": 1,
  • "streamSubscriptionsCount": 2,
  • "changeLog": {
    }
}

Delete Stream

This API provides capability to delete user's stream

Authorizations:
BearerAuth
path Parameters
streamId
required
string <uuid> (StreamId)
Example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5

Stream UUID

Responses

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418",
  • "uuid": "d684aa26-8276-48b7-bb42-a6d9def0a418",
  • "type": "TELEMETRY_STREAM",
  • "name": "stream1",
  • "description": "stream 1",
  • "project": {
    },
  • "state": "DEPROVISIONING",
  • "assetsCount": 1,
  • "streamSubscriptionsCount": 2,
  • "changeLog": {
    }
}

Get Assets

This API provides capability to retrieve stream assets

Authorizations:
BearerAuth
query Parameters
offset
integer
Example: offset=1

offset

limit
integer
Example: limit=10

number of records to fetch

Request Body schema: application/json
required
object (StreamAssetFilters)
Array of StreamAssetSimpleExpression (object) or StreamAssetOrFilter (object) (StreamAssetFilter) <= 8 items
Array (<= 8 items)
Any of
property
string

Possible field names to use on filters:

  • /uuid - Asset uuid
  • /streamUuid - Stream uuid
  • /projectId - Asset projectId
  • /* - all-category search
operator
string

Possible operators to use on filters:

  • = - equal
  • != - not equal
  • > - greater than
  • >= - greater than or equal to
  • < - less than
  • <= - less than or equal to
  • [NOT] BETWEEN - (not) between
  • [NOT] LIKE - (not) like
  • [NOT] IN - (not) in
  • ILIKE - case-insensitive like
values
Array of strings
object (PaginationRequest)

Pagination request information

offset
integer >= 0
Default: 0

Index of the first element.

limit
integer >= 1
Default: 20

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

Array of objects (StreamAssetSortCriteria)
Array
direction
string (StreamAssetSortDirection)
Default: "DESC"
Enum: "DESC" "ASC"

Sorting direction

property
string (StreamAssetSortBy)
Default: "/uuid"
Value: "/uuid"

Possible field names to use on sorting

Responses

Response Schema: application/json
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Array of objects (StreamAsset)

Data returned from the API call.

Array
href
string <uri>

Stream Asset URI

uuid
string <uuid>

Equinix-assigned access point identifier

type
string
Enum: "XF_PORT" "IP_VC" "EVPLAN_VC" "EVPL_VC" "XF_METRO" "XF_ROUTER" "ORGANIZATION" "PROJECT"

Asset types

metricsEnabled
boolean

enable metric

attachmentStatus
string
Enum: "ATTACHING" "ATTACHED" "DETACHED" "DETACHING" "FAILED"

asset status

Request samples

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

Response samples

Content type
application/json
{}

Get Asset

This API provides capability to get user's assets attached to a stream

Authorizations:
BearerAuth
path Parameters
assetId
required
string <uuid> (AssetId_1)
Example: 757400f8-d360-11e9-bb65-2a2ae2dbcce6

asset UUID

asset
required
string (Asset)
Enum: "ports" "connections" "routers" "metros" "organizations" "projects"

asset

streamId
required
string <uuid> (StreamId)
Example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5

Stream UUID

Responses

Response Schema: application/json
href
string <uri>

Stream Asset URI

uuid
string <uuid>

Equinix-assigned access point identifier

type
string
Enum: "XF_PORT" "IP_VC" "EVPLAN_VC" "EVPL_VC" "XF_METRO" "XF_ROUTER" "ORGANIZATION" "PROJECT"

Asset types

metricsEnabled
boolean

enable metric

attachmentStatus
string
Enum: "ATTACHING" "ATTACHED" "DETACHED" "DETACHING" "FAILED"

asset status

Response samples

Content type
application/json
{}

Attach Asset

This API provides capability to attach an asset to a stream

Authorizations:
BearerAuth
path Parameters
assetId
required
string <uuid> (AssetId_1)
Example: 757400f8-d360-11e9-bb65-2a2ae2dbcce6

asset UUID

asset
required
string (Asset)
Enum: "ports" "connections" "routers" "metros" "organizations" "projects"

asset

streamId
required
string <uuid> (StreamId)
Example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5

Stream UUID

Request Body schema: application/json
required
metricsEnabled
boolean

enable metric

Responses

Request samples

Content type
application/json
{
  • "metricsEnabled": false
}

Response samples

Content type
application/json
{}

Detach Asset

This API provides capability to detach an asset from a stream

Authorizations:
BearerAuth
path Parameters
assetId
required
string <uuid> (AssetId_1)
Example: 757400f8-d360-11e9-bb65-2a2ae2dbcce6

asset UUID

asset
required
string (Asset)
Enum: "ports" "connections" "routers" "metros" "organizations" "projects"

asset

streamId
required
string <uuid> (StreamId)
Example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5

Stream UUID

Responses

Response samples

Content type
application/json
{}

Health

Get service status

GET All service health statys with an option query parameter to return all Equinix Fabric customer in which the customer has a presence.

Authorizations:
BearerAuth

Responses

Response Schema: application/json
href
string

The Canonical URL at which the resource resides.

version
string

Indicator of a version

release
string

release details.

state
string

status of a service

object (ApiServices)

Available services details

route
string

service routes

status
string

service status

changedDateTime
string

service status change date

Response samples

Content type
application/json
{
  • "href": null,
  • "version": "4.4",
  • "release": "2022.4.0",
  • "description": "Equinix Fabric Health Check API",
  • "state": "HEALTHY",
  • "apiServices": [
    ]
}

Networks

Create Network

This API provides capability to create user's Fabric Network

Authorizations:
BearerAuth
query Parameters
dryRun
boolean
Default: false

option to verify that API calls will succeed

Request Body schema: application/json
required
type
required
string (NetworkType)
Enum: "EVPLAN" "EPLAN" "IPWAN" "EVPTREE" "EPTREE"

Network type

name
required
string

Customer-provided network name

scope
required
string (NetworkScope)
Enum: "REGIONAL" "GLOBAL" "LOCAL"

Network scope

object (SimplifiedLocation)
metroHref
string
region
string
metroName
string
metroCode
string
ibx
string
Deprecated
object (Project)
projectId
required
string

Subscriber-assigned project ID

required
Array of objects (SimplifiedNotification)

Preferences for notifications on network configuration or status changes

Array
type
required
string
Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS"

Notification Type

sendInterval
string
emails
required
Array of strings <email> [ items <email > ]

Array of contact emails

registeredUsers
Array of strings

Array of registered users

Responses

Response Schema: application/json
href
required
string <uri>

Network URI

uuid
required
string <uuid>

Equinix-assigned network identifier

state
required
string (NetworkState)
Enum: "ACTIVE" "INACTIVE" "DELETED"

Network status

connectionsCount
number

number of connections created on the network

object (SimplifiedAccount)
accountNumber
integer <int64>

Account number

accountName
string

Account name

orgId
integer <int64>

Customer organization identifier

organizationName
string

Customer organization name

globalOrgId
string

Global organization identifier

globalOrganizationName
string

Global organization name

ucmId
string

Account ucmId

globalCustId
string

Account name

resellerAccountNumber
integer <int64>

Reseller account number

resellerAccountName
string

Reseller account name

resellerUcmId
string

Reseller account ucmId

resellerOrgId
integer <int64>

Reseller customer organization identifier

object (SimplifiedNetworkChange)

Current state of latest network change

href
string <uri>

Network URI

uuid
string <uuid>

Uniquely identifies a change

type
string (NetworkChangeType)
Enum: "NETWORK_CREATION" "NETWORK_UPDATE" "NETWORK_DELETION"

Type of change

object (NetworkOperation)

Network operational data

equinixStatus
string (NetworkEquinixStatus)
Enum: "PROVISIONING" "PROVISIONED" "NOT_PROVISIONED" "DEPROVISIONING" "DEPROVISIONED" "NOT_DEPROVISIONED"

Network status

required
object (Changelog)

Change log

createdBy
string

Created by User Key

createdByFullName
string

Created by User Full Name

createdByEmail
string

Created by User Email Address

createdDateTime
string <date-time>

Created by Date and Time

updatedBy
string

Updated by User Key

updatedByFullName
string

Updated by User Full Name

updatedByEmail
string

Updated by User Email Address

updatedDateTime
string <date-time>

Updated by Date and Time

deletedBy
string

Deleted by User Key

deletedByFullName
string

Deleted by User Full Name

deletedByEmail
string

Deleted by User Email Address

deletedDateTime
string <date-time>

Deleted by Date and Time

Array of objects (Link)

Network sub-resources links

Array
href
string <uri>

Resource URI

rel
string

OperationId from Swagger hub spec

method
string

Http method type

contentType
string

Content type for the response

authenticate
boolean

Authentication required or not

type
required
string (NetworkType)
Enum: "EVPLAN" "EPLAN" "IPWAN" "EVPTREE" "EPTREE"

Network type

name
required
string

Customer-provided network name

scope
required
string (NetworkScope)
Enum: "REGIONAL" "GLOBAL" "LOCAL"

Network scope

object (SimplifiedLocation)
metroHref
string
region
string
metroName
string
metroCode
string
ibx
string
Deprecated
object (Project)
projectId
required
string

Subscriber-assigned project ID

required
Array of objects (SimplifiedNotification)

Preferences for notifications on network configuration or status changes

Array
type
required
string
Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS"

Notification Type

sendInterval
string
emails
required
Array of strings <email> [ items <email > ]

Array of contact emails

registeredUsers
Array of strings

Array of registered users

Request samples

Content type
application/json
Example
{
  • "type": "EVPLAN",
  • "name": "My-Network-1",
  • "scope": "GLOBAL",
  • "project": {
    },
  • "notifications": [
    ]
}

Response samples

Content type
application/json
Example
{}

Get Network By ID

This API provides capability to retrieve user's Fabric Network

Authorizations:
BearerAuth
path Parameters
networkId
required
string <uuid> (NetworkId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Network UUID

Responses

Response Schema: application/json
href
required
string <uri>

Network URI

uuid
required
string <uuid>

Equinix-assigned network identifier

state
required
string (NetworkState)
Enum: "ACTIVE" "INACTIVE" "DELETED"

Network status

connectionsCount
number

number of connections created on the network

object (SimplifiedAccount)
accountNumber
integer <int64>

Account number

accountName
string

Account name

orgId
integer <int64>

Customer organization identifier

organizationName
string

Customer organization name

globalOrgId
string

Global organization identifier

globalOrganizationName
string

Global organization name

ucmId
string

Account ucmId

globalCustId
string

Account name

resellerAccountNumber
integer <int64>

Reseller account number

resellerAccountName
string

Reseller account name

resellerUcmId
string

Reseller account ucmId

resellerOrgId
integer <int64>

Reseller customer organization identifier

object (SimplifiedNetworkChange)

Current state of latest network change

href
string <uri>

Network URI

uuid
string <uuid>

Uniquely identifies a change

type
string (NetworkChangeType)
Enum: "NETWORK_CREATION" "NETWORK_UPDATE" "NETWORK_DELETION"

Type of change

object (NetworkOperation)

Network operational data

equinixStatus
string (NetworkEquinixStatus)
Enum: "PROVISIONING" "PROVISIONED" "NOT_PROVISIONED" "DEPROVISIONING" "DEPROVISIONED" "NOT_DEPROVISIONED"

Network status

required
object (Changelog)

Change log

createdBy
string

Created by User Key

createdByFullName
string

Created by User Full Name

createdByEmail
string

Created by User Email Address

createdDateTime
string <date-time>

Created by Date and Time

updatedBy
string

Updated by User Key

updatedByFullName
string

Updated by User Full Name

updatedByEmail
string

Updated by User Email Address

updatedDateTime
string <date-time>

Updated by Date and Time

deletedBy
string

Deleted by User Key

deletedByFullName
string

Deleted by User Full Name

deletedByEmail
string

Deleted by User Email Address

deletedDateTime
string <date-time>

Deleted by Date and Time

Array of objects (Link)

Network sub-resources links

Array
href
string <uri>

Resource URI

rel
string

OperationId from Swagger hub spec

method
string

Http method type

contentType
string

Content type for the response

authenticate
boolean

Authentication required or not

type
required
string (NetworkType)
Enum: "EVPLAN" "EPLAN" "IPWAN" "EVPTREE" "EPTREE"

Network type

name
required
string

Customer-provided network name

scope
required
string (NetworkScope)
Enum: "REGIONAL" "GLOBAL" "LOCAL"

Network scope

object (SimplifiedLocation)
metroHref
string
region
string
metroName
string
metroCode
string
ibx
string
Deprecated
object (Project)
projectId
required
string

Subscriber-assigned project ID

required
Array of objects (SimplifiedNotification)

Preferences for notifications on network configuration or status changes

Array
type
required
string
Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS"

Notification Type

sendInterval
string
emails
required
Array of strings <email> [ items <email > ]

Array of contact emails

registeredUsers
Array of strings

Array of registered users

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784",
  • "type": "EVPLAN",
  • "uuid": "92dc376a-a932-43aa-a6a2-c806dedbd784",
  • "name": "My-EVPLAN-1",
  • "state": "ACTIVE",
  • "location": {
    },
  • "scope": "REGIONAL",
  • "connectionsCount": 0,
  • "project": {
    },
  • "notifications": [
    ],
  • "operation": {
    },
  • "changeLog": {
    },
  • "links": []
}

Delete Network By ID

This API provides capability to delete user's Fabric Network

Authorizations:
BearerAuth
path Parameters
networkId
required
string <uuid> (NetworkId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Network UUID

Responses

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784",
  • "type": "EVPLAN",
  • "uuid": "92dc376a-a932-43aa-a6a2-c806dedbd784",
  • "name": "My-EVPLAN-1",
  • "state": "INACTIVE",
  • "change": {},
  • "location": {
    },
  • "scope": "REGIONAL",
  • "project": {
    },
  • "notifications": [
    ],
  • "operation": {
    },
  • "changeLog": {
    }
}

Update Network By ID

This API provides capability to update user's Fabric Network

Authorizations:
BearerAuth
path Parameters
networkId
required
string <uuid> (NetworkId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Network UUID

Request Body schema: application/json-patch+json
required
Array (non-empty)
op
required
string
Enum: "replace" "add" "remove"

Handy shortcut for operation name

path
required
string

path inside document leading to updated parameter

value
required
object

new value for updated parameter

Responses

Response Schema: application/json
href
required
string <uri>

Network URI

uuid
required
string <uuid>

Equinix-assigned network identifier

state
required
string (NetworkState)
Enum: "ACTIVE" "INACTIVE" "DELETED"

Network status

connectionsCount
number

number of connections created on the network

object (SimplifiedAccount)
accountNumber
integer <int64>

Account number

accountName
string

Account name

orgId
integer <int64>

Customer organization identifier

organizationName
string

Customer organization name

globalOrgId
string

Global organization identifier

globalOrganizationName
string

Global organization name

ucmId
string

Account ucmId

globalCustId
string

Account name

resellerAccountNumber
integer <int64>

Reseller account number

resellerAccountName
string

Reseller account name

resellerUcmId
string

Reseller account ucmId

resellerOrgId
integer <int64>

Reseller customer organization identifier

object (SimplifiedNetworkChange)

Current state of latest network change

href
string <uri>

Network URI

uuid
string <uuid>

Uniquely identifies a change

type
string (NetworkChangeType)
Enum: "NETWORK_CREATION" "NETWORK_UPDATE" "NETWORK_DELETION"

Type of change

object (NetworkOperation)

Network operational data

equinixStatus
string (NetworkEquinixStatus)
Enum: "PROVISIONING" "PROVISIONED" "NOT_PROVISIONED" "DEPROVISIONING" "DEPROVISIONED" "NOT_DEPROVISIONED"

Network status

required
object (Changelog)

Change log

createdBy
string

Created by User Key

createdByFullName
string

Created by User Full Name

createdByEmail
string

Created by User Email Address

createdDateTime
string <date-time>

Created by Date and Time

updatedBy
string

Updated by User Key

updatedByFullName
string

Updated by User Full Name

updatedByEmail
string

Updated by User Email Address

updatedDateTime
string <date-time>

Updated by Date and Time

deletedBy
string

Deleted by User Key

deletedByFullName
string

Deleted by User Full Name

deletedByEmail
string

Deleted by User Email Address

deletedDateTime
string <date-time>

Deleted by Date and Time

Array of objects (Link)

Network sub-resources links

Array
href
string <uri>

Resource URI

rel
string

OperationId from Swagger hub spec

method
string

Http method type

contentType
string

Content type for the response

authenticate
boolean

Authentication required or not

type
required
string (NetworkType)
Enum: "EVPLAN" "EPLAN" "IPWAN" "EVPTREE" "EPTREE"

Network type

name
required
string

Customer-provided network name

scope
required
string (NetworkScope)
Enum: "REGIONAL" "GLOBAL" "LOCAL"

Network scope

object (SimplifiedLocation)
metroHref
string
region
string
metroName
string
metroCode
string
ibx
string
Deprecated
object (Project)
projectId
required
string

Subscriber-assigned project ID

required
Array of objects (SimplifiedNotification)

Preferences for notifications on network configuration or status changes

Array
type
required
string
Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS"

Notification Type

sendInterval
string
emails
required
Array of strings <email> [ items <email > ]

Array of contact emails

registeredUsers
Array of strings

Array of registered users

Request samples

Content type
application/json-patch+json
Example
[
  • {
    }
]

Response samples

Content type
application/json
{}

Search Network

The API provides capability to get list of user's Fabric Network using search criteria, including optional filtering, pagination and sorting

Authorizations:
BearerAuth
Request Body schema: application/json
required
object (NetworkFilter)
and
Array of objects (NetworkSimpleExpression)
or
Array of objects (NetworkSimpleExpression)
property
string (NetworkSearchFieldName)
Enum: "/name" "/uuid" "/scope" "/type" "/operation/equinixStatus" "/location/region" "/project/projectId" "/account/globalCustId" "/account/orgId" "/deletedDate" "/*"

Possible field names to use on filters

operator
string
Enum: "=" "!=" ">" ">=" "<" "<=" "BETWEEN" "NOT BETWEEN" "LIKE" "NOT LIKE" "ILIKE" "NOT ILIKE" "IN" "NOT IN"
values
Array of strings
object (PaginationRequest)

Pagination request information

offset
integer >= 0
Default: 0

Index of the first element.

limit
integer >= 1
Default: 20

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

Array of objects (NetworkSortCriteria)
Array
direction
string (NetworkSortDirection)
Default: "DESC"
Enum: "DESC" "ASC"

Sorting direction

property
string (NetworkSortBy)
Default: "/changeLog/updatedDateTime"
Enum: "/name" "/uuid" "/scope" "/operation/equinixStatus" "/location/region" "/changeLog/createdDateTime" "/changeLog/updatedDateTime"

Possible field names to use on sorting

Responses

Response Schema: application/json
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Array of objects (NetworkSortCriteriaResponse)
Array
direction
string (NetworkSortDirectionResponse)
Default: "DESC"
Enum: "DESC" "ASC"

Sorting direction

property
string (NetworkSortByResponse)
Default: "/changeLog/updatedDateTime"
Enum: "/name" "/type" "/uuid" "/state" "/scope" "/location/region" "/changeLog/createdDateTime" "/changeLog/updatedDateTime"

Possible field names to use on sorting

Array of objects (Network)
Array
href
required
string <uri>

Network URI

uuid
required
string <uuid>

Equinix-assigned network identifier

state
required
string (NetworkState)
Enum: "ACTIVE" "INACTIVE" "DELETED"

Network status

connectionsCount
number

number of connections created on the network

object (SimplifiedAccount)
object (SimplifiedNetworkChange)

Current state of latest network change

object (NetworkOperation)

Network operational data

required
object (Changelog)

Change log

Array of objects (Link)

Network sub-resources links

type
required
string (NetworkType)
Enum: "EVPLAN" "EPLAN" "IPWAN" "EVPTREE" "EPTREE"

Network type

name
required
string

Customer-provided network name

scope
required
string (NetworkScope)
Enum: "REGIONAL" "GLOBAL" "LOCAL"

Network scope

object (SimplifiedLocation)
object (Project)
required
Array of objects (SimplifiedNotification)

Preferences for notifications on network configuration or status changes

Request samples

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

Response samples

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

Get Connections

The API provides capability to get list of user's Fabric Network connections

Authorizations:
BearerAuth
path Parameters
networkId
required
string <uuid> (NetworkId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Network UUID

Responses

Response Schema: application/json
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Array of objects (Connection)
Array
href
string <uri>

Connection URI

type
required
string (ConnectionType)
Enum: "EVPL_VC" "EPL_VC" "EC_VC" "IP_VC" "ACCESS_EPL_VC" "EIA_VC" "EVPLAN_VC" "EPLAN_VC" "IPWAN_VC" "IA_VC"

Connection type

uuid
string

Equinix-assigned connection identifier

name
required
string

Customer-provided connection name

description
string

Customer-provided connection description

state
string (ConnectionState)
Enum: "ACTIVE" "CANCELLED" "DEPROVISIONED" "DEPROVISIONING" "DRAFT" "FAILED" "PENDING" "PROVISIONED" "PROVISIONING" "REPROVISIONING" ""

Connection status

object (Change)

Current state of latest connection change

object (ConnectionOperation)

Connection type-specific operational data

object (Order)
Array of objects (SimplifiedNotification)

Preferences for notifications on connection configuration or status changes

object (SimplifiedAccount)
object (Changelog)

Change log

bandwidth
required
integer [ 0 .. 10000 ]

Connection bandwidth in Mbps

geoScope
string (GeoScopeType)
Enum: "CANADA" "CONUS" "JAPAN"

Geographic boundary types

object (ConnectionRedundancy)

Connection redundancy configuration

isRemote
boolean

Connection property derived from access point locations

direction
string (ConnectionDirection)
Enum: "INTERNAL" "INCOMING" "OUTGOING"

Connection directionality from the requester point of view

required
object (ConnectionSide)

Connection configuration object for each side of multi-segment connection

required
object (ConnectionSide)

Connection configuration object for each side of multi-segment connection

object (marketplaceSubscription)

Equinix Fabric Entity for Marketplace Subscription

Array of objects (ConnectionSideAdditionalInfo)

Connection additional information

object (Project)

Response samples

Content type
application/json
{}

Get Network Changes

The API provides capability to get list of user's Fabric Network changes

Authorizations:
BearerAuth
path Parameters
networkId
required
string <uuid> (NetworkId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Network UUID

Responses

Response Schema: application/json
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: 20

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

total
required
integer >= 0

Total number of elements returned.

next
string

URL relative to the next item in the response.

previous
string

URL relative to the previous item in the response.

Array of objects (NetworkChange)
Array
href
string <uri>

Network URI

uuid
string <uuid>

Uniquely identifies a change

type
string (NetworkChangeType)
Enum: "NETWORK_CREATION" "NETWORK_UPDATE" "NETWORK_DELETION"

Type of change

status
string (NetworkChangeStatus)
Enum: "APPROVED" "COMPLETED" "FAILED" "REJECTED" "REQUESTED" "SUBMITTED_FOR_APPROVAL"

Current outcome of the change flow

createdDateTime
string <date-time>

Set when change flow starts

updatedDateTime
string <date-time>

Set when change object is updated

Array of objects (NetworkChangeOperation)

Response samples

Content type
application/json
{}

Get Change By ID

This API provides capability to retrieve user's Fabric Network Change

Authorizations:
BearerAuth
path Parameters
networkId
required
string <uuid> (NetworkId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Network UUID

changeId
required
string <uuid> (ChangeId_5)
Example: 6d500177-9404-41f2-99e8-2bf1a84d8db5

Network Change UUID

Responses

Response Schema: application/json
href
string <uri>

Network URI

uuid
string <uuid>

Uniquely identifies a change

type
string (NetworkChangeType)
Enum: "NETWORK_CREATION" "NETWORK_UPDATE" "NETWORK_DELETION"

Type of change

status
string (NetworkChangeStatus)
Enum: "APPROVED" "COMPLETED" "FAILED" "REJECTED" "REQUESTED" "SUBMITTED_FOR_APPROVAL"

Current outcome of the change flow

createdDateTime
string <date-time>

Set when change flow starts

updatedDateTime
string <date-time>

Set when change object is updated

Array of objects (NetworkChangeOperation)
Array
op
required
string
Enum: "replace" "add" "remove"

Handy shortcut for operation name

path
required
string

path inside document leading to updated parameter

value
required
object

new value for updated parameter

Response samples

Content type
application/json
{}

Marketplace Subscriptions

Get Subscription

The API provides capability to get subscription

Authorizations:
BearerAuth
path Parameters
subscriptionId
required
string <uuid> (SubscriptionId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

Subscription UUID

Responses

Response Schema: application/json
href
string <uri>

Subscription URL

uuid
string <uuid>

Unique identifier of the Subscription

state
required
string (SubscriptionState)
Enum: "ACTIVE" "EXPIRED" "CANCELLED" "GRACE_PERIOD"

Subscription State

marketplace
required
string
Enum: "AWS" "GCP" "AZURE" "REDHAT"

Marketplace Type

offerType
string
Enum: "PUBLIC" "PRIVATE_OFFER"

Marketplace Offer Type

isAutoRenew
boolean

Is Auto Renewal Enabled

offerId
string

Marketplace Offer Id

object (SubscriptionTrial)

Free Trial Subscription

enabled
boolean

Free Trial Enabled

expiryDateTime
string <date-time>

Free Trial Expiry Date

metroCodes
Array of strings

List of available metro

required
Array of objects (SubscriptionEntitlementResponse)

List of entitlements associated with the subscription

Array
uuid
string <uuid>

Subscription Entitlement Id

quantityEntitled
integer >= 0

Quantity entitled for the subscription

quantityConsumed
integer >= 0

Quantity consumed from the entitlement

quantityAvailable
integer >= 0

Quantity available from the entitlement

object (SubscriptionAsset)

Asset information

object (Changelog)

Change log

createdBy
string

Created by User Key

createdByFullName
string

Created by User Full Name

createdByEmail
string

Created by User Email Address

createdDateTime
string <date-time>

Created by Date and Time

updatedBy
string

Updated by User Key

updatedByFullName
string

Updated by User Full Name

updatedByEmail
string

Updated by User Email Address

updatedDateTime
string <date-time>

Updated by Date and Time

deletedBy
string

Deleted by User Key

deletedByFullName
string

Deleted by User Full Name

deletedByEmail
string

Deleted by User Email Address

deletedDateTime
string <date-time>

Deleted by Date and Time

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/marketplaceSubscriptions/c5557b51-7938-4f7d-afaa-41b930903a5e",
  • "uuid": "c5557b51-7938-4f7d-afaa-41b930903a5e",
  • "state": "ACTIVE",
  • "marketplace": "AWS",
  • "offerType": "PRIVATE_OFFER",
  • "isAutoRenew": false,
  • "offerId": "offer-wqquayy2jy25o",
  • "trial": {
    },
  • "metroCodes": [
    ],
  • "entitlements": [
    ],
  • "changeLog": {
    }
}