Skip to main content
API docs by Redocly

Equinix Fabric API v4 (4.31)

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

Application Domains

Application Domains Beta

Create App Domain

This API provides capability to create user's App Domain

Authorizations:
BearerAuth
Request Body schema: application/json
required
type
required
string (AppDomainType)
Default: "APP_DOMAIN"
Value: "APP_DOMAIN"

App Domain Type

name
required
string <string> [ 1 .. 50 ] characters

Customer-provided App Domain name

description
string <string>

Customer-provided App Domain description

required
object (Project)
projectId
required
string

Subscriber-assigned project ID

Responses

Request samples

Content type
application/json
{
  • "type": "APP_DOMAIN",
  • "name": "atlassian.net",
  • "description": "Atlassian Domain",
  • "project": {
    }
}

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3",
  • "uuid": "20f3ef8e-d670-4236-86fa-bb0038adcfc3",
  • "type": "APP_DOMAIN",
  • "name": "atlassian.net",
  • "description": "Atlassian Domain",
  • "state": "PENDING_VERIFICATION",
  • "project": {
    },
  • "changeLog": {
    }
}

Get App Domain

This API provides capability to retrieve user's App Domain

Authorizations:
BearerAuth
path Parameters
appDomainId
required
string <uuid> (AppDomainId)
Example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3

App Domain UUID

Responses

Response Schema: application/json
href
string <uri>

Resource URI

type
required
string (AppDomainType)
Default: "APP_DOMAIN"
Value: "APP_DOMAIN"

App Domain Type

uuid
string <uuid>

Equinix-assigned access point identifier

name
required
string <string>

Customer-provided App Domain name

description
string <string>

Customer-provided App Domain description

state
string <string> (AppDomainState)
Enum: "PENDING_VERIFICATION" "PROVISIONING_FAILED" "PROVISIONED" "DEPROVISIONING" "DEPROVISIONING_FAILED" "DEPROVISIONED"

App Domain lifecycle state

required
object (Project)
projectId
required
string

Subscriber-assigned project ID

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 (AppDomainChange)

Current state of latest AppDomain change

uuid
string

Uniquely identifies a change

type
required
string
Value: "APP_DOMAIN_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

Array of objects (AppDomainChangeOperation)
Array
op
required
string
Enum: "replace" "add" "remove"

Handy shortcut for operation name

path
required
string
Value: "/description"

path inside document leading to updated parameter

value
required
object

new value for updated parameter

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3",
  • "uuid": "20f3ef8e-d670-4236-86fa-bb0038adcfc3",
  • "type": "APP_DOMAIN",
  • "name": "atlassian.net",
  • "description": "Atlassian Domain",
  • "state": "PROVISIONED",
  • "project": {
    },
  • "changeLog": {
    }
}

Delete App Domain

This API provides capability to delete user's App Domain

Authorizations:
BearerAuth
path Parameters
appDomainId
required
string <uuid> (AppDomainId)
Example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3

App Domain UUID

Responses

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3",
  • "uuid": "20f3ef8e-d670-4236-86fa-bb0038adcfc3",
  • "type": "APP_DOMAIN",
  • "name": "atlassian.net",
  • "description": "Atlassian Domain",
  • "state": "DEPROVISIONED",
  • "project": {
    },
  • "changeLog": {
    }
}

Update App Domain

This API provides capability to update user's App Domain

Authorizations:
BearerAuth
path Parameters
appDomainId
required
string <uuid> (AppDomainId)
Example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3

App Domain 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
Value: "/description"

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
{
  • "href": "https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3",
  • "uuid": "20f3ef8e-d670-4236-86fa-bb0038adcfc3",
  • "type": "APP_DOMAIN",
  • "name": "atlassian.net",
  • "description": "Updated Atlassian Domain",
  • "state": "PROVISIONED",
  • "project": {
    },
  • "change": {
    },
  • "changeLog": {
    }
}

Search App Domains

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

Authorizations:
BearerAuth
Request Body schema: application/json
required
object (AppDomainFilters)
Array of AppDomainSimpleExpression (object) or AppDomainOrFilter (object) (AppDomainFilter) <= 8 items
Array (<= 8 items)
Any of
property
string

Possible field names to use on filters:

  • /project/projectId - project id
  • /uuid - App Domain uuid
  • /name - App Domain name
  • /description - App Domain description
  • /state - App Domain status
  • /changeLog/createdDateTime - App Domain creation timestamp
  • /changeLog/updatedDateTime - App Domain last updated timestamp
  • /changeLog/deletedDateTime - App Domain deletion timestamp
operator
string

Possible operators to use on filters:

  • = - equal
  • != - not equal
  • > - greater than
  • < - less than
  • IN - in
  • NOT IN - not in
  • LIKE - like
  • ILIKE - case-insensitive like
  • BETWEEN - between
  • NOT BETWEEN - not between
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 (AppDomainSortCriteria)
Array
direction
string (AppDomainSortDirection)
Default: "DESC"
Enum: "DESC" "ASC"

Sorting direction

property
string <string> (AppDomainSortBy)
Default: "/changeLog/updatedDateTime"

Possible field names to use on '400_InvalidSorting':

  • /name - App Domain name
  • /uuid - App Domain uuid
  • /state - App Domain status
  • /changeLog/createdDateTime - Date and time when change flow starts
  • /changeLog/updatedDateTime - Date and time when change object is updated

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 (AppDomain)

Data returned from the API call.

Array
href
string <uri>

Resource URI

type
required
string (AppDomainType)
Default: "APP_DOMAIN"
Value: "APP_DOMAIN"

App Domain Type

uuid
string <uuid>

Equinix-assigned access point identifier

name
required
string <string>

Customer-provided App Domain name

description
string <string>

Customer-provided App Domain description

state
string <string> (AppDomainState)
Enum: "PENDING_VERIFICATION" "PROVISIONING_FAILED" "PROVISIONED" "DEPROVISIONING" "DEPROVISIONING_FAILED" "DEPROVISIONED"

App Domain lifecycle state

required
object (Project)
object (Changelog)

Change log

object (AppDomainChange)

Current state of latest AppDomain change

Request samples

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

Response samples

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

Get attached App Links for App Domain

This API provides capability to retrieve App Links attached to an App Domain.

Authorizations:
BearerAuth
path Parameters
appDomainId
required
string <uuid> (AppDomainId)
Example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3

App Domain UUID

query Parameters
offset
integer
Example: offset=1

offset

limit
integer
Example: limit=10

number of records to fetch

state
Array of strings <string> (AttachedAppLinkState) [ items <string > ]
Items Enum: "PROVISIONING" "PROVISIONING_FAILED" "PROVISIONED" "DEPROVISIONING" "DEPROVISIONING_FAILED" "DEPROVISIONED" "REPROVISIONING"
Example: state=PROVISIONED,PROVISIONING

Filter attached App Links by one or more lifecycle states.

order
string (AttachedAppLinkOrder)
Default: "DESC"
Enum: "DESC" "ASC"
Example: order=DESC

Sort order for attached App Links.

style
string (Style)
Default: "MEDIUM"
Enum: "MIN" "MEDIUM" "FULL"
Example: style=MEDIUM

Detail level of the response.

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 (AppDomainAttachedAppLink)

Data returned from the API call.

Array
href
string <uri>

Resource URI

type
required
string (AppLinkType)
Default: "APP_LINK"
Value: "APP_LINK"

App Link Type

uuid
required
string <uuid>

Equinix-assigned access point identifier

name
string <string>

Customer-provided App Link name

description
string <string>

Customer-provided App Link description

state
string <string> (AppLinkState)
Enum: "PROVISIONING" "PROVISIONING_FAILED" "PROVISIONED" "DEPROVISIONING" "DEPROVISIONING_FAILED" "DEPROVISIONED" "REPROVISIONING"

App Link lifecycle state

object (AppLinkCloudRouter)

App Link Cloud Router

ipv4Address
string <ipv4>

App Link IP address

bandwidth
integer

App Link aggregated data transfer capacity in Mbps

object (Project)

Response samples

Content type
application/json
{}

Get App Link

This API provides capability to retrieve user's App Link

Authorizations:
BearerAuth
path Parameters
appLinkId
required
string <uuid> (AppLinkId)
Example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914

App Link UUID

Responses

Response Schema: application/json
href
string <uri>

Resource URI

type
required
string (AppLinkType)
Default: "APP_LINK"
Value: "APP_LINK"

App Link Type

uuid
string <uuid>

Equinix-assigned access point identifier

name
required
string <string>

Customer-provided App Link name

description
string <string>

Customer-provided App Link description

state
string <string> (AppLinkState)
Enum: "PROVISIONING" "PROVISIONING_FAILED" "PROVISIONED" "DEPROVISIONING" "DEPROVISIONING_FAILED" "DEPROVISIONED" "REPROVISIONING"

App Link lifecycle state

required
object (AppLinkCloudRouter)

App Link Cloud Router

href
string <uri>

Resource URI

type
string
Value: "XF_ROUTER"

Cloud Router Type

uuid
string <uuid>

Cloud Router UUID

ipv4Address
string <ipv4>

App Link IP address

bandwidth
required
integer

App Link aggregated data transfer capacity in Mbps

required
object (Project)
projectId
required
string

Subscriber-assigned project ID

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 (AppLinkChange)

Current state of latest AppLink change

uuid
string

Uniquely identifies a change

type
required
string
Value: "APP_LINK_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

Array of objects (AppLinkChangeOperation)
Array
op
required
string
Enum: "replace" "add" "remove"

Handy shortcut for operation name

path
required
string
Enum: "/name" "/description" "/bandwidth" "/ipv4Address"

path inside document leading to updated parameter

value
required
object

new value for updated parameter

Response samples

Content type
application/json
{}

Delete App Link

This API provides capability to delete user's App Link

Authorizations:
BearerAuth
path Parameters
appLinkId
required
string <uuid> (AppLinkId)
Example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914

App Link UUID

Responses

Response samples

Content type
application/json
{}

Update App Link

This API provides capability to update user's App Link

Authorizations:
BearerAuth
path Parameters
appLinkId
required
string <uuid> (AppLinkId)
Example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914

App Link 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" "/description" "/bandwidth" "/ipv4Address"

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
{
  • "href": "https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914",
  • "uuid": "23cd19ab-d3bb-478b-9f25-bd12a3af1914",
  • "type": "APP_LINK",
  • "name": "Updated Atlassian App Link",
  • "description": "Atlassian App Link in SV",
  • "state": "REPROVISIONING",
  • "router": {},
  • "ipv4Address": "192.168.10.1",
  • "bandwidth": 1000,
  • "project": {
    },
  • "change": {
    },
  • "changeLog": {
    }
}

Get attached App Domain for App Link

This API provides ability to retrieve an App Domain attached to an App Link.

Authorizations:
BearerAuth
path Parameters
appLinkId
required
string <uuid> (AppLinkId)
Example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914

App Link UUID

appDomainId
required
string <uuid> (AppDomainId)
Example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3

App Domain UUID

Responses

Response Schema: application/json
href
string <uri>

Resource URI

type
string (AppDomainType)
Default: "APP_DOMAIN"
Value: "APP_DOMAIN"

App Domain Type

uuid
required
string <uuid>

Equinix-assigned access point identifier

name
string

Customer-provided App Domain name

attachmentStatus
string <string> (AppLinkAttachState)
Enum: "ATTACHING" "ATTACHED" "DETACHING" "DETACHED" "FAILED"

App Link attachment lifecycle 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
{}

Search attached App Domain to App Link

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

Authorizations:
BearerAuth
path Parameters
appLinkId
required
string <uuid> (AppLinkId)
Example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914

App Link UUID

Request Body schema: application/json
required
object (AppLinkAttachDomainFilters)
Array of AppLinkAttachDomainSimpleExpression (object) or AppLinkAttachDomainOrFilter (object) (AppLinkAttachDomainFilter) <= 8 items
Array (<= 8 items)
Any of
property
string

Possible field names to use on filters:

  • /uuid - App Domain attach to App Link uuid
  • /attachmentStatus - App Domain attach to App Link status
operator
string

Possible operators to use on filters:

  • = - equal
  • != - not equal
  • IN - in
  • NOT 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 (AppLinkAttachDomainSortCriteria)
Array
direction
string (AppLinkAttachDomainSortDirection)
Default: "DESC"
Enum: "DESC" "ASC"

Sorting direction

property
string <string> (AppLinkAttachDomainSortBy)
Default: "/changeLog/updatedDateTime"

Possible field names to use on '400_InvalidSorting':

  • /uuid - App Domain attach to App Link uuid
  • /attachmentStatus - App Domain attach to App Link status
  • /changeLog/createdDateTime - Date and time when change flow starts
  • /changeLog/updatedDateTime - Date and time when change object is updated

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 (AppLinkAppDomainAttachment)

Data returned from the API call.

Array
href
string <uri>

Resource URI

type
string (AppDomainType)
Default: "APP_DOMAIN"
Value: "APP_DOMAIN"

App Domain Type

uuid
required
string <uuid>

Equinix-assigned access point identifier

name
string

Customer-provided App Domain name

attachmentStatus
string <string> (AppLinkAttachState)
Enum: "ATTACHING" "ATTACHED" "DETACHING" "DETACHED" "FAILED"

App Link attachment lifecycle state

object (Changelog)

Change log

Request samples

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

Response samples

Content type
application/json
{}

Get attached App Domains for App Link

This API provides capability to retrieve App Domains attached to an App Link.

Authorizations:
BearerAuth
path Parameters
appLinkId
required
string <uuid> (AppLinkId)
Example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914

App Link UUID

query Parameters
offset
integer
Example: offset=1

offset

limit
integer
Example: limit=10

number of records to fetch

attachmentStatus
Array of strings <string> (AttachedAppDomainAttachmentStatus) [ items <string > ]
Items Enum: "ATTACHING" "ATTACHED" "DETACHING" "DETACHED" "FAILED"
Example: attachmentStatus=ATTACHED,ATTACHING

Filter attached App Domains by one or more attachment lifecycle states.

order
string (AttachedAppDomainOrder)
Default: "DESC"
Enum: "DESC" "ASC"
Example: order=DESC

Sort order for attached App Domains.

style
string (Style)
Default: "MEDIUM"
Enum: "MIN" "MEDIUM" "FULL"
Example: style=MEDIUM

Detail level of the response.

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 (AppLinkAttachedAppDomain)

Data returned from the API call.

Array
href
string <uri>

Resource URI

type
required
string (AppDomainType)
Default: "APP_DOMAIN"
Value: "APP_DOMAIN"

App Domain Type

uuid
required
string <uuid>

Equinix-assigned access point identifier

name
string <string>

Customer-provided App Domain name

description
string <string>

Customer-provided App Domain description

state
string <string> (AppDomainState)
Enum: "PENDING_VERIFICATION" "PROVISIONING_FAILED" "PROVISIONED" "DEPROVISIONING" "DEPROVISIONING_FAILED" "DEPROVISIONED"

App Domain lifecycle state

object (Project)
attachmentStatus
string <string> (AppLinkAttachState)
Enum: "ATTACHING" "ATTACHED" "DETACHING" "DETACHED" "FAILED"

App Link attachment lifecycle state

Response samples

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

Get attached App Service for App Link

This API provides ability to retrieve an App Service attached to an App Link.

Authorizations:
BearerAuth
path Parameters
appLinkId
required
string <uuid> (AppLinkId)
Example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914

App Link UUID

appServiceId
required
string <uuid> (AppServiceId)
Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4

App Service UUID

Responses

Response Schema: application/json
href
string <uri>

Resource URI

type
string (AppServiceType)
Default: "APP_SERVICE"
Value: "APP_SERVICE"

App Service Type

uuid
required
string <uuid>

Equinix-assigned access point identifier

geoScope
required
string

Geo scope for the App Service

destinationIp
required
string <ipv4>

Target IP for forwarding API requests

attachmentStatus
string <string> (AppLinkAttachState)
Enum: "ATTACHING" "ATTACHED" "DETACHING" "DETACHED" "FAILED"

App Link attachment lifecycle 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

object (AppLinkAppServiceAttachmentChange)

Current state of latest AppLink change

uuid
string

Uniquely identifies a change

type
required
string
Value: "APP_LINK_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

Array of objects (AppLinkChangeOperation)
Array
op
required
string
Enum: "replace" "add" "remove"

Handy shortcut for operation name

path
required
string
Enum: "/name" "/description" "/bandwidth" "/ipv4Address"

path inside document leading to updated parameter

value
required
object

new value for updated parameter

Response samples

Content type
application/json
{}

Search attached App Service to App Link

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

Authorizations:
BearerAuth
path Parameters
appLinkId
required
string <uuid> (AppLinkId)
Example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914

App Link UUID

Request Body schema: application/json
required
object (AppLinkAttachServiceFilters)
Array of AppLinkAttachServiceSimpleExpression (object) or AppLinkAttachServiceOrFilter (object) (AppLinkAttachServiceFilter) <= 8 items
Array (<= 8 items)
Any of
property
string

Possible field names to use on filters:

  • /uuid - App Service attach to App Link uuid
  • /attachmentStatus - App Service attach to App Link status
operator
string

Possible operators to use on filters:

  • = - equal
  • != - not equal
  • IN - in
  • NOT 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 (AppLinkAttachServiceSortCriteria)
Array
direction
string (AppLinkAttachServiceSortDirection)
Default: "DESC"
Enum: "DESC" "ASC"

Sorting direction

property
string <string> (AppLinkAttachServiceSortBy)
Default: "/changeLog/updatedDateTime"

Possible field names to use on '400_InvalidSorting':

  • /uuid - App Service attach to App Link uuid
  • /attachmentStatus - App Service attach to App Link status
  • /changeLog/createdDateTime - Date and time when change flow starts
  • /changeLog/updatedDateTime - Date and time when change object is updated

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 (AppLinkAppServiceAttachment)

Data returned from the API call.

Array
href
string <uri>

Resource URI

type
string (AppServiceType)
Default: "APP_SERVICE"
Value: "APP_SERVICE"

App Service Type

uuid
required
string <uuid>

Equinix-assigned access point identifier

geoScope
required
string

Geo scope for the App Service

destinationIp
required
string <ipv4>

Target IP for forwarding API requests

attachmentStatus
string <string> (AppLinkAttachState)
Enum: "ATTACHING" "ATTACHED" "DETACHING" "DETACHED" "FAILED"

App Link attachment lifecycle state

object (Changelog)

Change log

object (AppLinkAppServiceAttachmentChange)

Current state of latest AppLink change

Request samples

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

Response samples

Content type
application/json
{}

Get attached App Services for App Link

This API provides capability to retrieve App Services attached to an App Link.

Authorizations:
BearerAuth
path Parameters
appLinkId
required
string <uuid> (AppLinkId)
Example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914

App Link UUID

query Parameters
offset
integer
Example: offset=1

offset

limit
integer
Example: limit=10

number of records to fetch

attachmentStatus
Array of strings <string> (AttachedAppServiceAttachmentStatus) [ items <string > ]
Items Enum: "ATTACHING" "ATTACHED" "DETACHING" "DETACHED" "FAILED"
Example: attachmentStatus=ATTACHED,ATTACHING

Filter attached App Services by one or more attachment lifecycle states.

order
string (AttachedAppServiceOrder)
Default: "DESC"
Enum: "DESC" "ASC"
Example: order=DESC

Sort order for attached App Services.

style
string (Style)
Default: "MEDIUM"
Enum: "MIN" "MEDIUM" "FULL"
Example: style=MEDIUM

Detail level of the response.

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 (AppLinkAttachedAppService)

Data returned from the API call.

Array
href
string <uri>

Resource URI

type
required
string (AppServiceType)
Default: "APP_SERVICE"
Value: "APP_SERVICE"

App Service Type

uuid
required
string <uuid>

Equinix-assigned access point identifier

name
string <string>

Customer-provided App Service name

description
string <string>

Customer-provided App Service description

state
string (AppServiceState)
Enum: "PROVISIONING" "PROVISIONED" "DEPROVISIONING" "DEPROVISIONED" "REPROVISIONING"

App Service lifecycle state

endpoint
string

Accessible endpoint through this service

sourceDomains
Array of strings

List of source domains from where traffic is allowed

object (Project)
geoScope
required
string

Geo scope for the App Service

destinationIp
required
string <ipv4>

Target IP for forwarding API requests

attachmentStatus
string <string> (AppLinkAttachState)
Enum: "ATTACHING" "ATTACHED" "DETACHING" "DETACHED" "FAILED"

App Link attachment lifecycle state

Response samples

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

Application Services

Application Services Beta

Create App Service

This API provides capability to create user's App Service

Authorizations:
BearerAuth
Request Body schema: application/json
required
type
required
string (AppServiceType)
Default: "APP_SERVICE"
Value: "APP_SERVICE"

App Service Type

name
required
string <string> [ 1 .. 50 ] characters

Customer-provided App Service name

description
string <string>

Customer-provided App Service description

endpoint
required
string

Accessible endpoint through this service

sourceDomains
Array of strings

List of source domains from where traffic is allowed

required
object (Project)
projectId
required
string

Subscriber-assigned project ID

Responses

Request samples

Content type
application/json
{
  • "type": "APP_SERVICE",
  • "name": "Atlassian App Service",
  • "description": "Atlassian App Service in SV",
  • "endpoints": [
    ],
  • "sourceDomains": [
    ],
  • "project": {
    }
}

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2",
  • "uuid": "5008a109-9d1c-485c-b0ba-de9736f283c2",
  • "type": "APP_SERVICE",
  • "name": "Atlassian App Service",
  • "description": "Atlassian App Service in SV",
  • "state": "PROVISIONING",
  • "endpoint": "equinixjira.atlassian.net",
  • "sourceDomains": [
    ],
  • "project": {
    },
  • "changeLog": {
    }
}

Get App Service

This API provides capability to retrieve user's App Service

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

App Service UUID

Responses

Response Schema: application/json
href
string <uri>

Resource URI

type
required
string (AppServiceType)
Default: "APP_SERVICE"
Value: "APP_SERVICE"

App Service Type

uuid
string <uuid>

Equinix-assigned access point identifier

name
required
string <string>

Customer-provided App Service name

description
string <string>

Customer-provided App Service description

state
string (AppServiceState)
Enum: "PROVISIONING" "PROVISIONED" "DEPROVISIONING" "DEPROVISIONED" "REPROVISIONING"

App Service lifecycle state

endpoint
string

Accessible endpoint through this service

sourceDomains
Array of strings

List of source domains from where traffic is allowed

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 (Project)
projectId
required
string

Subscriber-assigned project ID

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 (AppServiceChange)

Current state of latest AppService change

uuid
string

Uniquely identifies a change

type
required
string
Value: "APP_SERVICE_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

Array of objects (AppServiceChangeOperation)
Array
op
required
string
Enum: "replace" "add" "remove"

Handy shortcut for operation name

path
required
string
Enum: "/name" "/description" "/sourceDomains"

path inside document leading to updated parameter

value
required
object

new value for updated parameter

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2",
  • "uuid": "5008a109-9d1c-485c-b0ba-de9736f283c2",
  • "type": "APP_SERVICE",
  • "name": "Atlassian App Service",
  • "description": "Atlassian App Service in SV",
  • "state": "PROVISIONED",
  • "endpoint": "equinixjira.atlassian.net",
  • "sourceDomains": [
    ],
  • "project": {
    },
  • "account": {
    },
  • "changeLog": {
    }
}

Delete App Service

This API provides capability to delete user's App Service

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

App Service UUID

Responses

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2",
  • "uuid": "5008a109-9d1c-485c-b0ba-de9736f283c2",
  • "type": "APP_SERVICE",
  • "name": "Atlassian App Service",
  • "description": "Atlassian App Service in SV",
  • "state": "DEPROVISIONING",
  • "endpoint": "equinixjira.atlassian.net",
  • "sourceDomains": [
    ],
  • "project": {
    },
  • "changeLog": {
    }
}

Update App Service

This API provides capability to update user's App Service

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

App 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" "/description" "/sourceDomains"

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
{
  • "href": "https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2",
  • "uuid": "5008a109-9d1c-485c-b0ba-de9736f283c2",
  • "type": "APP_SERVICE",
  • "name": "Updated Atlassian App Service",
  • "description": "Atlassian App Service in SV",
  • "state": "REPROVISIONING",
  • "endpoint": "equinixjira.atlassian.net",
  • "sourceDomains": [
    ],
  • "project": {
    },
  • "change": {
    },
  • "changeLog": {
    }
}

Search App Services

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

Authorizations:
BearerAuth
Request Body schema: application/json
required
object (AppServiceFilters)
Array of AppServiceSimpleExpression (object) or AppServiceOrFilter (object) (AppServiceFilter) <= 8 items
Array (<= 8 items)
Any of
property
string

Possible field names to use on filters:

  • /project/projectId - project id
  • /uuid - App Service uuid
  • /name - App Service name
  • /description - App Service description
  • /state - App Service status
  • /endpoint - App Service endpoint
  • /sourceDomains - App Service source domains
  • /changeLog/createdDateTime - App Service creation timestamp
  • /changeLog/updatedDateTime - App Service last updated timestamp
  • /changeLog/deletedDateTime - App Service deletion timestamp
operator
string

Possible operators to use on filters:

  • = - equal
  • != - not equal
  • > - greater than
  • < - less than
  • IN - in
  • NOT IN - not in
  • LIKE - like
  • ILIKE - case-insensitive like
  • BETWEEN - between
  • NOT BETWEEN - not between
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 (AppServiceSortCriteria)
Array
direction
string (AppServiceSortDirection)
Default: "DESC"
Enum: "DESC" "ASC"

Sorting direction

property
string <string> (AppServiceSortBy)
Default: "/changeLog/updatedDateTime"

Possible field names to use on '400_InvalidSorting':

  • /name - App Service name
  • /uuid - App Service uuid
  • /state - App Service status
  • /changeLog/createdDateTime - Date and time when change flow starts
  • /changeLog/updatedDateTime - Date and time when change object is updated

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 (AppService)

Data returned from the API call.

Array
href
string <uri>

Resource URI

type
required
string (AppServiceType)
Default: "APP_SERVICE"
Value: "APP_SERVICE"

App Service Type

uuid
string <uuid>

Equinix-assigned access point identifier

name
required
string <string>

Customer-provided App Service name

description
string <string>

Customer-provided App Service description

state
string (AppServiceState)
Enum: "PROVISIONING" "PROVISIONED" "DEPROVISIONING" "DEPROVISIONED" "REPROVISIONING"

App Service lifecycle state

endpoint
string

Accessible endpoint through this service

sourceDomains
Array of strings

List of source domains from where traffic is allowed

object (SimplifiedAccount)
object (Project)
object (Changelog)

Change log

object (AppServiceChange)

Current state of latest AppService change

Request samples

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

Response samples

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

Get attached App Links for App Service

This API provides capability to retrieve App Links attached to an App Service.

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

App Service UUID

query Parameters
offset
integer
Example: offset=1

offset

limit
integer
Example: limit=10

number of records to fetch

state
Array of strings <string> (AttachedAppLinkState_1) [ items <string > ]
Items Enum: "PROVISIONING" "PROVISIONING_FAILED" "PROVISIONED" "DEPROVISIONING" "DEPROVISIONING_FAILED" "DEPROVISIONED" "REPROVISIONING"
Example: state=PROVISIONED,PROVISIONING

Filter attached App Links by one or more lifecycle states.

order
string (AttachedAppLinkOrder)
Default: "DESC"
Enum: "DESC" "ASC"
Example: order=DESC

Sort order for attached App Links.

style
string (Style)
Default: "MEDIUM"
Enum: "MIN" "MEDIUM" "FULL"
Example: style=MEDIUM

Detail level of the response.

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 (AppServiceAttachedAppLink)

Data returned from the API call.

Array
href
string <uri>

Resource URI

type
required
string (AppLinkType)
Default: "APP_LINK"
Value: "APP_LINK"

App Link Type

uuid
required
string <uuid>

Equinix-assigned access point identifier

name
string <string>

Customer-provided App Link name

description
string <string>

Customer-provided App Link description

state
string <string> (AppLinkState)
Enum: "PROVISIONING" "PROVISIONING_FAILED" "PROVISIONED" "DEPROVISIONING" "DEPROVISIONING_FAILED" "DEPROVISIONED" "REPROVISIONING"

App Link lifecycle state

object (AppLinkCloudRouter)

App Link Cloud Router

ipv4Address
string <ipv4>

App Link IP address

bandwidth
integer

App Link aggregated data transfer capacity in Mbps

object (Project)

Response samples

Content type
application/json
{}

Get attached App Subscriptions for App Service

This API provides capability to retrieve App Subscriptions attached to an App Service.

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

App Service UUID

query Parameters
offset
integer
Example: offset=1

offset

limit
integer
Example: limit=10

number of records to fetch

state
Array of strings (AttachedAppSubscriptionState)
Items Enum: "PROVISIONING" "PROVISIONING_FAILED" "PROVISIONED" "DEPROVISIONING" "DEPROVISIONING_FAILED" "DEPROVISIONED" "REPROVISIONING"
Example: state=PROVISIONED,PROVISIONING

Filter attached App Subscriptions by one or more lifecycle states.

order
string (AttachedAppSubscriptionOrder)
Default: "DESC"
Enum: "DESC" "ASC"
Example: order=DESC

Sort order for attached App Subscriptions.

style
string (Style)
Default: "MEDIUM"
Enum: "MIN" "MEDIUM" "FULL"
Example: style=MEDIUM

Detail level of the response.

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 (AppServiceAttachedAppSubscription)

Data returned from the API call.

Array
href
string <uri>

Resource URI

type
required
string (AppSubscriptionType)
Default: "APP_SUBSCRIPTION"
Value: "APP_SUBSCRIPTION"

App Subscription Type

uuid
required
string <uuid>

Equinix-assigned access point identifier

state
required
string (AppSubscriptionState)
Enum: "PROVISIONING" "PROVISIONING_FAILED" "PROVISIONED" "DEPROVISIONING" "DEPROVISIONING_FAILED" "DEPROVISIONED" "REPROVISIONING"

App Subscription lifecycle state

object (SimplifiedAccount)

Response samples

Content type
application/json
{}

Search attached App Subscriptions

The API provides capability to get list of App Subscriptions attached to an App Service using search criteria.

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

App Service UUID

Request Body schema: application/json
required
object (AppServiceAttachedAppSubscriptionFilters)
Array of AppServiceAttachedAppSubscriptionSimpleExpression (object) or AppServiceAttachedAppSubscriptionOrFilter (object) (AppServiceAttachedAppSubscriptionFilter) <= 8 items
Array (<= 8 items)
Any of
property
string

Possible field names to use on filters:

  • /uuid - App Subscription UUID
  • /state - App Subscription lifecycle state
operator
string

Possible operators to use on filters:

  • = - equal
  • != - not equal
  • IN - in
  • NOT 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 (AppServiceAttachedAppSubscriptionSortCriteria)
Array
direction
string (AppServiceAttachedAppSubscriptionSortDirection)
Default: "DESC"
Enum: "DESC" "ASC"

Sorting direction

property
string <string> (AppServiceAttachedAppSubscriptionSortBy)
Default: "/uuid"

Possible field names to use on '400_InvalidSorting':

  • /uuid - App Subscription UUID
  • /state - App Subscription lifecycle state

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 (AppServiceAttachedAppSubscription)

Data returned from the API call.

Array
href
string <uri>

Resource URI

type
required
string (AppSubscriptionType)
Default: "APP_SUBSCRIPTION"
Value: "APP_SUBSCRIPTION"

App Subscription Type

uuid
required
string <uuid>

Equinix-assigned access point identifier

state
required
string (AppSubscriptionState)
Enum: "PROVISIONING" "PROVISIONING_FAILED" "PROVISIONED" "DEPROVISIONING" "DEPROVISIONING_FAILED" "DEPROVISIONED" "REPROVISIONING"

App Subscription lifecycle state

object (SimplifiedAccount)

Request samples

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

Response samples

Content type
application/json
{}

Application Subscriptions

Application Subscriptions Beta

Create App Subscription

This API provides capability to create user's App Subscription

Authorizations:
BearerAuth
Request Body schema: application/json
required
type
required
string (AppSubscriptionType)
Default: "APP_SUBSCRIPTION"
Value: "APP_SUBSCRIPTION"

App Subscription Type

object (AppSubscriptionSourceRequest)

Source details for the Subscription

object (AppSubscriptionSourceRequestAppLink)

App Link reference for App Subscription

uuid
required
string <uuid>

Equinix-assigned access point identifier

ipSubnets
required
Array of strings <ipv4-cidr> [ items <ipv4-cidr > ]

List of IP subnets in CIDR notation

object (AppSubscriptionTargetRequest)

Target details for the Subscription

object (AppSubscriptionTargetRequestAppService)

App Service reference for App Subscription

uuid
required
string <uuid>

Equinix-assigned access point identifier

geoScope
required
string

Geo scope

prioritization
required
string (AppSubscriptionPrioritization)
Enum: "LATENCY" "PERFORMANCE" "UTILIZATION" "THRESHOLD" "ANY_TAG"

Prioritization strategy for forwarding API requests

required
object (Project)
projectId
required
string

Subscriber-assigned project ID

Responses

Request samples

Content type
application/json
{
  • "type": "APP_SUBSCRIPTION",
  • "source": {
    },
  • "target": {
    },
  • "project": {
    }
}

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3",
  • "uuid": "20f3ef8e-d670-4236-86fa-bb0038adcfc3",
  • "type": "APP_SUBSCRIPTION",
  • "source": {
    },
  • "target": {
    },
  • "state": "PROVISIONING",
  • "project": {
    },
  • "changeLog": {
    }
}

Get App Subscription

This API provides capability to retrieve user's App Subscription

Authorizations:
BearerAuth
path Parameters
appSubscriptionId
required
string <uuid> (AppSubscriptionId)
Example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3

App Subscription UUID

Responses

Response Schema: application/json
href
string <uri>

Resource URI

type
required
string (AppSubscriptionType)
Default: "APP_SUBSCRIPTION"
Value: "APP_SUBSCRIPTION"

App Subscription Type

uuid
string <uuid>

Equinix-assigned access point identifier

required
object (AppSubscriptionSource)

Source details for the Subscription

object (AppSubscriptionSourceAppLink)

App Link reference for App Subscription

href
string <uri>

Resource URI

type
string

App Link Type

uuid
required
string <uuid>

Equinix-assigned access point identifier

ipSubnets
required
Array of strings <ipv4-cidr> [ items <ipv4-cidr > ]

List of IP subnets in CIDR notation

required
object (AppSubscriptionTarget)

Target details for the Subscription

object (AppSubscriptionTargetAppService)

App Service reference for App Subscription

href
string <uri>

Resource URI

type
string

App Service Type

uuid
required
string <uuid>

Equinix-assigned access point identifier

geoScope
required
string

Geo scope

prioritization
required
string (AppSubscriptionPrioritization)
Enum: "LATENCY" "PERFORMANCE" "UTILIZATION" "THRESHOLD" "ANY_TAG"

Prioritization strategy for forwarding API requests

state
string (AppSubscriptionState)
Enum: "PROVISIONING" "PROVISIONING_FAILED" "PROVISIONED" "DEPROVISIONING" "DEPROVISIONING_FAILED" "DEPROVISIONED" "REPROVISIONING"

App Subscription lifecycle state

required
object (Project)
projectId
required
string

Subscriber-assigned project ID

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 (AppSubscriptionChange)

Current state of latest AppSubscription change

uuid
string

Uniquely identifies a change

type
required
string
Value: "APP_SUBSCRIPTION_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

Array of objects (AppSubscriptionChangeOperation)
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
{
  • "href": "https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3",
  • "uuid": "20f3ef8e-d670-4236-86fa-bb0038adcfc3",
  • "type": "APP_SUBSCRIPTION",
  • "source": {
    },
  • "target": {
    },
  • "state": "PROVISIONED",
  • "project": {
    },
  • "changeLog": {
    }
}

Delete App Subscription

This API provides capability to delete user's App Subscription

Authorizations:
BearerAuth
path Parameters
appSubscriptionId
required
string <uuid> (AppSubscriptionId)
Example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3

App Subscription UUID

Responses

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3",
  • "uuid": "20f3ef8e-d670-4236-86fa-bb0038adcfc3",
  • "type": "APP_SUBSCRIPTION",
  • "source": {
    },
  • "target": {
    },
  • "state": "DEPROVISIONED",
  • "project": {
    },
  • "changeLog": {
    }
}

Update App Subscription

This API provides capability to update user's App Subscription

Authorizations:
BearerAuth
path Parameters
appSubscriptionId
required
string <uuid> (AppSubscriptionId)
Example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3

App Subscription 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

Request samples

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

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3",
  • "uuid": "20f3ef8e-d670-4236-86fa-bb0038adcfc3",
  • "type": "APP_SUBSCRIPTION",
  • "source": {
    },
  • "target": {
    },
  • "state": "PROVISIONING",
  • "project": {
    },
  • "change": {
    },
  • "changeLog": {
    }
}

Search App Subscriptions

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

Authorizations:
BearerAuth
Request Body schema: application/json
required
object (AppSubscriptionFilters)
Array of AppSubscriptionSimpleExpression (object) or AppSubscriptionOrFilter (object) (AppSubscriptionFilter) <= 8 items
Array (<= 8 items)
Any of
property
string

Possible field names to use on filters:

  • /project/projectId - project id
  • /uuid - App Subscription uuid
  • /state - App Subscription status
  • /source/appLink/uuid - Source App Link uuid
  • /source/ipSubnets - Source App Link ip subnets
  • /target/appService/uuid - Target App Service uuid
  • /target/geoScope - Target App Service geo scope
  • /target/prioritization - Target App Service prioritization
  • /changeLog/createdDateTime - App Subscription creation timestamp
  • /changeLog/updatedDateTime - App Subscription last updated timestamp
  • /changeLog/deletedDateTime - App Subscription deletion timestamp
operator
string

Possible operators to use on filters:

  • = - equal
  • != - not equal
  • > - greater than
  • < - less than
  • IN - in
  • NOT IN - not in
  • LIKE - like
  • ILIKE - case-insensitive like
  • BETWEEN - between
  • NOT BETWEEN - not between
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 (AppSubscriptionSortCriteria)
Array
direction
string (AppSubscriptionSortDirection)
Default: "DESC"
Enum: "DESC" "ASC"

Sorting direction

property
string <string> (AppSubscriptionSortBy)
Default: "/changeLog/updatedDateTime"

Possible field names to use on '400_InvalidSorting':

  • /uuid - App Subscription uuid
  • /state - App Subscription status
  • /changeLog/createdDateTime - Date and time when change flow starts
  • /changeLog/updatedDateTime - Date and time when change object is updated

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 (AppSubscription)

Data returned from the API call.

Array
href
string <uri>

Resource URI

type
required
string (AppSubscriptionType)
Default: "APP_SUBSCRIPTION"
Value: "APP_SUBSCRIPTION"

App Subscription Type

uuid
string <uuid>

Equinix-assigned access point identifier

required
object (AppSubscriptionSource)

Source details for the Subscription

required
object (AppSubscriptionTarget)

Target details for the Subscription

state
string (AppSubscriptionState)
Enum: "PROVISIONING" "PROVISIONING_FAILED" "PROVISIONED" "DEPROVISIONING" "DEPROVISIONING_FAILED" "DEPROVISIONED" "REPROVISIONING"

App Subscription lifecycle state

required
object (Project)
object (Changelog)

Change log

object (AppSubscriptionChange)

Current state of latest AppSubscription change

Request samples

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

Response samples

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

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" "metros" "serviceTokens" "networks" "projects" "organizations" "timeServices" "companyProfiles"

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

time
string <date-time>

Cloud Event time the event occurred

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

equinixalert
string

Equinix alert

equinixorganization
string

Equinix organization identifier

equinixproject
string

Equinix project identifier

authtype
string

Cloud Event auth type

authid
string

Cloud Event user identifier

traceparent
string

Cloud Event traceparent

tracestate
string

Cloud Event tracestate

object (CloudEventData)

Response samples

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

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

time
string <date-time>

Cloud Event time the event occurred

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

equinixalert
string

Equinix alert

equinixorganization
string

Equinix organization identifier

equinixproject
string

Equinix project identifier

authtype
string

Cloud Event auth type

authid
string

Cloud Event user identifier

traceparent
string

Cloud Event traceparent

tracestate
string

Cloud Event tracestate

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 (OperationalStatus)
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
required
object (CloudEventFilters)
Array of CloudEventSimpleExpression (object) (CloudEventFilter)
Array
Any of
property
string

Possible field names to use on filters:

  • /id - Cloud Event identifier
  • /subject - Cloud Event subject description
  • /type - Cloud Event type
  • /time - Time of Cloud Events
  • /equinixproject - Equinix Project of Cloud Events
  • /equinixorganization - Equinix Organization of Cloud Events
  • /equinixalert - Equinix Alert Identifier for raise/clear Cloud Events
  • /severitytext - cloud event severity text
  • /authid - Equinix user key to identify the user that performed the action that triggered the Cloud Event
  • /authtype - Equinix user type either user or system
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
  • BETWEEN - between
  • IN - in
  • LIKE - like
  • ILIKE - like case-insensitive
  • IS NULL - is null
  • IS NOT NULL - is not 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.

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

time
string <date-time>

Cloud Event time the event occurred

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

equinixalert
string

Equinix alert

equinixorganization
string

Equinix organization identifier

equinixproject
string

Equinix project identifier

authtype
string

Cloud Event auth type

authid
string

Cloud Event user identifier

traceparent
string

Cloud Event traceparent

tracestate
string

Cloud Event tracestate

object (CloudEventData)

Request samples

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

Response samples

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

Search Last Operational Cloud Events

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

Authorizations:
BearerAuth
Request Body schema: application/json
required
object (OperationalEventFilters)
Array of OperationalEventSimpleExpression (object) (OperationalEventFilter)
Array
Any of
property
string

Possible field names to use on filters:

  • /subject - Cloud Event subject description
operator
string

Possible operators to use on filters:

  • = - equal
  • 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.

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

time
string <date-time>

Cloud Event time the event occurred

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

equinixalert
string

Equinix alert

equinixorganization
string

Equinix organization identifier

equinixproject
string

Equinix project identifier

authtype
string

Cloud Event auth type

authid
string

Cloud Event user identifier

traceparent
string

Cloud Event traceparent

tracestate
string

Cloud Event tracestate

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
string
Enum: "ACTIVE" "INACTIVE"
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
Example
{
  • "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
string
Enum: "ACTIVE" "INACTIVE"
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
Example
{
  • "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" "BASIC" "STANDARD" "ADVANCED" "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).

contractedBandwidth
integer

Contracted bandwidth

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" "TECHNICAL" "ORDERING" "QUOTE_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

Array of objects (Phone)

Array of contact phone numbers

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
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
Value: "ROUTER_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

Array of objects (CloudRouterChangeOperation)
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

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

The Canonical URL at which the resource resides.

region
string
metroName
string
metroCode
required
string
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" "BASIC" "STANDARD" "ADVANCED" "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).

contractedBandwidth
integer

Contracted bandwidth

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" "TECHNICAL" "ORDERING" "QUOTE_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

Array of objects (Phone)

Array of contact phone numbers

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
type
string
Enum: "IC_ROUTER" "XF_ROUTER"
name
string

Customer-provided Cloud Router name

object (SimplifiedLocationWithoutIBX)
metroHref
string

The Canonical URL at which the resource resides.

region
string
metroName
string
metroCode
required
string
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" "BASIC" "STANDARD" "ADVANCED" "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).

contractedBandwidth
integer

Contracted bandwidth

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" "TECHNICAL" "ORDERING" "QUOTE_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

Array of objects (Phone)

Array of contact phone numbers

href
string <uri>

Cloud Routers URI

uuid
string <uuid>

Equinix-assigned access point identifier

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 (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

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
Value: "ROUTER_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

Array of objects (CloudRouterChangeOperation)
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
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
Example
[
  • {
    }
]

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
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
Value: "ROUTER_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

Array of objects (CloudRouterChangeOperation)
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

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

The Canonical URL at which the resource resides.

region
string
metroName
string
metroCode
required
string
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" "BASIC" "STANDARD" "ADVANCED" "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).

contractedBandwidth
integer

Contracted bandwidth

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" "TECHNICAL" "ORDERING" "QUOTE_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

Array of objects (Phone)

Array of contact phone numbers

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 all actions for a given cloud router

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
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 (RouterActionsRouter)

Router object for router actions

Response samples

Content type
application/json
{}

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

href
string
type
string (ConnectionType)
Enum: "EVPL_VC" "EPL_VC" "EC_VC" "IP_VC" "ACCESS_EPL_VC" "EIA_VC" "EVPLAN_VC" "EPLAN_VC" "EVPTREE_VC" "EPTREE_VC" "IPWAN_VC" "IA_VC" "MC_VC" "IX_VC" "GW_VC" "IPX_VC"

Connection type

object (Operation)

Operation object for router actions

bgpIpv4RoutesCount
integer

IPV4 route count

bgpIpv6RoutesCount
integer

IPV6 route count

distinctIpv4PrefixesCount
integer

distinct IPV4 prefixes count

distinctIpv6PrefixesCount
integer

distinct IPV6 prefixes count

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 search route table actions for a given cloud router

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 (RouterActionsRouter)

Router object for router actions

Request samples

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

Response samples

Content type
application/json
{}

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

href
string
type
string (ConnectionType)
Enum: "EVPL_VC" "EPL_VC" "EC_VC" "IP_VC" "ACCESS_EPL_VC" "EIA_VC" "EVPLAN_VC" "EPLAN_VC" "EVPTREE_VC" "EPTREE_VC" "IPWAN_VC" "IA_VC" "MC_VC" "IX_VC" "GW_VC" "IPX_VC"

Connection type

object (Operation)

Operation object for router actions

bgpIpv4RoutesCount
integer

IPV4 route count

bgpIpv6RoutesCount
integer

IPV6 route count

distinctIpv4PrefixesCount
integer

distinct IPV4 prefixes count

distinctIpv6PrefixesCount
integer

distinct IPV6 prefixes count

object (RouterActionsRouter)

Router object for router actions

uuid
string

Router UUID

href
string
type
string
Value: "XF_ROUTER"
object (Operation)

Operation object for router actions

bgpIpv4RoutesCount
integer

IPV4 route count

bgpIpv6RoutesCount
integer

IPV6 route count

distinctIpv4PrefixesCount
integer

distinct IPV4 prefixes count

distinctIpv6PrefixesCount
integer

distinct IPV6 prefixes 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)
Enum: "PING_COMMAND" "TRACEROUTE_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 (CloudRouterCommandRequestResponse)

Fabric Cloud Router Command Request

CloudRouterCommandPingResponse (object) or CloudRouterCommandTracerouteResponse (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)
Enum: "PING_COMMAND" "TRACEROUTE_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 (CloudRouterCommandRequestPayload)

Fabric Cloud Router Command Request

destination
required
string

Fabric Cloud Router Ping or Traceroute Command Destination

required
object (CloudRouterCommandRequestConnection)

Connection object for Cloud Router Command

uuid
required
string

Connection UUID

timeout
integer

Timeout in seconds for Fabric Cloud Router Command:

  • For PING_COMMAND: Packet timeout duration. The default value is 5.
  • For TRACEROUTE_COMMAND: Probe timeout duration. The default value is 2 and it is not configurable.
dataBytes
integer [ 16 .. 9000 ]
Default: 64

Ping Command DataBytes. This field is only applicable for commands of type PING_COMMAND.

probes
integer
Default: 3

Number of probes for Fabric Cloud Router Traceroute Command. This field is only applicable for commands of type TRACEROUTE_COMMAND and is not configurable.

hopsMax
integer <= 30
Default: 20

Maximum number of hops for the traceroute command. This field is only applicable for commands of type TRACEROUTE_COMMAND.

Responses

Request samples

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

Response samples

Content type
application/json
Example
{}

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)
Enum: "PING_COMMAND" "TRACEROUTE_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 (CloudRouterCommandRequestResponse)

Fabric Cloud Router Command Request

CloudRouterCommandPingResponse (object) or CloudRouterCommandTracerouteResponse (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)
Enum: "PING_COMMAND" "TRACEROUTE_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 (CloudRouterCommandRequestResponse)

Fabric Cloud Router Command Request

destination
string

Fabric Cloud Router Ping or Traceroute Command Destination

object (CloudRouterCommandRequestConnection)

Connection object for Cloud Router Command

uuid
required
string

Connection UUID

timeout
integer

Timeout in seconds for Fabric Cloud Router Command:

  • For PING_COMMAND: Packet timeout duration. The default value is 5.
  • For TRACEROUTE_COMMAND: Probe timeout duration. The default value is 2 and it is not configurable.
dataBytes
integer [ 16 .. 9000 ]
Default: 64

Ping Command DataBytes. This field is only applicable for commands of type PING_COMMAND.

interval
integer
Default: 1000

Time in milliseconds between sending each packet. This field is only applicable for commands of type PING_COMMAND.

count
integer
Default: 5

Total number of ping requests. This field is only applicable for commands of type PING_COMMAND.

probes
integer
Default: 3

Number of probes for Fabric Cloud Router Traceroute Command. This field is only applicable for commands of type TRACEROUTE_COMMAND and is not configurable.

hopsMax
integer <= 30
Default: 20

Maximum number of hops for the traceroute command. This field is only applicable for commands of type TRACEROUTE_COMMAND.

CloudRouterCommandPingResponse (object) or CloudRouterCommandTracerouteResponse (object) (CloudRouterCommandResponse)
One of
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)
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 (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
{
  • "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
  • /MED - Route table entry med
  • /* - 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" "/MED"

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

prefix
string
nextHop
string
MED
integer
localPreference
integer
asPath
Array of strings
object (RouteTableEntry_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
  • /type - Fabric Cloud Router type
  • /connectionsCount - Fabric Cloud Router attached connections count
  • /changeLog/createdDateTime - Fabric Cloud Router creation timestamp
  • /changeLog/updatedDateTime - Fabric Cloud Router last updated timestamp
  • /changeLog/deletedDateTime - Fabric Cloud Router deletion timestamp
  • /* - 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" "/type" "/connectionsCount" "/changeLog/createdDateTime" "/changeLog/updatedDateTime" "/changeLog/deletedDateTime" "/order/termLength"

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 (CloudRouterReadResponse)

Data returned from the API call.

Array
type
string
Enum: "IC_ROUTER" "XF_ROUTER"
name
string

Customer-provided Cloud Router name

object (SimplifiedLocationWithoutIBX)
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

href
string <uri>

Cloud Routers URI

uuid
string <uuid>

Equinix-assigned access point identifier

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 (marketplaceSubscription)

Equinix Fabric Entity for Marketplace Subscription

object (Changelog)

Change log

object (CloudRouterChange)

Current state of latest CloudRouter change

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" "BASIC" "STANDARD" "ADVANCED" "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" "BASIC" "STANDARD" "ADVANCED" "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" "BASIC" "STANDARD" "ADVANCED" "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": {
    }
}

Company Profiles

Company Profiles Beta

Create Company Profile

Create a new company profile Beta

Authorizations:
BearerAuth
Request Body schema: application/json
required
type
required
string
name
required
string [ 1 .. 50 ] characters
summary
required
string [ 1 .. 125 ] characters
description
required
string [ 1 .. 450 ] characters
Array of objects (CompanyProfileContact)
Array
type
string
Value: "SUPPORT"

Contact Type

Array of objects (CompanyProfileContact_contacts)
Array of objects (SimplifiedNotification)
Array
type
required
string
Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS" "TECHNICAL" "ORDERING" "QUOTE_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

Array of objects (Phone)

Array of contact phone numbers

overview
string
webUrl
required
string
contactUrl
string

Responses

Request samples

Content type
application/json
{
  • "type": "COMPANY_PROFILE",
  • "name": "Equinix",
  • "summary": "Global interconnection and data center company",
  • "description": "Equinix, Inc. connects the world's leading businesses to their customers, employees and partners inside the most interconnected data centers.",
  • "pointOfContacts": [
    ],
  • "notifications": [
    ],
  • "overview": "<b>About Initech Corp</b> <p>lorem ipsum</p>",
  • "webUrl": "https://www.equinix.com",
  • "contactUrl": "https://www.equinix.com/contact-us"
}

Response samples

Content type
application/json
{}

Get Company Profile by UUID

Get company profile details by UUID Beta

Authorizations:
BearerAuth
path Parameters
companyProfileId
required
string

Company Profile UUID

Responses

Response Schema: application/json
href
string
uuid
string
type
string
name
string [ 1 .. 50 ] characters
summary
string [ 1 .. 125 ] characters
description
string [ 1 .. 450 ] characters
state
string (CompanyProfileState)

Company Profile State

object (CompanyProfileResponse_account)
rootOrgId
string
Array of objects (CompanyMetro)
Array
href
string
metroCode
string
object (CompanyLogo)
href
string
uuid
string
extensionType
string
Array of objects (TagResponse)
Array
href
string <uri>
uuid
string <uuid>
type
string
name
string
displayName
string
state
string
Enum: "APPROVED" "PENDING_APPROVAL" "REJECTED"

Status of the Tag request. Can be APPROVED, PENDING_APPROVAL, REJECT

Array of objects (SimplifiedNotification)
object (Changelog)

Change log

Array of objects (CompanyServiceProfile)
Array
href
string
uuid
string
Array of objects (PrivateService)
Array
href
string
uuid
string
Array of objects (CompanyProfileContact)
Array
type
string
Value: "SUPPORT"

Contact Type

Array of objects (CompanyProfileContact_contacts)
Array of objects (SimplifiedNotification)
Array
type
required
string
Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS" "TECHNICAL" "ORDERING" "QUOTE_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

Array of objects (Phone)

Array of contact phone numbers

overview
string
webUrl
string
contactUrl
string
object (CompanyProfileChange)
uuid
string
type
string
status
string
createdDateTime
string <date-time>
updatedDateTime
string <date-time>
data
object (CompanyProfileChangeItem)
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 Company Profile

Delete company profile by UUID Beta

Authorizations:
BearerAuth
path Parameters
companyProfileId
required
string

Company Profile UUID

Responses

Response Schema: application/json
href
string
uuid
string
type
string
name
string [ 1 .. 50 ] characters
summary
string [ 1 .. 125 ] characters
description
string [ 1 .. 450 ] characters
state
string (CompanyProfileState)

Company Profile State

object (CompanyProfileResponse_account)
rootOrgId
string
Array of objects (CompanyMetro)
Array
href
string
metroCode
string
object (CompanyLogo)
href
string
uuid
string
extensionType
string
Array of objects (TagResponse)
Array
href
string <uri>
uuid
string <uuid>
type
string
name
string
displayName
string
state
string
Enum: "APPROVED" "PENDING_APPROVAL" "REJECTED"

Status of the Tag request. Can be APPROVED, PENDING_APPROVAL, REJECT

Array of objects (SimplifiedNotification)
object (Changelog)

Change log

Array of objects (CompanyServiceProfile)
Array
href
string
uuid
string
Array of objects (PrivateService)
Array
href
string
uuid
string
Array of objects (CompanyProfileContact)
Array
type
string
Value: "SUPPORT"

Contact Type

Array of objects (CompanyProfileContact_contacts)
Array of objects (SimplifiedNotification)
Array
type
required
string
Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS" "TECHNICAL" "ORDERING" "QUOTE_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

Array of objects (Phone)

Array of contact phone numbers

overview
string
webUrl
string
contactUrl
string
object (CompanyProfileChange)
uuid
string
type
string
status
string
createdDateTime
string <date-time>
updatedDateTime
string <date-time>
data
object (CompanyProfileChangeItem)
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
{}

Search Company Profiles

Search company profiles based on filter criteria Beta

Authorizations:
BearerAuth
query Parameters
viewPoint
string
Default: "aSide"

Viewpoint for the request, either 'aSide' or 'zSide'

Request Body schema: application/json
required
object (CompanyProfileSearchFilters)

Filter criteria for company profile search. The and array combines conditions where all must match. Each item in and is either a simple expression (property/operator/values) or an or group. At most one or group is allowed per request.

Array of CompanyProfileSearchSimpleExpression (object) or CompanyProfileSearchOrFilter (object) (CompanyProfileSearchFilter)
Array
One of
property
required
string
Enum: "/name" "/uuid" "/tags/name" "/tags/uuid" "/tags/displayName" "/state" "/metros/metroCode" "/change/status"

Searchable field name. Properties are grouped by their supported operators: String properties (support all operators):

  • /name - Company profile name
  • /uuid - Company profile UUID
  • /tags/name - Tag name
  • /tags/uuid - Tag UUID
  • /tags/displayName - Tag display name

Discrete value properties (only support =, !=, IN, NOT IN):

  • /state - Company profile state (PENDING, PROVISIONED, DEPROVISIONED, REJECTED)
  • /metros/metroCode - Metro code (e.g. SV, NY, DC)
  • /change/status - Change status (PENDING, COMPLETED, REJECTED) — seller and admin users only
operator
required
string
Enum: "=" "!=" "LIKE" "NOT LIKE" "ILIKE" "NOT ILIKE" "IN" "NOT IN"

Comparison operator. LIKE, NOT LIKE, ILIKE, and NOT ILIKE require exactly one value. All other operators accept one or more values.

  • = - equal; equivalent to IN when multiple values are provided
  • != - not equal; equivalent to NOT IN when multiple values are provided
  • LIKE - case-sensitive partial match (single value)
  • NOT LIKE - case-sensitive partial non-match (single value)
  • ILIKE - case-insensitive partial match (single value)
  • NOT ILIKE - case-insensitive partial non-match (single value)
  • IN - matches any of the provided values
  • NOT IN - does not match any of the provided values
values
required
Array of strings non-empty
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.

object (Sort)
property
string

Property to sort by. Supported values:

  • /name - Company profile name
  • /state - Company profile state
  • /changeLog/updatedDateTime - Date and time the profile was last updated
  • /changeLog/createdDateTime - Date and time the profile was created
direction
string (CompanyProfileSortDirection)
Default: "ASC"
Enum: "DESC" "ASC"

Sorting direction

Responses

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

required
Array of objects (CompanyProfileResponse)
Array
href
string
uuid
string
type
string
name
string [ 1 .. 50 ] characters
summary
string [ 1 .. 125 ] characters
description
string [ 1 .. 450 ] characters
state
string (CompanyProfileState)

Company Profile State

object (CompanyProfileResponse_account)
Array of objects (CompanyMetro)
object (CompanyLogo)
Array of objects (TagResponse)
Array of objects (CompanyServiceProfile)
Array of objects (PrivateService)
Array of objects (CompanyProfileContact)
Array of objects (SimplifiedNotification)
overview
string
webUrl
string
contactUrl
string
object (CompanyProfileChange)
object (Changelog)

Change log

Request samples

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

Response samples

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

Get Service Profiles

Get all service profiles attached to a company profile Beta

Authorizations:
BearerAuth
path Parameters
companyProfileId
required
string

Company Profile UUID

Responses

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

List of service profiles

Array
href
string
uuid
string

Response samples

Content type
application/json
{}

Attach Service Profile

Attach a service profile to a company profile Beta

Authorizations:
BearerAuth
path Parameters
companyProfileId
required
string

Company Profile UUID

serviceProfileId
required
string

Service Profile UUID

Responses

Response Schema: application/json
href
string

URL to the attached service profile

type
required
string

Type of the service or attachment

uuid
required
string

Unique identifier for the service profile

attachmentStatus
string

Status of the attachment operation

Response samples

Content type
application/json
{}

Detach Service Profile

Detach a service profile from a company profile Beta

Authorizations:
BearerAuth
path Parameters
companyProfileId
required
string

Company Profile UUID

serviceProfileId
required
string

Service Profile UUID

Responses

Response Schema: application/json
href
string

URL to the attached service profile

type
required
string

Type of the service or attachment

uuid
required
string

Unique identifier for the service profile

attachmentStatus
string

Status of the attachment operation

Response samples

Content type
application/json
{}

Get Tags

Get all tags attached to a company profile Beta

Authorizations:
BearerAuth
path Parameters
companyProfileId
required
string

Company Profile UUID

Responses

Response Schema: application/json
Array of objects (TagResponse)
Array
href
string <uri>
uuid
string <uuid>
type
string
name
string
displayName
string
state
string
Enum: "APPROVED" "PENDING_APPROVAL" "REJECTED"

Status of the Tag request. Can be APPROVED, PENDING_APPROVAL, REJECT

Array of objects (SimplifiedNotification)
object (Changelog)

Change log

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
{
  • "data": [
    ],
  • "pagination": {
    }
}

Attach Tag

Attach a tag to a company profile Beta

Authorizations:
BearerAuth
path Parameters
companyProfileId
required
string

Company Profile UUID

tagId
required
string

Tag UUID

Responses

Response Schema: application/json
href
string

URL to the attached tag

type
required
string

Type of the tag or attachment

uuid
required
string

Unique identifier for the tag

attachmentStatus
string

Status of the attachment operation

Response samples

Content type
application/json
{}

Detach Tag

Detach a tag from a company profile Beta

Authorizations:
BearerAuth
path Parameters
companyProfileId
required
string

Company Profile UUID

tagId
required
string

Tag UUID

Responses

Response Schema: application/json
href
string

URL to the attached tag

type
required
string

Type of the tag or attachment

uuid
required
string

Unique identifier for the tag

attachmentStatus
string

Status of the attachment operation

Response samples

Content type
application/json
{}

Get Private Services

Get all private services attached to a company profile Beta

Authorizations:
BearerAuth
path Parameters
companyProfileId
required
string

Company Profile UUID

Responses

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

List of private services

Array
href
string
uuid
string

Response samples

Content type
application/json
{}

Attach Private Service

Attach a private service to a company profile Beta

Authorizations:
BearerAuth
path Parameters
companyProfileId
required
string

Company Profile UUID

privateServiceId
required
string

Private Service UUID

Responses

Response Schema: application/json
href
string

URL to the attached private service

type
required
string

Type of the private service or attachment

uuid
required
string

Unique identifier for the private service

attachmentStatus
string

Status of the attachment operation

Response samples

Content type
application/json
{}

Detach Private Service

Detach a private service from a company profile Beta

Authorizations:
BearerAuth
path Parameters
companyProfileId
required
string

Company Profile UUID

privateServiceId
required
string

Private Service UUID

Responses

Response Schema: application/json
href
string

URL to the attached private service

type
required
string

Type of the private service or attachment

uuid
required
string

Unique identifier for the private service

attachmentStatus
string

Status of the attachment operation

Response samples

Content type
application/json
{}

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" "EVPTREE_VC" "EPTREE_VC" "IPWAN_VC" "IA_VC" "MC_VC" "IX_VC" "GW_VC" "IPX_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).

contractedBandwidth
integer

Contracted bandwidth

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" "TECHNICAL" "ORDERING" "QUOTE_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

Array of objects (Phone)

Array of contact phone numbers

bandwidth
required
integer [ 0 .. 100000 ]

Connection bandwidth in Mbps

geoScope
string (GeoScopeType)
Enum: "CANADA" "CONUS" "JAPAN" "UK" "AUSTRALIA" "BRAZIL" "SWITZERLAND" "EU"

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" "APP_LINK" "XF_IC"

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

object (Interconnect)

Interconnect specification Beta

object (ProviderEnvironment)

Provider Environment associated with an IC_PROFILE service profile Beta

sellerRegion
string

Access point seller region

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

Access point peering type

authenticationKey
string

Access point authentication key

activationKey
string

Access point activation key

providerConnectionId
string

Provider assigned Connection Id

object (VirtualNetwork)

Virtual Network Information

object (MetalInterconnection)

Metal Interconnection

role
string
Enum: "LEAF" "ROOT"

E-Tree network connection role

object (ProductOffering)

Product offering for connection. Applicable to zSide only.

bandwidthCommit
integer [ 0 .. 100000 ]

Bandwidth commit in Mbps

providerIdentifier
string

Provider identifier

object (Address)

Address.

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" "APP_LINK" "XF_IC"

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

object (Interconnect)

Interconnect specification Beta

object (ProviderEnvironment)

Provider Environment associated with an IC_PROFILE service profile Beta

sellerRegion
string

Access point seller region

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

Access point peering type

authenticationKey
string

Access point authentication key

activationKey
string

Access point activation key

providerConnectionId
string

Provider assigned Connection Id

object (VirtualNetwork)

Virtual Network Information

object (MetalInterconnection)

Metal Interconnection

role
string
Enum: "LEAF" "ROOT"

E-Tree network connection role

object (ProductOffering)

Product offering for connection. Applicable to zSide only.

bandwidthCommit
integer [ 0 .. 100000 ]

Bandwidth commit in Mbps

providerIdentifier
string

Provider identifier

object (Address)

Address.

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" "EVPTREE_VC" "EPTREE_VC" "IPWAN_VC" "IA_VC" "MC_VC" "IX_VC" "GW_VC" "IPX_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" "PROVISIONING" ""

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" "ERROR" "ORDERING" "DELETING" "PENDING DELETE" "N/A"

Connection provider readiness status

equinixStatus
string (EquinixStatus)
Enum: "REJECTED_ACK" "REJECTED" "PENDING_DELETE" "PROVISIONED" "PENDING_APPROVAL" "NOT_PROVISIONED" "DEPROVISIONING" "NOT_DEPROVISIONED" "PENDING_AUTO_APPROVAL" "PROVISIONING" "PENDING_BGP_PEERING" "PENDING_PROVIDER_VLAN" "DEPROVISIONED" "DELETED" "AUTO_APPROVAL_FAILED" "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

maintenanceStatus
string (maintenanceState)
Enum: "SCHEDULED" "IN_PROGRESS" "COMPLETED" "DEFERRED"

Maintenance lifecycle state

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).

contractedBandwidth
integer

Contracted bandwidth

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" "TECHNICAL" "ORDERING" "QUOTE_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

Array of objects (Phone)

Array of contact phone numbers

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" "UK" "AUSTRALIA" "BRAZIL" "SWITZERLAND" "EU"

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" "APP_LINK" "XF_IC"

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

object (Interconnect)

Interconnect specification Beta

object (ProviderEnvironment)

Provider Environment associated with an IC_PROFILE service profile Beta

sellerRegion
string

Access point seller region

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

Access point peering type

authenticationKey
string

Access point authentication key

activationKey
string

Access point activation key

providerConnectionId
string

Provider assigned Connection Id

object (VirtualNetwork)

Virtual Network Information

object (MetalInterconnection)

Metal Interconnection

role
string
Enum: "LEAF" "ROOT"

E-Tree network connection role

object (ProductOffering)

Product offering for connection. Applicable to zSide only.

bandwidthCommit
integer [ 0 .. 100000 ]

Bandwidth commit in Mbps

providerIdentifier
string

Provider identifier

object (Address)

Address.

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" "APP_LINK" "XF_IC"

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

object (Interconnect)

Interconnect specification Beta

object (ProviderEnvironment)

Provider Environment associated with an IC_PROFILE service profile Beta

sellerRegion
string

Access point seller region

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

Access point peering type

authenticationKey
string

Access point authentication key

activationKey
string

Access point activation key

providerConnectionId
string

Provider assigned Connection Id

object (VirtualNetwork)

Virtual Network Information

object (MetalInterconnection)

Metal Interconnection

role
string
Enum: "LEAF" "ROOT"

E-Tree network connection role

object (ProductOffering)

Product offering for connection. Applicable to zSide only.

bandwidthCommit
integer [ 0 .. 100000 ]

Bandwidth commit in Mbps

providerIdentifier
string

Provider identifier

object (Address)

Address.

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" "EVPTREE_VC" "EPTREE_VC" "IPWAN_VC" "IA_VC" "MC_VC" "IX_VC" "GW_VC" "IPX_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" "PROVISIONING" ""

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" "ERROR" "ORDERING" "DELETING" "PENDING DELETE" "N/A"

Connection provider readiness status

equinixStatus
string (EquinixStatus)
Enum: "REJECTED_ACK" "REJECTED" "PENDING_DELETE" "PROVISIONED" "PENDING_APPROVAL" "NOT_PROVISIONED" "DEPROVISIONING" "NOT_DEPROVISIONED" "PENDING_AUTO_APPROVAL" "PROVISIONING" "PENDING_BGP_PEERING" "PENDING_PROVIDER_VLAN" "DEPROVISIONED" "DELETED" "AUTO_APPROVAL_FAILED" "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

maintenanceStatus
string (maintenanceState)
Enum: "SCHEDULED" "IN_PROGRESS" "COMPLETED" "DEFERRED"

Maintenance lifecycle state

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).

contractedBandwidth
integer

Contracted bandwidth

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" "TECHNICAL" "ORDERING" "QUOTE_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

Array of objects (Phone)

Array of contact phone numbers

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" "UK" "AUSTRALIA" "BRAZIL" "SWITZERLAND" "EU"

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" "APP_LINK" "XF_IC"

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

object (Interconnect)

Interconnect specification Beta

object (ProviderEnvironment)

Provider Environment associated with an IC_PROFILE service profile Beta

sellerRegion
string

Access point seller region

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

Access point peering type

authenticationKey
string

Access point authentication key

activationKey
string

Access point activation key

providerConnectionId
string

Provider assigned Connection Id

object (VirtualNetwork)

Virtual Network Information

object (MetalInterconnection)

Metal Interconnection

role
string
Enum: "LEAF" "ROOT"

E-Tree network connection role

object (ProductOffering)

Product offering for connection. Applicable to zSide only.

bandwidthCommit
integer [ 0 .. 100000 ]

Bandwidth commit in Mbps

providerIdentifier
string

Provider identifier

object (Address)

Address.

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" "APP_LINK" "XF_IC"

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

object (Interconnect)

Interconnect specification Beta

object (ProviderEnvironment)

Provider Environment associated with an IC_PROFILE service profile Beta

sellerRegion
string

Access point seller region

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

Access point peering type

authenticationKey
string

Access point authentication key

activationKey
string

Access point activation key

providerConnectionId
string

Provider assigned Connection Id

object (VirtualNetwork)

Virtual Network Information

object (MetalInterconnection)

Metal Interconnection

role
string
Enum: "LEAF" "ROOT"

E-Tree network connection role

object (ProductOffering)

Product offering for connection. Applicable to zSide only.

bandwidthCommit
integer [ 0 .. 100000 ]

Bandwidth commit in Mbps

providerIdentifier
string

Provider identifier

object (Address)

Address.

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-Port-2-Port-Connection-1",
  • "bandwidth": 1000,
  • "order": {
    },
  • "aSide": {
    },
  • "zSide": {
    },
  • "project": {
    },
  • "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" "EVPTREE_VC" "EPTREE_VC" "IPWAN_VC" "IA_VC" "MC_VC" "IX_VC" "GW_VC" "IPX_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" "PROVISIONING" ""

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" "ERROR" "ORDERING" "DELETING" "PENDING DELETE" "N/A"

Connection provider readiness status

equinixStatus
string (EquinixStatus)
Enum: "REJECTED_ACK" "REJECTED" "PENDING_DELETE" "PROVISIONED" "PENDING_APPROVAL" "NOT_PROVISIONED" "DEPROVISIONING" "NOT_DEPROVISIONED" "PENDING_AUTO_APPROVAL" "PROVISIONING" "PENDING_BGP_PEERING" "PENDING_PROVIDER_VLAN" "DEPROVISIONED" "DELETED" "AUTO_APPROVAL_FAILED" "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

maintenanceStatus
string (maintenanceState)
Enum: "SCHEDULED" "IN_PROGRESS" "COMPLETED" "DEFERRED"

Maintenance lifecycle state

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).

contractedBandwidth
integer

Contracted bandwidth

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" "TECHNICAL" "ORDERING" "QUOTE_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

Array of objects (Phone)

Array of contact phone numbers

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" "UK" "AUSTRALIA" "BRAZIL" "SWITZERLAND" "EU"

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" "APP_LINK" "XF_IC"

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

object (Interconnect)

Interconnect specification Beta

object (ProviderEnvironment)

Provider Environment associated with an IC_PROFILE service profile Beta

sellerRegion
string

Access point seller region

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

Access point peering type

authenticationKey
string

Access point authentication key

activationKey
string

Access point activation key

providerConnectionId
string

Provider assigned Connection Id

object (VirtualNetwork)

Virtual Network Information

object (MetalInterconnection)

Metal Interconnection

role
string
Enum: "LEAF" "ROOT"

E-Tree network connection role

object (ProductOffering)

Product offering for connection. Applicable to zSide only.

bandwidthCommit
integer [ 0 .. 100000 ]

Bandwidth commit in Mbps

providerIdentifier
string

Provider identifier

object (Address)

Address.

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" "APP_LINK" "XF_IC"

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

object (Interconnect)

Interconnect specification Beta

object (ProviderEnvironment)

Provider Environment associated with an IC_PROFILE service profile Beta

sellerRegion
string

Access point seller region

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

Access point peering type

authenticationKey
string

Access point authentication key

activationKey
string

Access point activation key

providerConnectionId
string

Provider assigned Connection Id

object (VirtualNetwork)

Virtual Network Information

object (MetalInterconnection)

Metal Interconnection

role
string
Enum: "LEAF" "ROOT"

E-Tree network connection role

object (ProductOffering)

Product offering for connection. Applicable to zSide only.

bandwidthCommit
integer [ 0 .. 100000 ]

Bandwidth commit in Mbps

providerIdentifier
string

Provider identifier

object (Address)

Address.

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" "EVPTREE_VC" "EPTREE_VC" "IPWAN_VC" "IA_VC" "MC_VC" "IX_VC" "GW_VC" "IPX_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" "PROVISIONING" ""

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" "ERROR" "ORDERING" "DELETING" "PENDING DELETE" "N/A"

Connection provider readiness status

equinixStatus
string (EquinixStatus)
Enum: "REJECTED_ACK" "REJECTED" "PENDING_DELETE" "PROVISIONED" "PENDING_APPROVAL" "NOT_PROVISIONED" "DEPROVISIONING" "NOT_DEPROVISIONED" "PENDING_AUTO_APPROVAL" "PROVISIONING" "PENDING_BGP_PEERING" "PENDING_PROVIDER_VLAN" "DEPROVISIONED" "DELETED" "AUTO_APPROVAL_FAILED" "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

maintenanceStatus
string (maintenanceState)
Enum: "SCHEDULED" "IN_PROGRESS" "COMPLETED" "DEFERRED"

Maintenance lifecycle state

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).

contractedBandwidth
integer

Contracted bandwidth

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" "TECHNICAL" "ORDERING" "QUOTE_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

Array of objects (Phone)

Array of contact phone numbers

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" "UK" "AUSTRALIA" "BRAZIL" "SWITZERLAND" "EU"

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" "APP_LINK" "XF_IC"

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

object (Interconnect)

Interconnect specification Beta

object (ProviderEnvironment)

Provider Environment associated with an IC_PROFILE service profile Beta

sellerRegion
string

Access point seller region

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

Access point peering type

authenticationKey
string

Access point authentication key

activationKey
string

Access point activation key

providerConnectionId
string

Provider assigned Connection Id

object (VirtualNetwork)

Virtual Network Information

object (MetalInterconnection)

Metal Interconnection

role
string
Enum: "LEAF" "ROOT"

E-Tree network connection role

object (ProductOffering)

Product offering for connection. Applicable to zSide only.

bandwidthCommit
integer [ 0 .. 100000 ]

Bandwidth commit in Mbps

providerIdentifier
string

Provider identifier

object (Address)

Address.

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" "APP_LINK" "XF_IC"

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

object (Interconnect)

Interconnect specification Beta

object (ProviderEnvironment)

Provider Environment associated with an IC_PROFILE service profile Beta

sellerRegion
string

Access point seller region

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

Access point peering type

authenticationKey
string

Access point authentication key

activationKey
string

Access point activation key

providerConnectionId
string

Provider assigned Connection Id

object (VirtualNetwork)

Virtual Network Information

object (MetalInterconnection)

Metal Interconnection

role
string
Enum: "LEAF" "ROOT"

E-Tree network connection role

object (ProductOffering)

Product offering for connection. Applicable to zSide only.

bandwidthCommit
integer [ 0 .. 100000 ]

Bandwidth commit in Mbps

providerIdentifier
string

Provider identifier

object (Address)

Address.

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" "EVPTREE_VC" "EPTREE_VC" "IPWAN_VC" "IA_VC" "MC_VC" "IX_VC" "GW_VC" "IPX_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" "PROVISIONING" ""

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" "ERROR" "ORDERING" "DELETING" "PENDING DELETE" "N/A"

Connection provider readiness status

equinixStatus
string (EquinixStatus)
Enum: "REJECTED_ACK" "REJECTED" "PENDING_DELETE" "PROVISIONED" "PENDING_APPROVAL" "NOT_PROVISIONED" "DEPROVISIONING" "NOT_DEPROVISIONED" "PENDING_AUTO_APPROVAL" "PROVISIONING" "PENDING_BGP_PEERING" "PENDING_PROVIDER_VLAN" "DEPROVISIONED" "DELETED" "AUTO_APPROVAL_FAILED" "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

maintenanceStatus
string (maintenanceState)
Enum: "SCHEDULED" "IN_PROGRESS" "COMPLETED" "DEFERRED"

Maintenance lifecycle state

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).

contractedBandwidth
integer

Contracted bandwidth

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" "TECHNICAL" "ORDERING" "QUOTE_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

Array of objects (Phone)

Array of contact phone numbers

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" "UK" "AUSTRALIA" "BRAZIL" "SWITZERLAND" "EU"

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" "APP_LINK" "XF_IC"

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

object (Interconnect)

Interconnect specification Beta

object (ProviderEnvironment)

Provider Environment associated with an IC_PROFILE service profile Beta

sellerRegion
string

Access point seller region

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

Access point peering type

authenticationKey
string

Access point authentication key

activationKey
string

Access point activation key

providerConnectionId
string

Provider assigned Connection Id

object (VirtualNetwork)

Virtual Network Information

object (MetalInterconnection)

Metal Interconnection

role
string
Enum: "LEAF" "ROOT"

E-Tree network connection role

object (ProductOffering)

Product offering for connection. Applicable to zSide only.

bandwidthCommit
integer [ 0 .. 100000 ]

Bandwidth commit in Mbps

providerIdentifier
string

Provider identifier

object (Address)

Address.

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" "APP_LINK" "XF_IC"

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

object (Interconnect)

Interconnect specification Beta

object (ProviderEnvironment)

Provider Environment associated with an IC_PROFILE service profile Beta

sellerRegion
string

Access point seller region

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

Access point peering type

authenticationKey
string

Access point authentication key

activationKey
string

Access point activation key

providerConnectionId
string

Provider assigned Connection Id

object (VirtualNetwork)

Virtual Network Information

object (MetalInterconnection)

Metal Interconnection

role
string
Enum: "LEAF" "ROOT"

E-Tree network connection role

object (ProductOffering)

Product offering for connection. Applicable to zSide only.

bandwidthCommit
integer [ 0 .. 100000 ]

Bandwidth commit in Mbps

providerIdentifier
string

Provider identifier

object (Address)

Address.

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_CREATION_RETRY" "CONNECTION_DELETION_RETRY"

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

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/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" "/bandwidth" "/change/status" "/changeLog/createdBy" "/changeLog/createdDateTime" "/changeLog/deletedBy" "/changeLog/deletedDateTime" "/changeLog/lastUpdatedBy" "/operation/equinixStatus" "/operation/providerStatus" "/operation/maintenanceStatus" "/operation/lockEnabled" "/project/projectId" "/redundancy/group" "/redundancy/priority" "/zSide/accessPoint/account/accountName" "/zSide/accessPoint/authenticationKey" "/zSide/accessPoint/linkProtocol/vlanTagMin" "/zSide/accessPoint/linkProtocol/vlanTagMax" "/zSide/accessPoint/location/metroCode" "/zSide/accessPoint/location/metroName" "/zSide/accessPoint/sellerRegion" "/zSide/accessPoint/name" "/zSide/accessPoint/port/uuid" "/zSide/accessPoint/network/uuid" "/zSide/accessPoint/port/name" "/zSide/accessPoint/profile/uuid" "/zSide/accessPoint/type" "/zSide/accessPoint/role" "/zSide/accessPoint/virtualDevice/name" "/zSide/accessPoint/virtualDevice/uuid" "/zSide/serviceToken/uuid" "/zSide/internetAccess/uuid" "/state"

Possible field names to use on filters

operator
string
Enum: "=" "!=" ">" ">=" "<" "<=" "LIKE" "ILKE" "IS NOT NULL" "IS NULL" "IN" "BETWEEN"
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/role" "/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/role" "/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" "EVPTREE_VC" "EPTREE_VC" "IPWAN_VC" "IA_VC" "MC_VC" "IX_VC" "GW_VC" "IPX_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" "PROVISIONING" ""

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" "UK" "AUSTRALIA" "BRAZIL" "SWITZERLAND" "EU"

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 .. 100000 ]

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": [
    ]
}

Health

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": [
    ]
}

Internet Exchange Services

Internet Exchange Services Beta

Get Internet Exchange Service

The API provides capability to get Internet Exchange Service

Authorizations:
BearerAuth
path Parameters
exchangeServiceId
required
string <uuid> (ExchangeServiceId)
Example: a8ba52de-faae-43b5-b0b1-6904d37ee011

Internet Exchange Service Id

Responses

Response Schema: application/json
href
string

Internet Exchange Service URI

uuid
string <uuid>

Internet Exchange Service identifier

type
string
Default: "IX"
Value: "IX"

Internet Exchange Service Type

name
string

Name

bandwidth
integer

bandwidth in Mbps

description
string

Description

state
string
Enum: "PROVISIONING" "PROVISIONING_FAILED" "PENDING_ACTIVATION" "ACTIVATING" "ACTIVATING_FAILED" "PROVISIONED" "REPROVISIONING" "REPROVISIONING_FAILED" "DEPROVISIONING" "DEPROVISIONED" "DEPROVISIONING_FAILED"

State

object (SimplifiedLocation)
metroHref
string
region
string
metroName
string
metroCode
string
ibx
string
Deprecated
object (PublicPeeringConnectionResponse)
type
string <enum>

Connection type IX_VC

href
string <string>

URI

uuid
string <uuid>

uuid

object (RoutingProtocolResponse)
customerAsn
string
macAddress
string
vlan
integer <int64>

VLAN ID

routeServerAsn
integer <int64>

Equinix Route Server ASN

object (ExchangeServiceResponseBgp)
customerPeerIp
string
domainName
string
primaryRouteServerIp
string
secondaryRouteServerIp
string
asSet
string
mlpeEnabled
boolean
md5AuthKey
string
rcMd5AuthKey
string
prefixes
Array of strings

List of IP prefix

maxPrefixLimit
integer <int64>
prependSelfEnabled
boolean
object (ExchangeServiceResponseBgp)
customerPeerIp
string
domainName
string
primaryRouteServerIp
string
secondaryRouteServerIp
string
asSet
string
mlpeEnabled
boolean
md5AuthKey
string
rcMd5AuthKey
string
prefixes
Array of strings

List of IP prefix

maxPrefixLimit
integer <int64>
prependSelfEnabled
boolean
object (RouteCollector)

Route Collector

asn
integer <int64>

Route Collector ASN

ipV4
string

Route Collector ipV4 address

ipV6
string

Route Collector ipV6 address

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).

contractedBandwidth
integer

Contracted bandwidth

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 (ExchangeServiceNotification)

Preferences for notifications on Internet Exchange Service configuration or status changes

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

Internet Exchange Service Notification Type

registeredUsers
required
Array of strings

Array of registered users

object (PlatformChangelog)

Change log

createdBy
string

Created by User Key

createdDateTime
string <date-time>

Created by Date and Time

updatedBy
string

Updated by User Key

updatedDateTime
string <date-time>

Updated by Date and Time

deletedBy
string

Deleted by User Key

deletedDateTime
string <date-time>

Deleted by Date and Time

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/exchangeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011",
  • "uuid": "a8ba52de-faae-43b5-b0b1-6904d37ee011",
  • "type": "IX",
  • "name": "ix_exchange_service",
  • "bandwidth": 400000,
  • "description": "ix_exchange_service",
  • "state": "PROVISIONING",
  • "location": {},
  • "publicPeeringConnection": {},
  • "routingProtocol": {
    },
  • "order": {
    },
  • "project": {
    },
  • "account": {
    },
  • "notifications": [
    ],
  • "changelog": {
    }
}

Search Internet Exchange Service

The API provides capability to get list of user's Internet Exchange Service using search criteria, including optional filtering, pagination and sorting.

Authorizations:
BearerAuth
Request Body schema: application/json
required
ExchangeServiceAndExpression (object) or ExchangeServiceOrExpression (object) or ExchangeServicePropertyExpression (object) (ExchangeServiceSearchExpression)
One of
and
required
Array of any (ExchangeServiceSearchExpression)
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 (ExchangeServiceSearchSortCriteria)
Array
direction
string
Default: "DESC"
Enum: "DESC" "ASC"

Sorting direction

property
string
Default: "/changeLog/updatedDateTime"
Enum: "/name" "/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 (ExchangeServiceSearchSortCriteria)
Array
direction
string
Default: "DESC"
Enum: "DESC" "ASC"

Sorting direction

property
string
Default: "/changeLog/updatedDateTime"
Enum: "/name" "/changeLog/createdDateTime" "/changeLog/updatedDateTime"

Possible field names to use on sorting

Array of objects (ExchangeServiceResponse)
Array
href
string

Internet Exchange Service URI

uuid
string <uuid>

Internet Exchange Service identifier

type
string
Default: "IX"
Value: "IX"

Internet Exchange Service Type

name
string

Name

bandwidth
integer

bandwidth in Mbps

description
string

Description

state
string
Enum: "PROVISIONING" "PROVISIONING_FAILED" "PENDING_ACTIVATION" "ACTIVATING" "ACTIVATING_FAILED" "PROVISIONED" "REPROVISIONING" "REPROVISIONING_FAILED" "DEPROVISIONING" "DEPROVISIONED" "DEPROVISIONING_FAILED"

State

object (SimplifiedLocation)
object (PublicPeeringConnectionResponse)
object (RoutingProtocolResponse)
object (Order)
object (Project)
object (SimplifiedAccount)
Array of objects (ExchangeServiceNotification)

Preferences for notifications on Internet Exchange Service configuration or status changes

object (PlatformChangelog)

Change log

Request samples

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

Response samples

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

Gateways

Fabric Gateway Service Beta

Create Gateway

This API provides capability to create user's Gateways

Authorizations:
BearerAuth
Request Body schema: application/json
required
type
required
string (GatewayType)
Value: "VPN_GW"

Gateway type

name
required
string <string> [ 1 .. 50 ] characters

Customer-provided Gateway name

description
string <string>

Customer-provided Gateway description

bandwidth
required
integer [ 0 .. 10000 ]

Gateway bandwidth in Mbps

localAsn
required
integer

Gateway local Autonomous System Number

required
object (Router)
uuid
string <uuid>

Cloud Router UUID

type
string
Value: "XF_ROUTER"
haEnabled
boolean
Default: false

High availability enabled

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

required
object (Project)
projectId
required
string

Subscriber-assigned project ID

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).

contractedBandwidth
integer

Contracted bandwidth

Responses

Request samples

Content type
application/json
{
  • "type": "VPN_GW",
  • "name": "My-VPN-Gateway",
  • "description": "my test gateway",
  • "bandwidth": 1000,
  • "haEnabled": true,
  • "router": {
    },
  • "project": {
    },
  • "account": {
    }
}

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/gateways/c93a9ca0-bb56-490b-8bce-4b2bdaeb4d46",
  • "uuid": "c93a9ca0-bb56-490b-8bce-4b2bdaeb4d46",
  • "type": "VPN_GW",
  • "name": "My-VPN-Gateway",
  • "description": "my test gateway",
  • "state": "PROVISIONING",
  • "bandwidth": 50,
  • "router": {},
  • "haEnabled": true,
  • "ipv4": {
    },
  • "project": {
    },
  • "account": {
    },
  • "changeLog": {
    }
}

Get Gateway

This API provides capability to retrieve user's Gateways

Authorizations:
BearerAuth
path Parameters
gatewayId
required
string <uuid> (GatewayId)
Example: 6658cc3b-18e0-437c-b972-62b51a419a1e

Gateway UUID

Responses

Response Schema: application/json
href
string <uri>

Gateways URI

type
string (GatewayType)
Value: "VPN_GW"

Gateway type

uuid
string <uuid>

Equinix-assigned access point identifier

name
string <string>

Customer-provided Gateway name

description
string <string>

Customer-provided Gateway description

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

Gateway lifecycle state

bandwidth
integer [ 0 .. 100000 ]

Gateway bandwidth in Mbps

localAsn
integer

Gateway local Autonomous System Number

object (Router)
href
string <uri>

Fabric Cloud Router URI

uuid
string <uuid>

Cloud Router UUID

type
string
Value: "XF_ROUTER"
object (Gateway_ipv4)

Gateway IPv4 address

primaryIp
string
secondaryIp
string
object (Project)
projectId
required
string

Subscriber-assigned project ID

object (Account)
accountId
integer

Account identifier

accountNumber
integer

Account number

accountName
string

Account name

ucmId
string

Account ucm id

globalCustId
string

Global customer organization id

orgId
integer

Customer organization id

organizationName
string

Customer organization name

subCustomes
Array of objects (Account)

All sub customer accounts

countryCode
string

Account country code

operationalUnit
string

Account operational unit

operationalUnitMetros
Array of strings

Account operational unit metros

signatureRequired
boolean

Is signature required

poBearing
boolean

Purchase order bearing

default
boolean

Default account or not

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).

contractedBandwidth
integer

Contracted bandwidth

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/gateways/c93a9ca0-bb56-490b-8bce-4b2bdaeb4d46",
  • "uuid": "c93a9ca0-bb56-490b-8bce-4b2bdaeb4d46",
  • "type": "VPN_GW",
  • "name": "My-VPN-Gateway",
  • "description": "my test gateway",
  • "state": "PROVISIONED",
  • "bandwidth": 50,
  • "router": {},
  • "haEnabled": true,
  • "ipv4": {
    },
  • "project": {
    },
  • "account": {
    },
  • "changeLog": {
    }
}

Delete Gateway

This API provides capability to delete user's Gateways

Authorizations:
BearerAuth
path Parameters
gatewayId
required
string <uuid> (GatewayId)
Example: 6658cc3b-18e0-437c-b972-62b51a419a1e

Gateway UUID

Responses

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/gateways/c93a9ca0-bb56-490b-8bce-4b2bdaeb4d46",
  • "uuid": "c93a9ca0-bb56-490b-8bce-4b2bdaeb4d46",
  • "type": "VPN_GW",
  • "name": "My-VPN-Gateway",
  • "description": "my test gateway",
  • "state": "DEPROVISIONING",
  • "bandwidth": 50,
  • "router": {},
  • "haEnabled": true,
  • "ipv4": {
    },
  • "project": {
    },
  • "account": {
    },
  • "changeLog": {
    }
}

Update Gateway by ID

Update Gateway by Uuid

Authorizations:
BearerAuth
path Parameters
gatewayId
required
string <uuid> (GatewayId)
Example: 6658cc3b-18e0-437c-b972-62b51a419a1e

Gateway 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

Request samples

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

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/gateways/c93a9ca0-bb56-490b-8bce-4b2bdaeb4d46",
  • "uuid": "c93a9ca0-bb56-490b-8bce-4b2bdaeb4d46",
  • "type": "VPN_GW",
  • "name": "Gw-Name-2",
  • "description": "my test gateway",
  • "state": "REPROVISIONING",
  • "bandwidth": 50,
  • "router": {},
  • "haEnabled": true,
  • "ipv4": {
    },
  • "project": {
    },
  • "account": {
    },
  • "changeLog": {
    }
}

Fabric One

Fabric One Beta

Create Interconnect

This API provides capability to create user's Interconnect Beta

Authorizations:
BearerAuth
Request Body schema: application/json
required
type
required
string
Value: "XF_IC"

Interconnect type

name
required
string [ 1 .. 24 ] characters

Customer-provided interconnect name

description
string [ 1 .. 50 ] characters

Customer-provided interconnect description

required
object (InterconnectLocationRequest)

Interconnect location for create request

metroCode
string

Metro code where the interconnect is created

required
object (InterconnectPackage)

Interconnect Package details Beta

type
required
string

Interconnect Package Type

uuid
string

Equinix-assigned Interconnect Package identifier

code
required
string

Interconnect Package code (e.g. LAB, BASIC, STANDARD, PREMIUM)

description
string

Interconnect Package description

routesMax
integer

Maximum number of routes

bandwidthMax
integer

Maximum bandwidth in Mbps

isRemote
boolean

Authorization to connect remotely

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).

contractedBandwidth
integer

Contracted bandwidth

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

required
object (Project)
projectId
required
string

Subscriber-assigned project ID

required
Array of objects (InterconnectNotification)

Preferences for notifications on interconnect configuration or status changes

Array
type
string
Value: "NOTIFICATIONS"

Notification type

emails
Array of strings <email> [ items <email > ]

Array of contact emails

Responses

Response Schema: application/json
href
string

Interconnect URI

uuid
string <uuid>

Equinix-assigned interconnect identifier

type
string
Value: "XF_IC"

Interconnect type

name
string

Interconnect name

description
string

Interconnect description

state
string (InterconnectState)
Enum: "PROVISIONING" "PROVISIONED" "DEPROVISIONING" "DEPROVISIONED"

Interconnect lifecycle state

object (InterconnectLocation)

Interconnect metro location

href
string

Metro URI

metroCode
string

Metro code where the interconnect is created

usedBandwidth
integer >= 0

Interconnect used bandwidth in Mbps

object (InterconnectPackage)

Interconnect Package details Beta

href
string

Interconnect Package URI

type
required
string

Interconnect Package Type

uuid
string

Equinix-assigned Interconnect Package identifier

code
required
string

Interconnect Package code (e.g. LAB, BASIC, STANDARD, PREMIUM)

description
string

Interconnect Package description

routesMax
integer

Maximum number of routes

bandwidthMax
integer

Maximum bandwidth in Mbps

isRemote
boolean

Authorization to connect remotely

object (InterconnectRouter)

Router associated with the interconnect Beta

href
string

Router URI

type
string
Value: "IC_ROUTER"

Router type

uuid
string <uuid>

Router identifier

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).

contractedBandwidth
integer

Contracted bandwidth

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 (Project)
projectId
required
string

Subscriber-assigned project ID

Array of objects (InterconnectNotification)

Interconnect notification preferences

Array
type
string
Value: "NOTIFICATIONS"

Notification type

emails
Array of strings <email> [ items <email > ]

Array of contact emails

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

Request samples

Content type
application/json
{
  • "type": "XF_IC",
  • "name": "test ic sv",
  • "description": "test interconnect",
  • "location": {
    },
  • "package": {
    },
  • "order": {
    },
  • "account": {
    },
  • "project": {
    },
  • "notifications": [
    ]
}

Response samples

Content type
application/json
{}

Get Interconnect By ID

This API provides capability to retrieve user's Interconnect Beta

Authorizations:
BearerAuth
path Parameters
interconnectId
required
string <uuid> (InterconnectId)
Example: 34085b91-2ea3-4578-bc1f-bbd526b57885

Interconnect UUID

Responses

Response Schema: application/json
href
string

Interconnect URI

uuid
string <uuid>

Equinix-assigned interconnect identifier

type
string
Value: "XF_IC"

Interconnect type

name
string

Interconnect name

description
string

Interconnect description

state
string (InterconnectState)
Enum: "PROVISIONING" "PROVISIONED" "DEPROVISIONING" "DEPROVISIONED"

Interconnect lifecycle state

object (InterconnectLocation)

Interconnect metro location

href
string

Metro URI

metroCode
string

Metro code where the interconnect is created

usedBandwidth
integer >= 0

Interconnect used bandwidth in Mbps

object (InterconnectPackage)

Interconnect Package details Beta

href
string

Interconnect Package URI

type
required
string

Interconnect Package Type

uuid
string

Equinix-assigned Interconnect Package identifier

code
required
string

Interconnect Package code (e.g. LAB, BASIC, STANDARD, PREMIUM)

description
string

Interconnect Package description

routesMax
integer

Maximum number of routes

bandwidthMax
integer

Maximum bandwidth in Mbps

isRemote
boolean

Authorization to connect remotely

object (InterconnectRouter)

Router associated with the interconnect Beta

href
string

Router URI

type
string
Value: "IC_ROUTER"

Router type

uuid
string <uuid>

Router identifier

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).

contractedBandwidth
integer

Contracted bandwidth

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 (Project)
projectId
required
string

Subscriber-assigned project ID

Array of objects (InterconnectNotification)

Interconnect notification preferences

Array
type
string
Value: "NOTIFICATIONS"

Notification type

emails
Array of strings <email> [ items <email > ]

Array of contact emails

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 Interconnect By ID

This API provides capability to delete user's Interconnect Beta

Authorizations:
BearerAuth
path Parameters
interconnectId
required
string <uuid> (InterconnectId)
Example: 34085b91-2ea3-4578-bc1f-bbd526b57885

Interconnect UUID

Responses

Response samples

Content type
application/json
{}

Search Interconnects

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

Authorizations:
BearerAuth
Request Body schema: application/json
required
object (InterconnectFilter)
and
Array of objects (InterconnectSimpleExpression)
or
Array of objects (InterconnectSimpleExpression)
property
string (InterconnectSearchFieldName)
Enum: "/uuid" "/type" "/name" "/state" "/description" "/location/metroCode" "/package/code" "/project/projectId" "/changeLog/createdDateTime" "/changeLog/updatedDateTime" "/changeLog/deletedDateTime" "/router/uuid" "/*"

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 (InterconnectSortCriteria)
Array
direction
string (InterconnectSortDirection)
Default: "DESC"
Enum: "DESC" "ASC"

Sorting direction

property
string (InterconnectSortBy)
Default: "/changeLog/updatedDateTime"
Enum: "/changeLog/createdDateTime" "/changeLog/updatedDateTime" "/name" "/state"

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 (InterconnectSortCriteriaResponse)
Array
direction
string (InterconnectSortDirectionResponse)
Default: "DESC"
Enum: "DESC" "ASC"

Sorting direction

property
string (InterconnectSortByResponse)
Default: "/changeLog/updatedDateTime"
Enum: "/changeLog/createdDateTime" "/changeLog/updatedDateTime" "/name" "/state"

Possible field names to use on sorting

Array of objects (Interconnect)
Array
href
string

Interconnect URI

uuid
string <uuid>

Equinix-assigned interconnect identifier

type
string
Value: "XF_IC"

Interconnect type

name
string

Interconnect name

description
string

Interconnect description

state
string (InterconnectState)
Enum: "PROVISIONING" "PROVISIONED" "DEPROVISIONING" "DEPROVISIONED"

Interconnect lifecycle state

object (InterconnectLocation)

Interconnect metro location

usedBandwidth
integer >= 0

Interconnect used bandwidth in Mbps

object (InterconnectPackage)

Interconnect Package details Beta

object (InterconnectRouter)

Router associated with the interconnect Beta

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

Interconnect notification preferences

object (Changelog)

Change log

Request samples

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

Response samples

Content type
application/json
{}

Get All Interconnect Packages

Get All Interconnect Packages returns details of all available interconnect packages for the specified user credentials. Beta

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.

required
Array of objects (InterconnectPackage)

List of Interconnect Packages

Array
href
string

Interconnect Package URI

type
required
string

Interconnect Package Type

uuid
string

Equinix-assigned Interconnect Package identifier

code
required
string

Interconnect Package code (e.g. LAB, BASIC, STANDARD, PREMIUM)

description
string

Interconnect Package description

routesMax
integer

Maximum number of routes

bandwidthMax
integer

Maximum bandwidth in Mbps

isRemote
boolean

Authorization to connect remotely

Response samples

Content type
application/json
{}

Internet Access Services

Equinix Internet Access (EIA) Beta

Creates Internet Access Service

Creates Internet Access Service

Authorizations:
BearerAuth
Request Body schema: application/json
required
type
required
string (InternetAccessServiceType)
Enum: "SINGLE_IA" "DUAL_IA"

Type of the service, either single or dual internet access

name
required
string

The name of the EIA Service

bandwidth
integer

Bandwidth of the service

bandwidthCommit
integer

Minimum bandwidth commit for burst billing variant of the service

required
object (InternetAccessRoutingProtocolRequest)
type
required
string (InternetAccessRoutingProtocolType)
required
Array of objects (InternetAccessCustomerRouteRequest) [ 1 .. 100 ] items
Array ([ 1 .. 100 ] items)
required
object (InternetAccessIpBlockRequest)
uuid
required
string <uuid>

Unique identifier for the IP Block

required
Array of objects (InternetAccessConnectionBgpRequest) [ 1 .. 2 ] items
Array ([ 1 .. 2 ] items)
uuid
required
string <uuid>

Unique identifier for the connection

exportPolicy
required
string (InternetAccessExportPolicy)
Enum: "FULL" "DEFAULT" "FULL_DEFAULT" "PARTIAL"

Denotes which routes should be advertised to the internet

object (InternetAccessRoutingProtocolBgpRequest_asn)
uuid
required
string <uuid>

Unique identifier of the ASN

customerAsn
integer <int64>
Deprecated

Customer ASN. Valid range is 1-64495 or 65536-4199999999.

bgpAuthKey
string

BGP authentication key

customerAsnRange
string (InternetAccessCustomerAsnRange)
Enum: "BITS_16" "BITS_32"

Customer Autonomous System Number range. Based on the value a proper private ASN will be generated.

object (InternetAccessOrderRequest)
purchaseOrderNumber
string or null

Purchase order number

orderNumber
string or null

Order Number

orderLine
string or null

Order Line Number

required
object (InternetAccessPostRequest_billing)
type
required
string (InternetAccessBillingType)
Enum: "FIXED" "USAGE_BASED" "BURST_BASED"
required
object (Project)
projectId
required
string

Subscriber-assigned project ID

required
object (InternetAccessAccount)
accountNumber
required
string

Account number

href
string <uri>

Account URL path

Responses

Request samples

Content type
application/json
{
  • "type": "SINGLE_IA",
  • "name": "internet-access-primary",
  • "bandwidth": 1000,
  • "routingProtocol": {
    },
  • "billing": {
    },
  • "project": {
    },
  • "account": {
    },
  • "order": {
    }
}

Response samples

Content type
application/json
{}

Search for Internet Access Services

Search for Internet Access Services

Authorizations:
BearerAuth
Request Body schema: application/json
required
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.

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
Array of objects (SearchSort)
Array
direction
required
string
Enum: "ASC" "DESC"
property
required
string

Responses

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

required
Array of objects (SearchSort)
Array
direction
required
string
Enum: "ASC" "DESC"
property
required
string
required
Array of objects (InternetAccessService)
Array
href
required
string <uri>

Service URL path

type
required
string (InternetAccessServiceType)
Enum: "SINGLE_IA" "DUAL_IA"

Type of the service, either single or dual internet access

uuid
required
string <uuid>

Unique identifier for the EIA Service

name
required
string

The name of the EIA Service

bandwidth
integer

Bandwidth of the service

bandwidthCommit
integer

Minimum bandwidth commit for burst billing variant of the service

state
required
string (InternetAccessServiceState)
Enum: "PROVISIONING" "PROVISIONED" "FAILED" "DEPROVISIONING" "DEPROVISIONED"

Current state of the service

required
object (InternetAccessChange)
Array of objects (InternetAccessLocation)

List of locations associated with the service

required
object (InternetAccessRoutingProtocol)
required
object (InternetAccessBilling)
required
object (InternetAccessAccount)
required
object (Project)
required
object (InternetAccessOrder)
required
object (Changelog)

Change log

useCase
required
string (InternetAccessUseCase)
Enum: "MAIN" "MANAGEMENT_ACCESS"

Request samples

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

Response samples

Content type
application/json
{}

Retrieve Internet Access Service by UUID

Retrieve Internet Access Service by UUID

Authorizations:
BearerAuth
path Parameters
uuid
required
string <uuid>

UUID of the EIA Service

Responses

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

Service URL path

type
required
string (InternetAccessServiceType)
Enum: "SINGLE_IA" "DUAL_IA"

Type of the service, either single or dual internet access

uuid
required
string <uuid>

Unique identifier for the EIA Service

name
required
string

The name of the EIA Service

bandwidth
integer

Bandwidth of the service

bandwidthCommit
integer

Minimum bandwidth commit for burst billing variant of the service

state
required
string (InternetAccessServiceState)
Enum: "PROVISIONING" "PROVISIONED" "FAILED" "DEPROVISIONING" "DEPROVISIONED"

Current state of the service

required
object (InternetAccessChange)
href
required
string <uri>

URI of the change object

Array of objects (InternetAccessLocation)

List of locations associated with the service

Array
metroHref
required
string <uri>

Metro URL path for the linked resource

metroCode
required
string^[A-Z]{2}$

Code representing the metro

region
required
string
Enum: "APAC" "EMEA" "AMER"

Geographic region

ibx
required
string

IBX data center code

required
object (InternetAccessRoutingProtocol)
type
required
string (InternetAccessRoutingProtocolType)
required
Array of objects (InternetAccessCustomerRoute)
Array
object (InternetAccessIpBlock)
href
required
string <uri>

URI of the IP block

uuid
required
string <uuid>

Unique identifier for the IP block

required
Array of objects (InternetAccessConnection)
Array
href
required
string <uri>

URI of the connection

uuid
required
string <uuid>

Unique identifier for the connection

object (InternetAccessPeeringIpv4)
object (InternetAccessPeeringIpv6)
exportPolicy
required
string (InternetAccessExportPolicy)
Enum: "FULL" "DEFAULT" "FULL_DEFAULT" "PARTIAL"

Denotes which routes should be advertised to the internet

object (InternetAccessRoutingProtocolBgp_asn)
href
string

URI of the ASN resource

uuid
required
string <uuid>

Unique identifier of the ASN

customerAsn
integer <int64>
Deprecated

Customer ASN. Valid range is 1-64495 or 131072-4199999999. Currently this option is only available for EIA over dedicated port.

bgpAuthKey
string

BGP authentication key

customerAsnRange
required
string (InternetAccessCustomerAsnRange)
Enum: "BITS_16" "BITS_32"

Customer Autonomous System Number range. Based on the value a proper private ASN will be generated.

required
object (InternetAccessBilling)
type
required
string (InternetAccessBillingType)
Enum: "FIXED" "USAGE_BASED" "BURST_BASED"
enabled
boolean

Indicates whether the billing is enabled

startDate
string <date-time>

The start date for the billing period

required
object (InternetAccessAccount)
accountNumber
required
string

Account number

href
string <uri>

Account URL path

required
object (Project)
projectId
required
string

Subscriber-assigned project ID

required
object (InternetAccessOrder)
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).

contractedBandwidth
integer

Contracted bandwidth

href
string <uri>

Order URI

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

useCase
required
string (InternetAccessUseCase)
Enum: "MAIN" "MANAGEMENT_ACCESS"

Response samples

Content type
application/json
{}

Delete Internet Access Service by UUID

Delete Internet Access Service by UUID

Authorizations:
BearerAuth
path Parameters
uuid
required
string <uuid>

UUID of the EIA Service

Responses

Response samples

Content type
application/json
{}

Patch Internet Access Service by UUID

Patch Internet Access Service by UUID

Authorizations:
BearerAuth
path Parameters
uuid
required
string <uuid>

UUID of the EIA Service

Request Body schema: application/json
required
Array ([ 1 .. 100 ] items)
op
required
string (InternetAccessPatchOperationUpdateAllowedOp)
Enum: "replace" "add" "remove"

Allowed patch operations.

path
required
string (InternetAccessPatchOperationUpdateAllowedPath) ^(\/bandwidth|\/bandwidthCommit|\/routingProt...

Allowed patch paths for Internet Access update.

value
any

New value for updated parameter. Required for add and replace.

Responses

Request samples

Content type
application/json
Example
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{}

IP Blocks

IP Blocks Beta

Submits new Equinix owned or customer owned IP Block request

Submits new Equinix owned or customer owned IP Block request

Authorizations:
BearerAuth
Request Body schema: application/json
required
object (IpBlockLocation)
metroHref
string

Metro URL path for the linked resource

metroCode
required
string^[A-Z]{2}$
type
required
string (TypeOfIpBlockProduct)
Enum: "IPV4_IP_BLOCK" "IPV6_IP_BLOCK"
required
object (IpBlockProjectRequest)
projectId
required
string

project id

object (IpBlockAccount)
accountNumber
required
string

account number

object (IpBlockOrderRequest)
purchaseOrderNumber
string or null

Purchase order number

orderNumber
string or null

Order Number

orderLine
string or null

Order Line Number

object (IpBlockRegulations)
required
Array of objects (IpBlockAddressingPlan)

List of addressing plans

Array
purpose
required
string

purpose

size
required
integer <int32>

size

required
object (IpBlockRegulations_questions)
privateSpaceConsidered
required
boolean
refusedPreviously
required
boolean
returningAddressSpace
required
boolean
prefixLength
integer (IpBlockPrefixLength) [ 1 .. 128 ]

IpBlockPrefix length

prefix
string (IpBlockPrefix)

CIDR prefix

Responses

Request samples

Content type
application/json
Example
{
  • "prefixLength": 24,
  • "location": {
    },
  • "project": {
    },
  • "type": "IPV4_IP_BLOCK",
  • "regulations": {
    },
  • "account": {
    },
  • "order": {
    }
}

Response samples

Content type
application/json
Example
{}

Retrieve IP Block by UUID

Retrieve IP Block by UUID

Authorizations:
BearerAuth
path Parameters
uuid
required
string <uuid>

UUID of the IP Block

Responses

Response Schema: application/json
uuid
required
string <uuid>

Unique identifier for the IP Block

href
required
string

Resource URL path for the IP Block

type
required
string (TypeOfIpBlockProduct)
Enum: "IPV4_IP_BLOCK" "IPV6_IP_BLOCK"
state
required
string (IpBlockState)
Enum: "PENDING" "ACTIVE" "DELETING" "DELETED" "FAILED"

Current state of the IP Block

ownership
required
string (IpBlockOwnership)
Enum: "EQUINIX" "CUSTOMER"

IpBlockOwnership of the IP Block

object (IpBlockLocation)
metroHref
string

Metro URL path for the linked resource

metroCode
required
string^[A-Z]{2}$
prefixLength
required
integer (IpBlockPrefixLength) [ 1 .. 128 ]

IpBlockPrefix length

prefix
string (IpBlockPrefix)

CIDR prefix

object (IpBlockOrderResponse)
href
required
string <uri>

Order URI

orderNumber
required
string

Order number

object (IpBlockAccount)
accountNumber
required
string

account number

required
object (IpBlockProject)
href
string <uri>

URI of the project

projectId
required
string

project id

object (IpBlockRegulations)
required
Array of objects (IpBlockAddressingPlan)

List of addressing plans

Array
purpose
required
string

purpose

size
required
integer <int32>

size

required
object (IpBlockRegulations_questions)
privateSpaceConsidered
required
boolean
refusedPreviously
required
boolean
returningAddressSpace
required
boolean
Array of objects (IpBlockAsset)

Products using this IP Block

Array
type
required
string (IpBlockProductType)
Enum: "EIA" "FABRIC" "NE"
uuid
required
string <uuid>

Unique identifier for the asset

href
required
string

Resource URL path for the linked resource

object (IpBlockChange)
href
required
string <uri>

URI of the IpBlockChange object

required
object (IpBlockChangeLog)
createdDateTime
required
string <date-time>
updatedDateTime
string <date-time>
deletedDateTime
string <date-time>
object (Error)

Error Response with details

errorCode
required
string^EQ-\d{7}$
errorMessage
required
string
correlationId
string
details
string
help
string
Array of objects (PriceError_additionalInfo)
Array
property
string
reason
string

Response samples

Content type
application/json
Example
{}

Delete IP Block by UUID

Delete IP Block by UUID

Authorizations:
BearerAuth
path Parameters
uuid
required
string <uuid>

UUID of the IP Block

Responses

Response samples

Content type
application/json
Example
{}

patch IP Block by UUID

patch IP Block by UUID

Authorizations:
BearerAuth
path Parameters
uuid
required
string <uuid>

UUID of the IP Block

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

operation

path
required
string

path

object (PatchIpBlockRequestBodyItem_value)

new value

uuid
required
string <uuid>

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
Example
{}

Search for IP Blocks

Search for IP Blocks based on criteria

Authorizations:
BearerAuth
Request Body schema: application/json
required
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.

object (IpBlockFilter)
Array of objects (IpBlockAndQuery)
Array
property
required
string
operator
required
string
Value: "="
values
required
Array of strings
Array of objects (SearchSort)
Array
direction
required
string
Enum: "ASC" "DESC"
property
required
string

Responses

Response Schema: application/json
required
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 (SearchSort)
Array
direction
required
string
Enum: "ASC" "DESC"
property
required
string
required
Array of objects (IpBlock)
Array
uuid
required
string <uuid>

Unique identifier for the IP Block

href
required
string

Resource URL path for the IP Block

type
required
string (TypeOfIpBlockProduct)
Enum: "IPV4_IP_BLOCK" "IPV6_IP_BLOCK"
state
required
string (IpBlockState)
Enum: "PENDING" "ACTIVE" "DELETING" "DELETED" "FAILED"

Current state of the IP Block

ownership
required
string (IpBlockOwnership)
Enum: "EQUINIX" "CUSTOMER"

IpBlockOwnership of the IP Block

object (IpBlockLocation)
prefixLength
required
integer (IpBlockPrefixLength) [ 1 .. 128 ]

IpBlockPrefix length

prefix
string (IpBlockPrefix)

CIDR prefix

object (IpBlockOrderResponse)
object (IpBlockAccount)
required
object (IpBlockProject)
object (IpBlockRegulations)
Array of objects (IpBlockAsset)

Products using this IP Block

object (IpBlockChange)
required
object (IpBlockChangeLog)
object (Error)

Error Response with details

Request samples

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

Response samples

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

Loas

Loas Beta

Create Loa

The API provides capability to create a new Loa

Authorizations:
BearerAuth
Request Body schema: application/json
required
One of
type
required
string (LoaType)
Enum: "CAGE_LOA" "PATCH_PANEL_LOA" "PATCH_PANEL_PORT_LOA"

Type of Letter of Authorization

name
required
string [ 3 .. 50 ] characters

A short, descriptive name for this LOA.

description
string [ 0 .. 450 ] characters

Additional context about this LOA.

authorizedProductType
required
string (LoaProductType)
Enum: "XC" "XF_PORT" "VD"

Product type associated with this LOA.
XC - Cross Connect
XF_PORT - Fabric Port
VD - Network Edge

expirationDateTime
string <date-time> (LoaExpiration)

Date and time when this LOA expires.
Default to 3 months from the creation date

object (LoaRequestor)

Requestor

email
string <email>

Email address of the requestor contact.

orgId
integer

Organization ID of the requestor.

orgName
string

Organization name of the requestor.

required
object (LoaDemarcationPoint)

Specifies the demarcation point.
For CAGE_LOA - cageUniqueSpaceId is required.
For PATCH_PANEL_LOA - patchPanelId is required.
For PATCH_PANEL_PORT_LOA - patchPanelId, patchPanelPortA, patchPanelPortB and connectorType is required.

cageUniqueSpaceId
string

Unique identifier of the Cage.

patchPanelId
string

Unique identifier of the Patch Panel.

patchPanelPortA
integer

Specify the desired port number.
When ports are not provided, next available ports will be used.

patchPanelPortB
integer

Specify the desired port number.
When ports are not provided, next available ports will be used.
Required for Connector type FC and ST only.

connectorType
string (LoaPatchPanelConnectorType)
Enum: "FC" "SC" "LC" "ST"

Connector Type

Responses

Request samples

Content type
application/json
Example
{
  • "type": "CAGE_LOA",
  • "name": "LOA-Equinix-SV1-2026",
  • "description": "Authorization for cage access to Equinix at SV1",
  • "authorizedProductType": "XC",
  • "expirationDateTime": "2026-12-31T23:59:59Z",
  • "requestor": {
    },
  • "demarcationPoint": {
    }
}

Response samples

Content type
application/json
Example
{
  • "href": "https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2",
  • "uuid": "29cc7878-54e3-4e1a-8651-87a61354bac2",
  • "type": "PATCH_PANEL_PORT_LOA",
  • "name": "LOA-Equinix-SV1-2026",
  • "description": "Authorization for cage access to Equinix at SV1",
  • "authorizedProductType": "XC",
  • "state": "PENDING_AUTHORIZATION",
  • "requestor": {
    },
  • "issuer": {
    },
  • "location": {
    },
  • "changeLog": {
    }
}

Get Loa

The API provides capability to get Loa details by Loa ID

Authorizations:
BearerAuth
path Parameters
loaId
required
string <uuid> (LoaId)
Example: 29cc7878-54e3-4e1a-8651-87a61354bac2

Loa UUID

Responses

Response Schema: application/json
href
string <uri>

URI of this LOA resource.

uuid
string <uuid>

Unique identifier of this LOA.

type
string (LoaType)
Enum: "CAGE_LOA" "PATCH_PANEL_LOA" "PATCH_PANEL_PORT_LOA"

Type of Letter of Authorization

name
string

A short, descriptive name for this LOA

description
string

Additional context about this LOA

authorizedProductType
string (LoaProductType)
Enum: "XC" "XF_PORT" "VD"

Product type associated with this LOA.
XC - Cross Connect
XF_PORT - Fabric Port
VD - Network Edge

state
string (LoaState)
Enum: "PENDING" "FAILED" "PENDING_AUTHORIZATION" "PENDING_ACCEPTANCE" "CANCELLED" "INACTIVE" "ACTIVE" "EXPIRED"

Current lifecycle state of the LOA.

object (LoaResponse_operation)
consumersCount
integer

Number of consumers associated with this LOA.

object (LoaRequestor)

Requestor

email
string <email>

Email address of the requestor contact.

orgId
integer

Organization ID of the requestor.

orgName
string

Organization name of the requestor.

object (LoaIssuer)

Issuer

email
string <email>

Email address of the issuer contact.

orgId
integer

Organization ID of the issuer.

orgName
string

Organization name of the issuer.

object (LoaDemarcationPoint)

Specifies the demarcation point.
For CAGE_LOA - cageUniqueSpaceId is required.
For PATCH_PANEL_LOA - patchPanelId is required.
For PATCH_PANEL_PORT_LOA - patchPanelId, patchPanelPortA, patchPanelPortB and connectorType is required.

cageUniqueSpaceId
string

Unique identifier of the Cage.

patchPanelId
string

Unique identifier of the Patch Panel.

patchPanelPortA
integer

Specify the desired port number.
When ports are not provided, next available ports will be used.

patchPanelPortB
integer

Specify the desired port number.
When ports are not provided, next available ports will be used.
Required for Connector type FC and ST only.

connectorType
string (LoaPatchPanelConnectorType)
Enum: "FC" "SC" "LC" "ST"

Connector Type

object (LoaLocation)

Eligible location where LOA can be issued.

ibxCode
string

IBX Code

expirationDateTime
string <date-time> (LoaExpiration)

Date and time when this LOA expires.
Default to 3 months from the creation date

object (LoaChangelog)

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

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2",
  • "uuid": "29cc7878-54e3-4e1a-8651-87a61354bac2",
  • "type": "PATCH_PANEL_PORT_LOA",
  • "name": "LOA-Equinix-SV1-2026",
  • "description": "Authorization for cage access to Equinix at SV1",
  • "authorizedProductType": "XC",
  • "state": "INACTIVE",
  • "expirationDateTime": "2024-12-31T23:59:59Z",
  • "operation": {
    },
  • "requestor": {
    },
  • "issuer": {
    },
  • "demarcationPoint": {
    },
  • "location": {
    },
  • "changeLog": {
    }
}

Update Loa

The API provides capability to update Loa details by Loa ID

Authorizations:
BearerAuth
path Parameters
loaId
required
string <uuid> (LoaId)
Example: 29cc7878-54e3-4e1a-8651-87a61354bac2

Loa UUID

Request Body schema: application/json
required
Array
op
required
string (LoaOpEnum)
Enum: "replace" "add" "remove"

Operation to be performed

path
required
string (LoaPath)

A JSON Pointer path.

  • /name - Name of the Loa
  • /description - Description of the Loa
  • /requestor/email - Email of the requestor contact
  • /requestor/orgName - Organization name of the requestor
  • /issuer/email - Email of the issuer contact
  • /issuer/orgName - Organization name of the issuer
  • /demarcationPoint/patchPanelId - Patch Panel Identifier
  • /demarcationPoint/patchPanelPortA - Patch Panel Port A
  • /demarcationPoint/patchPanelPortB - Patch Panel Port B
  • /demarcationPoint/connectorType - Connector Type
  • /demarcationPoint/cageUniqueSpaceId - Cage Unique Space Identifier
  • /expirationDateTime - Expiration date and time of the Loa
  • /location/ibxCode - IBX code of the Eligible location
value
required
object

New value for updated parameter

Responses

Response Schema: application/json
href
string <uri>

URI of this LOA resource.

uuid
string <uuid>

Unique identifier of this LOA.

type
string (LoaType)
Enum: "CAGE_LOA" "PATCH_PANEL_LOA" "PATCH_PANEL_PORT_LOA"

Type of Letter of Authorization

name
string

A short, descriptive name for this LOA

description
string

Additional context about this LOA

authorizedProductType
string (LoaProductType)
Enum: "XC" "XF_PORT" "VD"

Product type associated with this LOA.
XC - Cross Connect
XF_PORT - Fabric Port
VD - Network Edge

state
string (LoaState)
Enum: "PENDING" "FAILED" "PENDING_AUTHORIZATION" "PENDING_ACCEPTANCE" "CANCELLED" "INACTIVE" "ACTIVE" "EXPIRED"

Current lifecycle state of the LOA.

object (LoaResponse_operation)
consumersCount
integer

Number of consumers associated with this LOA.

object (LoaRequestor)

Requestor

email
string <email>

Email address of the requestor contact.

orgId
integer

Organization ID of the requestor.

orgName
string

Organization name of the requestor.

object (LoaIssuer)

Issuer

email
string <email>

Email address of the issuer contact.

orgId
integer

Organization ID of the issuer.

orgName
string

Organization name of the issuer.

object (LoaDemarcationPoint)

Specifies the demarcation point.
For CAGE_LOA - cageUniqueSpaceId is required.
For PATCH_PANEL_LOA - patchPanelId is required.
For PATCH_PANEL_PORT_LOA - patchPanelId, patchPanelPortA, patchPanelPortB and connectorType is required.

cageUniqueSpaceId
string

Unique identifier of the Cage.

patchPanelId
string

Unique identifier of the Patch Panel.

patchPanelPortA
integer

Specify the desired port number.
When ports are not provided, next available ports will be used.

patchPanelPortB
integer

Specify the desired port number.
When ports are not provided, next available ports will be used.
Required for Connector type FC and ST only.

connectorType
string (LoaPatchPanelConnectorType)
Enum: "FC" "SC" "LC" "ST"

Connector Type

object (LoaLocation)

Eligible location where LOA can be issued.

ibxCode
string

IBX Code

expirationDateTime
string <date-time> (LoaExpiration)

Date and time when this LOA expires.
Default to 3 months from the creation date

object (LoaChangelog)

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

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2",
  • "uuid": "29cc7878-54e3-4e1a-8651-87a61354bac2",
  • "type": "PATCH_PANEL_PORT_LOA",
  • "name": "LOA-Equinix-SV1-2026",
  • "description": "Authorization for cage access to Equinix at SV1",
  • "authorizedProductType": "XC",
  • "state": "INACTIVE",
  • "operation": {
    },
  • "requestor": {
    },
  • "issuer": {
    },
  • "demarcationPoint": {
    },
  • "location": {
    },
  • "changeLog": {
    }
}

Loa Actions

The API provides capability to perform actions on Loa

Authorizations:
BearerAuth
path Parameters
loaId
required
string <uuid> (LoaId)
Example: 29cc7878-54e3-4e1a-8651-87a61354bac2

Loa UUID

Request Body schema: application/json
required
type
required
string (LoaActionType)
Enum: "LOA_ISSUER_AUTHORIZATION" "LOA_REQUESTOR_ACCEPTANCE" "LOA_COPY_LINK" "LOA_SEND_EMAIL_NOTIFICATION" "LOA_CANCEL"

Action to perform on the LOA.

object (LoaActionData)

Action Data.
For LOA_ISSUER_AUTHORIZATION — always required.

object (LoaDemarcationPoint)

Specifies the demarcation point.
For CAGE_LOA - cageUniqueSpaceId is required.
For PATCH_PANEL_LOA - patchPanelId is required.
For PATCH_PANEL_PORT_LOA - patchPanelId, patchPanelPortA, patchPanelPortB and connectorType is required.

cageUniqueSpaceId
string

Unique identifier of the Cage.

patchPanelId
string

Unique identifier of the Patch Panel.

patchPanelPortA
integer

Specify the desired port number.
When ports are not provided, next available ports will be used.

patchPanelPortB
integer

Specify the desired port number.
When ports are not provided, next available ports will be used.
Required for Connector type FC and ST only.

connectorType
string (LoaPatchPanelConnectorType)
Enum: "FC" "SC" "LC" "ST"

Connector Type

expirationDateTime
string <date-time> (LoaExpiration)

Date and time when this LOA expires.
Default to 3 months from the creation date

Responses

Request samples

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

Response samples

Content type
application/json
Example
{}

Get Loa Action by Action ID

This API provides capability to fetch action details

Authorizations:
BearerAuth
path Parameters
loaId
required
string <uuid> (LoaId)
Example: 29cc7878-54e3-4e1a-8651-87a61354bac2

Loa UUID

actionId
required
string <uuid> (ActionId_2)
Example: 30cc7878-54e3-4e1a-8651-87a61354bad4

Action UUID

Responses

Response Schema: application/json
href
string <uri>

Action URI

uuid
string <uuid>

Action Identifier

state
string (LoaActionState)
Enum: "COMPLETED" "FAILED" "PENDING"

Action State

type
string (LoaActionType)
Enum: "LOA_ISSUER_AUTHORIZATION" "LOA_REQUESTOR_ACCEPTANCE" "LOA_COPY_LINK" "LOA_SEND_EMAIL_NOTIFICATION" "LOA_CANCEL"

Action to perform on the LOA.

object (LoaActionData)

Action Data.
For LOA_ISSUER_AUTHORIZATION — always required.

object (LoaDemarcationPoint)

Specifies the demarcation point.
For CAGE_LOA - cageUniqueSpaceId is required.
For PATCH_PANEL_LOA - patchPanelId is required.
For PATCH_PANEL_PORT_LOA - patchPanelId, patchPanelPortA, patchPanelPortB and connectorType is required.

cageUniqueSpaceId
string

Unique identifier of the Cage.

patchPanelId
string

Unique identifier of the Patch Panel.

patchPanelPortA
integer

Specify the desired port number.
When ports are not provided, next available ports will be used.

patchPanelPortB
integer

Specify the desired port number.
When ports are not provided, next available ports will be used.
Required for Connector type FC and ST only.

connectorType
string (LoaPatchPanelConnectorType)
Enum: "FC" "SC" "LC" "ST"

Connector Type

expirationDateTime
string <date-time> (LoaExpiration)

Date and time when this LOA expires.
Default to 3 months from the creation date

portalUrl
string (LoaMagicLink)

Portal URL for the LOA to either accept from requestor
or authorize from the issuer.

object (LoaChangelog)

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

Response samples

Content type
application/json
{}

Search Loas

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

Authorizations:
BearerAuth
Request Body schema: application/json
required
object (LoaSearchFilters)
Array of LoaSimpleExpression (object) or LoaOrFilter (object) (LoaFilter) <= 8 items
Array (<= 8 items)
Any of
property
string (LoaFieldName)
Enum: "/uuid" "/state" "/type" "/name" "/authorizedProductType" "/expirationDateTime" "/requestor/email" "/requestor/orgId" "/requestor/orgName" "/issuer/email" "/issuer/orgId" "/issuer/orgName" "/demarcationPoint/patchPanelId" "/demarcationPoint/patchPanelPortA" "/demarcationPoint/patchPanelPortB" "/demarcationPoint/connectorType" "/demarcationPoint/cageUniqueSpaceId" "/location/ibxCode" "/changeLog/createdDateTime" "/changeLog/updatedDateTime"

Possible field names to use on filters

operator
string
Enum: "=" "!=" "LIKE" "ILIKE" "BETWEEN" "NOT BETWEEN" "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 (LoaSortCriteria)
Array
direction
string
Default: "DESC"
Enum: "DESC" "ASC"

Sorting direction

property
string
Default: "/changeLog/updatedDateTime"
Enum: "/name" "/expirationDateTime" "/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 (LoaSortCriteria)
Array
direction
string
Default: "DESC"
Enum: "DESC" "ASC"

Sorting direction

property
string
Default: "/changeLog/updatedDateTime"
Enum: "/name" "/expirationDateTime" "/changeLog/createdDateTime" "/changeLog/updatedDateTime"

Possible field names to use on sorting

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

URI of this LOA resource.

uuid
string <uuid>

Unique identifier of this LOA.

type
string (LoaType)
Enum: "CAGE_LOA" "PATCH_PANEL_LOA" "PATCH_PANEL_PORT_LOA"

Type of Letter of Authorization

name
string

A short, descriptive name for this LOA

description
string

Additional context about this LOA

authorizedProductType
string (LoaProductType)
Enum: "XC" "XF_PORT" "VD"

Product type associated with this LOA.
XC - Cross Connect
XF_PORT - Fabric Port
VD - Network Edge

state
string (LoaState)
Enum: "PENDING" "FAILED" "PENDING_AUTHORIZATION" "PENDING_ACCEPTANCE" "CANCELLED" "INACTIVE" "ACTIVE" "EXPIRED"

Current lifecycle state of the LOA.

object (LoaResponse_operation)
object (LoaRequestor)

Requestor

object (LoaIssuer)

Issuer

object (LoaDemarcationPoint)

Specifies the demarcation point.
For CAGE_LOA - cageUniqueSpaceId is required.
For PATCH_PANEL_LOA - patchPanelId is required.
For PATCH_PANEL_PORT_LOA - patchPanelId, patchPanelPortA, patchPanelPortB and connectorType is required.

object (LoaLocation)

Eligible location where LOA can be issued.

expirationDateTime
string <date-time> (LoaExpiration)

Date and time when this LOA expires.
Default to 3 months from the creation date

object (LoaChangelog)

Change log

Request samples

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

Response samples

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

Search Loa Actions

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

Authorizations:
BearerAuth
path Parameters
loaId
required
string <uuid> (LoaId)
Example: 29cc7878-54e3-4e1a-8651-87a61354bac2

Loa UUID

Request Body schema: application/json
required
object (LoaActionSearchFilters)
Array of LoaActionSearchSimpleExpressions (object) or LoaActionOrFilter (object) (LoaActionFilter) <= 8 items
Array (<= 8 items)
Any of
property
string (LoaActionFieldName)
Enum: "/type" "/state" "/uuid"

Possible field names to use on filters

operator
string
Enum: "=" "!=" "LIKE" "ILIKE" "BETWEEN" "NOT BETWEEN" "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 (LoaActionSortCriteria)
Array
direction
string
Default: "DESC"
Enum: "DESC" "ASC"

Sorting direction

property
string
Default: "/changeLog/createdDateTime"
Value: "/changeLog/createdDateTime"

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 (LoaActionSortCriteria)
Array
direction
string
Default: "DESC"
Enum: "DESC" "ASC"

Sorting direction

property
string
Default: "/changeLog/createdDateTime"
Value: "/changeLog/createdDateTime"

Possible field names to use on sorting

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

Action URI

uuid
string <uuid>

Action Identifier

state
string (LoaActionState)
Enum: "COMPLETED" "FAILED" "PENDING"

Action State

type
string (LoaActionType)
Enum: "LOA_ISSUER_AUTHORIZATION" "LOA_REQUESTOR_ACCEPTANCE" "LOA_COPY_LINK" "LOA_SEND_EMAIL_NOTIFICATION" "LOA_CANCEL"

Action to perform on the LOA.

object (LoaActionData)

Action Data.
For LOA_ISSUER_AUTHORIZATION — always required.

object (LoaChangelog)

Change log

Request samples

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

Response samples

Content type
application/json
{}

Get Loa Consumers

The API provides capability to get Loa consumers by Loa ID

Authorizations:
BearerAuth
path Parameters
loaId
required
string <uuid> (LoaId)
Example: 29cc7878-54e3-4e1a-8651-87a61354bac2

Loa 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 (LoaConsumer)
Array
href
string <uri>

Consumer URI

uuid
string <uuid>

Consumer Identifier

type
string (LoaProductType)
Enum: "XC" "XF_PORT" "VD"

Product type associated with this LOA.
XC - Cross Connect
XF_PORT - Fabric Port
VD - Network Edge

object (LoaChangelog)

Change log

Response samples

Content type
application/json
{}

Get Loa Notes

The API provides capability to get Loa notes by Loa ID

Authorizations:
BearerAuth
path Parameters
loaId
required
string <uuid> (LoaId)
Example: 29cc7878-54e3-4e1a-8651-87a61354bac2

Loa UUID

Responses

Response Schema: application/json
Array of objects (LoaNoteDetails)
Array
type
string
Enum: "ISSUER" "REQUESTOR"

Indicates which party added the note.
ISSUER — note was added by a user from the issuer organization.
REQUESTOR — note was added by a user from the requestor organization.

href
string <uri>

URI to note resource.

uuid
string <uuid>

Unique identifier of this note.

comments
string

Content of the note as submitted by the user.

createdDateTime
string <date-time>

Date and time when the note was created.

Response samples

Content type
application/json
{}

Create Loa Note

The API provides capability to create Loa note by Loa ID

Authorizations:
BearerAuth
path Parameters
loaId
required
string <uuid> (LoaId)
Example: 29cc7878-54e3-4e1a-8651-87a61354bac2

Loa UUID

Request Body schema: application/json
required
comments
required
string [ 0 .. 4000 ] characters

The note content to add to this LOA. Notes are visible to both the issuer and requestor organizations. Use notes to communicate updates, clarifications, or additional context about the LOA.

Responses

Response Schema: application/json
type
string
Enum: "ISSUER" "REQUESTOR"

Indicates which party added the note.
ISSUER — note was added by a user from the issuer organization.
REQUESTOR — note was added by a user from the requestor organization.

href
string <uri>

URI to note resource.

uuid
string <uuid>

Unique identifier of this note.

comments
string

Content of the note as submitted by the user.

createdDateTime
string <date-time>

Date and time when the note was created.

Request samples

Content type
application/json
{
  • "comments": "LOA under review by our team. Expected response within 2 business days."
}

Response samples

Content type
application/json
{}

Logos

Logos Beta

Get Logo

Get Logo by UUID

Authorizations:
BearerAuth
path Parameters
uuid
required
string <uuid>

UUID of the Logo

Responses

Response Schema: multipart/mixed
string <binary>

Response samples

Content type
application/json
[
  • {
    }
]

Delete Logo

Delete Logo by UUID

Authorizations:
BearerAuth
path Parameters
uuid
required
string <uuid>

UUID of the Logo

Responses

Response samples

Content type
application/json; charset=UTF-8
{
  • "href": "https://api.equinix.com/fabric/v4/logos/18a127ad-9d0c-46e2-a66d-8ed85d1858b0",
  • "uuid": "18a127ad-9d0c-46e2-a66d-8ed85d1858b0",
  • "type": "COMPANY_LOGO",
  • "name": "Equinix Logo",
  • "description": "Company branding logo",
  • "status": "CREATED",
  • "extensionType": ".png",
  • "changelog": {
    }
}

Marketplace Subscriptions

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": {
    }
}

Metrics

Metrics

Get Metrics by Asset Id

This API provides capability to retrieve Metrics of an asset id

Authorizations:
BearerAuth
path Parameters
asset
required
string (MetricAssetType)
Enum: "ports" "connections" "metros"

asset

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

asset UUID

query Parameters
name
required
string^equinix\.fabric\.(connection|port|metro)\..+...
Examples:
  • name=equinix.fabric.connection.bandwidth_rx.usage -
  • name=equinix.fabric.connection.bandwidth_tx.usage -
  • name=equinix.fabric.connection.packets_dropped_rx_aside_rateexceeded.count -
  • name=equinix.fabric.connection.packets_dropped_tx_aside_rateexceeded.count -
  • name=equinix.fabric.connection.packets_dropped_rx_zside_rateexceeded.count -
  • name=equinix.fabric.connection.packets_dropped_tx_zside_rateexceeded.count -
  • name=equinix.fabric.connection.byte_rx.count -
  • name=equinix.fabric.connection.byte_tx.count -
  • name=equinix.fabric.connection.bandwidth_rx.usage_summary -
  • name=equinix.fabric.connection.bandwidth_tx.usage_summary -
  • name=equinix.fabric.port.bandwidth_rx.usage -
  • name=equinix.fabric.port.bandwidth_tx.usage -
  • name=equinix.fabric.port.packets_dropped_rx.count -
  • name=equinix.fabric.port.packets_dropped_tx.count -
  • name=equinix.fabric.port.packets_erred_rx.count -
  • name=equinix.fabric.port.packets_erred_tx.count -
  • name=equinix.fabric.metro.sv_dc.latency -
  • name=equinix.fabric.metro.sv_dc.jitter_avg -

Name of the metric types:

  • equinix.fabric.connection.bandwidth_rx.usage
  • equinix.fabric.connection.bandwidth_tx.usage
  • equinix.fabric.connection.packets_dropped_rx_aside_rateexceeded.count
  • equinix.fabric.connection.packets_dropped_tx_aside_rateexceeded.count
  • equinix.fabric.connection.packets_dropped_rx_zside_rateexceeded.count
  • equinix.fabric.connection.packets_dropped_tx_zside_rateexceeded.count
  • equinix.fabric.connection.byte_rx.count
  • equinix.fabric.connection.byte_tx.count
  • equinix.fabric.connection.bandwidth_rx.usage_summary
  • equinix.fabric.connection.bandwidth_tx.usage_summary
  • equinix.fabric.port.bandwidth_rx.usage
  • equinix.fabric.port.bandwidth_tx.usage
  • equinix.fabric.port.packets_dropped_rx.count
  • equinix.fabric.port.packets_dropped_tx.count
  • equinix.fabric.port.packets_erred_rx.count
  • equinix.fabric.port.packets_erred_tx.count
  • equinix.fabric.metro.{SOURCE_METRO_CODE}_{DESTINATION_METRO_CODE}.latency
  • equinix.fabric.metro.{SOURCE_METRO_CODE}_{DESTINATION_METRO_CODE}.jitter_avg
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_1)
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 (Metric)

Data returned from the API call.

Array
type
string

Equinix supported metric type

name
string

Metric name

unit
string

Metric unit

interval
string

Metric interval (set automatically based on search range)

object (Metric_resource)

Metric resource

summary
string

Metric summary

Array of objects (Metric_datapoints)

Metric data points

Response samples

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

Get Metrics by Name

This API provides capability to retrieve Metrics by specific wildcard metric types

Authorizations:
BearerAuth
query Parameters
name
required
string^equinix\.fabric\.metro\.\*\..+
Examples:
  • name=equinix.fabric.metro.*.latency -
  • name=equinix.fabric.metro.*.jitter_avg -

Name of the metric types with wildcard:

  • equinix.fabric.metro.*.latency
  • equinix.fabric.metro.*.jitter_avg
value
required
string (Value)
Example: value=last

value

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

offset

limit
integer (Limit_1)
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 (Metric)

Data returned from the API call.

Array
type
string

Equinix supported metric type

name
string

Metric name

unit
string

Metric unit

interval
string

Metric interval (set automatically based on search range)

object (Metric_resource)

Metric resource

summary
string

Metric summary

Array of objects (Metric_datapoints)

Metric data points

Response samples

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

Search Metrics

This API provides capability to search metrics from a filtered query

Authorizations:
BearerAuth
Request Body schema: application/json
required
required
object (MetricFilters)
Array of MetricSimpleExpression (object) (MetricFilter)
Array
Any of
property
string

Possible field names to use on filters:

  • /subject - Metric subject description (required and limited to 1 value)
  • /name - Metric names (required)
  • /dataPoints/endDateTime - Time of Metrics
  • /time - Time of Metrics
  • /interval - ISO-8601 duration format to specify the interval of metrics data points
  • /value - specific data points of the metric to return (e.g. 'last' - for metros only)
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.

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 (Metric)

Data returned from the API call.

Array
type
string

Equinix supported metric type

name
string

Metric name

unit
string

Metric unit

interval
string

Metric interval (set automatically based on search range)

object (Metric_resource)

Metric resource

summary
string

Metric summary

Array of objects (Metric_datapoints)

Metric data points

Request samples

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

Response samples

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

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.

country
string

Country code 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)
Array of objects (services)
geoScopes
Array of strings (GeoScopeType)
Items Enum: "CANADA" "CONUS" "JAPAN" "UK" "AUSTRALIA" "BRAZIL" "SWITZERLAND" "EU"

List of supported geographic boundaries of a Fabric Metro.

Array of objects (GeoZone)

List of supported geographic zones 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.

country
string

Country code 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

Array of objects (services)
Array
type
string

Type of Service

geoScopes
Array of strings (GeoScopeType)
Items Enum: "CANADA" "CONUS" "JAPAN" "UK" "AUSTRALIA" "BRAZIL" "SWITZERLAND" "EU"

List of supported geographic boundaries of a Fabric Metro.

Array of objects (GeoZone)

List of supported geographic zones of a Fabric Metro.

Array
code
string

Code assigned to a geographic zone.

name
string

Name of a geographic zone.

description
string

Description of a geographic zone.

Response samples

Content type
application/json
{}

Networks

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" "TECHNICAL" "ORDERING" "QUOTE_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

Array of objects (Phone)

Array of contact phone numbers

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" "TECHNICAL" "ORDERING" "QUOTE_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

Array of objects (Phone)

Array of contact phone numbers

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" "TECHNICAL" "ORDERING" "QUOTE_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

Array of objects (Phone)

Array of contact phone numbers

Response samples

Content type
application/json
{}

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
{}

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" "TECHNICAL" "ORDERING" "QUOTE_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

Array of objects (Phone)

Array of contact phone numbers

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" "/state" "/operation/equinixStatus" "/location/region" "/location/metroCode" "/connectionsCount" "/project/projectId" "/account/globalCustId" "/account/orgId" "/changeLog/createdDateTime" "/changeLog/updatedDateTime" "/changeLog/deletedDateTime" "/*"

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" "EVPTREE_VC" "EPTREE_VC" "IPWAN_VC" "IA_VC" "MC_VC" "IX_VC" "GW_VC" "IPX_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" "PROVISIONING" ""

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" "UK" "AUSTRALIA" "BRAZIL" "SWITZERLAND" "EU"

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
{}

Optical Metro Connects

Optical Metro Connects Beta

Create Optical Metro Connect Service

Create a single Optical Metro Connect circuit.

Authorizations:
BearerAuth
Request Body schema: application/json
required
type
required
string
Value: "OC"

OC - Optical Connect Type

bandwidth
required
integer

Connection bandwidth Mbps.
Available bandwidths depend on the IBX pair.
1000 - 1 Gbps.
10000 - 10 Gbps.
100000 - 100 Gbps.

connectionDestinationType
required
string
Enum: "COLO" "BMMR" "REMOTE"

Where the Z-side terminates.
COLO - your own colocation space at another Equinix IBX.
BMMR - a Building Meet-Me Room.
REMOTE - another customer's colocation space at another Equinix IBX.
BMMR and REMOTE require a Letter of Authorization on the Z-side.

pathType
required
string
Enum: "DUAL_DIVERSE" "PROTECTED" "UNPROTECTED"

Level of resilience for the connection.
UNPROTECTED - a single fiber path with no node redundancy.
PROTECTED - two diverse fiber paths between single nodes at each IBX.
DUAL_DIVERSE - two diverse fiber paths terminating on redundant nodes at both IBXs.

object (OpticalConnectRedundancy)

Optical Connect redundancy configuration.
Required only for DUAL_DIVERSE connection.

priority
string
Enum: "PRIMARY" "SECONDARY"

Role within the diverse pair.
PRIMARY - first connection of the pair.
SECONDARY - the diverse connection on a separate path.

group
string <uuid>

Redundancy group identifier

required
object (OpticalConnectASideRequest)

A-Side configuration. Always a patch panel port from your cage.

patchPanelId
string

Unique identifier of the patch panel.

patchPanelPortA
string

Specify the desired port number for Port A.
When ports are not provided, next available ports will be used.

patchPanelPortB
string

Specify the desired port number for Port B.
When ports are not provided, next available ports will be used.
Required for Connector type FC, SC and ST only.

connectorType
string
Enum: "FC" "SC" "LC" "ST"

Type of Connector

required
object (OpticalConnectZSideRequest)

Z-Side configuration.
For COLO, specify the destination patch panel and ports.
For BMMR and REMOTE, specify the location and Letter of Authorization.

patchPanelId
string

Unique identifier of the patch panel.

patchPanelPortA
string

Specify the desired port number for Port A.
When ports are not provided, next available ports will be used.

patchPanelPortB
string

Specify the desired port number for Port B.
When ports are not provided, next available ports will be used.
Required for Connector type FC, SC and ST only.

connectorType
string
Enum: "FC" "SC" "LC" "ST"

Type of Connector

object (OpticalConnectLocation)

Destination location for BMMR and REMOTE connections.

ibxCode
string

Equinix IBX data centre code.

object (OpticalConnectLOA)

Letter of Authorization granting the right to terminate at the Z-side location.
Required for BMMR and REMOTE.

uuid
string

Identifier of the Letter of Authorization

object (OpticalConnectOrder)

Ordering and billing reference details for this connection.

purchaseOrderNumber
string

Purchase order number reference.

customerReferenceId
string

Your own reference for this connection.

orderNumber
string

Equinix order reference number.

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 (OpticalConnectNotification)

Contacts to notify about connection configuration and status changes

Array
type
required
string
Enum: "NOTIFICATION" "ORDERING" "TECHNICAL"

Notification category.
NOTIFICATION - states and configuration updates.
ORDERING - order and fulfilment correspondence.
TECHNICAL - maintenance and technical advisories.

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

Email addresses to notify.

registeredUsers
Array of strings

Usernames of registered Equinix Portal users to notify.

bmmrType
string
Enum: "EQUINIX" "SELF"

BMMR infrastructure ownership type.
EQUINIX - Equinix-operated.
SELF - customer-operated.
Required only when connectionDestinationType is BMMR.

Responses

Request samples

Content type
application/json
Example

Both ends terminate on patch panels in colocation space you occupy, so no Letter of Authorization is needed.

{
  • "type": "OC",
  • "bandwidth": 100000,
  • "connectionDestinationType": "COLO",
  • "pathType": "UNPROTECTED",
  • "aSide": {
    },
  • "zSide": {
    },
  • "order": {
    },
  • "notifications": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "href": "https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0",
  • "uuid": "06dbb0e3-e55d-4090-8aff-fc5654abaad0",
  • "type": "OC",
  • "name": "270848-SV1-SV2-01",
  • "state": "PROVISIONING",
  • "bandwidth": 100000,
  • "connectionDestinationType": "COLO",
  • "pathType": "UNPROTECTED",
  • "aSide": {
    },
  • "zSide": {
    },
  • "order": {
    },
  • "account": {
    },
  • "notifications": [
    ],
  • "changeLog": {
    }
}

Create Dual Diverse Optical Metro Connect Service

Create a dual diverse pair of circuits on separate optical paths.

Authorizations:
BearerAuth
Request Body schema: application/json
required
Array of objects (OpticalConnectPostRequest)

The two connections forming the diverse pair — one PRIMARY and one SECONDARY.

Array
type
required
string
Value: "OC"

OC - Optical Connect Type

bandwidth
required
integer

Connection bandwidth Mbps.
Available bandwidths depend on the IBX pair.
1000 - 1 Gbps.
10000 - 10 Gbps.
100000 - 100 Gbps.

connectionDestinationType
required
string
Enum: "COLO" "BMMR" "REMOTE"

Where the Z-side terminates.
COLO - your own colocation space at another Equinix IBX.
BMMR - a Building Meet-Me Room.
REMOTE - another customer's colocation space at another Equinix IBX.
BMMR and REMOTE require a Letter of Authorization on the Z-side.

pathType
required
string
Enum: "DUAL_DIVERSE" "PROTECTED" "UNPROTECTED"

Level of resilience for the connection.
UNPROTECTED - a single fiber path with no node redundancy.
PROTECTED - two diverse fiber paths between single nodes at each IBX.
DUAL_DIVERSE - two diverse fiber paths terminating on redundant nodes at both IBXs.

object (OpticalConnectRedundancy)

Optical Connect redundancy configuration.
Required only for DUAL_DIVERSE connection.

required
object (OpticalConnectASideRequest)

A-Side configuration. Always a patch panel port from your cage.

required
object (OpticalConnectZSideRequest)

Z-Side configuration.
For COLO, specify the destination patch panel and ports.
For BMMR and REMOTE, specify the location and Letter of Authorization.

object (OpticalConnectOrder)

Ordering and billing reference details for this connection.

object (SimplifiedAccount)
Array of objects (OpticalConnectNotification)

Contacts to notify about connection configuration and status changes

bmmrType
string
Enum: "EQUINIX" "SELF"

BMMR infrastructure ownership type.
EQUINIX - Equinix-operated.
SELF - customer-operated.
Required only when connectionDestinationType is BMMR.

Responses

Request samples

Content type
application/json
Example

Two connections on separate patch panels. Equinix assigns the shared redundancy group and returns it on both connections.

{
  • "data": [
    ]
}

Response samples

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

Get Optical Metro Connect Service

Get a single Optical Metro Connect by UUID.

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

Unique identifier of an Optical Connect.

Responses

Response Schema: application/json
href
string <uri>

URI of this Optical Connect resource.

uuid
string <uuid>

Unique identifier of this Optical Connect.

type
string
Value: "OC"

Connection Type.
OC - Optical Connect.

name
string

Equinix-assigned name, derived from the account number and the two IBX locations.

state
string (OpticalConnectState)
Enum: "PROVISIONING" "PROVISIONED" "PROVISIONING_FAILED" "REPROVISIONING" "REPROVISIONING_FAILED" "DEPROVISIONING" "DEPROVISIONED"

Optical Connect lifecycle states.

bandwidth
integer

Provisioned connection bandwidth in Mbps.

connectionDestinationType
string
Enum: "COLO" "BMMR" "REMOTE"

Where the Z-side terminates.
COLO - your own colocation space at another Equinix IBX.
BMMR - a Building Meet-Me Room.
REMOTE - another customer's colocation space at another Equinix IBX.

pathType
string
Enum: "DUAL_DIVERSE" "PROTECTED" "UNPROTECTED"

Level of resilience for the connection.
UNPROTECTED - a single fiber path with no node redundancy.
PROTECTED - two diverse fiber paths between single nodes at each IBX.
DUAL_DIVERSE - two diverse fiber paths terminating on redundant nodes at both IBXs.

bmmrType
string
Enum: "EQUINIX" "SELF"

BMMR infrastructure ownership type.
EQUINIX - Equinix-operated.
SELF - customer-operated.
Required only when connectionDestinationType is BMMR.

object (OpticalConnectRedundancy)

Optical Connect redundancy configuration.
Required only for DUAL_DIVERSE connection.

priority
string
Enum: "PRIMARY" "SECONDARY"

Role within the diverse pair.
PRIMARY - first connection of the pair.
SECONDARY - the diverse connection on a separate path.

group
string <uuid>

Redundancy group identifier

object (OpticalConnectASideResponse)

Originating end as provisioned, with the cage, cabinet and IBX location.

patchPanelId
string

Unique identifier of the patch panel.

patchPanelPortA
string

Specify the desired port number for Port A.
When ports are not provided, next available ports will be used.

patchPanelPortB
string

Specify the desired port number for Port B.
When ports are not provided, next available ports will be used.
Required for Connector type FC, SC and ST only.

connectorType
string
Enum: "FC" "SC" "LC" "ST"

Type of Connector

cageUniqueSpaceId
string

Unique identifier of the cage.

cabinetUniqueSpaceId
string

Unique identifier of the cabinet.

object (OpticalConnectLocation)

Destination location for BMMR and REMOTE connections.

ibxCode
string

Equinix IBX data centre code.

object (OpticalConnectZSideResponse)

Terminating end as provisioned, with the cage, cabinet and IBX location.

patchPanelId
string

Unique identifier of the patch panel.

patchPanelPortA
string

Specify the desired port number for Port A.
When ports are not provided, next available ports will be used.

patchPanelPortB
string

Specify the desired port number for Port B.
When ports are not provided, next available ports will be used.
Required for Connector type FC, SC and ST only.

connectorType
string
Enum: "FC" "SC" "LC" "ST"

Type of Connector

cageUniqueSpaceId
string

Unique identifier of the cage.

cabinetUniqueSpaceId
string

Unique identifier of the cabinet.

object (OpticalConnectLocation)

Destination location for BMMR and REMOTE connections.

ibxCode
string

Equinix IBX data centre code.

object (OpticalConnectLOA)

Letter of Authorization granting the right to terminate at the Z-side location.
Required for BMMR and REMOTE.

uuid
string

Identifier of the Letter of Authorization

object (OpticalConnectOrder)

Ordering and billing reference details for this connection.

purchaseOrderNumber
string

Purchase order number reference.

customerReferenceId
string

Your own reference for this connection.

orderNumber
string

Equinix order reference number.

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 (OpticalConnectNotification)

Preferences for notifications on connection configuration or status changes

Array
type
required
string
Enum: "NOTIFICATION" "ORDERING" "TECHNICAL"

Notification category.
NOTIFICATION - states and configuration updates.
ORDERING - order and fulfilment correspondence.
TECHNICAL - maintenance and technical advisories.

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

Email addresses to notify.

registeredUsers
Array of strings

Usernames of registered Equinix Portal users to notify.

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
{
  • "href": "https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0",
  • "uuid": "06dbb0e3-e55d-4090-8aff-fc5654abaad0",
  • "type": "OC",
  • "name": "270848-SV1-SV2-01",
  • "state": "PROVISIONING",
  • "bandwidth": 100000,
  • "connectionDestinationType": "COLO",
  • "pathType": "UNPROTECTED",
  • "aSide": {
    },
  • "zSide": {
    },
  • "order": {
    },
  • "account": {
    },
  • "notifications": [
    ],
  • "changeLog": {
    }
}

Search Optical Metro Connect Services

Get Optical Metro Connects matching the supplied criteria, with optional filtering, pagination and sorting.

Authorizations:
BearerAuth
Request Body schema: application/json
required
object (OpticalConnectFilters)
Array of OpticalConnectSimpleExpression (object) or OpticalConnectOrFilter (object) (OpticalConnectFilter) <= 8 items
Array (<= 8 items)
Any of
property
string

Possible field names to use on filters:

  • /name - Connection name
  • /uuid - Connection uuid
  • /type - type
  • /state - state
  • /bandwidth - Bandwidth
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 (OpticalConnectSortCriteria)
Array
direction
string (OpticalConnectSortDirection)
Default: "DESC"
Enum: "DESC" "ASC"

Sorting direction.
ASC - ascending
DESC - descending

property
string (OpticalConnectSortBy)
Default: "/changeLog/updatedDateTime"
Enum: "/name" "/uuid" "/state" "/type" "/bandwidth" "/aSide/location/ibxCode" "/zSide/location/ibxCode" "/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 (OpticalConnectResponse)

Data returned from the API call.

Array
href
string <uri>

URI of this Optical Connect resource.

uuid
string <uuid>

Unique identifier of this Optical Connect.

type
string
Value: "OC"

Connection Type.
OC - Optical Connect.

name
string

Equinix-assigned name, derived from the account number and the two IBX locations.

state
string (OpticalConnectState)
Enum: "PROVISIONING" "PROVISIONED" "PROVISIONING_FAILED" "REPROVISIONING" "REPROVISIONING_FAILED" "DEPROVISIONING" "DEPROVISIONED"

Optical Connect lifecycle states.

bandwidth
integer

Provisioned connection bandwidth in Mbps.

connectionDestinationType
string
Enum: "COLO" "BMMR" "REMOTE"

Where the Z-side terminates.
COLO - your own colocation space at another Equinix IBX.
BMMR - a Building Meet-Me Room.
REMOTE - another customer's colocation space at another Equinix IBX.

pathType
string
Enum: "DUAL_DIVERSE" "PROTECTED" "UNPROTECTED"

Level of resilience for the connection.
UNPROTECTED - a single fiber path with no node redundancy.
PROTECTED - two diverse fiber paths between single nodes at each IBX.
DUAL_DIVERSE - two diverse fiber paths terminating on redundant nodes at both IBXs.

bmmrType
string
Enum: "EQUINIX" "SELF"

BMMR infrastructure ownership type.
EQUINIX - Equinix-operated.
SELF - customer-operated.
Required only when connectionDestinationType is BMMR.

object (OpticalConnectRedundancy)

Optical Connect redundancy configuration.
Required only for DUAL_DIVERSE connection.

object (OpticalConnectASideResponse)

Originating end as provisioned, with the cage, cabinet and IBX location.

object (OpticalConnectZSideResponse)

Terminating end as provisioned, with the cage, cabinet and IBX location.

object (OpticalConnectOrder)

Ordering and billing reference details for this connection.

object (SimplifiedAccount)
Array of objects (OpticalConnectNotification)

Preferences for notifications on connection configuration or status changes

object (Changelog)

Change log

Request samples

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

Response samples

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

Port Packages

Port Packages Beta

Get All Port Packages

Get All Port Packages returns details of all available port packages for the specified user credentials.

Authorizations:
BearerAuth

Responses

Response Schema: application/json
required
Array of objects (PortPackage)

List of Port Packages

Array
href
string

Port Package URI

type
required
string
Value: "PORT_PACKAGE"

Port Package Type

code
required
string

Port Package code

vcBandwidthMax
integer

Maximum virtual connection bandwidth in Mbps

vcRemoteSupported
boolean

Indicates if remote virtual connections are supported

supportedServiceTypes
Array of strings
Items Value: "MSP"

List of supported service types

supportedSourceTypes
Array of strings (PortPackageSourceType)
Items Enum: "COLO" "REMOTE" "BMMR"

List of supported source types

supportedMetros
Array of strings

List of supported metros

Response samples

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

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)
Value: "XF_PORT"

Type of Port

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" "10GBASE_SMF" "400GBASE_LR4"

Physical Ports Type. 10GBASE_SMF and 400GBASE_LR4 are only used for IX ports

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" "PENDING_CROSS_CONNECT" "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

serviceCode
string (PortServiceCode)
Enum: "CX" "IX" "IA" "MC"

Identifies the service type associated with this port

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
Deprecated

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

object (marketplaceSubscription)

Equinix Fabric Entity for Marketplace Subscription

Response samples

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

Create Port

Creates Equinix Fabric™ Port.

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 (PortType)
Value: "XF_PORT"

Type of Port

physicalPortsSpeed
required
integer >= 0

Physical Ports Speed in Mbps

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

Physical Ports Type. 10GBASE_SMF is only applicable for IX ports

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

Port connectivity type

bmmrType
string
Enum: "SELF" "EQUINIX"

BMMR Type is mandatory when connectivitySourceType is BMMR

required
object (Project)
projectId
required
string

Subscriber-assigned project ID

object (PortOrder)
object (PortOrderPurchaseOrder)

Purchase Order information associate to the account

number
string

purchase order number

amount
string

purchase order amount

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

Customer order reference Id

object (PortOrderSignature)

Port signature details

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

Port signature Type

object (PortOrderSignatureDelegate)

order delegate details

required
object (SimplifiedAccountRequest)
accountNumber
required
integer <int64>

Account number

serviceType
string
Deprecated
Enum: "EPL" "MSP"

Port service Type

serviceCode
string (PortServiceCode)
Enum: "CX" "IX" "IA" "MC"

Identifies the service type associated with this port

bandwidth
integer >= 0
Deprecated

Equinix assigned response attribute for Port bandwidth in Mbps

required
object (SimplifiedLocationRequest)
metroCode
required
string
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: "DOT1Q" "QINQ" "UNTAGGED"

Port encapsulation protocol type

tagProtocolId
string

Port encapsulation tag protocol identifier

lagEnabled
boolean

Indicates whether Link Aggregation Group (LAG) is enabled on this port

object (Package)

Package settings for port

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

Type of Port Package

object (PortSettings)

Port configuration settings

buyout
boolean
Deprecated
viewPortPermission
boolean
Deprecated
placeVcOrderPermission
boolean
Deprecated
layer3Enabled
boolean
Deprecated
packageType
string
Deprecated
Enum: "STANDARD" "UNLIMITED" "UNLIMITED_PLUS"

Type of Port Package

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 (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" "PENDING_CROSS_CONNECT" "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

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)
Value: "XF_PORT"

Type of Port

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" "10GBASE_SMF" "400GBASE_LR4"

Physical Ports Type. 10GBASE_SMF and 400GBASE_LR4 are only used for IX ports

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" "PENDING_CROSS_CONNECT" "PROVISIONED" "ACTIVE" "DEPROVISIONING" "DEPROVISIONED" "INACTIVE" "FAILED" "ADDED" "DELETED" "TO_BE_ADDED" "TO_BE_DELETED"

Port lifecycle state

object (PortOrder)
object (PortOrderPurchaseOrder)

Purchase Order information associate to the account

number
string

purchase order number

amount
string

purchase order amount

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

Customer order reference Id

object (PortOrderSignature)

Port signature details

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

Port signature Type

object (PortOrderSignatureDelegate)

order delegate 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.

maintenanceStatus
string (maintenanceState)
Enum: "SCHEDULED" "IN_PROGRESS" "COMPLETED" "DEFERRED"

Maintenance lifecycle state

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

serviceCode
string (PortServiceCode)
Enum: "CX" "IX" "IA" "MC"

Identifies the service type associated with this port

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
Deprecated

Device name

object (PortDeviceRedundancy)

Device redundancy

group
string

Device redundancy group

priority
string
Enum: "PRIMARY" "SECONDARY"

Device redundancy priority

vcBandwidthMax
integer <int64>

Maximum bandwidth allowed for connection.

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: "DOT1Q" "QINQ" "UNTAGGED"

Port encapsulation protocol type

tagProtocolId
string

Port encapsulation tag protocol identifier

lagEnabled
boolean

If LAG enabled

object
Deprecated

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

object (PortSettings)

Port configuration settings

buyout
boolean
Deprecated
viewPortPermission
boolean
Deprecated
placeVcOrderPermission
boolean
Deprecated
layer3Enabled
boolean
Deprecated
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" "PENDING_CROSS_CONNECT" "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

Loa type

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

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
Example
{
  • "type": "XF_PORT",
  • "physicalPortsType": "10GBASE_L",
  • "physicalPortsSpeed": 10000,
  • "physicalPortsCount": 1,
  • "location": {
    },
  • "demarcationPointIbx": "AM1",
  • "redundancy": {
    },
  • "lagEnabled": true,
  • "encapsulation": {
    },
  • "package": {
    },
  • "settings": {
    },
  • "project": {
    },
  • "account": {
    },
  • "order": {
    },
  • "notifications": [
    ]
}

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" "PENDING_CROSS_CONNECT" "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" "PENDING_CROSS_CONNECT" "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)
Value: "XF_PORT"

Type of Port

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" "10GBASE_SMF" "400GBASE_LR4"

Physical Ports Type. 10GBASE_SMF and 400GBASE_LR4 are only used for IX ports

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" "PENDING_CROSS_CONNECT" "PROVISIONED" "ACTIVE" "DEPROVISIONING" "DEPROVISIONED" "INACTIVE" "FAILED" "ADDED" "DELETED" "TO_BE_ADDED" "TO_BE_DELETED"

Port lifecycle state

object (PortOrder)
object (PortOrderPurchaseOrder)

Purchase Order information associate to the account

number
string

purchase order number

amount
string

purchase order amount

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

Customer order reference Id

object (PortOrderSignature)

Port signature details

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

Port signature Type

object (PortOrderSignatureDelegate)

order delegate 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.

maintenanceStatus
string (maintenanceState)
Enum: "SCHEDULED" "IN_PROGRESS" "COMPLETED" "DEFERRED"

Maintenance lifecycle state

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

serviceCode
string (PortServiceCode)
Enum: "CX" "IX" "IA" "MC"

Identifies the service type associated with this port

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
Deprecated

Device name

object (PortDeviceRedundancy)

Device redundancy

group
string

Device redundancy group

priority
string
Enum: "PRIMARY" "SECONDARY"

Device redundancy priority

vcBandwidthMax
integer <int64>

Maximum bandwidth allowed for connection.

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: "DOT1Q" "QINQ" "UNTAGGED"

Port encapsulation protocol type

tagProtocolId
string

Port encapsulation tag protocol identifier

lagEnabled
boolean

If LAG enabled

object
Deprecated

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

object (PortSettings)

Port configuration settings

buyout
boolean
Deprecated
viewPortPermission
boolean
Deprecated
placeVcOrderPermission
boolean
Deprecated
layer3Enabled
boolean
Deprecated
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" "PENDING_CROSS_CONNECT" "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

Loa type

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

Response samples

Content type
application/json
Example
{
  • "href": "https://api.equinix.com/fabric/v4/ports/44c5712b-d704-4ca5-9b42-ee6be32ee06a",
  • "type": "XF_PORT",
  • "uuid": "44c5712b-d704-4ca5-9b42-ee6be32ee06a",
  • "name": "270843-DA1-CX-PRI-33",
  • "physicalPortsSpeed": 1000,
  • "physicalPortsType": "1000BASE_LX",
  • "project": {
    },
  • "package": {
    },
  • "state": "ACTIVE",
  • "cvpId": "2000833",
  • "connectivitySourceType": "COLO",
  • "operation": {
    },
  • "account": {
    },
  • "change": {
    },
  • "changeLog": {
    },
  • "bandwidth": 1000,
  • "availableBandwidth": 500,
  • "usedBandwidth": 500,
  • "location": {},
  • "device": {
    },
  • "demarcationPointIbx": "DA1",
  • "tetherIbx": "DA1",
  • "redundancy": {
    },
  • "encapsulation": {
    },
  • "lagEnabled": false,
  • "settings": {
    },
  • "physicalPorts": [
    ]
}

Delete a single port

The API provides capability to delete a single port

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

Port UUID

query Parameters
dryRun
boolean
Default: false

option to verify that API calls will succeed

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)
Value: "XF_PORT"

Type of Port

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" "10GBASE_SMF" "400GBASE_LR4"

Physical Ports Type. 10GBASE_SMF and 400GBASE_LR4 are only used for IX ports

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" "PENDING_CROSS_CONNECT" "PROVISIONED" "ACTIVE" "DEPROVISIONING" "DEPROVISIONED" "INACTIVE" "FAILED" "ADDED" "DELETED" "TO_BE_ADDED" "TO_BE_DELETED"

Port lifecycle state

object (PortOrder)
object (PortOrderPurchaseOrder)

Purchase Order information associate to the account

number
string

purchase order number

amount
string

purchase order amount

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

Customer order reference Id

object (PortOrderSignature)

Port signature details

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

Port signature Type

object (PortOrderSignatureDelegate)

order delegate 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.

maintenanceStatus
string (maintenanceState)
Enum: "SCHEDULED" "IN_PROGRESS" "COMPLETED" "DEFERRED"

Maintenance lifecycle state

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

serviceCode
string (PortServiceCode)
Enum: "CX" "IX" "IA" "MC"

Identifies the service type associated with this port

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
Deprecated

Device name

object (PortDeviceRedundancy)

Device redundancy

group
string

Device redundancy group

priority
string
Enum: "PRIMARY" "SECONDARY"

Device redundancy priority

vcBandwidthMax
integer <int64>

Maximum bandwidth allowed for connection.

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: "DOT1Q" "QINQ" "UNTAGGED"

Port encapsulation protocol type

tagProtocolId
string

Port encapsulation tag protocol identifier

lagEnabled
boolean

If LAG enabled

object
Deprecated

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

object (PortSettings)

Port configuration settings

buyout
boolean
Deprecated
viewPortPermission
boolean
Deprecated
placeVcOrderPermission
boolean
Deprecated
layer3Enabled
boolean
Deprecated
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" "PENDING_CROSS_CONNECT" "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

Loa type

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

Response samples

Content type
application/json
{
  • "type": "XF_PORT",
  • "uuid": "e91484bb-4f65-4ab3-8f77-500dec2f855d",
  • "name": "test-AT1-Dot1q-L-Secondary-108608",
  • "physicalPortsType": "10GBASE_L",
  • "physicalPortsSpeed": 10000,
  • "physicalPortsCount": 1,
  • "location": {
    },
  • "demarcationPointIbx": "AM1",
  • "redundancy": {
    },
  • "lagEnabled": true,
  • "encapsulation": {
    },
  • "package": {
    },
  • "settings": {
    },
  • "project": {
    },
  • "account": {
    },
  • "order": {
    },
  • "notifications": [
    ],
  • "physicalPorts": {
    }
}

Update by UUID

Update Port by UUID

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

Port 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

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
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)
Value: "XF_PORT"

Type of Port

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" "10GBASE_SMF" "400GBASE_LR4"

Physical Ports Type. 10GBASE_SMF and 400GBASE_LR4 are only used for IX ports

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" "PENDING_CROSS_CONNECT" "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

serviceCode
string (PortServiceCode)
Enum: "CX" "IX" "IA" "MC"

Identifies the service type associated with this port

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
Deprecated

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

object (marketplaceSubscription)

Equinix Fabric Entity for Marketplace Subscription

Request samples

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

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
required
object (PortExpression)

Either use 'and' for AND operations, 'or' for OR operations, or specify 'property', 'operator', and 'values' for field filtering. Only one of these patterns should be used at a time.

and
Array of objects (PortExpressions)
or
Array of objects (PortExpressions)
property
string (PortSearchFieldName)
Enum: "/device/name" "/physicalPorts/tether/crossConnectId" "/physicalPorts/interface/name" "/state" "/project/projectId" "/uuid" "/name" "/account/orgId" "/account/accountNumber" "/location/metroCode" "/operation/maintenanceStatus" "/operation/lockEnabled"

Possible field names to use on filters

operator
string
Enum: "=" "!=" ">" ">=" "<" "<=" "LIKE" "ILIKE" "IN" "NOT IN" "BETWEEN"
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"
Enum: "/device/name" "/name" "/state" "/location/metroName" "/demarcationPointIbx" "/device/redundancy/priority" "/lagEnabled" "/physicalPortsSpeed" "/encapsulation/type" "/physicalPorts/tether/crossConnectId" "/package/code" "/changeLog/updatedDateTime" "/changeLog/createdDateTime" "/bandwidth" "/serviceCode"

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)
Value: "XF_PORT"

Type of Port

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" "10GBASE_SMF" "400GBASE_LR4"

Physical Ports Type. 10GBASE_SMF and 400GBASE_LR4 are only used for IX ports

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" "PENDING_CROSS_CONNECT" "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

serviceCode
string (PortServiceCode)
Enum: "CX" "IX" "IA" "MC"

Identifies the service type associated with this port

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
Deprecated

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

object (marketplaceSubscription)

Equinix Fabric Entity for Marketplace Subscription

Request samples

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

Response samples

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

Precision Time

Precision Time

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 <byte> ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[...

The plaintext authentication key. Must be Base64 encoded. 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.

object (timeServiceOperation)

time service operational data

operationalStatus
string
Enum: "UP" "DOWN" "DEGRADED"

time service operational 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 <byte> ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[...

The plaintext authentication key. Must be Base64 encoded. 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 <byte> ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[...

The plaintext authentication key. Must be Base64 encoded. 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.

object (timeServiceOperation)

time service operational data

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" "OPTICAL_CONNECT_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

Optical Metro Connect Port 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:
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
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
{}

Search Route Aggregation Rules

This API provides capability to search 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
RouteAggregationRuleAndExpression (object) or RouteAggregationRuleOrExpression (object) (RouteAggregationRulesFilter)

Top-level filter that can be either an AND expression or OR expression

Any of
Array of RouteAggregationRuleAndExpression (object) or RouteAggregationRuleOrExpression (object) or RouteAggregationRuleSimpleExpression (object) (RouteAggregationRuleExpression) [ 1 .. 8 ] items
Array ([ 1 .. 8 ] items)
Any of
object RouteAggregationRuleAndExpression Recursive
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 (RouteAggregationRuleSortCriteria)
Array
direction
string (RouteAggregationRuleSortDirection)
Default: "DESC"
Enum: "DESC" "ASC"

Sorting direction

property
string (RouteAggregationRuleSortBy)
Default: "/changeLog/updatedDateTime"
Enum: "/type" "/uuid" "/name" "/state" "/prefix" "/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 (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

Request samples

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

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"
object (Changelog)

Change log

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"
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
{}

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:
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
[
  • {
    }
]

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" "EVPTREE_VC" "EPTREE_VC" "IPWAN_VC" "IA_VC" "MC_VC" "IX_VC" "GW_VC" "IPX_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
SearchAndExpression (object) or SearchOrExpression (object) (SearchFilter)

Top-level filter that can be either an AND expression or OR expression

One of
required
Array of SearchAndExpression (object) or SearchOrExpression (object) or SearchSimpleExpression (object) (SearchFilterExpression) [ 1 .. 8 ] items
Array ([ 1 .. 8 ] items)
One of
object SearchAndExpression Recursive
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 (RouteAggregationSortCriteria)
Array
direction
string (RouteAggregationSortDirection)
Default: "DESC"
Enum: "DESC" "ASC"

Sorting direction

property
string (RouteAggregationSortBy)
Default: "/changeLog/updatedDateTime"
Enum: "/type" "/uuid" "/name" "/project/projectId" "/state" "/changeLog/createdDateTime" "/changeLog/updatedDateTime" "/changeLog/deletedDateTime"

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 (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
Example
{
  • "filter": {
    },
  • "pagination": {
    },
  • "sort": [
    ]
}

Response samples

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

Search Cloud Router Route Aggregation Attachments

This API provides capability to search route aggregation attachments for a given cloud router Beta

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

Cloud Router UUID

Request Body schema: application/json
required
CloudRouterRouteAggregationAndExpression (object) or CloudRouterRouteAggregationOrExpression (object) (CloudRouterRouteAggregationsFilter)

Top-level filter that can be either an AND expression or OR expression

Any of
Array of CloudRouterRouteAggregationAndExpression (object) or CloudRouterRouteAggregationOrExpression (object) or CloudRouterRouteAggregationSimpleExpression (object) (CloudRouterRouteAggregationExpression) [ 1 .. 8 ] items
Array ([ 1 .. 8 ] items)
Any of
object CloudRouterRouteAggregationAndExpression Recursive
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 (RaAttachmentSortItem) [ 1 .. 3 ] items
Array ([ 1 .. 3 ] items)
property
string
Default: "/changeLog/updatedDateTime"
Enum: "/type" "/uuid" "/attachmentStatus" "/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 (ConnectionRouteAggregationData)

List of route aggregation attachments for a given cloud router

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"
object (Changelog)

Change log

Request samples

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

Response samples

Content type
application/json
{}

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:
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
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
{}

Search Route Filter Rules

This API provides capability to search 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
RouteFilterRuleAndExpression (object) or RouteFilterRuleOrExpression (object) (RouteFilterRulesFilter)

Top-level filter that can be either an AND expression or OR expression

Any of
Array of RouteFilterRuleAndExpression (object) or RouteFilterRuleOrExpression (object) or RouteFilterRuleSimpleExpression (object) (RouteFilterRuleExpression) [ 1 .. 8 ] items
Array ([ 1 .. 8 ] items)
Any of
object RouteFilterRuleAndExpression Recursive
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 (RouteFilterRuleSortCriteria)
Array
direction
string (RouteFilterRuleSortDirection)
Default: "DESC"
Enum: "DESC" "ASC"

Sorting direction

property
string (RouteFilterRuleSortBy)
Default: "/changeLog/updatedDateTime"
Enum: "/type" "/uuid" "/name" "/state" "/prefix" "/prefixMatch" "/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 (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

Request samples

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

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"
object (Changelog)

Change log

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"
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
{}

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:
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
[
  • {
    }
]

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" "EVPTREE_VC" "EPTREE_VC" "IPWAN_VC" "IA_VC" "MC_VC" "IX_VC" "GW_VC" "IPX_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
SearchAndExpression (object) or SearchOrExpression (object) (SearchFilter)

Top-level filter that can be either an AND expression or OR expression

One of
required
Array of SearchAndExpression (object) or SearchOrExpression (object) or SearchSimpleExpression (object) (SearchFilterExpression) [ 1 .. 8 ] items
Array ([ 1 .. 8 ] items)
One of
object SearchAndExpression Recursive
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 (RouteFilterSortCriteria)
Array
direction
string (RouteFilterSortDirection)
Default: "DESC"
Enum: "DESC" "ASC"

Sorting direction

property
string (RouteFilterSortBy)
Default: "/changeLog/updatedDateTime"
Enum: "/type" "/uuid" "/name" "/project/projectId" "/state" "/changeLog/createdDateTime" "/changeLog/updatedDateTime" "/changeLog/deletedDateTime"

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 (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
Example
{
  • "filter": {
    },
  • "pagination": {
    },
  • "sort": [
    ]
}

Response samples

Content type
application/json
{}

Search Cloud Router Route Filter Attachments

This API provides capability to search route filter attachments for a given cloud router Beta

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

Cloud Router UUID

Request Body schema: application/json
required
CloudRouterRouteFilterAndExpression (object) or CloudRouterRouteFilterOrExpression (object) (CloudRouterRouteFiltersFilter)

Top-level filter that can be either an AND expression or OR expression

Any of
Array of CloudRouterRouteFilterAndExpression (object) or CloudRouterRouteFilterOrExpression (object) or CloudRouterRouteFilterSimpleExpression (object) (CloudRouterRouteFilterExpression) [ 1 .. 8 ] items
Array ([ 1 .. 8 ] items)
Any of
object CloudRouterRouteFilterAndExpression Recursive
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 (RfAttachmentSortItem) [ 1 .. 3 ] items
Array ([ 1 .. 3 ] items)
property
string
Default: "/changeLog/updatedDateTime"
Enum: "/type" "/uuid" "/direction" "/attachmentStatus" "/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 (ConnectionRouteFilterData)

List of route filter attachments for a given cloud router

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"
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

object (RoutingProtocolProject)

The Routing Protocol's project

object (RoutingProtocolConnection)

Connection specification

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

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

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

object (RoutingProtocolProject)

The Routing Protocol's project

projectId
required
string

Uniquely identifies a project

object (RoutingProtocolConnection)

Connection specification

uuid
string

Equinix-assigned connection identifier

platformUuid
string

Equinix-assigned platform connection identifier

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

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

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 (ServiceProfileChange)

Current state of latest service profile change

object

Seller Account for Service Profile.

href
string <uri>

Service Profile URI response attribute

type
string (ServiceProfileTypeEnum)
Enum: "L2_PROFILE" "L3_PROFILE" "IA_PROFILE" "IX_PROFILE" "IC_PROFILE" "LMAAS_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.

Array of objects (ProviderEnvironment)

Provider environments associated with this IC_PROFILE service profile. Beta

selfProfile
boolean

response attribute indicates whether the profile belongs to the same organization as the api-invoker.

projectId
string
object (ServiceProfileLastMileConfig)

Last-mile configuration for the service profile.

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" "IX_PROFILE" "IC_PROFILE" "LMAAS_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" "TECHNICAL" "ORDERING" "QUOTE_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

Array of objects (Phone)

Array of contact phone numbers

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

selectiveRedundancy
boolean
Default: false

Optional 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
Enum: "XF_PORT" "IX_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
Array of objects (ProviderEnvironment)

Provider environments associated with this IC_PROFILE service profile. Beta

Array
uuid
string <uuid>

Equinix-assigned provider environment identifier

type
string (ProviderEnvironmentTypeEnum)
Value: "IC_ENV"

Provider environment type

name
string

Provider environment name

description
string

Provider environment description

region
string

Cloud provider region identifier

supportedBandwidths
Array of integers

Supported bandwidths in Mbps

Array of objects (ServiceMetro)

Derived response attribute.

supportedFeatures
Array of strings

Supported Feature Types

object (Changelog)

Change log

projectId
string
object (ServiceProfileLastMileConfig)

Last-mile configuration for the service profile.

object (ServiceProfileLastMileApiIntegration)

Last-mile API integration details.

siteValidationEnabled
boolean

Whether site validation is enabled for the last-mile provider.

dataCenterLocationEnabled
boolean

Whether data center location is enabled for the last-mile provider.

productOfferingEnabled
boolean

Whether product offering is enabled for the last-mile provider.

poqEnabled
boolean

Whether product qualification is enabled for the last-mile provider.

quoteEnabled
boolean

Whether quote generation is enabled for the last-mile provider.

placeOrderEnabled
boolean

Whether place order is enabled for the last-mile provider.

Array of objects (ServiceProfileLastMileProductCatalog)

Last-mile provider catalogs.

Array
name
string

Last-mile provider or catalog name.

id
string

Last-mile provider or catalog identifier.

webUrl
string

Last-mile catalog or provider website URL.

object (ServiceProfileLastMileDeliveryDateRange)

Range details for delivery window.

Array of objects (ServiceProfileLastMileOffering)

Available last-mile offerings.

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 (ServiceProfileChange)

Current state of latest service profile change

uuid
string

Uniquely identifies a change

type
required
string

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

Array of AddOperation (object) or RemoveOperation (object) or ReplaceOperation (object) (ServiceProfileUpdateRequest)
Array
One of
op
required
string
Value: "add"
path
required
string (Path)

A JSON Pointer path.

value
required
object

value to add

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" "IX_PROFILE" "IC_PROFILE" "LMAAS_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" "TECHNICAL" "ORDERING" "QUOTE_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

Array of objects (Phone)

Array of contact phone numbers

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

selectiveRedundancy
boolean
Default: false

Optional 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
Enum: "XF_PORT" "IX_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
Array of objects (ProviderEnvironment)

Provider environments associated with this IC_PROFILE service profile. Beta

Array
href
string <uri>

Provider Environment URI

uuid
string <uuid>

Equinix-assigned provider environment identifier

type
string (ProviderEnvironmentTypeEnum)
Value: "IC_ENV"

Provider environment type

name
string

Provider environment name

description
string

Provider environment description

region
string

Cloud provider region identifier

supportedBandwidths
Array of integers

Supported bandwidths in Mbps

Array of objects (ServiceMetro)

Derived response attribute.

supportedFeatures
Array of strings

Supported Feature Types

object (Changelog)

Change log

selfProfile
boolean

response attribute indicates whether the profile belongs to the same organization as the api-invoker.

projectId
string
object (ServiceProfileLastMileConfig)

Last-mile configuration for the service profile.

object (ServiceProfileLastMileApiIntegration)

Last-mile API integration details.

siteValidationEnabled
boolean

Whether site validation is enabled for the last-mile provider.

dataCenterLocationEnabled
boolean

Whether data center location is enabled for the last-mile provider.

productOfferingEnabled
boolean

Whether product offering is enabled for the last-mile provider.

poqEnabled
boolean

Whether product qualification is enabled for the last-mile provider.

quoteEnabled
boolean

Whether quote generation is enabled for the last-mile provider.

placeOrderEnabled
boolean

Whether place order is enabled for the last-mile provider.

Array of objects (ServiceProfileLastMileProductCatalog)

Last-mile provider catalogs.

Array
name
string

Last-mile provider or catalog name.

id
string

Last-mile provider or catalog identifier.

webUrl
string

Last-mile catalog or provider website URL.

object (ServiceProfileLastMileDeliveryDateRange)

Range details for delivery window.

Array of objects (ServiceProfileLastMileOffering)

Available last-mile offerings.

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
Example
{
  • "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 (ServiceProfileChange)

Current state of latest service profile change

object

Seller Account for Service Profile.

href
string <uri>

Service Profile URI response attribute

type
string (ServiceProfileTypeEnum)
Enum: "L2_PROFILE" "L3_PROFILE" "IA_PROFILE" "IX_PROFILE" "IC_PROFILE" "LMAAS_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.

Array of objects (ProviderEnvironment)

Provider environments associated with this IC_PROFILE service profile. Beta

selfProfile
boolean

response attribute indicates whether the profile belongs to the same organization as the api-invoker.

projectId
string
object (ServiceProfileLastMileConfig)

Last-mile configuration for the service profile.

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 (ServiceProfileChange)

Current state of latest service profile change

uuid
string

Uniquely identifies a change

type
required
string

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

Array of AddOperation (object) or RemoveOperation (object) or ReplaceOperation (object) (ServiceProfileUpdateRequest)
Array
One of
op
required
string
Value: "add"
path
required
string (Path)

A JSON Pointer path.

value
required
object

value to add

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" "IX_PROFILE" "IC_PROFILE" "LMAAS_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" "TECHNICAL" "ORDERING" "QUOTE_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

Array of objects (Phone)

Array of contact phone numbers

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

selectiveRedundancy
boolean
Default: false

Optional 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
Enum: "XF_PORT" "IX_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
Array of objects (ProviderEnvironment)

Provider environments associated with this IC_PROFILE service profile. Beta

Array
href
string <uri>

Provider Environment URI

uuid
string <uuid>

Equinix-assigned provider environment identifier

type
string (ProviderEnvironmentTypeEnum)
Value: "IC_ENV"

Provider environment type

name
string

Provider environment name

description
string

Provider environment description

region
string

Cloud provider region identifier

supportedBandwidths
Array of integers

Supported bandwidths in Mbps

Array of objects (ServiceMetro)

Derived response attribute.

supportedFeatures
Array of strings

Supported Feature Types

object (Changelog)

Change log

selfProfile
boolean

response attribute indicates whether the profile belongs to the same organization as the api-invoker.

projectId
string
object (ServiceProfileLastMileConfig)

Last-mile configuration for the service profile.

object (ServiceProfileLastMileApiIntegration)

Last-mile API integration details.

siteValidationEnabled
boolean

Whether site validation is enabled for the last-mile provider.

dataCenterLocationEnabled
boolean

Whether data center location is enabled for the last-mile provider.

productOfferingEnabled
boolean

Whether product offering is enabled for the last-mile provider.

poqEnabled
boolean

Whether product qualification is enabled for the last-mile provider.

quoteEnabled
boolean

Whether quote generation is enabled for the last-mile provider.

placeOrderEnabled
boolean

Whether place order is enabled for the last-mile provider.

Array of objects (ServiceProfileLastMileProductCatalog)

Last-mile provider catalogs.

Array
name
string

Last-mile provider or catalog name.

id
string

Last-mile provider or catalog identifier.

webUrl
string

Last-mile catalog or provider website URL.

object (ServiceProfileLastMileDeliveryDateRange)

Range details for delivery window.

Array of objects (ServiceProfileLastMileOffering)

Available last-mile offerings.

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" "IX_PROFILE" "IC_PROFILE" "LMAAS_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" "TECHNICAL" "ORDERING" "QUOTE_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

Array of objects (Phone)

Array of contact phone numbers

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

selectiveRedundancy
boolean
Default: false

Optional 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
Enum: "XF_PORT" "IX_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
Array of objects (ProviderEnvironment)

Provider environments associated with this IC_PROFILE service profile. Beta

Array
uuid
string <uuid>

Equinix-assigned provider environment identifier

type
string (ProviderEnvironmentTypeEnum)
Value: "IC_ENV"

Provider environment type

name
string

Provider environment name

description
string

Provider environment description

region
string

Cloud provider region identifier

supportedBandwidths
Array of integers

Supported bandwidths in Mbps

Array of objects (ServiceMetro)

Derived response attribute.

supportedFeatures
Array of strings

Supported Feature Types

object (Changelog)

Change log

projectId
string
object (ServiceProfileLastMileConfig)

Last-mile configuration for the service profile.

object (ServiceProfileLastMileApiIntegration)

Last-mile API integration details.

siteValidationEnabled
boolean

Whether site validation is enabled for the last-mile provider.

dataCenterLocationEnabled
boolean

Whether data center location is enabled for the last-mile provider.

productOfferingEnabled
boolean

Whether product offering is enabled for the last-mile provider.

poqEnabled
boolean

Whether product qualification is enabled for the last-mile provider.

quoteEnabled
boolean

Whether quote generation is enabled for the last-mile provider.

placeOrderEnabled
boolean

Whether place order is enabled for the last-mile provider.

Array of objects (ServiceProfileLastMileProductCatalog)

Last-mile provider catalogs.

Array
name
string

Last-mile provider or catalog name.

id
string

Last-mile provider or catalog identifier.

webUrl
string

Last-mile catalog or provider website URL.

object (ServiceProfileLastMileDeliveryDateRange)

Range details for delivery window.

Array of objects (ServiceProfileLastMileOffering)

Available last-mile offerings.

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 (ServiceProfileChange)

Current state of latest service profile change

uuid
string

Uniquely identifies a change

type
required
string

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

Array of AddOperation (object) or RemoveOperation (object) or ReplaceOperation (object) (ServiceProfileUpdateRequest)
Array
One of
op
required
string
Value: "add"
path
required
string (Path)

A JSON Pointer path.

value
required
object

value to add

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" "IX_PROFILE" "IC_PROFILE" "LMAAS_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" "TECHNICAL" "ORDERING" "QUOTE_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

Array of objects (Phone)

Array of contact phone numbers

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

selectiveRedundancy
boolean
Default: false

Optional 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
Enum: "XF_PORT" "IX_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
Array of objects (ProviderEnvironment)

Provider environments associated with this IC_PROFILE service profile. Beta

Array
href
string <uri>

Provider Environment URI

uuid
string <uuid>

Equinix-assigned provider environment identifier

type
string (ProviderEnvironmentTypeEnum)
Value: "IC_ENV"

Provider environment type

name
string

Provider environment name

description
string

Provider environment description

region
string

Cloud provider region identifier

supportedBandwidths
Array of integers

Supported bandwidths in Mbps

Array of objects (ServiceMetro)

Derived response attribute.

supportedFeatures
Array of strings

Supported Feature Types

object (Changelog)

Change log

selfProfile
boolean

response attribute indicates whether the profile belongs to the same organization as the api-invoker.

projectId
string
object (ServiceProfileLastMileConfig)

Last-mile configuration for the service profile.

object (ServiceProfileLastMileApiIntegration)

Last-mile API integration details.

siteValidationEnabled
boolean

Whether site validation is enabled for the last-mile provider.

dataCenterLocationEnabled
boolean

Whether data center location is enabled for the last-mile provider.

productOfferingEnabled
boolean

Whether product offering is enabled for the last-mile provider.

poqEnabled
boolean

Whether product qualification is enabled for the last-mile provider.

quoteEnabled
boolean

Whether quote generation is enabled for the last-mile provider.

placeOrderEnabled
boolean

Whether place order is enabled for the last-mile provider.

Array of objects (ServiceProfileLastMileProductCatalog)

Last-mile provider catalogs.

Array
name
string

Last-mile provider or catalog name.

id
string

Last-mile provider or catalog identifier.

webUrl
string

Last-mile catalog or provider website URL.

object (ServiceProfileLastMileDeliveryDateRange)

Range details for delivery window.

Array of objects (ServiceProfileLastMileOffering)

Available last-mile offerings.

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

Request Body schema: application/json-patch+json
required
Array
One of
op
required
string
Value: "add"
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 (ServiceProfileChange)

Current state of latest service profile change

uuid
string

Uniquely identifies a change

type
required
string

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

Array of AddOperation (object) or RemoveOperation (object) or ReplaceOperation (object) (ServiceProfileUpdateRequest)
Array
One of
op
required
string
Value: "add"
path
required
string (Path)

A JSON Pointer path.

value
required
object

value to add

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" "IX_PROFILE" "IC_PROFILE" "LMAAS_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" "TECHNICAL" "ORDERING" "QUOTE_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

Array of objects (Phone)

Array of contact phone numbers

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

selectiveRedundancy
boolean
Default: false

Optional 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
Enum: "XF_PORT" "IX_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
Array of objects (ProviderEnvironment)

Provider environments associated with this IC_PROFILE service profile. Beta

Array
href
string <uri>

Provider Environment URI

uuid
string <uuid>

Equinix-assigned provider environment identifier

type
string (ProviderEnvironmentTypeEnum)
Value: "IC_ENV"

Provider environment type

name
string

Provider environment name

description
string

Provider environment description

region
string

Cloud provider region identifier

supportedBandwidths
Array of integers

Supported bandwidths in Mbps

Array of objects (ServiceMetro)

Derived response attribute.

supportedFeatures
Array of strings

Supported Feature Types

object (Changelog)

Change log

selfProfile
boolean

response attribute indicates whether the profile belongs to the same organization as the api-invoker.

projectId
string
object (ServiceProfileLastMileConfig)

Last-mile configuration for the service profile.

object (ServiceProfileLastMileApiIntegration)

Last-mile API integration details.

siteValidationEnabled
boolean

Whether site validation is enabled for the last-mile provider.

dataCenterLocationEnabled
boolean

Whether data center location is enabled for the last-mile provider.

productOfferingEnabled
boolean

Whether product offering is enabled for the last-mile provider.

poqEnabled
boolean

Whether product qualification is enabled for the last-mile provider.

quoteEnabled
boolean

Whether quote generation is enabled for the last-mile provider.

placeOrderEnabled
boolean

Whether place order is enabled for the last-mile provider.

Array of objects (ServiceProfileLastMileProductCatalog)

Last-mile provider catalogs.

Array
name
string

Last-mile provider or catalog name.

id
string

Last-mile provider or catalog identifier.

webUrl
string

Last-mile catalog or provider website URL.

object (ServiceProfileLastMileDeliveryDateRange)

Range details for delivery window.

Array of objects (ServiceProfileLastMileOffering)

Available last-mile offerings.

Request samples

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

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",
  • "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": [
    ]
}

Profile Actions

This API provides capability to accept/reject service profile update requests

Authorizations:
BearerAuth
path Parameters
serviceProfileId
required
string <uuid> (ServiceProfileId)

Service Profile UUID

Request Body schema: application/json
required
type
required
string

Action type. Example values: PROFILE_UPDATE_ACCEPTANCE, PROFILE_UPDATE_REJECTION

description
string

Action description

Responses

Response Schema: application/json; charset=UTF-8
href
string <uri>

Service Profile Action URI

type
string

Action type. Example values: PROFILE_UPDATE_ACCEPTANCE, PROFILE_UPDATE_REJECTION

uuid
string <uuid>

Equinix-assigned action identifier

comments
string

Action comments

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

Request samples

Content type
application/json
Example
{
  • "type": "PROFILE_UPDATE_ACCEPTANCE",
  • "description": "Approved to migrate to public"
}

Response samples

Content type
application/json; charset=UTF-8
{}

Get Profile Environments

Get service profile provider environments by UUID Beta.

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 (ProviderEnvironment)
Array
href
string <uri>

Provider Environment URI

uuid
string <uuid>

Equinix-assigned provider environment identifier

type
string (ProviderEnvironmentTypeEnum)
Value: "IC_ENV"

Provider environment type

name
string

Provider environment name

description
string

Provider environment description

region
string

Cloud provider region identifier

supportedBandwidths
Array of integers

Supported bandwidths in Mbps

Array of objects (ServiceMetro)

Derived response attribute.

supportedFeatures
Array of strings

Supported Feature Types

object (Changelog)

Change log

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
{}

Service Profile Environment Actions

This API provides capability to perform actions on a service profile environment, such as validating an activation key.Beta

Authorizations:
BearerAuth
path Parameters
serviceProfileId
required
string <uuid> (ServiceProfileId)

Service Profile UUID

environmentId
required
string (EnvironmentId)

Provider Environment Reference

Request Body schema: application/json
required
type
required
string (EnvironmentActionTypeEnum)
Value: "VALIDATE_ACTIVATION_KEY"

Environment action type

required
object (ActivationKeyDetails)

Activation Key Details Beta

value
string

Provider Encoded activation key

providerId
string

AWS Connection identifier

accountId
string

Account identifier

bandwidth
integer

Bandwidth in Mbps

region
string

Cloud provider region identifier

Responses

Response Schema: application/json
href
string <uri>

Environment action URI

type
string (EnvironmentActionTypeEnum)
Value: "VALIDATE_ACTIVATION_KEY"

Environment action type

uuid
string <uuid>

Equinix-assigned action identifier

state
string (EnvironmentActionStateEnum)
Enum: "ACTIVE" "INACTIVE"

Environment action state. ACTIVE - already used , INACTIVE - not used

object (ActivationKeyDetails)

Activation Key Details Beta

value
string

Provider Encoded activation key

providerId
string

AWS Connection identifier

accountId
string

Account identifier

bandwidth
integer

Bandwidth in Mbps

region
string

Cloud provider region 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

Request samples

Content type
application/json
{
  • "type": "VALIDATE_ACTIVATION_KEY",
  • "keyDetails": {
    }
}

Response samples

Content type
application/json
{
  • "href": "http://example.com",
  • "type": "VALIDATE_ACTIVATION_KEY",
  • "uuid": "3a58dd05-f46d-4b1d-a154-2e85c396ea62",
  • "state": "ACTIVE",
  • "keyDetails": {
    },
  • "changeLog": {
    }
}

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" "EVPTREE_VC" "EPTREE_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" "TECHNICAL" "ORDERING" "QUOTE_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

Array of objects (Phone)

Array of contact phone numbers

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": "http://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" "EVPTREE_VC" "EPTREE_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" "TECHNICAL" "ORDERING" "QUOTE_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

Array of objects (Phone)

Array of contact phone numbers

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": "http://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" "EVPTREE_VC" "EPTREE_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" "TECHNICAL" "ORDERING" "QUOTE_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

Array of objects (Phone)

Array of contact phone numbers

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": "http://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" "EVPTREE_VC" "EPTREE_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" "TECHNICAL" "ORDERING" "QUOTE_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

Array of objects (Phone)

Array of contact phone numbers

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" "EVPTREE_VC" "EPTREE_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" "TECHNICAL" "ORDERING" "QUOTE_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

Array of objects (Phone)

Array of contact phone numbers

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" "EVPTREE_VC" "EPTREE_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" "TECHNICAL" "ORDERING" "QUOTE_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

Array of objects (Phone)

Array of contact phone numbers

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": "http://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)
or
Array of objects (ServiceTokenSearchExpressions)
property
string (ServiceTokenSearchFieldName)
Enum: "/uuid" "/state" "/name" "/project/projectId" "/type" "/expirationDateTime" "/changeLog/createdDateTime" "/changeLog/updatedDateTime" "/connection/aSide/accessPointSelectors/port/uuid" "/connection/zSide/accessPointSelectors/port/uuid"

Possible field names to use on filters

operator
string
Enum: "=" "!=" "LIKE" "ILIKE" "<" ">" "<=" ">=" "IN" "NOT IN" "BETWEEN" "NOT BETWEEN"
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 **(DEPRECATED)** Deprecated

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.(DEPRECATED)

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": "http://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 **(DEPRECATED)** Deprecated

This API provides service-level metrics so that you can view access and gather key information required to manage service subscription sizing and capacity (DEPRECATED)

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 Alert Rules

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
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 (StreamAlertRule)

Data returned from the API call.

Array
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

object (MetricSelectorResponse)
object (ResourceSelectorResponse)
object (DetectionMethodResponse)
object (Changelog)

Change log

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
required
string
Value: "METRIC_ALERT"
name
required
string

Customer-provided stream name

description
string

Customer-provided stream description

enabled
boolean
Default: true

Stream alert rule enabled status

required
object (MetricSelector)
include
required
Array of strings

Stream alert rule filtered by metric name

required
object (ResourceSelector)
include
required
Array of strings

Supported metric names to use on filters with property /subject:

  • /fabric/v4/ports/<uuid> - port metrics
  • /fabric/v4/connections/<uuid> - connection metrics
  • /fabric/v4/metros/<metroCode> - metro latency metrics
required
object (DetectionMethod)
type
required
string
Enum: "THRESHOLD" "OUTLIER"
  • THRESHOLD - Alert when a metric crosses a defined threshold by user.
  • OUTLIER - Intelligent Alert that has an outlier behavior. This option is currently supported for metro latency metric.
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
Example
{
  • "name": "metric-alert-1",
  • "type": "METRIC_ALERT",
  • "description": "metric-alert-1",
  • "enabled": true,
  • "metricSelector": {
    },
  • "resourceSelector": {
    },
  • "detectionMethod": {
    }
}

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,
  • "metricSelector": {
    },
  • "resourceSelector": {
    },
  • "detectionMethod": {
    },
  • "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

object (MetricSelectorResponse)
include
Array of strings

Stream alert rule filtered by metric name

object (ResourceSelectorResponse)
include
Array of strings

Supported metric names to use on filters with property /subject:

  • /fabric/v4/ports/<uuid> - port metrics
  • /fabric/v4/connections/<uuid> - connection metrics
  • /fabric/v4/metros/<metroCode> - metro latency metrics
object (DetectionMethodResponse)
type
string
Enum: "THRESHOLD" "OUTLIER"
  • THRESHOLD - Alert when a metric crosses a defined threshold by user.
  • OUTLIER - Intelligent Alert that has an outlier behavior. This option is currently supported for metro latency metric.
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,
  • "metricSelector": {
    },
  • "resourceSelector": {
    },
  • "detectionMethod": {
    },
  • "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
required
string

Customer-provided stream name

type
required
string
Value: "METRIC_ALERT"
description
string

Customer-provided stream description

enabled
boolean
Default: true

Stream alert rule enabled status

required
object (MetricSelector)
include
required
Array of strings

Stream alert rule filtered by metric name

required
object (ResourceSelector)
include
required
Array of strings

Supported metric names to use on filters with property /subject:

  • /fabric/v4/ports/<uuid> - port metrics
  • /fabric/v4/connections/<uuid> - connection metrics
  • /fabric/v4/metros/<metroCode> - metro latency metrics
required
object (DetectionMethod)
type
required
string
Enum: "THRESHOLD" "OUTLIER"
  • THRESHOLD - Alert when a metric crosses a defined threshold by user.
  • OUTLIER - Intelligent Alert that has an outlier behavior. This option is currently supported for metro latency metric.
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
{
  • "name": "metric-alert-1",
  • "type": "METRIC_ALERT",
  • "description": "metric-alert-1",
  • "enabled": true,
  • "metricSelector": {
    },
  • "resourceSelector": {
    },
  • "detectionMethod": {
    }
}

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,
  • "metricSelector": {
    },
  • "resourceSelector": {
    },
  • "detectionMethod": {
    },
  • "changeLog": {
    }
}

Delete 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,
  • "metricSelector": {
    },
  • "resourceSelector": {
    },
  • "detectionMethod": {
    },
  • "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 (StreamSubscriptionSinkResponse)

Create Stream destination

object (StreamSubscriptionOperation)

Stream subscription operational information

object (Changelog)

Change log

Response samples

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

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
required
string
Value: "STREAM_SUBSCRIPTION"
name
required
string

Customer-provided stream subscription name

description
string

Customer-provided stream subscription description

enabled
boolean
Default: true

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
required
object (StreamSubscriptionSink)

Create Stream destination

uri
string

any publicly reachable http endpoint

type
required
string
Enum: "DATADOG" "GOOGLE_PUBSUB" "PAGERDUTY" "SERVICENOW" "SLACK" "SPLUNK_HEC" "TEAMS" "WEBHOOK"

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

format
string
Default: "CLOUDEVENT"
Enum: "CLOUDEVENT" "OPENTELEMETRY"

webhook message format

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
{}

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 (StreamSubscriptionSinkResponse)

Create Stream destination

uri
string

any publicly reachable http endpoint

type
string
Enum: "DATADOG" "GOOGLE_PUBSUB" "PAGERDUTY" "SERVICENOW" "SLACK" "SPLUNK_HEC" "TEAMS" "WEBHOOK"

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

format
string
Default: "CLOUDEVENT"
Enum: "CLOUDEVENT" "OPENTELEMETRY"

webhook message format

host
string

sink host

object (StreamSubscriptionOperation)

Stream subscription operational information

eventsDeliveredCount
integer

count of delivered events

metricsDeliveredCount
integer

count of delivered metrics

alertsDeliveredCount
integer

count of delivered alerts

lastSuccessfulDeliveryDateTime
string <date-time>

last successful date time of delivered event, metric, or alert

suspendedDateTime
string <date-time>

suspended date time of stream subscription delivery for event, metric, or alert

Array of objects (StreamSubscriptionOperationErrors)

List of error information for stream subscription delivery

Array
errorCode
string

Equinix Observability error code

errorMessage
string

Equinix Observability error message

dateTime
string <date-time>

Equinix Observability error date time

object (StreamSubscriptionOperationAdditionalInfo)

External error information from subscription sink

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
{}

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
type
required
string
Value: "STREAM_SUBSCRIPTION"
name
required
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
required
object (StreamSubscriptionSink)

Create Stream destination

uri
string

any publicly reachable http endpoint

type
required
string
Enum: "DATADOG" "GOOGLE_PUBSUB" "PAGERDUTY" "SERVICENOW" "SLACK" "SPLUNK_HEC" "TEAMS" "WEBHOOK"

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

format
string
Default: "CLOUDEVENT"
Enum: "CLOUDEVENT" "OPENTELEMETRY"

webhook message format

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
{}

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": {
    }
}

Search Stream Subscriptions

This API provides capability to search stream subscriptions

Authorizations:
BearerAuth
Request Body schema: application/json
required
required
object (StreamSubscriptionSearchFilters)
required
Array of StreamSubscriptionSearchSimpleExpression (object) or StreamSubscriptionSearchOrFilter (object) (StreamSubscriptionSearchFilter) non-empty
Array (non-empty)
Any of
property
string

Possible field names to use on filters:

  • /uuid - Subscription uuid
  • /streamUuid - Stream uuid the subscription belongs to
  • /state - Subscription state (DEPROVISIONED returned only when explicitly requested)
  • /name - Subscription name
  • /project/projectId - Subscription project id
  • /description - Subscription description
  • /changeLog/createdDateTime - Subscription created date time
  • /changeLog/updatedDateTime - Subscription updated date time
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
  • BETWEEN - between
  • NOT BETWEEN - not between
  • LIKE - like
  • ILIKE - like case-insensitive
  • IN - in
  • NOT IN - not in
values
Array of strings non-empty
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 (StreamSubscriptionSearchSortCriteria)
Array
direction
required
string (StreamSubscriptionSearchSortDirection)
Default: "DESC"
Enum: "DESC" "ASC"

Sorting direction

property
required
string (StreamSubscriptionSearchSortBy)
Default: "/changeLog/createdDateTime"
Enum: "/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 (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 (StreamSubscriptionSinkResponse)

Create Stream destination

object (StreamSubscriptionOperation)

Stream subscription operational information

object (Changelog)

Change log

Request samples

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

Response samples

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

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

type
string
Value: "TELEMETRY_STREAM"

type

name
string

Customer-provided stream name

description
string

Customer-provided stream description

object (Project)
state
string
Enum: "PROVISIONING" "PROVISIONED" "REPROVISIONING" "DEPROVISIONING" "DEPROVISIONED" "FAILED"

Stream provision state

assetsCount
integer

Stream assets count

streamSubscriptionsCount
integer

Stream subscriptions count

alertRulesCount
integer

Stream alert rules count

object (Changelog)

Change log

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
required
string
Value: "TELEMETRY_STREAM"
name
required
string

Customer-provided stream name

description
string

Customer-provided stream description

required
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,
  • "alertRulesCount": 3,
  • "changeLog": {
    }
}

Search Streams

This API provides capability to search streams

Authorizations:
BearerAuth
Request Body schema: application/json
optional
object (StreamSearchFilters)
required
Array of StreamSearchSimpleExpression (object) or StreamSearchOrFilter (object) (StreamSearchFilter) [ 1 .. 10 ] items
Array ([ 1 .. 10 ] items)
Any of
property
string

Possible field names to use on filters:

  • /uuid - Stream uuid
  • /name - Stream name
  • /state - Stream state (DEPROVISIONED returned only when explicitly requested)
  • /type - Stream type
  • /description - Stream description
  • /project/projectId - Stream project id
  • /changeLog/createdDateTime - Stream created date time
  • /changeLog/updatedDateTime - Stream updated date time
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
  • BETWEEN - between
  • NOT BETWEEN - not between
  • LIKE - like
  • ILIKE - like case-insensitive
  • IN - in
  • NOT IN - not in
values
Array of strings [ 1 .. 100 ] items
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 (StreamSearchSortCriteria)
Array
direction
required
string (StreamSearchSortDirection)
Default: "DESC"
Enum: "DESC" "ASC"

Sorting direction

property
required
string (StreamSearchSortBy)
Default: "/changeLog/createdDateTime"
Enum: "/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 (Stream)

Data returned from the API call.

Array
href
string <uri>

Stream URI

uuid
string <uuid>

Equinix-assigned access point identifier

type
string
Value: "TELEMETRY_STREAM"

type

name
string

Customer-provided stream name

description
string

Customer-provided stream description

object (Project)
state
string
Enum: "PROVISIONING" "PROVISIONED" "REPROVISIONING" "DEPROVISIONING" "DEPROVISIONED" "FAILED"

Stream provision state

assetsCount
integer

Stream assets count

streamSubscriptionsCount
integer

Stream subscriptions count

alertRulesCount
integer

Stream alert rules count

object (Changelog)

Change log

Request samples

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

Response samples

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

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

type
string
Value: "TELEMETRY_STREAM"

type

name
string

Customer-provided stream name

description
string

Customer-provided stream description

object (Project)
projectId
required
string

Subscriber-assigned project ID

state
string
Enum: "PROVISIONING" "PROVISIONED" "REPROVISIONING" "DEPROVISIONING" "DEPROVISIONED" "FAILED"

Stream provision state

assetsCount
integer

Stream assets count

streamSubscriptionsCount
integer

Stream subscriptions count

alertRulesCount
integer

Stream alert rules 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

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,
  • "alertRulesCount": 3,
  • "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
required
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,
  • "alertRulesCount": 3,
  • "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": {
    }
}

Search Stream Assets

This API provides capability to search stream assets

Authorizations:
BearerAuth
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 (= and IN only)
  • /streamUuid - Stream uuid (= and IN only)
  • /attachmentStatus - Asset attachment status (=, IN, and NOT IN)
operator
string

Possible operators to use on filters:

  • = - equal
  • IN - in
  • NOT IN - not in
values
Array of strings non-empty
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
required
string (StreamAssetSortDirection)
Default: "DESC"
Enum: "DESC" "ASC"

Sorting direction

property
required
string (StreamAssetSortBy)
Default: "/uuid"
Enum: "/uuid" "/streamUuid"

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 (StreamSearchAsset)

Data returned from the API call.

Array
href
string <uri>

Stream Asset URI

uuid
string <uuid>

Equinix-assigned access point identifier

streamUuid
string <uuid>

Equinix-assigned access point identifier

type
string

Asset type

metricsEnabled
boolean

enable metric

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

asset status

projectId
string

project ic

Request samples

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

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" "networkEdgeDevices" "companyProfiles"

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" "DATA" "MGMT" "SSH" "FAB" "CTRL"

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" "networkEdgeDevices" "companyProfiles"

asset

streamId
required
string <uuid> (StreamId)
Example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5

Stream UUID

Request Body schema: application/json
required
metricsEnabled
boolean
Default: false

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" "networkEdgeDevices" "companyProfiles"

asset

streamId
required
string <uuid> (StreamId)
Example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5

Stream UUID

Responses

Response samples

Content type
application/json
{}

Tags

Tags Beta

List Tags

Get all Tags

Authorizations:
BearerAuth
query Parameters
type
Array of strings

Filter by tag type

offset
integer <int32>
Default: 0

Offset for pagination

limit
integer <int32> <= 100
Default: 20

Limit for pagination

Responses

Response Schema: application/json
Array of objects (TagResponse)
Array
href
string <uri>
uuid
string <uuid>
type
string
name
string
displayName
string
state
string
Enum: "APPROVED" "PENDING_APPROVAL" "REJECTED"

Status of the Tag request. Can be APPROVED, PENDING_APPROVAL, REJECT

Array of objects (SimplifiedNotification)
object (Changelog)

Change log

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
{
  • "data": [
    ],
  • "pagination": {
    }
}

Create Tag

Create Tag for Equinix Fabric™.

Authorizations:
BearerAuth
Request Body schema: application/json
required
type
required
string

Type of tag

displayName
required
string [ 1 .. 24 ] characters

Display name of the Tag

Array of objects (SimplifiedNotification)
Array
type
required
string
Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS" "TECHNICAL" "ORDERING" "QUOTE_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

Array of objects (Phone)

Array of contact phone numbers

Responses

Request samples

Content type
application/json
{
  • "type": "PREDEFINED_TAG",
  • "displayName": "LLM",
  • "notifications": [
    ]
}

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/fabric/v4/tags/18a127ad-9d0c-46e2-a66d-8ed85d1858b0",
  • "uuid": "18a127ad-9d0c-46e2-a66d-8ed85d1858b0",
  • "type": "PREDEFINED_TAG",
  • "name": "equinix.fabric.spotlight.ai.llm",
  • "displayName": "LLM",
  • "state": "PENDING_APPROVAL",
  • "notifications": [
    ],
  • "changeLog": {
    }
}

Get Tag

Get Tag by UUID

Authorizations:
BearerAuth
path Parameters
uuid
required
string <uuid>

UUID of the Tag

Responses

Response Schema: application/json
href
string <uri>
uuid
string <uuid>
type
string
name
string
displayName
string
state
string
Enum: "APPROVED" "PENDING_APPROVAL" "REJECTED"

Status of the Tag request. Can be APPROVED, PENDING_APPROVAL, REJECT

Array of objects (SimplifiedNotification)
Array
type
required
string
Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS" "TECHNICAL" "ORDERING" "QUOTE_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

Array of objects (Phone)

Array of contact phone numbers

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/tags/18a127ad-9d0c-46e2-a66d-8ed85d1858b0",
  • "uuid": "18a127ad-9d0c-46e2-a66d-8ed85d1858b0",
  • "type": "PREDEFINED_TAG",
  • "name": "equinix.fabric.spotlight.ai.llm",
  • "displayName": "LLM",
  • "state": "PENDING_APPROVAL",
  • "notifications": [
    ],
  • "changeLog": {
    }
}
Was this page helpful?